v0.8.19
Public Member Functions | Public Attributes | List of all members
MoFEM::interface_Field< T > Struct Template Reference

Pointer interface for MoFEM::Field. More...

#include <src/multi_indices/FieldMultiIndices.hpp>

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

Public Member Functions

 interface_Field (const boost::shared_ptr< T > &field_ptr)
 
 interface_Field (const interface_Field< T > &interface)
 
virtual ~interface_Field ()
 
EntityHandle getMeshset () const
 
int getCoordSysId () const
 
int getCoordSysDim (const int d=0) const
 Get dimension of general two-point tensor MoFEM::CoordSys::getDim. More...
 
MoFEMErrorCode get_E_Base (const double m[]) const
 
MoFEMErrorCode get_E_DualBase (const double m[]) const
 
MoFEMErrorCode get_e_Base (const double m[]) const
 
MoFEMErrorCode get_e_DualBase (const double m[]) const
 
EntityHandle getCoordSysMeshSet () const
 
std::string getCoordSysName () const
 
boost::string_ref getCoordSysNameRef () const
 
const BitFieldIdgetId () const
 
boost::string_ref getNameRef () const
 
std::string getName () const
 
FieldSpace getSpace () const
 
FieldApproximationBase getApproxBase () const
 
FieldCoefficientsNumber getNbOfCoeffs () const
 
unsigned int getBitNumber () const
 
boost::shared_ptr< T > & getFieldPtr () const
 
std::vector< ApproximationOrder > & getDofOrderMap (const EntityType type) const
 get hash-map relating dof index on entity with its order More...
 

Public Attributes

boost::shared_ptr< TsFieldPtr
 

Detailed Description

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

Pointer interface for MoFEM::Field.

MoFEM::Field class is keeps data and methods. This class is interface to that class, and all other classes, like MoFEMEntities, DofEntity and derived form them inherits pointer interface, not MoFEM::Field class directly.

Definition at line 390 of file FieldMultiIndices.hpp.

Constructor & Destructor Documentation

◆ interface_Field() [1/2]

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

Definition at line 394 of file FieldMultiIndices.hpp.

395  : sFieldPtr(field_ptr) {}
boost::shared_ptr< T > sFieldPtr

◆ interface_Field() [2/2]

template<typename T>
MoFEM::interface_Field< T >::interface_Field ( const interface_Field< T > &  interface)

Definition at line 397 of file FieldMultiIndices.hpp.

398  : sFieldPtr(interface.getFieldPtr()) {}
boost::shared_ptr< T > sFieldPtr

◆ ~interface_Field()

template<typename T>
virtual MoFEM::interface_Field< T >::~interface_Field ( )
virtual

Definition at line 400 of file FieldMultiIndices.hpp.

400 {}

Member Function Documentation

◆ get_E_Base()

template<typename T>
MoFEMErrorCode MoFEM::interface_Field< T >::get_E_Base ( const double  m[]) const

Definition at line 419 of file FieldMultiIndices.hpp.

419  {
421  MoFEMFunctionReturnHot(this->sFieldPtr->get_E_Base(m));
422  }
#define MoFEMFunctionBeginHot
First executable line of each MoFEM function, used for error handling. Final line of MoFEM functions ...
Definition: definitions.h:499
#define MoFEMFunctionReturnHot(a)
Last executable line of each PETSc function used for error handling. Replaces return() ...
Definition: definitions.h:506
boost::shared_ptr< T > sFieldPtr

◆ get_e_Base()

template<typename T>
MoFEMErrorCode MoFEM::interface_Field< T >::get_e_Base ( const double  m[]) const

Definition at line 427 of file FieldMultiIndices.hpp.

427  {
429  MoFEMFunctionReturnHot(this->sFieldPtr->get_e_Base(m));
430  }
#define MoFEMFunctionBeginHot
First executable line of each MoFEM function, used for error handling. Final line of MoFEM functions ...
Definition: definitions.h:499
#define MoFEMFunctionReturnHot(a)
Last executable line of each PETSc function used for error handling. Replaces return() ...
Definition: definitions.h:506
boost::shared_ptr< T > sFieldPtr

◆ get_E_DualBase()

template<typename T>
MoFEMErrorCode MoFEM::interface_Field< T >::get_E_DualBase ( const double  m[]) const

Definition at line 423 of file FieldMultiIndices.hpp.

423  {
425  MoFEMFunctionReturnHot(this->sFieldPtr->get_E_DualBase(m));
426  }
#define MoFEMFunctionBeginHot
First executable line of each MoFEM function, used for error handling. Final line of MoFEM functions ...
Definition: definitions.h:499
#define MoFEMFunctionReturnHot(a)
Last executable line of each PETSc function used for error handling. Replaces return() ...
Definition: definitions.h:506
boost::shared_ptr< T > sFieldPtr

◆ get_e_DualBase()

template<typename T>
MoFEMErrorCode MoFEM::interface_Field< T >::get_e_DualBase ( const double  m[]) const

Definition at line 432 of file FieldMultiIndices.hpp.

432  {
434  MoFEMFunctionReturnHot(this->sFieldPtr->get_e_DualBase(m));
435  }
#define MoFEMFunctionBeginHot
First executable line of each MoFEM function, used for error handling. Final line of MoFEM functions ...
Definition: definitions.h:499
#define MoFEMFunctionReturnHot(a)
Last executable line of each PETSc function used for error handling. Replaces return() ...
Definition: definitions.h:506
boost::shared_ptr< T > sFieldPtr

◆ getApproxBase()

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

Definition at line 467 of file FieldMultiIndices.hpp.

467  {
468  return this->sFieldPtr->getApproxBase();
469  }
boost::shared_ptr< T > sFieldPtr

◆ getBitNumber()

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

Definition at line 477 of file FieldMultiIndices.hpp.

477  {
478  return this->sFieldPtr->getBitNumber();
479  }
boost::shared_ptr< T > sFieldPtr

◆ getCoordSysDim()

template<typename T>
int MoFEM::interface_Field< T >::getCoordSysDim ( const int  d = 0) const

Get dimension of general two-point tensor MoFEM::CoordSys::getDim.

See details here MoFEM::CoordSys::getDim

Definition at line 415 of file FieldMultiIndices.hpp.

415  {
416  return this->sFieldPtr->getCoordSysDim(d);
417  }
boost::shared_ptr< T > sFieldPtr

◆ getCoordSysId()

template<typename T>
int MoFEM::interface_Field< T >::getCoordSysId ( ) const

Definition at line 406 of file FieldMultiIndices.hpp.

406 { return this->sFieldPtr->getCoordSysId(); }
boost::shared_ptr< T > sFieldPtr

◆ getCoordSysMeshSet()

template<typename T>
EntityHandle MoFEM::interface_Field< T >::getCoordSysMeshSet ( ) const
Returns
return meshset for coordinate system

Definition at line 438 of file FieldMultiIndices.hpp.

438  {
439  return this->sFieldPtr->getCoordSysMeshSet();
440  }
boost::shared_ptr< T > sFieldPtr

◆ getCoordSysName()

template<typename T>
std::string MoFEM::interface_Field< T >::getCoordSysName ( ) const
Returns
return coordinate system name for field

Definition at line 443 of file FieldMultiIndices.hpp.

443  {
444  return this->sFieldPtr->getCoordSysName();
445  }
boost::shared_ptr< T > sFieldPtr

◆ getCoordSysNameRef()

template<typename T>
boost::string_ref MoFEM::interface_Field< T >::getCoordSysNameRef ( ) const
Returns
return coordinate system name for field

Definition at line 448 of file FieldMultiIndices.hpp.

448  {
449  return this->sFieldPtr->getCoordSysNameRef();
450  }
boost::shared_ptr< T > sFieldPtr

◆ getDofOrderMap()

template<typename T>
std::vector<ApproximationOrder>& MoFEM::interface_Field< 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 493 of file FieldMultiIndices.hpp.

493  {
494  return this->sFieldPtr->getDofOrderMap(type);
495  }
boost::shared_ptr< T > sFieldPtr

◆ getFieldPtr()

template<typename T>
boost::shared_ptr<T>& MoFEM::interface_Field< T >::getFieldPtr ( ) const
Returns
get pointer to the field data structure

Definition at line 482 of file FieldMultiIndices.hpp.

482 { return this->sFieldPtr; }
boost::shared_ptr< T > sFieldPtr

◆ getId()

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

Definition at line 453 of file FieldMultiIndices.hpp.

453 { return this->sFieldPtr->getId(); }
boost::shared_ptr< T > sFieldPtr

◆ getMeshset()

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

Definition at line 402 of file FieldMultiIndices.hpp.

402  {
403  return this->sFieldPtr->getMeshset();
404  }
boost::shared_ptr< T > sFieldPtr

◆ getName()

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

Definition at line 461 of file FieldMultiIndices.hpp.

461 { return this->sFieldPtr->getName(); }
boost::shared_ptr< T > sFieldPtr

◆ getNameRef()

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

Definition at line 456 of file FieldMultiIndices.hpp.

456  {
457  return this->sFieldPtr->getNameRef();
458  }
boost::shared_ptr< T > sFieldPtr

◆ getNbOfCoeffs()

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

Definition at line 472 of file FieldMultiIndices.hpp.

472  {
473  return this->sFieldPtr->getNbOfCoeffs();
474  }
boost::shared_ptr< T > sFieldPtr

◆ getSpace()

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

Definition at line 464 of file FieldMultiIndices.hpp.

464 { return this->sFieldPtr->getSpace(); }
boost::shared_ptr< T > sFieldPtr

Member Data Documentation

◆ sFieldPtr

template<typename T>
boost::shared_ptr<T> MoFEM::interface_Field< T >::sFieldPtr
mutable

Definition at line 392 of file FieldMultiIndices.hpp.


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