PCMGSetUpViaApproxOrders.hpp

Go to the documentation of this file.

/** \file PCMGSetUpViaApproxOrders.hpp
 * \brief header of multi-grid solver for p- adaptivity
 */
 
#include <DMCtxImpl.hpp>
 
#ifndef __PCMGSETUP_VIA_APPROX_ORDERS_HPP__
#define __PCMGSETUP_VIA_APPROX_ORDERS_HPP__
struct PCMGSubMatrixCtx {
  Mat A;
  Vec X, F;
  IS iS;
  VecScatter sCat;
  PCMGSubMatrixCtx(Mat a, IS is);
  virtual ~PCMGSubMatrixCtx();
};
 
/**
 * \brief Structure for DM for multi-grid via approximation orders
 * \ingroup dm
 */
struct DMMGViaApproxOrdersCtx : public MoFEM::DMCtxImpl {
 
  MoFEMErrorCode query_interface(boost::typeindex::type_index type_index,
                                 MoFEM::UnknownInterface **iface) const;
 
  DMMGViaApproxOrdersCtx();
  virtual ~DMMGViaApproxOrdersCtx();
 
  MoFEMErrorCode destroyCoarseningIS();
 
  AO aO;
  std::vector<IS> coarseningIS;  ///< Coarsening IS
  std::vector<Mat> kspOperators; ///< Get KSP operators
  boost::ptr_vector<PCMGSubMatrixCtx>
      shellMatrixCtxPtr; ///< Shell sub-matrix context
};
 
/**
 * Get DM Ctx
 */
MoFEMErrorCode DMMGViaApproxOrdersGetCtx(DM dm, DMMGViaApproxOrdersCtx **ctx);
 
/**
 * \brief Set DM ordering
 *
 * IS can be given is some other ordering, AO will transform indices from
 * coarseningIS ordering to ordering used to construct fine matrix.
 *
 * @param  dm [description]
 * @param  ao [description]
 * @return    [description]
 */
MoFEMErrorCode DMMGViaApproxOrdersSetAO(DM dm, AO ao);
 
/**
 * \brief Gets size of coarseningIS in internal data struture
 * DMMGViaApproxOrdersCtx
 * @param  dm   DM
 * @param  size size of coarseningIS
 * @return      Error code
 */
MoFEMErrorCode DMMGViaApproxOrdersGetCoarseningISSize(DM dm, int *size);
 
/**
 * \brief Push back coarsening level to MG via approximation orders
 *
 * @param  DM discrete manager
 * @param  is Push back IS used for coarsening
 * @param  A  Get sub-matrix of A using is (that sets operators for coarsening
 * levels)
 * @param  subA  Returning pointer to created sub matrix
 * @param  subA  If true create sub matrix, otherwise in subA has to be valid
 * pointer to subA
 * @return Error code
 *
 * \ingroup dm
 */
MoFEMErrorCode DMMGViaApproxOrdersPushBackCoarseningIS(DM, IS is, Mat A,
                                                       Mat *subA,
                                                       bool create_sub_matrix,
                                                       bool shell_sub_a);
 
/**
 * \brief Pop is form MG via approximation orders
 * @param  DM dm
 * @param  is pop back IS
 * @return    error code
 *
 * \ingroup dm
 */
MoFEMErrorCode DMMGViaApproxOrdersPopBackCoarseningIS(DM);
 
/**
 * \brief Clear approximation orders
 * @param  DM dm
 * @return Error code
 *
 * \ingroup dm
 */
MoFEMErrorCode DMMGViaApproxOrdersClearCoarseningIS(DM);
 
/**
 * \brief Replace coarsening IS in DM via approximation orders
 * @param  dm       dm
 * @param  is_vec   Pointer to vector of is
 * @param  nb_elems Number of elements
 * @param  A        Fine matrix
 * @return          Error code
 */
MoFEMErrorCode DMMGViaApproxOrdersReplaceCoarseningIS(DM dm, IS *is_vec,
                                                      int nb_elems, Mat A,
                                                      int verb = 0);
 
/**
 * \brief Get context for DM via approximation orders
 * @param  dm   the DM object
 * @param  ctx  data context
 * @return      error code
 */
MoFEMErrorCode DMMGViaApproxOrdersGetCtx(DM dm,
                                         const DMMGViaApproxOrdersCtx **ctx);
 
/**
 * \brief Register DM for Multi-Grid via approximation orders
 * @param  sname problem/dm registered name
 * @return       error code
 * \ingroup dm
 */
MoFEMErrorCode DMRegister_MGViaApproxOrders(const char sname[]);
 
/**
 * \brief Create DM data structure for Multi-Grid via approximation orders
 *
 * It set data structure and operators needed
 *
 * @param  dm Discrete manager
 * @return    Error code
 */
MoFEMErrorCode DMCreate_MGViaApproxOrders(DM dm);
 
/**
 * \brief Create matrix for Multi-Grid via approximation orders
 *
 * Not used directly by user
 *
 * @param  dm  Distributed mesh data structure
 * @param  M  Matrix
 * @return    Error code
 * \ingroup dm
 */
MoFEMErrorCode DMCreateMatrix_MGViaApproxOrders(DM dm, Mat *M);
 
/**
 * \brief Coarsen DM
 *
 * Not used directly by user
 *
 * @param  dm   Distributed mesh data structure
 * @param  comm Communicator
 * @param  dmc  Coarse distributed mesh data structure
 * @return      Error code
 *
 * \ingroup dm
 */
MoFEMErrorCode DMCoarsen_MGViaApproxOrders(DM dm, MPI_Comm comm, DM *dmc);
 
/**
 * \brief Create interpolation matrix between data managers dm1 and dm2
 * @param  dm1 Distributed mesh data structure
 * @param  dm2 Distributed mesh data structure
 * @param  mat Pointer to returned interpolation matrix
 * @param  vec Pointer to scaling vector here returned NULL
 * @return     Error code
 */
MoFEMErrorCode DMCreateInterpolation_MGViaApproxOrders(DM dm1, DM dm2, Mat *mat,
                                                       Vec *vec);
 
/**
 * \brief Create global vector for DMGViaApproxOrders
 * @param  dm Distributed mesh data structure
 * @param  g  returned pointer to vector
 * @return    Error code
 */
MoFEMErrorCode DMCreateGlobalVector_MGViaApproxOrders(DM dm, Vec *g);
 
/**
 * \brief Set data structures of MG pre-conditioner via approximation orders
 */
struct PCMGSetUpViaApproxOrdersCtx {
 
  // Interface *mFieldPtr;      ///< MoFEM interface
  // string problemName;                  ///< Problem name
 
  DM dM; ///< Distributed mesh manager
  Mat A; ///< Matrix at fine level
 
  PCMGSetUpViaApproxOrdersCtx(DM dm, Mat a, bool shell_sub_a)
      : dM(dm), A(a), nbLevels(2), coarseOrder(2), orderAtLastLevel(1000),
        shellSubA(shell_sub_a), verboseLevel(0) {}
 
  virtual ~PCMGSetUpViaApproxOrdersCtx() = default;
 
  int nbLevels;         ///< number of multi-grid levels
  int coarseOrder;      ///< approximation order of coarse level
  int orderAtLastLevel; ///< set maximal evaluated order
 
  bool shellSubA;
  int verboseLevel;
 
  /**
   * \brief get options from line command
   * @return error code
   */
  virtual MoFEMErrorCode getOptions();
 
  /**
   * \brief Set IS for levels
   * @param  kk level
   * @param  is pointer to IS
   * @return    error code
   */
  virtual MoFEMErrorCode createIsAtLevel(int kk, IS *is);
 
  /**
   * \brief Destroy IS if internally created
   * @param  kk level
   * @param  is pointer to is
   * @return    error code
   */
  virtual MoFEMErrorCode destroyIsAtLevel(int kk, IS *is);
 
  /**
   * \brief Set up data structures for MG
   * @param  pc   MG pre-conditioner
   * <http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/PC/PCMG.html>
   * @param  verb verbosity level
   * @return      error code
   */
  virtual MoFEMErrorCode buildProlongationOperator(bool use_mat_a,
                                                   int verb = 0);
 
  // DEPRECATED  virtual MoFEMErrorCode buildProlongationOperator(PC pc,int verb
  // = 0) {
  //   return buildProlongationOperator(false,verb);
  // }
};
 
/**
 * \brief Function build MG structure
 * @param  pc   MG pre-conditioner
 * <http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/PC/PCMG.html>
 * @param  ctx  MoFEM data structure for MG
 * @param  verb verbosity level
 * @return      error code
 */
MoFEMErrorCode PCMGSetUpViaApproxOrders(PC pc, PCMGSetUpViaApproxOrdersCtx *ctx,
                                        int verb = 0);
 
#endif //__PCMGSETUP_VIA_APPROX_ORDERS_HPP__