v0.10.0
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 ()
 
auto getDataDofsPtr () const
 
auto getDataVectorDofsPtr () const
 
const FieldEntity_vector_viewgetDataFieldEnts () const
 
boost::shared_ptr< FieldEntity_vector_view > & getDataFieldEntsPtr () const
 
auto & getRowFieldEnts () const
 
auto & getRowFieldEntsPtr () const
 
auto & getColFieldEnts () const
 
auto & getColFieldEntsPtr () const
 
auto getRowDofsPtr () const
 
auto getColDofsPtr () const
 
MoFEMErrorCode getNumberOfNodes (int &num_nodes) const
 Get number of DOFs on element. More...
 
EntityHandle getFEEntityHandle () const
 
MoFEMErrorCode getNodeData (const std::string field_name, VectorDouble &data, const bool reset_dofs=true)
 
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
 
- Public Member Functions inherited from MoFEM::BasicMethod
 BasicMethod ()
 
virtual ~BasicMethod ()=default
 
int getNinTheLoop () const
 get number of evaluated element in the loop More...
 
int getLoopSize () const
 get loop size 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...
 
- Public Member Functions inherited from MoFEM::KspMethod
 KspMethod ()
 
virtual ~KspMethod ()=default
 
MoFEMErrorCode copyKsp (const KspMethod &ksp)
 copy data form another method More...
 
- Public Member Functions inherited from MoFEM::PetscData
 PetscData ()
 
virtual ~PetscData ()=default
 
- 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 ()=default
 
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 ()=default
 
MoFEMErrorCode copySnes (const SnesMethod &snes)
 Copy snes data. More...
 
DEPRECATED MoFEMErrorCode setSnesCtx (SNESContext ctx)
 
- Public Member Functions inherited from MoFEM::TSMethod
 TSMethod ()
 
virtual ~TSMethod ()=default
 
MoFEMErrorCode copyTs (const TSMethod &ts)
 Copy TS solver data. More...
 
DEPRECATED MoFEMErrorCode setTsCtx (TSContext ctx)
 

Public Attributes

std::string feName
 Name of finite element. More...
 
boost::shared_ptr< const NumeredEntFiniteElementnumeredEntFiniteElementPtr
 
- Public Attributes inherited from MoFEM::BasicMethod
int nInTheLoop
 number currently of processed method More...
 
int loopSize
 local number oe methods to process 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
 
- 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 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...
 
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
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::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
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
}
 
- 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)
 
- 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
dm_build_partitioned_mesh.cpp, dynamic_elastic.cpp, EshelbianPlasticity.cpp, reaction_diffusion.cpp, simple_elasticity.cpp, and UnsaturatedFlow.hpp.

Definition at line 369 of file LoopMethods.hpp.

Constructor & Destructor Documentation

◆ FEMethod()

FEMethod::FEMethod ( )

Definition at line 192 of file LoopMethods.cpp.

Member Function Documentation

◆ get_begin() [1/2]

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

Definition at line 444 of file LoopMethods.hpp.

446  {
447  return index.lower_bound(boost::make_tuple(field_name, type));
448  }

◆ get_begin() [2/2]

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

Definition at line 470 of file LoopMethods.hpp.

471  {
472  return index.lower_bound(field_name);
473  }

◆ get_end() [1/2]

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

Definition at line 451 of file LoopMethods.hpp.

453  {
454  return index.upper_bound(boost::make_tuple(field_name, type));
455  }

◆ get_end() [2/2]

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

Definition at line 475 of file LoopMethods.hpp.

476  {
477  return index.upper_bound(field_name);
478  }

◆ getColDofsPtr()

auto MoFEM::FEMethod::getColDofsPtr ( ) const

Definition at line 431 of file LoopMethods.hpp.

431  {
432  return numeredEntFiniteElementPtr->getColDofsPtr();
433  };
boost::shared_ptr< const NumeredEntFiniteElement > numeredEntFiniteElementPtr

◆ getColFieldEnts()

auto& MoFEM::FEMethod::getColFieldEnts ( ) const

Definition at line 419 of file LoopMethods.hpp.

419  {
420  return numeredEntFiniteElementPtr->getColFieldEnts();
421  };
boost::shared_ptr< const NumeredEntFiniteElement > numeredEntFiniteElementPtr

◆ getColFieldEntsPtr()

auto& MoFEM::FEMethod::getColFieldEntsPtr ( ) const

Definition at line 423 of file LoopMethods.hpp.

423  {
424  return numeredEntFiniteElementPtr->getColFieldEntsPtr();
425  };
boost::shared_ptr< const NumeredEntFiniteElement > numeredEntFiniteElementPtr

◆ getDataDofsPtr()

auto MoFEM::FEMethod::getDataDofsPtr ( ) const

Definition at line 392 of file LoopMethods.hpp.

392  {
393  return numeredEntFiniteElementPtr->getDataDofsPtr();
394  };
boost::shared_ptr< const NumeredEntFiniteElement > numeredEntFiniteElementPtr

◆ getDataFieldEnts()

const FieldEntity_vector_view& MoFEM::FEMethod::getDataFieldEnts ( ) const

Definition at line 400 of file LoopMethods.hpp.

400  {
401  return numeredEntFiniteElementPtr->getDataFieldEnts();
402  }
boost::shared_ptr< const NumeredEntFiniteElement > numeredEntFiniteElementPtr

◆ getDataFieldEntsPtr()

boost::shared_ptr<FieldEntity_vector_view>& MoFEM::FEMethod::getDataFieldEntsPtr ( ) const

Definition at line 405 of file LoopMethods.hpp.

405  {
406  return const_cast<NumeredEntFiniteElement *>(
409  }
boost::shared_ptr< const NumeredEntFiniteElement > numeredEntFiniteElementPtr
boost::shared_ptr< FieldEntity_vector_view > & getDataFieldEntsPtr() const

◆ getDataVectorDofsPtr()

auto MoFEM::FEMethod::getDataVectorDofsPtr ( ) const

Definition at line 396 of file LoopMethods.hpp.

396  {
397  return numeredEntFiniteElementPtr->getDataVectorDofsPtr();
398  };
boost::shared_ptr< const NumeredEntFiniteElement > numeredEntFiniteElementPtr

◆ getFEEntityHandle()

EntityHandle FEMethod::getFEEntityHandle ( ) const

Definition at line 517 of file LoopMethods.hpp.

517  {
518  return numeredEntFiniteElementPtr->getEnt();
519 }
boost::shared_ptr< const NumeredEntFiniteElement > numeredEntFiniteElementPtr

◆ getNodeData()

MoFEMErrorCode FEMethod::getNodeData ( const std::string  field_name,
VectorDouble data,
const bool  reset_dofs = true 
)

Definition at line 234 of file LoopMethods.cpp.

236  {
238 
239  // TODO: [CORE-60] Fix implementation not to use DOFs
240 
241  auto get_nodes_field_data =
242  [&](boost::shared_ptr<FEDofEntity_multiIndex> &&dofs,
243  VectorDouble &nodes_data) {
245 
246  auto bit_number = getFieldBitNumber(field_name);
247  auto &dofs_by_uid = dofs->get<Unique_mi_tag>();
248  auto dit =
249  dofs_by_uid.lower_bound(FieldEntity::getLocalUniqueIdCalculate(
250  bit_number, get_id_for_min_type<MBVERTEX>()));
251  auto hi_dit =
252  dofs_by_uid.upper_bound(FieldEntity::getLocalUniqueIdCalculate(
253  bit_number, get_id_for_max_type<MBVERTEX>()));
254 
255  if (dit != hi_dit) {
256  auto &first_dof = **dit;
257  int num_nodes;
258  CHKERR getNumberOfNodes(num_nodes);
259  const int nb_dof_idx = first_dof.getNbOfCoeffs();
260  const int max_nb_dofs = nb_dof_idx * num_nodes;
261  nodes_data.resize(max_nb_dofs, false);
262  nodes_data.clear();
263 
264  for (; dit != hi_dit;) {
265  const auto &dof_ptr = *dit;
266  const auto &dof = *dof_ptr;
267  const auto &sn = *dof.getSideNumberPtr();
268  const int side_number = sn.side_number;
269 
270  int pos = side_number * nb_dof_idx;
271  auto ent_filed_data_vec = dof.getEntFieldData();
272  for (int ii = 0; ii != nb_dof_idx; ++ii) {
273  nodes_data[pos] = ent_filed_data_vec[ii];
274  ++pos;
275  ++dit;
276  }
277  }
278 
279  } else if (reset_dofs) {
280  nodes_data.resize(0, false);
281  }
282 
284  };
285 
286  return get_nodes_field_data(getDataDofsPtr(), data);
287 
289 }
UId getLocalUniqueIdCalculate()
Get the Local Unique Id Calculate object.
#define MoFEMFunctionReturn(a)
Last executable line of each PETSc function used for error handling. Replaces return()
Definition: definitions.h:485
auto getDataDofsPtr() const
unsigned int getFieldBitNumber(std::string field_name) const
#define CHKERR
Inline error check.
Definition: definitions.h:604
#define MoFEMFunctionBegin
First executable line of each MoFEM function, used for error handling. Final line of MoFEM functions ...
Definition: definitions.h:415
ublas::vector< double, DoubleAllocator > VectorDouble
Definition: Types.hpp:74
MoFEMErrorCode getNumberOfNodes(int &num_nodes) const
Get number of DOFs on element.

◆ getNumberOfNodes()

MoFEMErrorCode FEMethod::getNumberOfNodes ( int &  num_nodes) const

Get number of DOFs on element.

Definition at line 200 of file LoopMethods.cpp.

200  {
202 
203  EntityHandle handle = numeredEntFiniteElementPtr->getEnt();
204  if (handle) {
205  switch (static_cast<EntityType>(handle >> MB_ID_WIDTH)) {
206  case MBVERTEX:
207  num_nodes = 1;
208  break;
209  case MBEDGE:
210  num_nodes = 2;
211  break;
212  case MBTRI:
213  num_nodes = 3;
214  break;
215  case MBQUAD:
216  num_nodes = 4;
217  break;
218  case MBTET:
219  num_nodes = 4;
220  break;
221  case MBPRISM:
222  num_nodes = 6;
223  break;
224  default:
225  SETERRQ(PETSC_COMM_SELF, MOFEM_NOT_IMPLEMENTED, "not implemented");
226  }
227  } else {
228  num_nodes = 0;
229  }
230 
232 }
#define MoFEMFunctionBeginHot
First executable line of each MoFEM function, used for error handling. Final line of MoFEM functions ...
Definition: definitions.h:509
#define MoFEMFunctionReturnHot(a)
Last executable line of each PETSc function used for error handling. Replaces return()
Definition: definitions.h:516
boost::shared_ptr< const NumeredEntFiniteElement > numeredEntFiniteElementPtr
#define MB_ID_WIDTH
Definition: definitions.h:296

◆ getRowDofsPtr()

auto MoFEM::FEMethod::getRowDofsPtr ( ) const

Definition at line 427 of file LoopMethods.hpp.

427  {
428  return numeredEntFiniteElementPtr->getRowDofsPtr();
429  };
boost::shared_ptr< const NumeredEntFiniteElement > numeredEntFiniteElementPtr

◆ getRowFieldEnts()

auto& MoFEM::FEMethod::getRowFieldEnts ( ) const

Definition at line 411 of file LoopMethods.hpp.

411  {
412  return numeredEntFiniteElementPtr->getRowFieldEnts();
413  };
boost::shared_ptr< const NumeredEntFiniteElement > numeredEntFiniteElementPtr

◆ getRowFieldEntsPtr()

auto& MoFEM::FEMethod::getRowFieldEntsPtr ( ) const

Definition at line 415 of file LoopMethods.hpp.

415  {
416  return numeredEntFiniteElementPtr->getRowFieldEntsPtr();
417  };
boost::shared_ptr< const NumeredEntFiniteElement > numeredEntFiniteElementPtr

◆ query_interface()

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

Reimplemented from MoFEM::BasicMethod.

Definition at line 371 of file LoopMethods.hpp.

372  {
374  if (uuid == IDD_MOFEMFEMethod) {
375  *iface = const_cast<FEMethod *>(this);
377  }
378 
379  ierr = query_interface(uuid, iface);
380  CHKERRG(ierr);
382  }
#define MoFEMFunctionBeginHot
First executable line of each MoFEM function, used for error handling. Final line of MoFEM functions ...
Definition: definitions.h:509
#define CHKERRG(n)
Check error code of MoFEM/MOAB/PETSc function.
Definition: definitions.h:552
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:516
static MoFEMErrorCodeGeneric< PetscErrorCode > ierr
Definition: Exceptions.hpp:87
static const MOFEMuuid IDD_MOFEMFEMethod
Definition: LoopMethods.hpp:33

Member Data Documentation

◆ feName

std::string MoFEM::FEMethod::feName

Name of finite element.

Definition at line 386 of file LoopMethods.hpp.

◆ numeredEntFiniteElementPtr

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

Pointer to finite element database structure

Examples
prism_elements_from_surface.cpp.

Definition at line 389 of file LoopMethods.hpp.


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