v0.8.13
Public Member Functions | Public Attributes | List of all members
MoFEM::FEMethod Struct Reference

structure for User Loop Methods on finite elementsIt can be used to calculate stiffness matrices, residuals, load vectors etc. It is low level class however in some class users looking for speed and efficiency, can use it directly. More...

#include <src/interfaces/LoopMethods.hpp>

Inheritance diagram for MoFEM::FEMethod:
[legend]
Collaboration diagram for MoFEM::FEMethod:
[legend]

Public Member Functions

MoFEMErrorCode query_interface (const MOFEMuuid &uuid, UnknownInterface **iface) const
 
 FEMethod ()
 
template<class MULTIINDEX >
MULTIINDEX::iterator get_begin (const MULTIINDEX &index, const std::string &field_name, const EntityType type, const int side_number) const
 
template<class MULTIINDEX >
MULTIINDEX::iterator get_end (const MULTIINDEX &index, const std::string &field_name, const EntityType type, const int side_number) const
 
template<class MULTIINDEX >
MULTIINDEX::iterator get_begin (const MULTIINDEX &index, const std::string &field_name, const EntityType type) const
 
template<class MULTIINDEX >
MULTIINDEX::iterator get_end (const MULTIINDEX &index, const std::string &field_name, const EntityType type) const
 
template<class MULTIINDEX >
MULTIINDEX::iterator get_begin (const MULTIINDEX &index, const std::string &field_name) const
 
template<class MULTIINDEX >
MULTIINDEX::iterator get_end (const MULTIINDEX &index, const std::string &field_name) const
 
template<class MULTIINDEX >
MULTIINDEX::iterator get_begin (const MULTIINDEX &index, const EntityHandle ent) const
 
template<class MULTIINDEX >
MULTIINDEX::iterator get_end (const MULTIINDEX &index, const EntityHandle ent) const
 
template<class MULTIINDEX >
MULTIINDEX::iterator get_begin (const MULTIINDEX &index, const std::string &field_name, const EntityHandle ent) const
 
template<class MULTIINDEX >
MULTIINDEX::iterator get_end (const MULTIINDEX &index, const std::string &field_name, const EntityHandle ent) const
 
- Public Member Functions inherited from MoFEM::BasicMethod
 BasicMethod ()
 
virtual ~BasicMethod ()
 
int getNinTheLoop () const
 get number of evaluated element in the loop More...
 
int getLoopSize () const
 get loop size More...
 
MoFEMErrorCode copyBasicMethod (const BasicMethod &basic)
 
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...
 
- Public Member Functions inherited from MoFEM::KspMethod
 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 Member Functions inherited from MoFEM::SnesMethod
 SnesMethod ()
 
virtual ~SnesMethod ()
 
MoFEMErrorCode setSnesCtx (const SNESContext &ctx)
 Set SNES context. More...
 
MoFEMErrorCode setSnes (SNES snes)
 Set SNES instance. More...
 
MoFEMErrorCode copySnes (const SnesMethod &snes)
 Copy snes data. More...
 
- Public Member Functions inherited from MoFEM::TSMethod
 TSMethod ()
 
virtual ~TSMethod ()
 
MoFEMErrorCode setTsCtx (const TSContext &ctx)
 Set Ts context. More...
 
MoFEMErrorCode copyTs (const TSMethod &ts)
 Copy TS solver data. More...
 
MoFEMErrorCode setTs (TS _ts)
 Set TS solver. More...
 

Public Attributes

std::string feName
 
boost::shared_ptr< const NumeredEntFiniteElementnumeredEntFiniteElementPtr
 
boost::shared_ptr< const FENumeredDofEntity_multiIndexrowPtr
 
boost::shared_ptr< const FENumeredDofEntity_multiIndexcolPtr
 
boost::shared_ptr< const FEDofEntity_multiIndexdataPtr
 
- Public Attributes inherited from MoFEM::BasicMethod
int nInTheLoop
 
int loopSize
 
int rAnk
 
int sIze
 
const RefEntity_multiIndexrefinedEntitiesPtr
 
const RefElement_multiIndexrefinedFiniteElementsPtr
 
const ProblemproblemPtr
 
const Field_multiIndexfieldsPtr
 
const FieldEntity_multiIndexentitiesPtr
 
const DofEntity_multiIndexdofsPtr
 
const FiniteElement_multiIndexfiniteElementsPtr
 
const EntFiniteElement_multiIndexfiniteElementsEntitiesPtr
 
const FieldEntityEntFiniteElementAdjacencyMap_multiIndexadjacenciesPtr
 
boost::function< MoFEMErrorCode()> preProcessHook
 
boost::function< MoFEMErrorCode()> postProcessHook
 
boost::function< MoFEMErrorCode()> operatorHook
 
- Public Attributes inherited from MoFEM::KspMethod
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...
 
- Public Attributes inherited from MoFEM::SnesMethod
SNESContext snes_ctx
 
SNES snes
 
Vec snes_x
 
Vec snes_f
 
Mat snes_A
 
Mat snes_B
 
- Public Attributes inherited from MoFEM::TSMethod
TSContext ts_ctx
 
TS ts
 
Vec ts_u
 
Vec ts_u_t
 
Vec ts_F
 
Mat ts_A
 
Mat ts_B
 
PetscInt ts_step
 
PetscReal ts_a
 
PetscReal ts_t
 

Additional Inherited Members

- Public Types inherited from MoFEM::KspMethod
enum  KSPContext { CTX_SETFUNCTION, CTX_OPERATORS, CTX_KSPNONE }
 pass information about context of KSP/DM for with finite element is computed More...
 
- Public Types inherited from MoFEM::SnesMethod
enum  SNESContext { CTX_SNESSETFUNCTION, CTX_SNESSETJACOBIAN, CTX_SNESNONE }
 
- Public Types inherited from MoFEM::TSMethod
enum  TSContext {
  CTX_TSSETRHSFUNCTION, CTX_TSSETRHSJACOBIAN, CTX_TSSETIFUNCTION, CTX_TSSETIJACOBIAN,
  CTX_TSTSMONITORSET, CTX_TSNONE
}
 
- 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

structure for User Loop Methods on finite elements

It can be used to calculate stiffness matrices, residuals, load vectors etc. It is low level class however in some class users looking for speed and efficiency, can use it directly.

This class is used with Interface::loop_finite_elements, where user overloaded operator FEMethod::operator() is executed for each element in the problem. Class have to additional methods which are overloaded by user, FEMethod::preProcess() and FEMethod::postProcess() executed at beginning and end of the loop over problem elements, respectively.

Examples:
simple_elasticity.cpp, and UnsaturatedFlow.hpp.

Definition at line 306 of file LoopMethods.hpp.

Constructor & Destructor Documentation

◆ FEMethod()

FEMethod::FEMethod ( )

Definition at line 154 of file LoopMethods.cpp.

Member Function Documentation

◆ get_begin() [1/5]

template<class MULTIINDEX >
MULTIINDEX::iterator MoFEM::FEMethod::get_begin ( const MULTIINDEX &  index,
const std::string &  field_name,
const EntityType  type,
const int  side_number 
) const

Definition at line 356 of file LoopMethods.hpp.

357  {
358  return index.lower_bound(boost::make_tuple(field_name, type, side_number));
359  }

◆ get_begin() [2/5]

template<class MULTIINDEX >
MULTIINDEX::iterator MoFEM::FEMethod::get_begin ( const MULTIINDEX &  index,
const std::string &  field_name,
const EntityType  type 
) const

Definition at line 411 of file LoopMethods.hpp.

413  {
414  return index.lower_bound(boost::make_tuple(field_name, type));
415  }

◆ get_begin() [3/5]

template<class MULTIINDEX >
MULTIINDEX::iterator MoFEM::FEMethod::get_begin ( const MULTIINDEX &  index,
const std::string &  field_name 
) const

Definition at line 454 of file LoopMethods.hpp.

455  {
456  return index.lower_bound(field_name);
457  }

◆ get_begin() [4/5]

template<class MULTIINDEX >
MULTIINDEX::iterator MoFEM::FEMethod::get_begin ( const MULTIINDEX &  index,
const EntityHandle  ent 
) const

Definition at line 495 of file LoopMethods.hpp.

496  {
497  return index.lower_bound(ent);
498  }

◆ get_begin() [5/5]

template<class MULTIINDEX >
MULTIINDEX::iterator MoFEM::FEMethod::get_begin ( const MULTIINDEX &  index,
const std::string &  field_name,
const EntityHandle  ent 
) const

Definition at line 536 of file LoopMethods.hpp.

538  {
539  return index.lower_bound(boost::make_tuple(field_name, ent));
540  }

◆ get_end() [1/5]

template<class MULTIINDEX >
MULTIINDEX::iterator MoFEM::FEMethod::get_end ( const MULTIINDEX &  index,
const std::string &  field_name,
const EntityType  type,
const int  side_number 
) const

Definition at line 362 of file LoopMethods.hpp.

363  {
364  return index.upper_bound(boost::make_tuple(field_name, type, side_number));
365  }

◆ get_end() [2/5]

template<class MULTIINDEX >
MULTIINDEX::iterator MoFEM::FEMethod::get_end ( const MULTIINDEX &  index,
const std::string &  field_name,
const EntityType  type 
) const

Definition at line 417 of file LoopMethods.hpp.

419  {
420  return index.upper_bound(boost::make_tuple(field_name, type));
421  }

◆ get_end() [3/5]

template<class MULTIINDEX >
MULTIINDEX::iterator MoFEM::FEMethod::get_end ( const MULTIINDEX &  index,
const std::string &  field_name 
) const

Definition at line 459 of file LoopMethods.hpp.

460  {
461  return index.upper_bound(field_name);
462  }

◆ get_end() [4/5]

template<class MULTIINDEX >
MULTIINDEX::iterator MoFEM::FEMethod::get_end ( const MULTIINDEX &  index,
const EntityHandle  ent 
) const

Definition at line 500 of file LoopMethods.hpp.

501  {
502  return index.upper_bound(ent);
503  }

◆ get_end() [5/5]

template<class MULTIINDEX >
MULTIINDEX::iterator MoFEM::FEMethod::get_end ( const MULTIINDEX &  index,
const std::string &  field_name,
const EntityHandle  ent 
) const

Definition at line 542 of file LoopMethods.hpp.

544  {
545  return index.upper_bound(boost::make_tuple(field_name, ent));
546  }

◆ query_interface()

MoFEMErrorCode MoFEM::FEMethod::query_interface ( const MOFEMuuid uuid,
UnknownInterface **  iface 
) const
virtual

Reimplemented from MoFEM::BasicMethod.

Definition at line 308 of file LoopMethods.hpp.

309  {
311  if (uuid == IDD_MOFEMFEMethod) {
312  *iface = const_cast<FEMethod *>(this);
314  }
315 
316  ierr = query_interface(uuid, iface);
317  CHKERRG(ierr);
319  }
#define MoFEMFunctionBeginHot
First executable line of each MoFEM function, used for error handling. Final line of MoFEM functions ...
Definition: definitions.h:519
#define CHKERRG(n)
Check error code of MoFEM/MOAB/PETSc function.
Definition: definitions.h:562
MoFEMErrorCode query_interface(const MOFEMuuid &uuid, UnknownInterface **iface) const
#define MoFEMFunctionReturnHot(a)
Last executable line of each PETSc function used for error handling. Replaces return() ...
Definition: definitions.h:526
static MoFEMErrorCodeGeneric< PetscErrorCode > ierr
Definition: Common.hpp:80
static const MOFEMuuid IDD_MOFEMFEMethod
Definition: LoopMethods.hpp:31

Member Data Documentation

◆ colPtr

boost::shared_ptr<const FENumeredDofEntity_multiIndex> MoFEM::FEMethod::colPtr

Definition at line 327 of file LoopMethods.hpp.

◆ dataPtr

boost::shared_ptr<const FEDofEntity_multiIndex> MoFEM::FEMethod::dataPtr

Definition at line 328 of file LoopMethods.hpp.

◆ feName

std::string MoFEM::FEMethod::feName

Definition at line 323 of file LoopMethods.hpp.

◆ numeredEntFiniteElementPtr

boost::shared_ptr<const NumeredEntFiniteElement> MoFEM::FEMethod::numeredEntFiniteElementPtr

Definition at line 325 of file LoopMethods.hpp.

◆ rowPtr

boost::shared_ptr<const FENumeredDofEntity_multiIndex> MoFEM::FEMethod::rowPtr

Definition at line 326 of file LoopMethods.hpp.


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