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 ()

FEMethodsSequence &	get_loops_to_do_Mat ()

FEMethodsSequence &	get_loops_to_do_Rhs ()

BasicMethodsSequence &	get_preProcess_to_do_Rhs ()

BasicMethodsSequence &	get_postProcess_to_do_Rhs ()

BasicMethodsSequence &	get_preProcess_to_do_Mat ()

BasicMethodsSequence &	get_postProcess_to_do_Mat ()

Public Attributes
DEPRECATED typedef MoFEM::PairNameFEMethodPtr	loop_pair_type

DEPRECATED typedef MoFEM::FEMethodsSequence	loops_to_do_type

DEPRECATED typedef MoFEM::BasicMethodsSequence	basic_method_to_do

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
	Sequence of methods run before residual is assembled. More...

BasicMethodsSequence	postProcess_Rhs
	Sequence of methods run after residual is assembled. More...

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 elenents in the list. More...

Detailed Description

Interface for linear (KSP) solver.

Definition at line 27 of file KspCtx.hpp.

Member Typedef Documentation

◆ BasicMethodsSequence

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

Definition at line 46 of file KspCtx.hpp.

◆ FEMethodsSequence

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

Definition at line 45 of file KspCtx.hpp.

◆ PairNameFEMethodPtr

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

Definition at line 44 of file KspCtx.hpp.

Constructor & Destructor Documentation

◆ KspCtx()

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

Definition at line 61 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 ( )

virtual

Definition at line 67 of file KspCtx.hpp.

67 {}

Member Function Documentation

◆ get_loops_to_do_Mat()

FEMethodsSequence& MoFEM::KspCtx::get_loops_to_do_Mat ( )

Returns: return reference to vector with FEMethod to calculate matrix

Definition at line 72 of file KspCtx.hpp.

72 { return loops_to_do_Mat; }

MoFEM::KspCtx::loops_to_do_Mat

FEMethodsSequence loops_to_do_Mat

Definition: KspCtx.hpp:48

◆ get_loops_to_do_Rhs()

FEMethodsSequence& MoFEM::KspCtx::get_loops_to_do_Rhs ( )

Returns: return vector to vector with FEMethod to vector

Definition at line 77 of file KspCtx.hpp.

77 { return loops_to_do_Rhs; }

MoFEM::KspCtx::loops_to_do_Rhs

FEMethodsSequence loops_to_do_Rhs

Definition: KspCtx.hpp:50

◆ get_postProcess_to_do_Mat()

BasicMethodsSequence& MoFEM::KspCtx::get_postProcess_to_do_Mat ( )

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 109 of file KspCtx.hpp.

109 { return postProcess_Mat; }

MoFEM::KspCtx::postProcess_Mat

BasicMethodsSequence postProcess_Mat

Definition: KspCtx.hpp:54

◆ get_postProcess_to_do_Rhs()

BasicMethodsSequence& MoFEM::KspCtx::get_postProcess_to_do_Rhs ( )

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 95 of file KspCtx.hpp.

95 { return postProcess_Rhs; }

MoFEM::KspCtx::postProcess_Rhs

BasicMethodsSequence postProcess_Rhs

Sequence of methods run after residual is assembled.

Definition: KspCtx.hpp:59

◆ get_preProcess_to_do_Mat()

BasicMethodsSequence& MoFEM::KspCtx::get_preProcess_to_do_Mat ( )

Returns: reference to BasicMethod for preprocessing

Definition at line 100 of file KspCtx.hpp.

100 { return preProcess_Mat; }

MoFEM::KspCtx::preProcess_Mat

BasicMethodsSequence preProcess_Mat

Definition: KspCtx.hpp:52

◆ get_preProcess_to_do_Rhs()

BasicMethodsSequence& MoFEM::KspCtx::get_preProcess_to_do_Rhs ( )

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 86 of file KspCtx.hpp.

86 { return preProcess_Rhs; }

MoFEM::KspCtx::preProcess_Rhs

BasicMethodsSequence preProcess_Rhs

Sequence of methods run before residual is assembled.

Definition: KspCtx.hpp:57

Friends And Related Function Documentation

◆ KspMat

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

friend

Run over elenents in the list.

Parameters

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

Returns: error code

Definition at line 82 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 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;
   };
 
   auto unset = [&](auto &fe) {
     fe.ksp_ctx = KspMethod::CTX_KSPNONE;
     fe.data_ctx = PetscData::CtxSetNone;
   };
 
   // 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);
     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 23 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 set = [&](auto &fe) {
     fe.ksp = ksp;
     fe.ksp_ctx = KspMethod::CTX_SETFUNCTION;
     fe.data_ctx = PetscData::CtxSetF;
     fe.ksp_f = f;
   };
 
   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);
     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

◆ basic_method_to_do

DEPRECATED typedef MoFEM::BasicMethodsSequence MoFEM::KspCtx::basic_method_to_do

Deprecated:: use BasicMethodsSequence

Definition at line 42 of file KspCtx.hpp.

◆ bH

MoFEMTypes MoFEM::KspCtx::bH

If set to MF_EXIST check if element exist.

Definition at line 33 of file KspCtx.hpp.

◆ loop_pair_type

DEPRECATED typedef MoFEM::PairNameFEMethodPtr MoFEM::KspCtx::loop_pair_type

Deprecated:: use PairNameFEMethodPtr

Definition at line 36 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 48 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 50 of file KspCtx.hpp.

◆ loops_to_do_type

DEPRECATED typedef MoFEM::FEMethodsSequence MoFEM::KspCtx::loops_to_do_type

Deprecated:: use FEMethodsSequence

Definition at line 39 of file KspCtx.hpp.

◆ matAssembleSwitch

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

private

Definition at line 120 of file KspCtx.hpp.

◆ mField

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

Definition at line 29 of file KspCtx.hpp.

◆ moab

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

Definition at line 30 of file KspCtx.hpp.

◆ MOFEM_EVENT_KspMat

PetscLogEvent MoFEM::KspCtx::MOFEM_EVENT_KspMat

private

Definition at line 117 of file KspCtx.hpp.

◆ MOFEM_EVENT_KspRhs

PetscLogEvent MoFEM::KspCtx::MOFEM_EVENT_KspRhs

private

Definition at line 116 of file KspCtx.hpp.

◆ postProcess_Mat

BasicMethodsSequence MoFEM::KspCtx::postProcess_Mat

Sequence of methods run after tangent matrix is assembled

Definition at line 54 of file KspCtx.hpp.

◆ postProcess_Rhs

BasicMethodsSequence MoFEM::KspCtx::postProcess_Rhs

Sequence of methods run after residual is assembled.

Definition at line 59 of file KspCtx.hpp.

◆ preProcess_Mat

BasicMethodsSequence MoFEM::KspCtx::preProcess_Mat

Sequence of methods run before tangent matrix is assembled

Definition at line 52 of file KspCtx.hpp.

◆ preProcess_Rhs

BasicMethodsSequence MoFEM::KspCtx::preProcess_Rhs

Sequence of methods run before residual is assembled.

Definition at line 57 of file KspCtx.hpp.

◆ problemName

std::string MoFEM::KspCtx::problemName

Problem name.

Definition at line 32 of file KspCtx.hpp.

◆ vecAssembleSwitch

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

private

Definition at line 119 of file KspCtx.hpp.

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

src/petsc/KspCtx.hpp

Public Types

Public Member Functions

Public Attributes

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ BasicMethodsSequence

◆ FEMethodsSequence

◆ PairNameFEMethodPtr

Constructor & Destructor Documentation

◆ KspCtx()

◆ ~KspCtx()

Member Function Documentation

◆ get_loops_to_do_Mat()

◆ get_loops_to_do_Rhs()

◆ get_postProcess_to_do_Mat()

◆ get_postProcess_to_do_Rhs()

◆ get_preProcess_to_do_Mat()

◆ get_preProcess_to_do_Rhs()

Friends And Related Function Documentation

◆ KspMat

◆ KspRhs

Member Data Documentation

◆ basic_method_to_do

◆ bH

◆ loop_pair_type

◆ loops_to_do_Mat

◆ loops_to_do_Rhs

◆ loops_to_do_type

◆ matAssembleSwitch

◆ mField

◆ moab

◆ MOFEM_EVENT_KspMat

◆ MOFEM_EVENT_KspRhs

◆ postProcess_Mat

◆ postProcess_Rhs

◆ preProcess_Mat

◆ preProcess_Rhs

◆ problemName

◆ vecAssembleSwitch