MoFEM::KspCtx Struct Reference

Interface for linear (KSP) solver. More...

#include <src/petsc/KspCtx.hpp>

Collaboration diagram for MoFEM::KspCtx:

Public Types
typedef MoFEM::PairNameFEMethodPtr	PairNameFEMethodPtr
typedef MoFEM::FEMethodsSequence	FEMethodsSequence
typedef MoFEM::BasicMethodsSequence	BasicMethodsSequence

Public Member Functions
	KspCtx (MoFEM::Interface &m_field, const std::string &_problem_name)
virtual	~KspCtx ()=default
FEMethodsSequence &	getSetOperators ()
FEMethodsSequence &	getComputeRhs ()
BasicMethodsSequence &	getPreProcComputeRhs ()
BasicMethodsSequence &	getPostProcComputeRhs ()
BasicMethodsSequence &	getPreProcSetOperators ()
BasicMethodsSequence &	getPostProcSetOperators ()
MoFEMErrorCode	clearLoops ()
	Clear loops. More...
DEPRECATED FEMethodsSequence &	get_loops_to_do_Mat ()
DEPRECATED FEMethodsSequence &	get_loops_to_do_Rhs ()
DEPRECATED BasicMethodsSequence &	get_preProcess_to_do_Rhs ()
BasicMethodsSequence &	get_postProcess_to_do_Rhs ()
DEPRECATED BasicMethodsSequence &	get_preProcess_to_do_Mat ()
DEPRECATED BasicMethodsSequence &	get_postProcess_to_do_Mat ()

Public Attributes
MoFEM::Interface &	mField
moab::Interface &	moab
std::string	problemName
	Problem name. More...
MoFEMTypes	bH
	If set to MF_EXIST check if element exist. More...
FEMethodsSequence	loops_to_do_Mat
FEMethodsSequence	loops_to_do_Rhs
BasicMethodsSequence	preProcess_Mat
BasicMethodsSequence	postProcess_Mat
BasicMethodsSequence	preProcess_Rhs
BasicMethodsSequence	postProcess_Rhs

Private Attributes
PetscLogEvent	MOFEM_EVENT_KspRhs
PetscLogEvent	MOFEM_EVENT_KspMat
boost::movelib::unique_ptr< bool >	vecAssembleSwitch
boost::movelib::unique_ptr< bool >	matAssembleSwitch

Friends
PetscErrorCode	KspRhs (KSP ksp, Vec f, void *ctx)
	Run over elements in the lists. More...
PetscErrorCode	KspMat (KSP ksp, Mat A, Mat B, void *ctx)
	Run over elements in the list. More...

Detailed Description

Interface for linear (KSP) solver.

Definition at line 13 of file KspCtx.hpp.

Member Typedef Documentation

BasicMethodsSequence

typedef MoFEM::BasicMethodsSequence MoFEM::KspCtx::BasicMethodsSequence

Definition at line 23 of file KspCtx.hpp.

FEMethodsSequence

typedef MoFEM::FEMethodsSequence MoFEM::KspCtx::FEMethodsSequence

Definition at line 22 of file KspCtx.hpp.

PairNameFEMethodPtr

typedef MoFEM::PairNameFEMethodPtr MoFEM::KspCtx::PairNameFEMethodPtr

Definition at line 21 of file KspCtx.hpp.

Constructor & Destructor Documentation

KspCtx()

MoFEM::KspCtx::KspCtx ( MoFEM::Interface &  m_field, const std::string &  _problem_name  )

inline

Definition at line 38 of file KspCtx.hpp.

      : mField(m_field), moab(m_field.get_moab()), problemName(_problem_name),
        bH(MF_EXIST) {
    PetscLogEventRegister("LoopKSPRhs", 0, &MOFEM_EVENT_KspRhs);
    PetscLogEventRegister("LoopKSPMat", 0, &MOFEM_EVENT_KspMat);
  }

~KspCtx()

virtual MoFEM::KspCtx::~KspCtx ( )

virtualdefault

Member Function Documentation

clearLoops()

MoFEMErrorCode MoFEM::KspCtx::clearLoops

(

)

Clear loops.

Returns

MoFEMErrorCode

Definition at line 11 of file KspCtx.cpp.

                                  {
  MoFEMFunctionBegin;
  loops_to_do_Mat.clear();
  loops_to_do_Rhs.clear();
  preProcess_Mat.clear();
  postProcess_Mat.clear();
  preProcess_Rhs.clear();
  MoFEMFunctionReturn(0);
}

get_loops_to_do_Mat()

DEPRECATED FEMethodsSequence& MoFEM::KspCtx::get_loops_to_do_Mat ( )

inline

Deprecated:

use getSetOperator

Definition at line 99 of file KspCtx.hpp.

                                                      {
    return getSetOperators();
  }

get_loops_to_do_Rhs()

DEPRECATED FEMethodsSequence& MoFEM::KspCtx::get_loops_to_do_Rhs ( )

inline

Deprecated:

use getComputeRhs

Definition at line 104 of file KspCtx.hpp.

                                                      {
    return getComputeRhs();
  }

get_postProcess_to_do_Mat()

DEPRECATED BasicMethodsSequence& MoFEM::KspCtx::get_postProcess_to_do_Mat ( )

inline

Deprecated:

use getPostProcSetOperators

Definition at line 124 of file KspCtx.hpp.

                                                               {
    return getPostProcSetOperators();
  }

get_postProcess_to_do_Rhs()

BasicMethodsSequence& MoFEM::KspCtx::get_postProcess_to_do_Rhs ( )

inline

Deprecated:

use getPostProcComputeRhs

Definition at line 114 of file KspCtx.hpp.

                                                    {
    return getPostProcComputeRhs();
  }

get_preProcess_to_do_Mat()

DEPRECATED BasicMethodsSequence& MoFEM::KspCtx::get_preProcess_to_do_Mat ( )

inline

Deprecated:

use getPreProcSetOperators

Definition at line 119 of file KspCtx.hpp.

                                                              {
    return getPreProcSetOperators();
  }

get_preProcess_to_do_Rhs()

DEPRECATED BasicMethodsSequence& MoFEM::KspCtx::get_preProcess_to_do_Rhs ( )

inline

Deprecated:

use getPreProcComputeRhs

Definition at line 109 of file KspCtx.hpp.

                                                              {
    return getPreProcComputeRhs();
  }

getComputeRhs()

FEMethodsSequence& MoFEM::KspCtx::getComputeRhs ( )

inline

Returns

return vector to vector with FEMethod to vector

Definition at line 54 of file KspCtx.hpp.

{ return loops_to_do_Rhs; }

getPostProcComputeRhs()

BasicMethodsSequence& MoFEM::KspCtx::getPostProcComputeRhs ( )

inline

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.

Returns

reference to BasicMethod for postprocessing

Definition at line 72 of file KspCtx.hpp.

{ return postProcess_Rhs; }

getPostProcSetOperators()

BasicMethodsSequence& MoFEM::KspCtx::getPostProcSetOperators ( )

inline

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.

Returns

reference to BasicMethod for postprocessing

Definition at line 86 of file KspCtx.hpp.

{ return postProcess_Mat; }

getPreProcComputeRhs()

BasicMethodsSequence& MoFEM::KspCtx::getPreProcComputeRhs ( )

inline

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.

Returns

reference to BasicMethod for preprocessing

Definition at line 63 of file KspCtx.hpp.

{ return preProcess_Rhs; }

getPreProcSetOperators()

BasicMethodsSequence& MoFEM::KspCtx::getPreProcSetOperators ( )

inline

Returns

reference to BasicMethod for preprocessing

Definition at line 77 of file KspCtx.hpp.

{ return preProcess_Mat; }

getSetOperators()

FEMethodsSequence& MoFEM::KspCtx::getSetOperators ( )

inline

Returns

return reference to vector with FEMethod to calculate matrix

Definition at line 49 of file KspCtx.hpp.

{ return loops_to_do_Mat; }

Friends And Related Function Documentation

KspMat

PetscErrorCode KspMat ( KSP  ksp, Mat  A, Mat  B, void *  ctx  )

friend

Run over elements in the list.

Parameters

ksp	KSP solver
A	matrix
B	Preconditioned matrix
ctx	data context, i.e. KspCtx

Returns

error code

Definition at line 86 of file KspCtx.cpp.

                                                        {
  // PetscValidHeaderSpecific(ksp,KSP_CLASSID,1);
  MoFEMFunctionBegin;
  KspCtx *ksp_ctx = static_cast<KspCtx *>(ctx);
  PetscLogEventBegin(ksp_ctx->MOFEM_EVENT_KspMat, 0, 0, 0, 0);
 
  ksp_ctx->matAssembleSwitch = boost::movelib::make_unique<bool>(true);
  auto cache_ptr = boost::make_shared<CacheTuple>();
  CHKERR ksp_ctx->mField.cache_problem_entities(ksp_ctx->problemName,
                                                cache_ptr);
 
  auto set = [&](auto &fe) {
    fe.ksp = ksp;
    fe.ksp_A = A;
    fe.ksp_B = B;
    fe.ksp_ctx = KspMethod::CTX_OPERATORS;
    fe.data_ctx = PetscData::CtxSetA | PetscData::CtxSetB;
    fe.cacheWeakPtr = cache_ptr;
  };
 
  auto unset = [&](auto &fe) {
    fe.ksp_ctx = KspMethod::CTX_KSPNONE;
    fe.data_ctx = PetscData::CtxSetNone;
  };
 
  auto ent_data_cache = boost::make_shared<std::vector<EntityCacheDofs>>();
  auto ent_row_cache =
      boost::make_shared<std::vector<EntityCacheNumeredDofs>>();
  auto ent_col_cache =
      boost::make_shared<std::vector<EntityCacheNumeredDofs>>();
 
  // pre-procsess
  for (auto &bit : ksp_ctx->preProcess_Mat) {
    bit->matAssembleSwitch = boost::move(ksp_ctx->matAssembleSwitch);
    set(*bit);
    CHKERR ksp_ctx->mField.problem_basic_method_preProcess(ksp_ctx->problemName,
                                                           *bit);
    unset(*bit);
    ksp_ctx->matAssembleSwitch = boost::move(bit->matAssembleSwitch);
  }
 
  // operators
  for (auto &lit : ksp_ctx->loops_to_do_Mat) {
    lit.second->matAssembleSwitch = boost::move(ksp_ctx->matAssembleSwitch);
    set(*lit.second);
    CHKERR ksp_ctx->mField.loop_finite_elements(ksp_ctx->problemName, lit.first,
                                                *(lit.second), nullptr,
                                                ksp_ctx->bH, cache_ptr);
    unset(*lit.second);
    ksp_ctx->matAssembleSwitch = boost::move(lit.second->matAssembleSwitch);
  }
 
  // post-process
  for (auto &bit : ksp_ctx->postProcess_Mat) {
    bit->matAssembleSwitch = boost::move(ksp_ctx->matAssembleSwitch);
    set(*bit);
    CHKERR ksp_ctx->mField.problem_basic_method_postProcess(
        ksp_ctx->problemName, *bit);
    unset(*bit);
    ksp_ctx->matAssembleSwitch = boost::move(bit->matAssembleSwitch);
  }
 
  if (ksp_ctx->matAssembleSwitch) {
    CHKERR MatAssemblyBegin(B, MAT_FINAL_ASSEMBLY);
    CHKERR MatAssemblyEnd(B, MAT_FINAL_ASSEMBLY);
  }
  PetscLogEventEnd(ksp_ctx->MOFEM_EVENT_KspMat, 0, 0, 0, 0);
  MoFEMFunctionReturn(0);
}

KspRhs

PetscErrorCode KspRhs ( KSP  ksp, Vec  f, void *  ctx  )

friend

Run over elements in the lists.

Parameters

ksp	KSP solver
f	the right hand side vector
ctx	data context, i.e. KspCtx

Returns

error code

Definition at line 21 of file KspCtx.cpp.

                                                 {
  // PetscValidHeaderSpecific(ksp,KSP_CLASSID,1);
  MoFEMFunctionBegin;
  KspCtx *ksp_ctx = static_cast<KspCtx *>(ctx);
  PetscLogEventBegin(ksp_ctx->MOFEM_EVENT_KspRhs, 0, 0, 0, 0);
 
  ksp_ctx->vecAssembleSwitch = boost::movelib::make_unique<bool>(true);
 
  auto cache_ptr = boost::make_shared<CacheTuple>();
  CHKERR ksp_ctx->mField.cache_problem_entities(ksp_ctx->problemName,
                                                cache_ptr);
 
  auto set = [&](auto &fe) {
    fe.ksp = ksp;
    fe.ksp_ctx = KspMethod::CTX_SETFUNCTION;
    fe.data_ctx = PetscData::CtxSetF;
    fe.ksp_f = f;
    fe.cacheWeakPtr = cache_ptr;
  };
 
  auto unset = [&](auto &fe) {
    fe.ksp_ctx = KspMethod::CTX_KSPNONE;
    fe.data_ctx = PetscData::CtxSetNone;
  };
 
  // pre-process
  for (auto &bit : ksp_ctx->preProcess_Rhs) {
    bit->vecAssembleSwitch = boost::move(ksp_ctx->vecAssembleSwitch);
    set(*bit);
    CHKERR ksp_ctx->mField.problem_basic_method_preProcess(ksp_ctx->problemName,
                                                           *bit);
    unset(*bit);
    ksp_ctx->vecAssembleSwitch = boost::move(bit->vecAssembleSwitch);
  }
 
  // operators
  for (auto &lit : ksp_ctx->loops_to_do_Rhs) {
    lit.second->vecAssembleSwitch = boost::move(ksp_ctx->vecAssembleSwitch);
    set(*lit.second);
    CHKERR ksp_ctx->mField.loop_finite_elements(ksp_ctx->problemName, lit.first,
                                                *(lit.second), nullptr,
                                                ksp_ctx->bH, cache_ptr);
    unset(*lit.second);
    ksp_ctx->vecAssembleSwitch = boost::move(lit.second->vecAssembleSwitch);
  }
 
  // post-process
  for (auto &bit : ksp_ctx->postProcess_Rhs) {
    bit->vecAssembleSwitch = boost::move(ksp_ctx->vecAssembleSwitch);
    set(*bit);
    CHKERR ksp_ctx->mField.problem_basic_method_postProcess(
        ksp_ctx->problemName, *bit);
    unset(*bit);
    ksp_ctx->vecAssembleSwitch = boost::move(bit->vecAssembleSwitch);
  }
 
  if (*ksp_ctx->vecAssembleSwitch) {
    CHKERR VecGhostUpdateBegin(f, ADD_VALUES, SCATTER_REVERSE);
    CHKERR VecGhostUpdateEnd(f, ADD_VALUES, SCATTER_REVERSE);
    CHKERR VecAssemblyBegin(f);
    CHKERR VecAssemblyEnd(f);
  }
  PetscLogEventEnd(ksp_ctx->MOFEM_EVENT_KspRhs, 0, 0, 0, 0);
  MoFEMFunctionReturn(0);
}

Member Data Documentation

bH

MoFEMTypes MoFEM::KspCtx::bH

If set to MF_EXIST check if element exist.

Definition at line 19 of file KspCtx.hpp.

loops_to_do_Mat

FEMethodsSequence MoFEM::KspCtx::loops_to_do_Mat

Sequence of finite elements instances assembling tangent matrix

Definition at line 25 of file KspCtx.hpp.

loops_to_do_Rhs

FEMethodsSequence MoFEM::KspCtx::loops_to_do_Rhs

Sequence of finite elements instances assembling residual vector

Definition at line 27 of file KspCtx.hpp.

matAssembleSwitch

boost::movelib::unique_ptr<bool> MoFEM::KspCtx::matAssembleSwitch

private

Definition at line 133 of file KspCtx.hpp.

mField

MoFEM::Interface& MoFEM::KspCtx::mField

Definition at line 15 of file KspCtx.hpp.

moab

moab::Interface& MoFEM::KspCtx::moab

Definition at line 16 of file KspCtx.hpp.

MOFEM_EVENT_KspMat

PetscLogEvent MoFEM::KspCtx::MOFEM_EVENT_KspMat

private

Definition at line 130 of file KspCtx.hpp.

MOFEM_EVENT_KspRhs

PetscLogEvent MoFEM::KspCtx::MOFEM_EVENT_KspRhs

private

Definition at line 129 of file KspCtx.hpp.

postProcess_Mat

BasicMethodsSequence MoFEM::KspCtx::postProcess_Mat

Sequence of methods run after tangent matrix is assembled

Definition at line 31 of file KspCtx.hpp.

postProcess_Rhs

BasicMethodsSequence MoFEM::KspCtx::postProcess_Rhs

Sequence of methods run after residual is assembled

Definition at line 35 of file KspCtx.hpp.

preProcess_Mat

BasicMethodsSequence MoFEM::KspCtx::preProcess_Mat

Sequence of methods run before tangent matrix is assembled

Definition at line 29 of file KspCtx.hpp.

preProcess_Rhs

BasicMethodsSequence MoFEM::KspCtx::preProcess_Rhs

Sequence of methods run before residual is assembled

Definition at line 33 of file KspCtx.hpp.

problemName

std::string MoFEM::KspCtx::problemName

Problem name.

Definition at line 18 of file KspCtx.hpp.

vecAssembleSwitch

boost::movelib::unique_ptr<bool> MoFEM::KspCtx::vecAssembleSwitch

private

Definition at line 132 of file KspCtx.hpp.

---

The documentation for this struct was generated from the following files:

• src/petsc/KspCtx.hpp
• src/petsc/impl/KspCtx.cpp