MoFEM::KspMethod Struct Reference

data structure for ksp (linear solver) contextStruture stores context data which are set in functions run by PETSc SNES functions. More...

#include <src/interfaces/LoopMethods.hpp>

Inheritance diagram for MoFEM::KspMethod:

Collaboration diagram for MoFEM::KspMethod:

Public Types
enum	KSPContext { CTX_SETFUNCTION, CTX_OPERATORS, CTX_KSPNONE }
	pass information about context of KSP/DM for with finite element is computed More...

Public Member Functions
MoFEMErrorCode	query_interface (const MOFEMuuid &uuid, UnknownInterface **iface) const
	KspMethod ()
virtual	~KspMethod ()
MoFEMErrorCode	setKspCtx (const KSPContext &ctx)
	set operator type More...
MoFEMErrorCode	setKsp (KSP ksp)
	set solver More...
MoFEMErrorCode	copyKsp (const KspMethod &ksp)
	copy data form another method More...
Public Member Functions inherited from MoFEM::UnknownInterface
template<class IFACE >
MoFEMErrorCode	registerInterface (const MOFEMuuid &uuid, bool error_if_registration_failed=true)
	Register interface. More...
template<class IFACE , bool VERIFY = false>
MoFEMErrorCode	getInterface (const MOFEMuuid &uuid, IFACE *&iface) const
	Get interface by uuid and return reference to pointer of interface. More...
template<class IFACE >
MoFEMErrorCode	getInterface (IFACE *&iface) const
	Get interface refernce to pointer of interface. More...
template<class IFACE >
MoFEMErrorCode	getInterface (IFACE **const iface) const
	Get interface pointer to pointer of interface. More...
template<class IFACE , typename boost::enable_if< boost::is_pointer< IFACE >, int >::type = 0>
IFACE	getInterface () const
	Get interface pointer to pointer of interface. More...
template<class IFACE , typename boost::enable_if< boost::is_reference< IFACE >, int >::type = 0>
IFACE	getInterface () const
	Get reference to interface. More...
template<class IFACE >
IFACE *	getInterface () const
	Function returning pointer to interface. More...
virtual	~UnknownInterface ()
virtual MoFEMErrorCode	getLibVersion (Version &version) const
	Get library version. More...
virtual const MoFEMErrorCode	getFileVersion (moab::Interface &moab, Version &version) const
	Get database major version. More...
virtual MoFEMErrorCode	getInterfaceVersion (Version &version) const
	Get database major version. More...
template<>
MoFEMErrorCode	getInterface (const MOFEMuuid &uuid, UnknownInterface *&iface) const

Public Attributes
KSPContext	ksp_ctx
	Context. More...
KSP	ksp
	KSP solver. More...
Vec	ksp_f
	the right hand side vector More...
Mat	ksp_A
	matrix More...
Mat	ksp_B
	preconditioner matrix More...

Additional Inherited Members
Protected Member Functions inherited from MoFEM::UnknownInterface
boost::typeindex::type_index	getClassIdx (const MOFEMuuid &uid) const
	Get type name for interface Id. More...
MOFEMuuid	getUId (const boost::typeindex::type_index &class_idx) const
	Get interface Id for class name. More...

Detailed Description

data structure for ksp (linear solver) context

Struture stores context data which are set in functions run by PETSc SNES functions.

Definition at line 45 of file LoopMethods.hpp.

Member Enumeration Documentation

KSPContext

enum MoFEM::KspMethod::KSPContext

pass information about context of KSP/DM for with finite element is computed

Enumerator
CTX_SETFUNCTION
CTX_OPERATORS
CTX_KSPNONE

Definition at line 61 of file LoopMethods.hpp.

{ CTX_SETFUNCTION, CTX_OPERATORS, CTX_KSPNONE };

Constructor & Destructor Documentation

KspMethod()

MoFEM::KspMethod::KspMethod

(

)

Definition at line 63 of file LoopMethods.hpp.

      : ksp_ctx(CTX_KSPNONE), ksp(PETSC_NULL), ksp_f(PETSC_NULL),
        ksp_A(PETSC_NULL), ksp_B(PETSC_NULL) {}

~KspMethod()

virtual MoFEM::KspMethod::~KspMethod ( )

virtual

Definition at line 67 of file LoopMethods.hpp.

{}

Member Function Documentation

copyKsp()

MoFEMErrorCode MoFEM::KspMethod::copyKsp

(

const KspMethod &

ksp

)

copy data form another method

Parameters

ksp	ksp method

Returns

error code

Definition at line 32 of file LoopMethods.cpp.

                                                      {
  MoFEMFunctionBeginHot;
  this->ksp_ctx = ksp.ksp_ctx;
  this->ksp = ksp.ksp;
  this->ksp_f = ksp.ksp_f;
  this->ksp_A = ksp.ksp_A;
  this->ksp_B = ksp.ksp_B;
  MoFEMFunctionReturnHot(0);
}

query_interface()

MoFEMErrorCode MoFEM::KspMethod::query_interface ( const MOFEMuuid &  uuid, UnknownInterface **  iface  ) const

virtual

Implements MoFEM::UnknownInterface.

Reimplemented in MoFEM::DofMethod, MoFEM::EntityMethod, MoFEM::FEMethod, and MoFEM::BasicMethod.

Definition at line 47 of file LoopMethods.hpp.

                                                                 {
    MoFEMFunctionBeginHot;
    if (uuid == IDD_MOFEMKspMethod) {
      *iface = const_cast<KspMethod *>(this);
      MoFEMFunctionReturnHot(0);
    }
    SETERRQ(PETSC_COMM_SELF, MOFEM_DATA_INCONSISTENCY, "unknown interface");
  }

setKsp()

MoFEMErrorCode MoFEM::KspMethod::setKsp

(

KSP

ksp

)

set solver

Parameters

ksp

solver

Returns

error code

Definition at line 27 of file LoopMethods.cpp.

                                         {
  MoFEMFunctionBeginHot;
  ksp = ksp_;
  MoFEMFunctionReturnHot(0);
}

setKspCtx()

MoFEMErrorCode MoFEM::KspMethod::setKspCtx

(

const KSPContext &

ctx

)

set operator type

Parameters

ctx	Context, CTX_SETFUNCTION, CTX_OPERATORS, CTX_KSPNONE

Returns

error code

Definition at line 22 of file LoopMethods.cpp.

                                                         {
  MoFEMFunctionBeginHot;
  ksp_ctx = ctx;
  MoFEMFunctionReturnHot(0);
}

Member Data Documentation

ksp

KSP MoFEM::KspMethod::ksp

KSP solver.

Definition at line 91 of file LoopMethods.hpp.

ksp_A

Mat MoFEM::KspMethod::ksp_A

matrix

Definition at line 93 of file LoopMethods.hpp.

ksp_B

Mat MoFEM::KspMethod::ksp_B

preconditioner matrix

Examples:

analytical_poisson_field_split.cpp.

Definition at line 94 of file LoopMethods.hpp.

ksp_ctx

KSPContext MoFEM::KspMethod::ksp_ctx

Context.

Definition at line 90 of file LoopMethods.hpp.

ksp_f

Vec MoFEM::KspMethod::ksp_f

the right hand side vector

Definition at line 92 of file LoopMethods.hpp.

---

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

• src/interfaces/LoopMethods.hpp
• src/interfaces/impl/LoopMethods.cpp