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

#include "src/petsc/KspCtx.hpp"

Collaboration diagram for MoFEM::KspCtx:

Public Member Functions
	KspCtx (MoFEM::Interface &m_field, std::string problem_name)

virtual	~KspCtx ()

FEMethodsSequence &	getSetOperators ()

FEMethodsSequence &	getComputeRhs ()

BasicMethodsSequence &	getPreProcComputeRhs ()

BasicMethodsSequence &	getPostProcComputeRhs ()

BasicMethodsSequence &	getPreProcSetOperators ()

BasicMethodsSequence &	getPostProcSetOperators ()

MoFEMErrorCode	clearLoops ()
	Clear loops.

Private Attributes
boost::movelib::unique_ptr< KspCtxImpl >	kspCtxImpl

Friends
PetscErrorCode	KspRhs (KSP ksp, Vec f, void *ctx)
	Run over elements in the lists.

PetscErrorCode	KspMat (KSP ksp, Mat A, Mat B, void *ctx)
	Run over elements in the list.

Detailed Description

Interface for linear (KSP) solver.

Definition at line 14 of file KspCtx.hpp.

Constructor & Destructor Documentation

◆ KspCtx()

MoFEM::KspCtx::KspCtx	(	MoFEM::Interface &	m_field,
		std::string	problem_name
	)

Definition at line 96 of file KspCtx.cpp.

97 : kspCtxImpl(boost::movelib::make_unique<KspCtx::KspCtxImpl>(

98 m_field, problem_name)) {}

MoFEM::KspCtx::kspCtxImpl

boost::movelib::unique_ptr< KspCtxImpl > kspCtxImpl

Definition KspCtx.hpp:74

◆ ~KspCtx()

MoFEM::KspCtx::~KspCtx ( )

virtualdefault

Member Function Documentation

◆ clearLoops()

MoFEMErrorCode MoFEM::KspCtx::clearLoops ( )

Clear loops.

Returns: MoFEMErrorCode

Definition at line 126 of file KspCtx.cpp.

126{ return kspCtxImpl->clearLoops(); }

◆ getComputeRhs()

FEMethodsSequence & MoFEM::KspCtx::getComputeRhs ( )

Returns: return vector to vector with FEMethod to vector

Definition at line 106 of file KspCtx.cpp.

                                         {
  return kspCtxImpl->getComputeRhs();
}

◆ getPostProcComputeRhs()

BasicMethodsSequence & MoFEM::KspCtx::getPostProcComputeRhs ( )

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 114 of file KspCtx.cpp.

                                                    {
  return kspCtxImpl->getPostProcComputeRhs();
}

◆ getPostProcSetOperators()

BasicMethodsSequence & MoFEM::KspCtx::getPostProcSetOperators ( )

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 122 of file KspCtx.cpp.

                                                      {
  return kspCtxImpl->getPostProcSetOperators();
}

◆ getPreProcComputeRhs()

BasicMethodsSequence & MoFEM::KspCtx::getPreProcComputeRhs ( )

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 110 of file KspCtx.cpp.

                                                   {
  return kspCtxImpl->getPreProcComputeRhs();
}

◆ getPreProcSetOperators()

BasicMethodsSequence & MoFEM::KspCtx::getPreProcSetOperators ( )

Returns: reference to BasicMethod for preprocessing

Definition at line 118 of file KspCtx.cpp.

                                                     {
  return kspCtxImpl->getPreProcSetOperators();
}

◆ getSetOperators()

FEMethodsSequence & MoFEM::KspCtx::getSetOperators ( )

Returns: return reference to vector with FEMethod to calculate matrix

Definition at line 102 of file KspCtx.cpp.

                                           {
  return kspCtxImpl->getSetOperators();
}

Friends And Related Symbol 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 210 of file KspCtx.cpp.

                                                        {
  // PetscValidHeaderSpecific(ksp,KSP_CLASSID,1);
  MoFEMFunctionBegin;
  KspCtx::KspCtxImpl *ksp_ctx = static_cast<KspCtx *>(ctx)->kspCtxImpl.get();
  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->preProcessOperator) {
    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->loopsOperator) {
    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->postProcessOperator) {
    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 146 of file KspCtx.cpp.

                                                 {
  MoFEMFunctionBegin;
  KspCtx::KspCtxImpl *ksp_ctx = static_cast<KspCtx *>(ctx)->kspCtxImpl.get();
  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->preProcessRhs) {
    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->loopsRhs) {
    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->postProcessRhs) {
    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

◆ kspCtxImpl

boost::movelib::unique_ptr<KspCtxImpl> MoFEM::KspCtx::kspCtxImpl

private

Definition at line 74 of file KspCtx.hpp.

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

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

Public Member Functions

Private Attributes

Friends