KspCtx.hpp

Go to the documentation of this file.

/** \file KspCtx.hpp
 * \brief Context for PETSc KSP, i.e. nonlinear solver
 * \author Anonymous contributor under MIT license
 */
 
#ifndef __KSPCTX_HPP__
#define __KSPCTX_HPP__
 
namespace MoFEM {
 
/** \brief Interface for linear (KSP) solver
 * \ingroup mofem_petsc_solvers
 */
struct KspCtx {
 
  KspCtx(MoFEM::Interface &m_field, std::string problem_name);
 
  virtual ~KspCtx();
 
  /**
   * @return return reference to vector with FEMethod to calculate matrix
   */
  FEMethodsSequence &getSetOperators();
 
  /**
   * @return return vector to vector with FEMethod to vector
   */
  FEMethodsSequence &getComputeRhs();
 
  /**
   * The sequence of BasicMethod is executed before residual is calculated. It
   * can be used to setup data structures, e.g. zero global variable which is
   * integrated in domain, e.g. for calculation of strain energy.
   *
   * @return reference to BasicMethod for preprocessing
   */
  BasicMethodsSequence &getPreProcComputeRhs();
 
  /**
   * The sequence of BasicMethod is executed after residual is calculated. It
   * can be used to setup data structures, e.g. aggregate data from processors
   * or to apply essential boundary conditions.
   *
   * @return reference to BasicMethod for postprocessing
   */
  BasicMethodsSequence &getPostProcComputeRhs();
 
  /**
   * @return reference to BasicMethod for preprocessing
   */
  BasicMethodsSequence &getPreProcSetOperators();
 
  /**
   * The sequence of BasicMethod is executed after tangent matrix is calculated.
   * It can be used to setup data structures, e.g. aggregate data from
   * processors or to apply essential boundary conditions.
   *
   * @return reference to BasicMethod for postprocessing
   */
  BasicMethodsSequence &getPostProcSetOperators();
 
  /**
   * @brief Clear loops
   *
   * @return MoFEMErrorCode
   */
  MoFEMErrorCode clearLoops();
 
  friend PetscErrorCode KspRhs(KSP ksp, Vec f, void *ctx);
  friend PetscErrorCode KspMat(KSP ksp, Mat A, Mat B, void *ctx);
 
  struct KspCtxImpl;
private:
  boost::movelib::unique_ptr<KspCtxImpl> kspCtxImpl;
};
 
/**
 * \brief Run over elements in the lists
 * @param  ksp KSP solver
 * @param  f   the right hand side vector
 * @param  ctx data context, i.e. KspCtx
 * @return     error code
 */
PetscErrorCode KspRhs(KSP ksp, Vec f, void *ctx);
 
/**
 * \brief Run over elements in the list
 * @param  ksp KSP solver
 * @param  A   matrix
 * @param  B   Preconditioned matrix
 * @param  ctx data context, i.e. KspCtx
 * @return     error code
 */
PetscErrorCode KspMat(KSP ksp, Mat A, Mat B, void *ctx);
 
} // namespace MoFEM
 
#endif // __KSPCTX_HPP__