v0.13.1
Public Types | Public Member Functions | List of all members
MoFEM::interface_Field< T, T > Struct Template Reference

#include <src/multi_indices/FieldMultiIndices.hpp>

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

Public Types

using interface_type_FieldImpl = interface_FieldImpl< T, T >
 
- Public Types inherited from MoFEM::interface_FieldImpl< T, T >
using interface_type_RefEntity = interface_RefEntity< T >
 

Public Member Functions

 interface_Field (const boost::shared_ptr< T > &ptr)
 
EntityHandle getMeshset () const
 
const BitFieldIdgetId () const
 
boost::string_ref getNameRef () const
 
std::string getName () const
 
FieldSpace getSpace () const
 
auto getSpaceName () const
 
FieldApproximationBase getApproxBase () const
 
auto getApproxBaseName () 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
 
- Public Member Functions inherited from MoFEM::interface_FieldImpl< T, T >
 interface_FieldImpl (const boost::shared_ptr< T > &field_ptr, const boost::shared_ptr< T > &ref_ents_ptr)
 
virtual ~interface_FieldImpl ()=default
 
- Public Member Functions inherited from MoFEM::interface_RefEntity< T >
 interface_RefEntity (const boost::shared_ptr< T > &sptr)
 
 interface_RefEntity (const interface_RefEntity< T > &interface)
 
virtual ~interface_RefEntity ()=default
 
int getSideNumber () const
 
boost::shared_ptr< SideNumbergetSideNumberPtr () const
 Get the Side number. More...
 
const boost::shared_ptr< BasicEntityDatagetBasicDataPtr () const
 Get pointer to basic data struture. More...
 
EntityHandle getEnt () const
 Get the entity handle. More...
 
EntityType getParentEntType () const
 Get patent entity. More...
 
EntityHandle getParentEnt () const
 
BitRefLevelgetBitRefLevelPtr () const
 Get pointer to bit ref level tag. More...
 
const BitRefLevelgetBitRefLevel () const
 
unsigned long int getBitRefLevelULong () const
 Get entity ref bit refinement as ulong. More...
 
EntityType getEntType () const
 Get entity type. More...
 
int getEntDimension () const
 Get the Ent Dimension. More...
 
const char * getEntTypeName () const
 Get the Ent Type Name. More...
 
EntityID getEntId () const
 get entity id More...
 
EntityHandle getOwnerEnt () const
 
EntityHandle & getOwnerEnt ()
 
int getOwnerProc () const
 
int getPartProc () const
 
int * getPartProcPtr () const
 Get pointer to partition tag. More...
 
unsigned char getPStatus () const
 
int * getSharingProcsPtr () const
 get shared processors More...
 
EntityHandle * getSharingHandlersPtr () const
 get sharid entity handlers More...
 
boost::shared_ptr< T > & getRefEntityPtr () const
 

Additional Inherited Members

- Public Attributes inherited from MoFEM::interface_RefEntity< T >
boost::shared_ptr< TsPtr
 

Detailed Description

template<typename T>
struct MoFEM::interface_Field< T, T >

Definition at line 407 of file FieldMultiIndices.hpp.

Member Typedef Documentation

◆ interface_type_FieldImpl

template<typename T >
using MoFEM::interface_Field< T, T >::interface_type_FieldImpl = interface_FieldImpl<T,T>

Definition at line 411 of file FieldMultiIndices.hpp.

Constructor & Destructor Documentation

◆ interface_Field()

template<typename T >
MoFEM::interface_Field< T, T >::interface_Field ( const boost::shared_ptr< T > &  ptr)

Definition at line 408 of file FieldMultiIndices.hpp.

409 : interface_FieldImpl<T, T>(ptr, ptr) {}

Member Function Documentation

◆ getApproxBase()

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

Definition at line 441 of file FieldMultiIndices.hpp.

441 {
442 return getFieldRawPtr()->getApproxBase();
443 }
FieldApproximationBase getApproxBase() const
Get approximation base.
const Field * getFieldRawPtr() const

◆ getApproxBaseName()

template<typename T >
auto MoFEM::interface_Field< T, T >::getApproxBaseName ( ) const
Returns
get approximation base

Definition at line 446 of file FieldMultiIndices.hpp.

446 {
448 }
auto getApproxBaseName() const
Get approximation base.

◆ getBitNumber()

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

Definition at line 456 of file FieldMultiIndices.hpp.

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

◆ getDofOrderMap()

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

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 469 of file FieldMultiIndices.hpp.

469 {
471 }
const std::array< ApproximationOrder, MAX_DOFS_ON_ENTITY > & getDofOrderMap(const EntityType type) const
get hash-map relating dof index on entity with its order

◆ getFieldRawPtr()

template<typename T >
const Field * MoFEM::interface_Field< T, T >::getFieldRawPtr ( ) const

Definition at line 473 of file FieldMultiIndices.hpp.

473 {
474 return boost::static_pointer_cast<T>(this->getRefEntityPtr())
475 ->getFieldRawPtr();
476 };
boost::shared_ptr< T > & getRefEntityPtr() const

◆ getId()

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

Definition at line 418 of file FieldMultiIndices.hpp.

418 {
419 return getFieldRawPtr()->getId();
420 }
const BitFieldId & getId() const
Get unique field id.

◆ getMeshset()

template<typename T >
EntityHandle MoFEM::interface_Field< T, T >::getMeshset ( ) const

Definition at line 413 of file FieldMultiIndices.hpp.

413 {
414 return getFieldRawPtr()->getMeshset();
415 }
EntityHandle getMeshset() const
Get field meshset.

◆ getName()

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

Definition at line 428 of file FieldMultiIndices.hpp.

428 {
429 return getFieldRawPtr()->getName();
430 }
std::string getName() const
Get field name.

◆ getNameRef()

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

Definition at line 423 of file FieldMultiIndices.hpp.

423 {
424 return getFieldRawPtr()->getNameRef();
425 }
boost::string_ref getNameRef() const
Get string reference to field name.

◆ getNbOfCoeffs()

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

Definition at line 451 of file FieldMultiIndices.hpp.

451 {
452 return getFieldRawPtr()->getNbOfCoeffs();
453 }
FieldCoefficientsNumber getNbOfCoeffs() const
Get number of field coefficients.

◆ getSpace()

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

Definition at line 433 of file FieldMultiIndices.hpp.

433 {
434 return getFieldRawPtr()->getSpace();
435 }
FieldSpace getSpace() const
Get field approximation space.

◆ getSpaceName()

template<typename T >
auto MoFEM::interface_Field< T, T >::getSpaceName ( ) const
Returns
get approximation base

Definition at line 438 of file FieldMultiIndices.hpp.

438{ return getFieldRawPtr()->getSpaceName(); }
auto getSpaceName() const
Get field approximation space.

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