MoFEM::OpLoopThis< E > Struct Template Reference

Execute "this" element in the operator. More...

#include "src/finite_elements/ForcesAndSourcesCore.hpp"

Inheritance diagram for MoFEM::OpLoopThis< E >:

Collaboration diagram for MoFEM::OpLoopThis< E >:

Public Types
using	UserDataOperator = ForcesAndSourcesCore::UserDataOperator
Public Types inherited from MoFEM::ForcesAndSourcesCore::UserDataOperator
enum	OpType {   OPROW = 1 << 0 , OPCOL = 1 << 1 , OPROWCOL = 1 << 2 , OPSPACE = 1 << 3 ,   OPLAST = 1 << 3 }
	Controls loop over entities on element. More...
using	AdjCache = std::map< EntityHandle, std::vector< boost::weak_ptr< NumeredEntFiniteElement > > >
Public Types inherited from MoFEM::DataOperator
using	DoWorkLhsHookFunType = boost::function< MoFEMErrorCode(DataOperator *op_ptr, int row_side, int col_side, EntityType row_type, EntityType col_type, EntitiesFieldData::EntData &row_data, EntitiesFieldData::EntData &col_data)>
using	DoWorkRhsHookFunType = boost::function< MoFEMErrorCode(DataOperator *op_ptr, int side, EntityType type, EntitiesFieldData::EntData &data)>

Public Member Functions
	OpLoopThis (MoFEM::Interface &m_field, const std::string fe_name, const LogManager::SeverityLevel sev=Sev::noisy)
	Construct a new OpThis object.
	OpLoopThis (MoFEM::Interface &m_field, const std::string fe_name, boost::shared_ptr< Range > fe_range, const LogManager::SeverityLevel sev=Sev::noisy)
	OpLoopThis (MoFEM::Interface &m_field, const std::string fe_name, BitRefLevel bit_ref_level, BitRefLevel bit_ref_level_mask, const LogManager::SeverityLevel sev=Sev::noisy)
	Construct a new OpThis object.
MoFEMErrorCode	doWork (int side, EntityType type, EntitiesFieldData::EntData &data) override
	Operator for linear form, usually to calculate values on right hand side.
boost::ptr_deque< UserDataOperator > &	getOpPtrVector ()
boost::shared_ptr< E > &	getThisFEPtr ()
boost::weak_ptr< ForcesAndSourcesCore >	getSubPipelinePtr () const override
Public Member Functions inherited from MoFEM::ForcesAndSourcesCore::UserDataOperator
	UserDataOperator (const FieldSpace space, const char type=OPSPACE, const bool symm=true)
	Constructor for operators working on finite element spaces.
	UserDataOperator (const std::string field_name, const char type, const bool symm=true)
	Constructor for operators working on a single field.
	UserDataOperator (const std::string row_field_name, const std::string col_field_name, const char type, const bool symm=true)
	Constructor for operators working on two fields (bilinear forms)
boost::shared_ptr< const NumeredEntFiniteElement >	getNumeredEntFiniteElementPtr () const
	Return raw pointer to NumeredEntFiniteElement.
EntityHandle	getFEEntityHandle () const
	Return finite element entity handle.
int	getFEDim () const
	Get dimension of finite element.
EntityType	getFEType () const
	Get dimension of finite element.
boost::weak_ptr< SideNumber >	getSideNumberPtr (const int side_number, const EntityType type)
	Get the side number pointer.
EntityHandle	getSideEntity (const int side_number, const EntityType type)
	Get the side entity.
int	getNumberOfNodesOnElement () const
	Get the number of nodes on finite element.
MoFEMErrorCode	getProblemRowIndices (const std::string filed_name, const EntityType type, const int side, VectorInt &indices) const
	Get row indices.
MoFEMErrorCode	getProblemColIndices (const std::string filed_name, const EntityType type, const int side, VectorInt &indices) const
	Get col indices.
const FEMethod *	getFEMethod () const
	Return raw pointer to Finite Element Method object.
int	getOpType () const
	Get operator types.
void	setOpType (const OpType type)
	Set operator type.
void	addOpType (const OpType type)
	Add operator type.
int	getNinTheLoop () const
	get number of finite element in the loop
int	getLoopSize () const
	get size of elements in the loop
std::string	getFEName () const
	Get name of the element.
ForcesAndSourcesCore *	getPtrFE () const
ForcesAndSourcesCore *	getSidePtrFE () const
ForcesAndSourcesCore *	getRefinePtrFE () const
const PetscData::Switches &	getDataCtx () const
const KspMethod::KSPContext	getKSPCtx () const
const SnesMethod::SNESContext	getSNESCtx () const
const TSMethod::TSContext	getTSCtx () const
Vec	getKSPf () const
Mat	getKSPA () const
Mat	getKSPB () const
Vec	getSNESf () const
Vec	getSNESx () const
Mat	getSNESA () const
Mat	getSNESB () const
Vec	getTSu () const
Vec	getTSu_t () const
Vec	getTSu_tt () const
Vec	getTSf () const
Mat	getTSA () const
Mat	getTSB () const
int	getTSstep () const
double	getTStime () const
double	getTStimeStep () const
double	getTSa () const
double	getTSaa () const
MatrixDouble &	getGaussPts ()
	matrix of integration (Gauss) points for Volume Element
auto	getFTensor0IntegrationWeight ()
	Get integration weights.
MatrixDouble &	getCoordsAtGaussPts ()
	Gauss points and weight, matrix (nb. of points x 3)
auto	getFTensor1CoordsAtGaussPts ()
	Get coordinates at integration points assuming linear geometry.
double	getMeasure () const
	get measure of element
double &	getMeasure ()
	get measure of element
MoFEM::Interface &	getMField ()
moab::Interface &	getMoab ()
MoFEMErrorCode	loopSide (const string &fe_name, ForcesAndSourcesCore *side_fe, const size_t dim, const EntityHandle ent_for_side=0, boost::shared_ptr< Range > fe_range=nullptr, const int verb=QUIET, const LogManager::SeverityLevel sev=Sev::noisy, AdjCache *adj_cache=nullptr)
	User calls this function to loop over elements on the side of face. This function calls finite element with its operator to do calculations.
MoFEMErrorCode	loopThis (const string &fe_name, ForcesAndSourcesCore *this_fe, const int verb=QUIET, const LogManager::SeverityLevel sev=Sev::noisy)
	User calls this function to loop over the same element using a different set of integration points. This function calls finite element with its operator to do calculations.
MoFEMErrorCode	loopParent (const string &fe_name, ForcesAndSourcesCore *parent_fe, const int verb=QUIET, const LogManager::SeverityLevel sev=Sev::noisy)
	User calls this function to loop over parent elements. This function calls finite element with its operator to do calculations.
MoFEMErrorCode	loopChildren (const string &fe_name, ForcesAndSourcesCore *child_fe, const int verb=QUIET, const LogManager::SeverityLevel sev=Sev::noisy)
	User calls this function to loop over parent elements. This function calls finite element with its operator to do calculations.
MoFEMErrorCode	loopRange (const string &fe_name, ForcesAndSourcesCore *range_fe, boost::shared_ptr< Range > fe_range, const int verb=QUIET, const LogManager::SeverityLevel sev=Sev::noisy)
	Iterate over range of elements.
Public Member Functions inherited from MoFEM::DataOperator
	DataOperator (const bool symm=true)
virtual	~DataOperator ()=default
virtual MoFEMErrorCode	doWork (int row_side, int col_side, EntityType row_type, EntityType col_type, EntitiesFieldData::EntData &row_data, EntitiesFieldData::EntData &col_data)
	Operator for bi-linear form, usually to calculate values on left hand side.
virtual MoFEMErrorCode	opLhs (EntitiesFieldData &row_data, EntitiesFieldData &col_data)
virtual MoFEMErrorCode	opRhs (EntitiesFieldData &data, const bool error_if_no_base=false)
bool	getSymm () const
	Get if operator uses symmetry of DOFs or not.
void	setSymm ()
	set if operator is executed taking in account symmetry
void	unSetSymm ()
	unset if operator is executed for non symmetric problem

Protected Attributes
const std::string	feName
boost::shared_ptr< E >	thisFEPtr
const LogManager::SeverityLevel	sevLevel
BitRefLevel	bitLevel = BitRefLevel().set()
BitRefLevel	bitMask = BitRefLevel().set()
boost::shared_ptr< Range >	feRangePtr = nullptr
Protected Attributes inherited from MoFEM::ForcesAndSourcesCore::UserDataOperator
ForcesAndSourcesCore *	ptrFE

Additional Inherited Members
Public Attributes inherited from MoFEM::ForcesAndSourcesCore::UserDataOperator
char	opType
std::string	rowFieldName
std::string	colFieldName
FieldSpace	sPace
Public Attributes inherited from MoFEM::DataOperator
DoWorkLhsHookFunType	doWorkLhsHook
DoWorkRhsHookFunType	doWorkRhsHook
bool	sYmm
	If true assume that matrix is symmetric structure.
std::array< bool, MBMAXTYPE >	doEntities
	If true operator is executed for entity.
bool &	doVertices
	\deprectaed If false skip vertices
bool &	doEdges
	\deprectaed If false skip edges
bool &	doQuads
	\deprectaed
bool &	doTris
	\deprectaed
bool &	doTets
	\deprectaed
bool &	doPrisms
	\deprectaed
Static Public Attributes inherited from MoFEM::ForcesAndSourcesCore::UserDataOperator
static const char *const	OpTypeNames []
Protected Member Functions inherited from MoFEM::ForcesAndSourcesCore::UserDataOperator
virtual MoFEMErrorCode	setPtrFE (ForcesAndSourcesCore *ptr)

Detailed Description

template<typename E>
struct MoFEM::OpLoopThis< E >

Execute "this" element in the operator.

 An example of usage in post-processing
 
using InteriorElem = VolumeElementForcesAndSourcesCore;
using PostProcFe = PostProcBrokenMeshInMoab<InteriorElem>;
auto fe_post_proc = boost::make_shared<PostProcFe>(mField);
auto op_this = new OpLoopThis<InteriorElem>(m_field, "DomainFE", Sev::noisy);
fe_post_proc->getOpPtrVector()->push_back(op_this);
 
auto fe_physics = op_this->getThisFEPtr();
fe_physics->getRuleHook = [](int, int, int o) {
  return 2 * o; };
 
int order = 1;
 
// entity data shared between physical and post proc elements
auto entity_data_l2 = boost::make_shared<EntitiesFieldData>(MBENTITYSET); 
// integrated mass matrix of post proc element
auto mass_ptr = boost::make_shared<MatrixDouble>(); 
// vector of coeff shared between physical and post proc elements
auto coeffs_ptr = boost::make_shared<MatrixDouble>();
// data stored at
// integration points of the physical element and evaluated at integration
// points of the post proc element
auto data_ptr = boost::make_shared<MatrixDouble>(); 
fe_physics->getOpPtrVector()->push_back(new
 OpDGProjectionMassMatrix(order, mass_ptr, entity_data_l2,
  AINSWORTH_LEGENDRE_BASE, L2));
 
// You need to call operator which will evaluate data_ptr
 
fe_physics->getOpPtrVector()->push_back(new
  OpCalculateVectorFieldValues("V", data_ptr);
fe_physics->getOpPtrVector()->push_back( new
  OpDGProjectionCoefficients(data_ptr, coeffs_ptr, mass_ptr, entity_data_l2,
  AINSWORTH_LEGENDRE_BASE, L2));
 
fe_post_proc->getOpPtrVector()->push_back(new
  OpDGProjectionEvaluation(data_ptr, coeffs_ptr, 
  entity_data_l2, AINSWORTH_LEGENDRE_BASE, L2));

Template Parameters

E	template for "this" element type

Examples

/home/lk58p/mofem_install/vanilla_dev_release/mofem-cephas/mofem/users_modules/eshelbian_plasticity/src/impl/EshelbianPlasticity.cpp, mofem/atom_tests/dg_projection.cpp, mofem/tutorials/adv-6_dg_projection/between_meshes_dg_projection.cpp, and mofem/users_modules/adolc-plasticity/adolc_plasticity.cpp.

Definition at line 1539 of file ForcesAndSourcesCore.hpp.

Member Typedef Documentation

UserDataOperator

template<typename E >

using MoFEM::OpLoopThis< E >::UserDataOperator = ForcesAndSourcesCore::UserDataOperator

Definition at line 1541 of file ForcesAndSourcesCore.hpp.

Constructor & Destructor Documentation

OpLoopThis() [1/3]

template<typename E >

MoFEM::OpLoopThis< E >::OpLoopThis ( MoFEM::Interface &  m_field, const std::string  fe_name, const LogManager::SeverityLevel  sev = Sev::noisy  )

inline

Construct a new OpThis object.

Parameters

m_field
fe_name	name of "this" element (domain element)

Definition at line 1549 of file ForcesAndSourcesCore.hpp.

      : UserDataOperator(NOSPACE, OPSPACE), thisFEPtr(new E(m_field)),
        feName(fe_name), sevLevel(sev) {}

OpLoopThis() [2/3]

template<typename E >

MoFEM::OpLoopThis< E >::OpLoopThis ( MoFEM::Interface &  m_field, const std::string  fe_name, boost::shared_ptr< Range >  fe_range, const LogManager::SeverityLevel  sev = Sev::noisy  )

inline

Definition at line 1554 of file ForcesAndSourcesCore.hpp.

      : UserDataOperator(NOSPACE, OPSPACE), thisFEPtr(new E(m_field)),
        feName(fe_name), sevLevel(sev), feRangePtr(fe_range) {}

OpLoopThis() [3/3]

template<typename E >

MoFEM::OpLoopThis< E >::OpLoopThis ( MoFEM::Interface &  m_field, const std::string  fe_name, BitRefLevel  bit_ref_level, BitRefLevel  bit_ref_level_mask, const LogManager::SeverityLevel  sev = Sev::noisy  )

inline

Construct a new OpThis object.

Use this if you want to execute element on particular bit ref level and mask.

Definition at line 1566 of file ForcesAndSourcesCore.hpp.

      : UserDataOperator(NOSPACE, OPSPACE), thisFEPtr(new E(m_field)),
        feName(fe_name), sevLevel(sev), bitLevel(bit_ref_level),
        bitMask(bit_ref_level_mask) {}

Member Function Documentation

doWork()

template<typename E >

MoFEMErrorCode MoFEM::OpLoopThis< E >::doWork ( int  side, EntityType  type, EntitiesFieldData::EntData &  data  )

inlineoverridevirtual

Operator for linear form, usually to calculate values on right hand side.

Reimplemented from MoFEM::DataOperator.

Definition at line 1573 of file ForcesAndSourcesCore.hpp.

                                                                 {
    MoFEMFunctionBegin;
    if (feRangePtr) {
      if (feRangePtr->find(getFEEntityHandle()) == feRangePtr->end())
        MoFEMFunctionReturnHot(0);
    }
    auto bit = getNumeredEntFiniteElementPtr()->getBitRefLevel();
    if (((bitMask & bit) == bit) && (bitLevel & bit).any()) {
      CHKERR loopThis(feName, thisFEPtr.get(), VERBOSE, sevLevel);
    }
    MoFEMFunctionReturn(0);
  };

getOpPtrVector()

template<typename E >

boost::ptr_deque< UserDataOperator > & MoFEM::OpLoopThis< E >::getOpPtrVector ( )

inline

Here user will push operator evaluating field, or data at "this" element integration points.

Definition at line 1591 of file ForcesAndSourcesCore.hpp.

                                                     {
    return thisFEPtr->getOpPtrVector();
  }

getSubPipelinePtr()

template<typename E >

boost::weak_ptr< ForcesAndSourcesCore > MoFEM::OpLoopThis< E >::getSubPipelinePtr ( ) const

inlineoverridevirtual

Reimplemented from MoFEM::ForcesAndSourcesCore::UserDataOperator.

Definition at line 1597 of file ForcesAndSourcesCore.hpp.

                                                                         {
    return thisFEPtr;
  }

getThisFEPtr()

template<typename E >

boost::shared_ptr< E > & MoFEM::OpLoopThis< E >::getThisFEPtr ( )

inline

Definition at line 1595 of file ForcesAndSourcesCore.hpp.

{ return thisFEPtr; }

Member Data Documentation

bitLevel

template<typename E >

BitRefLevel MoFEM::OpLoopThis< E >::bitLevel = BitRefLevel().set()

protected

Definition at line 1605 of file ForcesAndSourcesCore.hpp.

bitMask

template<typename E >

BitRefLevel MoFEM::OpLoopThis< E >::bitMask = BitRefLevel().set()

protected

Definition at line 1606 of file ForcesAndSourcesCore.hpp.

feName

template<typename E >

const std::string MoFEM::OpLoopThis< E >::feName

protected

Definition at line 1602 of file ForcesAndSourcesCore.hpp.

feRangePtr

template<typename E >

boost::shared_ptr<Range> MoFEM::OpLoopThis< E >::feRangePtr = nullptr

protected

Definition at line 1607 of file ForcesAndSourcesCore.hpp.

sevLevel

template<typename E >

const LogManager::SeverityLevel MoFEM::OpLoopThis< E >::sevLevel

protected

Definition at line 1604 of file ForcesAndSourcesCore.hpp.

thisFEPtr

template<typename E >

boost::shared_ptr<E> MoFEM::OpLoopThis< E >::thisFEPtr

protected

Definition at line 1603 of file ForcesAndSourcesCore.hpp.

---

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

• src/finite_elements/ForcesAndSourcesCore.hpp