v0.14.0
Loading...
Searching...
No Matches
Public Member Functions | Private Attributes | List of all members
MoFEM::interface_Field< FIELD, REFENT > Struct Template Reference

#include <src/multi_indices/FieldMultiIndices.hpp>

Inheritance diagram for MoFEM::interface_Field< FIELD, REFENT >:
[legend]
Collaboration diagram for MoFEM::interface_Field< FIELD, REFENT >:
[legend]

Public Member Functions

 interface_Field (const boost::shared_ptr< FIELD > &field_ptr, const boost::shared_ptr< REFENT > &ref_ents_ptr)
 
EntityHandle getMeshset () const
 
int getCoordSysDim (const int d=0) const
 
const BitFieldIdgetId () const
 
boost::string_ref getNameRef () const
 
std::string getName () const
 
FieldSpace getSpace () const
 
FieldApproximationBase getApproxBase () const
 
FieldCoefficientsNumber getNbOfCoeffs () const
 
FieldBitNumber getBitNumber () const
 
std::array< ApproximationOrder, MAX_DOFS_ON_ENTITY > & getDofOrderMap (const EntityType type) const
 get hash-map relating dof index on entity with its order More...
 
const FieldgetFieldRawPtr () const
 
FieldOrderTablegetFieldOrderTable ()
 
- Public Member Functions inherited from MoFEM::interface_FieldImpl< FIELD, REFENT >
 interface_FieldImpl (const boost::shared_ptr< FIELD > &field_ptr, const boost::shared_ptr< REFENT > &ref_ents_ptr)
 
virtual ~interface_FieldImpl ()=default
 
- Public Member Functions inherited from MoFEM::interface_RefEntity< REFENT >
 interface_RefEntity (const boost::shared_ptr< REFENT > &sptr)
 
 interface_RefEntity (const interface_RefEntity< REFENT > &interface)
 
virtual ~interface_RefEntity ()=default
 
int getSideNumber () const
 
boost::shared_ptr< SideNumbergetSideNumberPtr () const
 
const boost::shared_ptr< BasicEntityDatagetBasicDataPtr () const
 
EntityHandle getEnt () const
 
EntityType getParentEntType () const
 
EntityHandle getParentEnt () const
 
BitRefLevelgetBitRefLevelPtr () const
 
const BitRefLevelgetBitRefLevel () const
 
unsigned long int getBitRefLevelULong () const
 
EntityType getEntType () const
 
int getEntDimension () const
 
const char * getEntTypeName () const
 
EntityID getEntId () const
 
EntityHandle getOwnerEnt () const
 
EntityHandlegetOwnerEnt ()
 
int getOwnerProc () const
 
int getPartProc () const
 
int * getPartProcPtr () const
 
unsigned char getPStatus () const
 
int * getSharingProcsPtr () const
 
EntityHandlegetSharingHandlersPtr () const
 
boost::shared_ptr< REFENT > & getRefEntityPtr () const
 

Private Attributes

boost::shared_ptr< FIELD > sFieldPtr
 

Additional Inherited Members

- Public Types inherited from MoFEM::interface_FieldImpl< FIELD, REFENT >
using interface_type_RefEntity = interface_RefEntity< REFENT >
 
- Public Attributes inherited from MoFEM::interface_RefEntity< REFENT >
boost::shared_ptr< REFENT > sPtr
 

Detailed Description

template<typename FIELD, typename REFENT>
struct MoFEM::interface_Field< FIELD, REFENT >

Definition at line 301 of file FieldMultiIndices.hpp.

Constructor & Destructor Documentation

◆ interface_Field()

template<typename FIELD , typename REFENT >
MoFEM::interface_Field< FIELD, REFENT >::interface_Field ( const boost::shared_ptr< FIELD > &  field_ptr,
const boost::shared_ptr< REFENT > &  ref_ents_ptr 
)
inline

Definition at line 303 of file FieldMultiIndices.hpp.

305 : interface_FieldImpl<FIELD, REFENT>(field_ptr, ref_ents_ptr),
306 sFieldPtr(field_ptr) {}
boost::shared_ptr< FIELD > sFieldPtr

Member Function Documentation

◆ getApproxBase()

template<typename FIELD , typename REFENT >
FieldApproximationBase MoFEM::interface_Field< FIELD, REFENT >::getApproxBase ( ) const
inline
Returns
get approximation base

Definition at line 337 of file FieldMultiIndices.hpp.

337 {
338 return getFieldRawPtr()->getApproxBase();
339 }
FieldApproximationBase getApproxBase() const
Get approximation base.
const Field * getFieldRawPtr() const

◆ getBitNumber()

template<typename FIELD , typename REFENT >
FieldBitNumber MoFEM::interface_Field< FIELD, REFENT >::getBitNumber ( ) const
inline
Returns
get bit number if filed Id

Definition at line 347 of file FieldMultiIndices.hpp.

347 {
348 return getFieldRawPtr()->getBitNumber();
349 }
FieldBitNumber getBitNumber() const
Get number of set bit in Field ID. Each field has uid, get getBitNumber get number of bit set for giv...

◆ getCoordSysDim()

template<typename FIELD , typename REFENT >
int MoFEM::interface_Field< FIELD, REFENT >::getCoordSysDim ( const int  d = 0) const
inline

Definition at line 312 of file FieldMultiIndices.hpp.

312 {
313 return getFieldRawPtr()->getCoordSysDim(d);
314 }

◆ getDofOrderMap()

template<typename FIELD , typename REFENT >
std::array< ApproximationOrder, MAX_DOFS_ON_ENTITY > & MoFEM::interface_Field< FIELD, REFENT >::getDofOrderMap ( const EntityType  type) const
inline

get hash-map relating dof index on entity with its order

Dofs of given field are indexed on entity of the same type, same space, approximation base and number of coefficients, are sorted in the way.

Definition at line 360 of file FieldMultiIndices.hpp.

360 {
361 return getFieldRawPtr()->getDofOrderMap(type);
362 }
const std::array< ApproximationOrder, MAX_DOFS_ON_ENTITY > & getDofOrderMap(const EntityType type) const
get hash-map relating dof index on entity with its order

◆ getFieldOrderTable()

template<typename FIELD , typename REFENT >
FieldOrderTable & MoFEM::interface_Field< FIELD, REFENT >::getFieldOrderTable ( )
inline

Definition at line 368 of file FieldMultiIndices.hpp.

368 {
369 return sFieldPtr->getFieldOrderTable();
370 };

◆ getFieldRawPtr()

template<typename FIELD , typename REFENT >
const Field * MoFEM::interface_Field< FIELD, REFENT >::getFieldRawPtr ( ) const
inline

Definition at line 364 of file FieldMultiIndices.hpp.

364 {
365 return sFieldPtr->getFieldRawPtr();
366 };

◆ getId()

template<typename FIELD , typename REFENT >
const BitFieldId & MoFEM::interface_Field< FIELD, REFENT >::getId ( ) const
inline
Returns
get field Id

Definition at line 317 of file FieldMultiIndices.hpp.

317 {
318 return getFieldRawPtr()->getId();
319 }
const BitFieldId & getId() const
Get unique field id.

◆ getMeshset()

template<typename FIELD , typename REFENT >
EntityHandle MoFEM::interface_Field< FIELD, REFENT >::getMeshset ( ) const
inline

Definition at line 308 of file FieldMultiIndices.hpp.

308 {
309 return getFieldRawPtr()->getMeshset();
310 }
EntityHandle getMeshset() const
Get field meshset.

◆ getName()

template<typename FIELD , typename REFENT >
std::string MoFEM::interface_Field< FIELD, REFENT >::getName ( ) const
inline
Returns
get field name

Definition at line 327 of file FieldMultiIndices.hpp.

327 {
328 return getFieldRawPtr()->getName();
329 }
std::string getName() const
Get field name.

◆ getNameRef()

template<typename FIELD , typename REFENT >
boost::string_ref MoFEM::interface_Field< FIELD, REFENT >::getNameRef ( ) const
inline
Returns
get field name

Definition at line 322 of file FieldMultiIndices.hpp.

322 {
323 return getFieldRawPtr()->getNameRef();
324 }
boost::string_ref getNameRef() const
Get string reference to field name.

◆ getNbOfCoeffs()

template<typename FIELD , typename REFENT >
FieldCoefficientsNumber MoFEM::interface_Field< FIELD, REFENT >::getNbOfCoeffs ( ) const
inline
Returns
get number of coefficients for DOF

Definition at line 342 of file FieldMultiIndices.hpp.

342 {
343 return getFieldRawPtr()->getNbOfCoeffs();
344 }
FieldCoefficientsNumber getNbOfCoeffs() const
Get number of field coefficients.

◆ getSpace()

template<typename FIELD , typename REFENT >
FieldSpace MoFEM::interface_Field< FIELD, REFENT >::getSpace ( ) const
inline
Returns
get approximation space

Definition at line 332 of file FieldMultiIndices.hpp.

332 {
333 return getFieldRawPtr()->getSpace();
334 }
FieldSpace getSpace() const
Get field approximation space.

Member Data Documentation

◆ sFieldPtr

template<typename FIELD , typename REFENT >
boost::shared_ptr<FIELD> MoFEM::interface_Field< FIELD, REFENT >::sFieldPtr
mutableprivate

Definition at line 373 of file FieldMultiIndices.hpp.


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