No Matches
Public Member Functions | Public Attributes | List of all members
MoFEM::DofMethod Struct Reference

Data structure to exchange data between mofem and User Loop Methods on entities. More...

#include <src/interfaces/LoopMethods.hpp>

Inheritance diagram for MoFEM::DofMethod:
Collaboration diagram for MoFEM::DofMethod:

Public Member Functions

MoFEMErrorCode query_interface (boost::typeindex::type_index type_index, UnknownInterface **iface) const
 DofMethod ()=default
- Public Member Functions inherited from MoFEM::BasicMethod
MoFEMErrorCode query_interface (boost::typeindex::type_index type_index, UnknownInterface **iface) const
 BasicMethod ()
virtual ~BasicMethod ()=default
int getNinTheLoop () const
 get number of evaluated element in the loop More...
int getLoopSize () const
 get loop size More...
auto getLoHiFERank () const
 Get lo and hi processor rank of iterated entities. More...
auto getLoFERank () const
 Get upper rank in loop for iterating elements. More...
auto getHiFERank () const
 Get upper rank in loop for iterating elements. More...
unsigned int getFieldBitNumber (std::string field_name) const
MoFEMErrorCode copyBasicMethod (const BasicMethod &basic)
 Copy data from other base method to this base method. More...
virtual MoFEMErrorCode preProcess ()
 function is run at the beginning of loop More...
virtual MoFEMErrorCode operator() ()
 function is run for every finite element More...
virtual MoFEMErrorCode postProcess ()
 function is run at the end of loop More...
boost::weak_ptr< CacheTuplegetCacheWeakPtr () const
 Get the cache weak ptr object. More...
- Public Member Functions inherited from MoFEM::KspMethod
MoFEMErrorCode query_interface (boost::typeindex::type_index type_index, UnknownInterface **iface) const
 KspMethod ()
virtual ~KspMethod ()=default
MoFEMErrorCode copyKsp (const KspMethod &ksp)
 copy data form another method More...
- Public Member Functions inherited from MoFEM::PetscData
MoFEMErrorCode query_interface (boost::typeindex::type_index type_index, UnknownInterface **iface) const
 PetscData ()
virtual ~PetscData ()=default
MoFEMErrorCode copyPetscData (const PetscData &petsc_data)
- Public Member Functions inherited from MoFEM::UnknownInterface
virtual MoFEMErrorCode query_interface (boost::typeindex::type_index type_index, UnknownInterface **iface) const =0
template<class IFACE >
MoFEMErrorCode registerInterface (bool error_if_registration_failed=true)
 Register 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 ()=default
- Public Member Functions inherited from MoFEM::SnesMethod
MoFEMErrorCode query_interface (boost::typeindex::type_index type_index, UnknownInterface **iface) const
 SnesMethod ()
virtual ~SnesMethod ()=default
MoFEMErrorCode copySnes (const SnesMethod &snes)
 Copy snes data. More...
- Public Member Functions inherited from MoFEM::TSMethod
MoFEMErrorCode query_interface (boost::typeindex::type_index type_index, UnknownInterface **iface) const
 TSMethod ()
virtual ~TSMethod ()=default
MoFEMErrorCode copyTs (const TSMethod &ts)
 Copy TS solver data. More...

Public Attributes

boost::shared_ptr< FieldfieldPtr
boost::shared_ptr< DofEntitydofPtr
boost::shared_ptr< NumeredDofEntitydofNumeredPtr
- Public Attributes inherited from MoFEM::BasicMethod
int nInTheLoop
 number currently of processed method More...
int loopSize
 local number oe methods to process More...
std::pair< int, int > loHiFERank
 Llo and hi processor rank of iterated entities. More...
int rAnk
 processor rank More...
int sIze
 number of processors in communicator More...
const RefEntity_multiIndexrefinedEntitiesPtr
 container of mofem dof entities More...
const RefElement_multiIndexrefinedFiniteElementsPtr
 container of mofem finite element entities More...
const ProblemproblemPtr
 raw pointer to problem More...
const Field_multiIndexfieldsPtr
 raw pointer to fields container More...
const FieldEntity_multiIndexentitiesPtr
 raw pointer to container of field entities More...
const DofEntity_multiIndexdofsPtr
 raw pointer container of dofs More...
const FiniteElement_multiIndexfiniteElementsPtr
 raw pointer to container finite elements More...
const EntFiniteElement_multiIndexfiniteElementsEntitiesPtr
const FieldEntityEntFiniteElementAdjacencyMap_multiIndexadjacenciesPtr
boost::function< MoFEMErrorCode()> preProcessHook
 Hook function for pre-processing. More...
boost::function< MoFEMErrorCode()> postProcessHook
 Hook function for post-processing. More...
boost::function< MoFEMErrorCode()> operatorHook
 Hook function for operator. More...
boost::movelib::unique_ptr< boolvecAssembleSwitch
boost::movelib::unique_ptr< boolmatAssembleSwitch
boost::weak_ptr< CacheTuplecacheWeakPtr
- Public Attributes inherited from MoFEM::KspMethod
KSPContext ksp_ctx
 Context. More...
KSP ksp
 KSP solver. More...
Vec & ksp_f
Mat & ksp_A
Mat & ksp_B
- Public Attributes inherited from MoFEM::PetscData
Switches data_ctx
Vec f
Mat A
Mat B
Vec x
Vec x_t
Vec x_tt
- Public Attributes inherited from MoFEM::SnesMethod
SNESContext snes_ctx
SNES snes
 snes solver More...
Vec & snes_x
 state vector More...
Vec & snes_f
 residual More...
Mat & snes_A
 jacobian matrix More...
Mat & snes_B
 preconditioner of jacobian matrix More...
- Public Attributes inherited from MoFEM::TSMethod
TS ts
 time solver More...
TSContext ts_ctx
PetscInt ts_step
 time step number More...
PetscReal ts_a
 shift for U_t (see PETSc Time Solver) More...
PetscReal ts_aa
 shift for U_tt shift for U_tt More...
PetscReal ts_t
 time More...
PetscReal ts_dt
 time step size More...
Vec & ts_u
 state vector More...
Vec & ts_u_t
 time derivative of state vector More...
Vec & ts_u_tt
 second time derivative of state vector More...
Vec & ts_F
 residual vector More...
Mat & ts_A
Mat & ts_B
 Preconditioner for ts_A. More...

Additional Inherited Members

- Public Types inherited from MoFEM::KspMethod
 pass information about context of KSP/DM for with finite element is computed More...
- Public Types inherited from MoFEM::PetscData
enum  DataContext {
  CTX_SET_NONE = 0 , CTX_SET_F = 1 << 0 , CTX_SET_A = 1 << 1 , CTX_SET_B = 1 << 2 ,
  CTX_SET_X = 1 << 3 , CTX_SET_X_T = 1 << 4 , CTX_SET_X_TT = 1 << 6 , CTX_SET_TIME = 1 << 7
using Switches = std::bitset< 8 >
- Public Types inherited from MoFEM::SnesMethod
- Public Types inherited from MoFEM::TSMethod
enum  TSContext {
- Static Public Member Functions inherited from MoFEM::UnknownInterface
static MoFEMErrorCode getLibVersion (Version &version)
 Get library version. More...
static MoFEMErrorCode getFileVersion (moab::Interface &moab, Version &version)
 Get database major version. More...
static MoFEMErrorCode setFileVersion (moab::Interface &moab, Version version=Version(MoFEM_VERSION_MAJOR, MoFEM_VERSION_MINOR, MoFEM_VERSION_BUILD))
 Get database major version. More...
static MoFEMErrorCode getInterfaceVersion (Version &version)
 Get database major version. More...
- Static Public Attributes inherited from MoFEM::PetscData
static constexpr Switches CtxSetNone = PetscData::Switches(CTX_SET_NONE)
static constexpr Switches CtxSetF = PetscData::Switches(CTX_SET_F)
static constexpr Switches CtxSetA = PetscData::Switches(CTX_SET_A)
static constexpr Switches CtxSetB = PetscData::Switches(CTX_SET_B)
static constexpr Switches CtxSetX = PetscData::Switches(CTX_SET_X)
static constexpr Switches CtxSetX_T = PetscData::Switches(CTX_SET_X_T)
static constexpr Switches CtxSetX_TT = PetscData::Switches(CTX_SET_X_TT)
static constexpr Switches CtxSetTime = PetscData::Switches(CTX_SET_TIME)

Detailed Description

Data structure to exchange data between mofem and User Loop Methods on entities.

It allows to exchange data between MoFEM and user functions. It stores information about multi-indices.

Definition at line 493 of file LoopMethods.hpp.

Constructor & Destructor Documentation

◆ DofMethod()

MoFEM::DofMethod::DofMethod ( )

Member Function Documentation

◆ query_interface()

MoFEMErrorCode MoFEM::DofMethod::query_interface ( boost::typeindex::type_index  type_index,
UnknownInterface **  iface 
) const

Reimplemented from MoFEM::BasicMethod.

Definition at line 495 of file LoopMethods.hpp.

496 {
498 *iface = const_cast<DofMethod *>(this);
500 }
#define MoFEMFunctionReturnHot(a)
Last executable line of each PETSc function used for error handling. Replaces return()
Definition: definitions.h:447
#define MoFEMFunctionBeginHot
First executable line of each MoFEM function, used for error handling. Final line of MoFEM functions ...
Definition: definitions.h:440

Member Data Documentation

◆ dofNumeredPtr

boost::shared_ptr<NumeredDofEntity> MoFEM::DofMethod::dofNumeredPtr

Definition at line 506 of file LoopMethods.hpp.

◆ dofPtr

boost::shared_ptr<DofEntity> MoFEM::DofMethod::dofPtr

Definition at line 505 of file LoopMethods.hpp.

◆ fieldPtr

boost::shared_ptr<Field> MoFEM::DofMethod::fieldPtr

Definition at line 504 of file LoopMethods.hpp.

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