v0.15.0
Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
MoFEM::interface_Field< T, T > Struct Template Reference

Field interface specialization for same field and reference types. More...

#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)
 Constructor.
 
EntityHandle getMeshset () const
 Get field meshset handle.
 
const BitFieldIdgetId () const
 Get field ID.
 
boost::string_ref getNameRef () const
 Get field name reference.
 
std::string getName () const
 Get field name.
 
FieldSpace getSpace () const
 Get approximation space.
 
auto getSpaceName () const
 Get approximation space name.
 
FieldApproximationBase getApproxBase () const
 Get approximation basis.
 
auto getApproxBaseName () const
 Get approximation basis name.
 
FieldCoefficientsNumber getNbOfCoeffs () const
 Get number of coefficients per DOF.
 
FieldBitNumber getBitNumber () const
 Get bit number for field ID.
 
std::array< ApproximationOrder, MAX_DOFS_ON_ENTITY > & getDofOrderMap (const EntityType type) const
 Get DOF order mapping for entity type.
 
const FieldgetFieldRawPtr () const
 Get raw field pointer.
 
- 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)
 Constructor with field and reference entity pointers.
 
virtual ~interface_FieldImpl ()=default
 Virtual destructor.
 
- 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< T > sPtr
 

Detailed Description

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

Field interface specialization for same field and reference types.

Template Parameters
TField/reference type

Definition at line 416 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 425 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

Constructor.

Parameters
ptrShared pointer to field/reference object

Definition at line 422 of file FieldMultiIndices.hpp.

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

Member Function Documentation

◆ getApproxBase()

template<typename T >
FieldApproximationBase MoFEM::interface_Field< T, T >::getApproxBase ( ) const
inline

Get approximation basis.

Definition at line 456 of file FieldMultiIndices.hpp.

456 {
457 return getFieldRawPtr()->getApproxBase();
458 }
FieldApproximationBase getApproxBase() const
Get approximation basis type.
const Field * getFieldRawPtr() const
Get raw field pointer.

◆ getApproxBaseName()

template<typename T >
auto MoFEM::interface_Field< T, T >::getApproxBaseName ( ) const
inline

Get approximation basis name.

Definition at line 461 of file FieldMultiIndices.hpp.

461 {
463 }
auto getApproxBaseName() const
Get approximation basis name.

◆ getBitNumber()

template<typename T >
FieldBitNumber MoFEM::interface_Field< T, T >::getBitNumber ( ) const
inline

Get bit number for field ID.

Definition at line 471 of file FieldMultiIndices.hpp.

471 {
472 return getFieldRawPtr()->getBitNumber();
473 }
FieldBitNumber getBitNumber() const
Get bit number for this field's ID.

◆ getDofOrderMap()

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

Get DOF order mapping for entity type.

Parameters
typeEntity type
Returns
DOF order array

Definition at line 481 of file FieldMultiIndices.hpp.

481 {
482 return getFieldRawPtr()->getDofOrderMap(type);
483 }
const std::array< ApproximationOrder, MAX_DOFS_ON_ENTITY > & getDofOrderMap(const EntityType type) const
Get DOF order mapping for specific entity type.

◆ getFieldRawPtr()

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

Get raw field pointer.

Definition at line 486 of file FieldMultiIndices.hpp.

486 {
487 return boost::static_pointer_cast<T>(this->getRefEntityPtr())
488 ->getFieldRawPtr();
489 };
boost::shared_ptr< T > & getRefEntityPtr() const

◆ getId()

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

Get field ID.

Definition at line 433 of file FieldMultiIndices.hpp.

433 {
434 return getFieldRawPtr()->getId();
435 }
const BitFieldId & getId() const
Get unique field identifier.

◆ getMeshset()

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

Get field meshset handle.

Definition at line 428 of file FieldMultiIndices.hpp.

428 {
429 return getFieldRawPtr()->getMeshset();
430 }
EntityHandle getMeshset() const
Get field meshset handle.

◆ getName()

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

Get field name.

Definition at line 443 of file FieldMultiIndices.hpp.

443 {
444 return getFieldRawPtr()->getName();
445 }
std::string getName() const
Get field name as string.

◆ getNameRef()

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

Get field name reference.

Definition at line 438 of file FieldMultiIndices.hpp.

438 {
439 return getFieldRawPtr()->getNameRef();
440 }
boost::string_ref getNameRef() const
Get field name as string reference.

◆ getNbOfCoeffs()

template<typename T >
FieldCoefficientsNumber MoFEM::interface_Field< T, T >::getNbOfCoeffs ( ) const
inline

Get number of coefficients per DOF.

Definition at line 466 of file FieldMultiIndices.hpp.

466 {
467 return getFieldRawPtr()->getNbOfCoeffs();
468 }
FieldCoefficientsNumber getNbOfCoeffs() const
Get number of field coefficients per DOF.

◆ getSpace()

template<typename T >
FieldSpace MoFEM::interface_Field< T, T >::getSpace ( ) const
inline

Get approximation space.

Definition at line 448 of file FieldMultiIndices.hpp.

448 {
449 return getFieldRawPtr()->getSpace();
450 }
FieldSpace getSpace() const
Get field approximation space.

◆ getSpaceName()

template<typename T >
auto MoFEM::interface_Field< T, T >::getSpaceName ( ) const
inline

Get approximation space name.

Definition at line 453 of file FieldMultiIndices.hpp.

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

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