v0.14.0
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
 
EntityHandlegetOwnerEnt ()
 
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...
 
EntityHandlegetSharingHandlersPtr () 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< T > sPtr
 

Detailed Description

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

Definition at line 418 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 422 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)
inline

Definition at line 419 of file FieldMultiIndices.hpp.

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

Member Function Documentation

◆ getApproxBase()

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

Definition at line 452 of file FieldMultiIndices.hpp.

452  {
453  return getFieldRawPtr()->getApproxBase();
454  }

◆ getApproxBaseName()

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

Definition at line 457 of file FieldMultiIndices.hpp.

457  {
458  return getFieldRawPtr()->getApproxBaseName();
459  }

◆ getBitNumber()

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

Definition at line 467 of file FieldMultiIndices.hpp.

467  {
468  return getFieldRawPtr()->getBitNumber();
469  }

◆ getDofOrderMap()

template<typename T >
std::array<ApproximationOrder, MAX_DOFS_ON_ENTITY>& MoFEM::interface_Field< T, T >::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 480 of file FieldMultiIndices.hpp.

480  {
482  }

◆ getFieldRawPtr()

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

Definition at line 484 of file FieldMultiIndices.hpp.

484  {
485  return boost::static_pointer_cast<T>(this->getRefEntityPtr())
486  ->getFieldRawPtr();
487  };

◆ getId()

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

Definition at line 429 of file FieldMultiIndices.hpp.

429  {
430  return getFieldRawPtr()->getId();
431  }

◆ getMeshset()

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

Definition at line 424 of file FieldMultiIndices.hpp.

424  {
425  return getFieldRawPtr()->getMeshset();
426  }

◆ getName()

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

Definition at line 439 of file FieldMultiIndices.hpp.

439  {
440  return getFieldRawPtr()->getName();
441  }

◆ getNameRef()

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

Definition at line 434 of file FieldMultiIndices.hpp.

434  {
435  return getFieldRawPtr()->getNameRef();
436  }

◆ getNbOfCoeffs()

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

Definition at line 462 of file FieldMultiIndices.hpp.

462  {
463  return getFieldRawPtr()->getNbOfCoeffs();
464  }

◆ getSpace()

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

Definition at line 444 of file FieldMultiIndices.hpp.

444  {
445  return getFieldRawPtr()->getSpace();
446  }

◆ getSpaceName()

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

Definition at line 449 of file FieldMultiIndices.hpp.

449 { return getFieldRawPtr()->getSpaceName(); }

The documentation for this struct was generated from the following file:
MoFEM::Field::getSpaceName
auto getSpaceName() const
Get field approximation space.
Definition: FieldMultiIndices.hpp:157
MoFEM::Field::getNbOfCoeffs
FieldCoefficientsNumber getNbOfCoeffs() const
Get number of field coefficients.
Definition: FieldMultiIndices.hpp:202
MoFEM::Field::getDofOrderMap
const std::array< ApproximationOrder, MAX_DOFS_ON_ENTITY > & getDofOrderMap(const EntityType type) const
get hash-map relating dof index on entity with its order
Definition: FieldMultiIndices.hpp:268
MoFEM::Field::getMeshset
EntityHandle getMeshset() const
Get field meshset.
Definition: FieldMultiIndices.hpp:123
MoFEM::Field::getSpace
FieldSpace getSpace() const
Get field approximation space.
Definition: FieldMultiIndices.hpp:151
MoFEM::interface_RefEntity::getRefEntityPtr
boost::shared_ptr< T > & getRefEntityPtr() const
Definition: RefEntsMultiIndices.hpp:709
MoFEM::Field::getName
std::string getName() const
Get field name.
Definition: FieldMultiIndices.hpp:143
MoFEM::Field::getApproxBaseName
auto getApproxBaseName() const
Get approximation base.
Definition: FieldMultiIndices.hpp:184
MoFEM::Field::getId
const BitFieldId & getId() const
Get unique field id.
Definition: FieldMultiIndices.hpp:129
MoFEM::Field::getNameRef
boost::string_ref getNameRef() const
Get string reference to field name.
Definition: FieldMultiIndices.hpp:135
MoFEM::interface_Field< T, T >::getFieldRawPtr
const Field * getFieldRawPtr() const
Definition: FieldMultiIndices.hpp:484
convert.type
type
Definition: convert.py:64
MoFEM::Field::getApproxBase
FieldApproximationBase getApproxBase() const
Get approximation base.
Definition: FieldMultiIndices.hpp:178
MoFEM::Field::getBitNumber
FieldBitNumber getBitNumber() const
Get number of set bit in Field ID. Each field has uid, get getBitNumber get number of bit set for giv...
Definition: FieldMultiIndices.hpp:211