v0.14.0
Loading...
Searching...
No Matches
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
 
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< 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 377 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 381 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 378 of file FieldMultiIndices.hpp.

379 : 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 411 of file FieldMultiIndices.hpp.

411 {
412 return getFieldRawPtr()->getApproxBase();
413 }
FieldApproximationBase getApproxBase() const
Get approximation base.
const Field * getFieldRawPtr() const

◆ getApproxBaseName()

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

Definition at line 416 of file FieldMultiIndices.hpp.

416 {
418 }
auto getApproxBaseName() const
Get approximation base.

◆ getBitNumber()

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

Definition at line 426 of file FieldMultiIndices.hpp.

426 {
427 return getFieldRawPtr()->getBitNumber();
428 }
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
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 439 of file FieldMultiIndices.hpp.

439 {
440 return getFieldRawPtr()->getDofOrderMap(type);
441 }
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
inline

Definition at line 443 of file FieldMultiIndices.hpp.

443 {
444 return boost::static_pointer_cast<T>(this->getRefEntityPtr())
445 ->getFieldRawPtr();
446 };
boost::shared_ptr< T > & getRefEntityPtr() const

◆ getId()

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

Definition at line 388 of file FieldMultiIndices.hpp.

388 {
389 return getFieldRawPtr()->getId();
390 }
const BitFieldId & getId() const
Get unique field id.

◆ getMeshset()

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

Definition at line 383 of file FieldMultiIndices.hpp.

383 {
384 return getFieldRawPtr()->getMeshset();
385 }
EntityHandle getMeshset() const
Get field meshset.

◆ getName()

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

Definition at line 398 of file FieldMultiIndices.hpp.

398 {
399 return getFieldRawPtr()->getName();
400 }
std::string getName() const
Get field name.

◆ getNameRef()

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

Definition at line 393 of file FieldMultiIndices.hpp.

393 {
394 return getFieldRawPtr()->getNameRef();
395 }
boost::string_ref getNameRef() const
Get string reference to field name.

◆ getNbOfCoeffs()

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

Definition at line 421 of file FieldMultiIndices.hpp.

421 {
422 return getFieldRawPtr()->getNbOfCoeffs();
423 }
FieldCoefficientsNumber getNbOfCoeffs() const
Get number of field coefficients.

◆ getSpace()

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

Definition at line 403 of file FieldMultiIndices.hpp.

403 {
404 return getFieldRawPtr()->getSpace();
405 }
FieldSpace getSpace() const
Get field approximation space.

◆ getSpaceName()

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

Definition at line 408 of file FieldMultiIndices.hpp.

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

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