structure for User Loop Methods on finite elements More...

#include <src/interfaces/LoopMethods.hpp>

Inheritance diagram for MoFEM::FEMethod:

Collaboration diagram for MoFEM::FEMethod:

Public Member Functions
MoFEMErrorCode	query_interface (boost::typeindex::type_index type_index, UnknownInterface **iface) const

	FEMethod ()=default

auto	getFEName () const
	get finite element name More...

auto	getDataDofsPtr () const

auto	getDataVectorDofsPtr () const

const FieldEntity_vector_view &	getDataFieldEnts () 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

auto	getNumberOfNodes () const

EntityHandle	getFEEntityHandle () const

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

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...

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< CacheTuple >	getCacheWeakPtr () const
	Get the cache weak ptr object. 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

MoFEMErrorCode	copyPetscData (const PetscData &petsc_data)

Public Member Functions inherited from MoFEM::UnknownInterface
template<class IFACE >
MoFEMErrorCode	registerInterface (bool error_if_registration_failed=true)
	Register interface. More...

template<class IFACE >
MoFEMErrorCode	getInterface (IFACE *&iface) const
	Get interface reference 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
	SnesMethod ()

virtual	~SnesMethod ()=default

MoFEMErrorCode	copySnes (const SnesMethod &snes)
	Copy snes data. More...

Public Member Functions inherited from MoFEM::TSMethod
	TSMethod ()

virtual	~TSMethod ()=default

MoFEMErrorCode	copyTs (const TSMethod &ts)
	Copy TS solver data. More...

Public Attributes
std::string	feName
	Name of finite element. More...

boost::shared_ptr< const NumeredEntFiniteElement >	numeredEntFiniteElementPtr

boost::function< bool(FEMethod *fe_method_ptr)>	exeTestHook
	Tet if element to skip element. More...

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_multiIndex *	refinedEntitiesPtr
	container of mofem dof entities More...

const RefElement_multiIndex *	refinedFiniteElementsPtr
	container of mofem finite element entities More...

const Problem *	problemPtr
	raw pointer to problem More...

const Field_multiIndex *	fieldsPtr
	raw pointer to fields container More...

const FieldEntity_multiIndex *	entitiesPtr
	raw pointer to container of field entities More...

const DofEntity_multiIndex *	dofsPtr
	raw pointer container of dofs More...

const FiniteElement_multiIndex *	finiteElementsPtr
	raw pointer to container finite elements More...

const EntFiniteElement_multiIndex *	finiteElementsEntitiesPtr

const FieldEntityEntFiniteElementAdjacencyMap_multiIndex *	adjacenciesPtr

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< bool >	vecAssembleSwitch

boost::movelib::unique_ptr< bool >	matAssembleSwitch

boost::weak_ptr< CacheTuple >	cacheWeakPtr

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
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 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

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: adolc_plasticity.cpp, child_and_parent.cpp, dm_build_partitioned_mesh.cpp, dynamic_first_order_con_law.cpp, free_surface.cpp, hanging_node_approx.cpp, heat_equation.cpp, level_set.cpp, nonlinear_dynamics.cpp, operators_tests.cpp, photon_diffusion.cpp, reaction_diffusion.cpp, seepage.cpp, shallow_wave.cpp, simple_elasticity.cpp, thermo_elastic.cpp, UnsaturatedFlow.hpp, and wave_equation.cpp.

Definition at line 369 of file LoopMethods.hpp.

Constructor & Destructor Documentation

◆ FEMethod()

MoFEM::FEMethod::FEMethod ( )

default

Member Function Documentation

◆ getColDofsPtr()

auto MoFEM::FEMethod::getColDofsPtr ( ) const

inline

Definition at line 443 of file LoopMethods.hpp.

                                     {
     return numeredEntFiniteElementPtr->getColDofsPtr();
   };

◆ getColFieldEnts()

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

inline

Definition at line 431 of file LoopMethods.hpp.

                                        {
     return numeredEntFiniteElementPtr->getColFieldEnts();
   };

◆ getColFieldEntsPtr()

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

inline

Definition at line 435 of file LoopMethods.hpp.

                                           {
     return numeredEntFiniteElementPtr->getColFieldEntsPtr();
   };

◆ getDataDofsPtr()

auto MoFEM::FEMethod::getDataDofsPtr ( ) const

inline

Definition at line 404 of file LoopMethods.hpp.

                                      {
     return numeredEntFiniteElementPtr->getDataDofsPtr();
   };

◆ getDataFieldEnts()

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

inline

Definition at line 412 of file LoopMethods.hpp.

                                                                  {
     return numeredEntFiniteElementPtr->getDataFieldEnts();
   }

◆ getDataFieldEntsPtr()

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

inline

Definition at line 417 of file LoopMethods.hpp.

                               {
     return const_cast<NumeredEntFiniteElement *>(
                numeredEntFiniteElementPtr.get())
         ->getDataFieldEntsPtr();
   }

◆ getDataVectorDofsPtr()

auto MoFEM::FEMethod::getDataVectorDofsPtr ( ) const

inline

Definition at line 408 of file LoopMethods.hpp.

                                            {
     return numeredEntFiniteElementPtr->getDataVectorDofsPtr();
   };

◆ getFEEntityHandle()

EntityHandle FEMethod::getFEEntityHandle ( ) const

inline

Definition at line 460 of file LoopMethods.hpp.

                                                       {
   return numeredEntFiniteElementPtr->getEnt();
 }

◆ getFEName()

auto MoFEM::FEMethod::getFEName ( ) const

inline

get finite element name

Returns: std::string

Definition at line 391 of file LoopMethods.hpp.

391 { return feName; }

◆ getNodeData()

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

Definition at line 172 of file LoopMethods.cpp.

                                                             {
   MoFEMFunctionBegin;
  
   // TODO: [CORE-60] Fix implementation not to use DOFs
  
   auto get_nodes_field_data =
       [&](boost::shared_ptr<FEDofEntity_multiIndex> &&dofs,
           VectorDouble &nodes_data) {
         MoFEMFunctionBegin;
  
         auto bit_number = getFieldBitNumber(field_name);
         auto &dofs_by_uid = dofs->get<Unique_mi_tag>();
         auto dit =
             dofs_by_uid.lower_bound(FieldEntity::getLocalUniqueIdCalculate(
                 bit_number, get_id_for_min_type<MBVERTEX>()));
         auto hi_dit =
             dofs_by_uid.upper_bound(FieldEntity::getLocalUniqueIdCalculate(
                 bit_number, get_id_for_max_type<MBVERTEX>()));
  
         if (dit != hi_dit) {
           auto &first_dof = **dit;
           const int num_nodes = getNumberOfNodes();
           const int nb_dof_idx = first_dof.getNbOfCoeffs();
           const int max_nb_dofs = nb_dof_idx * num_nodes;
           nodes_data.resize(max_nb_dofs, false);
           nodes_data.clear();
  
           for (; dit != hi_dit;) {
             const auto &dof_ptr = *dit;
             const auto &dof = *dof_ptr;
             const auto &sn = *dof.getSideNumberPtr();
             const int side_number = sn.side_number;
  
             int pos = side_number * nb_dof_idx;
             auto ent_filed_data_vec = dof.getEntFieldData();
             for (int ii = 0; ii != nb_dof_idx; ++ii) {
               nodes_data[pos] = ent_filed_data_vec[ii];
               ++pos;
               ++dit;
             }
           }
  
         } else if (reset_dofs) {
           nodes_data.resize(0, false);
         }
  
         MoFEMFunctionReturn(0);
       };
  
   return get_nodes_field_data(getDataDofsPtr(), data);
  
   MoFEMFunctionReturn(0);
 }

◆ getNumberOfNodes()

auto FEMethod::getNumberOfNodes ( ) const

inline

Definition at line 456 of file LoopMethods.hpp.

                                              {
   return moab::CN::VerticesPerEntity(numeredEntFiniteElementPtr->getEntType());
 };

◆ getRowDofsPtr()

auto MoFEM::FEMethod::getRowDofsPtr ( ) const

inline

Definition at line 439 of file LoopMethods.hpp.

                                     {
     return numeredEntFiniteElementPtr->getRowDofsPtr();
   };

◆ getRowFieldEnts()

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

inline

Definition at line 423 of file LoopMethods.hpp.

                                        {
     return numeredEntFiniteElementPtr->getRowFieldEnts();
   };

◆ getRowFieldEntsPtr()

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

inline

Definition at line 427 of file LoopMethods.hpp.

                                           {
     return numeredEntFiniteElementPtr->getRowFieldEntsPtr();
   };

◆ query_interface()

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

inlinevirtual

Reimplemented from MoFEM::BasicMethod.

Definition at line 371 of file LoopMethods.hpp.

                                                                  {
     MoFEMFunctionBeginHot;
     *iface = const_cast<FEMethod *>(this);
     MoFEMFunctionReturnHot(0);
   }

Member Data Documentation

◆ exeTestHook

boost::function<bool(FEMethod *fe_method_ptr)> MoFEM::FEMethod::exeTestHook

Tet if element to skip element.

If is set and return false elemnent us skiped in MoFEM::Core::loop_finite_elements

Note: That functionality is used to run elements on particular bit levels

Definition at line 402 of file LoopMethods.hpp.

◆ feName

std::string MoFEM::FEMethod::feName

Name of finite element.

Definition at line 380 of file LoopMethods.hpp.

◆ numeredEntFiniteElementPtr

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

Pointer to finite element database structure

Examples: free_surface.cpp, and prism_elements_from_surface.cpp.

Definition at line 383 of file LoopMethods.hpp.

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

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

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FEMethod()

Member Function Documentation

◆ getColDofsPtr()

◆ getColFieldEnts()

◆ getColFieldEntsPtr()

◆ getDataDofsPtr()

◆ getDataFieldEnts()

◆ getDataFieldEntsPtr()

◆ getDataVectorDofsPtr()

◆ getFEEntityHandle()

◆ getFEName()

◆ getNodeData()

◆ getNumberOfNodes()

◆ getRowDofsPtr()

◆ getRowFieldEnts()

◆ getRowFieldEntsPtr()

◆ query_interface()

Member Data Documentation

◆ exeTestHook

◆ feName

◆ numeredEntFiniteElementPtr