v0.8.4
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< T > sFieldPtr
 

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

355  : 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 357 of file FieldMultiIndices.hpp.

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

◆ ~interface_Field()

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

Definition at line 360 of file FieldMultiIndices.hpp.

360 {}

Member Function Documentation

◆ get_E_Base()

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

Definition at line 379 of file FieldMultiIndices.hpp.

379  {
381  MoFEMFunctionReturnHot(this->sFieldPtr->get_E_Base(m));
382  }
#define MoFEMFunctionBeginHot
First executable line of each MoFEM function, used for error handling. Final line of MoFEM functions ...
Definition: definitions.h:522
#define MoFEMFunctionReturnHot(a)
Last executable line of each PETSc function used for error handling. Replaces return() ...
Definition: definitions.h:528
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 387 of file FieldMultiIndices.hpp.

387  {
389  MoFEMFunctionReturnHot(this->sFieldPtr->get_e_Base(m));
390  }
#define MoFEMFunctionBeginHot
First executable line of each MoFEM function, used for error handling. Final line of MoFEM functions ...
Definition: definitions.h:522
#define MoFEMFunctionReturnHot(a)
Last executable line of each PETSc function used for error handling. Replaces return() ...
Definition: definitions.h:528
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 383 of file FieldMultiIndices.hpp.

383  {
385  MoFEMFunctionReturnHot(this->sFieldPtr->get_E_DualBase(m));
386  }
#define MoFEMFunctionBeginHot
First executable line of each MoFEM function, used for error handling. Final line of MoFEM functions ...
Definition: definitions.h:522
#define MoFEMFunctionReturnHot(a)
Last executable line of each PETSc function used for error handling. Replaces return() ...
Definition: definitions.h:528
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 392 of file FieldMultiIndices.hpp.

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

◆ getApproxBase()

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

Definition at line 427 of file FieldMultiIndices.hpp.

427  {
428  return this->sFieldPtr->getApproxBase();
429  }
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 437 of file FieldMultiIndices.hpp.

437  {
438  return this->sFieldPtr->getBitNumber();
439  }
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 375 of file FieldMultiIndices.hpp.

375  {
376  return this->sFieldPtr->getCoordSysDim(d);
377  }
boost::shared_ptr< T > sFieldPtr

◆ getCoordSysId()

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

Definition at line 366 of file FieldMultiIndices.hpp.

366 { 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 398 of file FieldMultiIndices.hpp.

398  {
399  return this->sFieldPtr->getCoordSysMeshSet();
400  }
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 403 of file FieldMultiIndices.hpp.

403  {
404  return this->sFieldPtr->getCoordSysName();
405  }
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 408 of file FieldMultiIndices.hpp.

408  {
409  return this->sFieldPtr->getCoordSysNameRef();
410  }
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 453 of file FieldMultiIndices.hpp.

453  {
454  return this->sFieldPtr->getDofOrderMap(type);
455  }
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 442 of file FieldMultiIndices.hpp.

442 { 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 413 of file FieldMultiIndices.hpp.

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

◆ getMeshset()

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

Definition at line 362 of file FieldMultiIndices.hpp.

362  {
363  return this->sFieldPtr->getMeshset();
364  }
boost::shared_ptr< T > sFieldPtr

◆ getName()

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

Definition at line 421 of file FieldMultiIndices.hpp.

421 { 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 416 of file FieldMultiIndices.hpp.

416  {
417  return this->sFieldPtr->getNameRef();
418  }
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 432 of file FieldMultiIndices.hpp.

432  {
433  return this->sFieldPtr->getNbOfCoeffs();
434  }
boost::shared_ptr< T > sFieldPtr

◆ getSpace()

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

Definition at line 424 of file FieldMultiIndices.hpp.

424 { 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 352 of file FieldMultiIndices.hpp.


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