petsc_dm_wrapper.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2025 Benjamin S. Kirk, John W. Peterson, Roy H. Stogner

// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.

// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.

// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

#ifndef LIBMESH_PETSC_DM_WRAPPER_H
#define LIBMESH_PETSC_DM_WRAPPER_H

#include "libmesh/petsc_macro.h"

#ifdef LIBMESH_HAVE_PETSC
#if !PETSC_VERSION_LESS_THAN(3,7,3)
#if defined(LIBMESH_ENABLE_AMR) && defined(LIBMESH_HAVE_METAPHYSICL)

// libMesh includes
#include "libmesh/petsc_macro.h"
#include "libmesh/petsc_matrix_base.h"
#include "libmesh/petsc_vector.h"
#include "libmesh/wrapped_petsc.h"

// PETSc includes
#ifdef I
# define LIBMESH_SAW_I
#endif
#include <petsc.h>
#ifndef LIBMESH_SAW_I
# undef I // Avoid complex.h contamination
#endif

// C++ includes
#include <vector>
#include <memory>
#include <unordered_map>
#include <map>

namespace libMesh
{
  // Forward declarations
  class System;
  class DofObject;

  struct PetscDMContext
  {
    int n_dofs;
    int mesh_dim;
    DM * coarser_dm;
    DM * finer_dm;
    DM * global_dm;
    PetscMatrixBase<libMesh::Number> * K_interp_ptr;
    PetscMatrixBase<libMesh::Number> * K_sub_interp_ptr;
    PetscMatrixBase<libMesh::Number> * K_restrict_ptr;
    PetscVector<libMesh::Number> * current_vec;

    std::vector<std::vector<numeric_index_type>> dof_vec;

    std::vector<PetscInt> subfields;

  PetscDMContext() :
    n_dofs(-12345),
      mesh_dim(-12345),
      coarser_dm(nullptr),
      finer_dm(nullptr),
      global_dm(nullptr),
      K_interp_ptr(nullptr),
      K_sub_interp_ptr(nullptr),
      K_restrict_ptr(nullptr),
      current_vec(nullptr)
    {}

  };

  class PetscDMWrapper
  {
  public:

    PetscDMWrapper() = default;

    ~PetscDMWrapper();

    void clear();

    void init_and_attach_petscdm(System & system, SNES snes);
    void init_and_attach_petscdm(System & system, KSP ksp);

  private:
    unsigned int init_petscdm(System & system);

    std::vector<WrappedPetsc<DM>> _dms;

    std::vector<WrappedPetsc<PetscSection>> _sections;

    std::vector<PetscSF> _star_forests;

    std::vector<std::unique_ptr<PetscMatrixBase<Number>>> _pmtx_vec;

    std::vector<std::unique_ptr<PetscMatrixBase<Number>>> _subpmtx_vec;

    std::vector<PetscDMContext> _ctx_vec;

    std::vector<std::unique_ptr<PetscVector<Number>>> _vec_vec;

    std::vector<unsigned int> _mesh_dof_sizes;

    std::vector<unsigned int> _mesh_dof_loc_sizes;

    void init_dm_data(unsigned int n_levels, const Parallel::Communicator & comm);

    DM & get_dm(unsigned int level)
      { libmesh_assert_less(level, _dms.size());
        return *_dms[level]; }

    PetscSection & get_section(unsigned int level)
      { libmesh_assert_less(level, _sections.size());
        return *_sections[level]; }

    PetscSF & get_star_forest(unsigned int level)
      { libmesh_assert_less(level, _star_forests.size());
        return _star_forests[level]; }

    void build_section(const System & system, PetscSection & section);

    void build_sf( const System & system, PetscSF & star_forest );

    void set_point_range_in_section( const System & system,
                                     PetscSection & section,
                                     std::unordered_map<dof_id_type,dof_id_type> & node_map,
                                     std::unordered_map<dof_id_type,dof_id_type> & elem_map,
                                     std::map<dof_id_type,unsigned int> & scalar_map);

    void add_dofs_to_section (const System & system,
                              PetscSection & section,
                              const std::unordered_map<dof_id_type,dof_id_type> & node_map,
                              const std::unordered_map<dof_id_type,dof_id_type> & elem_map,
                              const std::map<dof_id_type,unsigned int> & scalar_map);

    dof_id_type check_section_n_dofs( PetscSection & section );

    // Helper function to reduce code duplication when setting dofs in section
    void add_dofs_helper (const System & system,
                          const DofObject & dof_object,
                          dof_id_type local_id,
                          PetscSection & section);
  };

}

#endif // #if LIBMESH_ENABLE_AMR && LIBMESH_HAVE_METAPHYSICL
#endif // #if PETSC_VERSION
#endif // #ifdef LIBMESH_HAVE_PETSC

#endif // LIBMESH_PETSC_DM_WRAPPER_H