MoFEM::Field Struct Reference

Provide data structure for (tensor) field approximation.The Field is intended to provide support for fields, with a strong bias towards supporting first and best the capabilities required for scientific computing applications. Since we work with discrete spaces, data structure has to carry information about type of approximation space, its regularity. More...

#include <src/multi_indices/FieldMultiIndices.hpp>

Collaboration diagram for MoFEM::Field:

Public Types
typedef multi_index_container< boost::weak_ptr< std::vector< FieldEntity > >, indexed_by< sequenced<> > >	SequenceEntContainer
typedef multi_index_container< boost::weak_ptr< std::vector< DofEntity > >, indexed_by< sequenced<> > >	SequenceDofContainer

Public Member Functions
	Field (const Interface &moab, const EntityHandle meshset, const boost::shared_ptr< CoordSys > coord_sys_ptr)
	constructor for moab field More...
EntityHandle	getMeshset () const
	Get field meshset. More...
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
	Get reference base vectors. More...
MoFEMErrorCode	get_E_DualBase (const double m[]) const
	Get reference dual base vectors. More...
MoFEMErrorCode	get_e_Base (const double m[]) const
	Get current dual base vectors. More...
MoFEMErrorCode	get_e_DualBase (const double m[]) const
	Get current dual base vectors. More...
EntityHandle	getCoordSysMeshSet () const
	Returns meshset on which Tags defining coordinate system are stored. More...
std::string	getCoordSysName () const
	Get coordinate system name. More...
boost::string_ref	getCoordSysNameRef () const
	Get coordinate system name. More...
const BitFieldId &	getId () const
	Get unique field id. More...
boost::string_ref	getNameRef () const
	Get string reference to field name. More...
std::string	getName () const
	Get field name. More...
FieldSpace	getSpace () const
	Get field approximation space. More...
FieldApproximationBase	getApproxBase () const
	Get approximation base. More...
FieldCoefficientsNumber	getNbOfCoeffs () const
	Get number of field coefficients. More...
unsigned int	getBitNumber () const
	Get number of set bit in Field ID. Each field has uid, get getBitNumber get number of bit set for given field. Field ID has only one bit set for each field. More...
unsigned int	getBitNumberCalculate () const
	Calculate number of set bit in Field ID. Each field has uid, get getBitNumber get number of bit set for given field. Field ID has only one bit set for each field. More...
boost::shared_ptr< SequenceEntContainer > &	getEntSequenceContainer () const
	Get reference to sequence data container. More...
boost::shared_ptr< SequenceDofContainer > &	getDofSequenceContainer () const
	Get reference to sequence data container. More...
std::vector< ApproximationOrder > &	getDofOrderMap (const EntityType type) const
	get hash-map relating dof index on entity with its order More...

Public Attributes
moab::Interface &	moab
EntityHandle	meshSet
	keeps entities for this meshset More...
boost::shared_ptr< CoordSys >	coordSysPtr
	Pointer to field coordinate system data structure. More...
Tag	th_FieldData
	Tag storing field values on entity in the field. More...
Tag	th_AppOrder
	Tag storing approximation order on entity. More...
BitFieldId *	tagId
	tag keeps field id More...
FieldSpace *	tag_space_data
	tag keeps field space More...
FieldApproximationBase *	tag_base_data
FieldCoefficientsNumber *	tag_nb_coeff_data
const void *	tagName
	tag keeps name of the field More...
int	tagNameSize
	number of bits necessary to keep field name More...
const void *	tag_name_prefix_data
	tag keeps name prefix of the field More...
int	tag_name_prefix_size
FieldOrderTable	forder_table
	nb. DOFs table for entities More...
unsigned int	bit_number

Private Attributes
boost::shared_ptr< SequenceEntContainer >	sequenceEntContainer
boost::shared_ptr< SequenceDofContainer >	sequenceDofContainer
std::map< EntityType, std::vector< int > >	dofOrderMap

Friends
std::ostream &	operator<< (std::ostream &os, const Field &e)

Detailed Description

Provide data structure for (tensor) field approximation.

The Field is intended to provide support for fields, with a strong bias towards supporting first and best the capabilities required for scientific computing applications. Since we work with discrete spaces, data structure has to carry information about type of approximation space, its regularity.

Field data structure storing information about space, approximation base, coordinate systems, etc. It stores additional data needed for book keeping, like tags to data on the mesh.

Each filed has unique ID and name. This data structure is shared between entities on which is spanning and DOFs on those entities.

Definition at line 64 of file FieldMultiIndices.hpp.

Member Typedef Documentation

SequenceDofContainer

typedef multi_index_container<boost::weak_ptr<std::vector<DofEntity> >, indexed_by<sequenced<> > > MoFEM::Field::SequenceDofContainer

Definition at line 72 of file FieldMultiIndices.hpp.

SequenceEntContainer

typedef multi_index_container<boost::weak_ptr<std::vector<FieldEntity> >, indexed_by<sequenced<> > > MoFEM::Field::SequenceEntContainer

Definition at line 68 of file FieldMultiIndices.hpp.

Constructor & Destructor Documentation

Field()

MoFEM::Field::Field	(	const Interface &	moab,
		const EntityHandle	meshset,
		const boost::shared_ptr< CoordSys >	coord_sys_ptr
	)

constructor for moab field

Parameters

meshset

which keeps entities for this field

Definition at line 48 of file CoreDataStructures.cpp.

    : moab(const_cast<Interface &>(moab)), meshSet(meshset),
      coordSysPtr(coord_sys_ptr), tagId(NULL), tag_space_data(NULL),
      tag_nb_coeff_data(NULL), tagName(NULL), tagNameSize(0),
      sequenceEntContainer(boost::make_shared<SequenceEntContainer>()),
      sequenceDofContainer(boost::make_shared<SequenceDofContainer>()) {
  // Change those tags only by modifiers
  ErrorCode rval;
  // id
  Tag th_field_id;
  rval = moab.tag_get_handle("_FieldId", th_field_id);
  MOAB_THROW(rval);
  rval = moab.tag_get_by_ptr(th_field_id, &meshSet, 1, (const void **)&tagId);
  MOAB_THROW(rval);
  // space
  Tag th_field_space;
  rval = moab.tag_get_handle("_FieldSpace", th_field_space);
  MOAB_THROW(rval);
  rval = moab.tag_get_by_ptr(th_field_space, &meshSet, 1,
                             (const void **)&tag_space_data);
  MOAB_THROW(rval);
  // approx. base
  Tag th_field_base;
  rval = moab.tag_get_handle("_FieldBase", th_field_base);
  MOAB_THROW(rval);
  rval = moab.tag_get_by_ptr(th_field_base, &meshSet, 1,
                             (const void **)&tag_base_data);
  MOAB_THROW(rval);
  // name
  Tag th_field_name;
  rval = moab.tag_get_handle("_FieldName", th_field_name);
  MOAB_THROW(rval);
  rval = moab.tag_get_by_ptr(th_field_name, &meshSet, 1,
                             (const void **)&tagName, &tagNameSize);
  MOAB_THROW(rval);
  // name prefix
  Tag th_field_name_data_name_prefix;
  rval = moab.tag_get_handle("_FieldName_DataNamePrefix",
                             th_field_name_data_name_prefix);
  MOAB_THROW(rval);
  rval = moab.tag_get_by_ptr(th_field_name_data_name_prefix, &meshSet, 1,
                             (const void **)&tag_name_prefix_data,
                             &tag_name_prefix_size);
  MOAB_THROW(rval);
  std::string name_data_prefix((char *)tag_name_prefix_data,
                               tag_name_prefix_size);
  // data
  std::string tag_data_name = name_data_prefix + getName();
  rval = moab.tag_get_handle(tag_data_name.c_str(), th_FieldData);
  MOAB_THROW(rval);
  // order
  std::string tag_approximation_order_name = "_App_Order_" + getName();
  rval = moab.tag_get_handle(tag_approximation_order_name.c_str(), th_AppOrder);
  MOAB_THROW(rval);
  // rank
  Tag th_rank;
  std::string Tag_rank_name = "_Field_Rank_" + getName();
  rval = moab.tag_get_handle(Tag_rank_name.c_str(), th_rank);
  MOAB_THROW(rval);
  rval = moab.tag_get_by_ptr(th_rank, &meshSet, 1,
                             (const void **)&tag_nb_coeff_data);
  MOAB_THROW(rval);
  bit_number = getBitNumberCalculate();
  for (int tt = 0; tt < MBMAXTYPE; tt++) {
    forder_table[tt] = NULL;
  }
  switch (*tag_base_data) {
  case AINSWORTH_LEGENDRE_BASE:
  case AINSWORTH_LOBATTO_BASE:
    switch (*tag_space_data) {
    case H1:
      forder_table[MBVERTEX] = fNBVERTEX_H1;
      forder_table[MBEDGE] = fNBEDGE_H1;
      forder_table[MBTRI] = fNBFACETRI_H1;
      forder_table[MBQUAD] = fNBFACEQUAD_H1;
      forder_table[MBTET] = fNBVOLUMETET_H1;
      forder_table[MBPRISM] = fNBVOLUMEPRISM_H1;
      break;
    case HCURL:
      forder_table[MBVERTEX] = fNBVERTEX_HCURL;
      forder_table[MBEDGE] = fNBEDGE_AINSWORTH_HCURL;
      forder_table[MBTRI] = fNBFACETRI_AINSWORTH_HCURL;
      forder_table[MBTET] = fNBVOLUMETET_AINSWORTH_HCURL;
      break;
    case HDIV:
      forder_table[MBVERTEX] = fNBVERTEX_HDIV;
      forder_table[MBEDGE] = fNBEDGE_HDIV;
      forder_table[MBTRI] = fNBFACETRI_AINSWORTH_HDIV;
      forder_table[MBTET] = fNBVOLUMETET_AINSWORTH_HDIV;
      break;
    case L2:
      forder_table[MBVERTEX] = fNBVERTEX_L2;
      forder_table[MBEDGE] = fNBEDGE_L2;
      forder_table[MBTRI] = fNBFACETRI_L2;
      forder_table[MBTET] = fNBVOLUMETET_L2;
      break;
    case NOFIELD:
      for (EntityType t = MBVERTEX; t < MBMAXTYPE; t++) {
        // Concept of approximation order make no sense if there is no field
        forder_table[t] = fNBENTITYSET_NOFIELD;
      }
      break;
    default:
      THROW_MESSAGE("unknown approximation space");
    }
    break;
  case DEMKOWICZ_JACOBI_BASE:
    switch (*tag_space_data) {
    case HCURL:
      forder_table[MBVERTEX] = fNBVERTEX_HCURL;
      forder_table[MBEDGE] = fNBEDGE_DEMKOWICZ_HCURL;
      forder_table[MBTRI] = fNBFACETRI_DEMKOWICZ_HCURL;
      forder_table[MBTET] = fNBVOLUMETET_DEMKOWICZ_HCURL;
      break;
    case HDIV:
      forder_table[MBVERTEX] = fNBVERTEX_HDIV;
      forder_table[MBEDGE] = fNBEDGE_HDIV;
      forder_table[MBTRI] = fNBFACETRI_DEMKOWICZ_HDIV;
      forder_table[MBTET] = fNBVOLUMETET_DEMKOWICZ_HDIV;
      break;
    default:
      THROW_MESSAGE("unknown approximation space or not yet implemented");
    }
    break;
  case AINSWORTH_BERNSTEIN_BEZIER_BASE:
    THROW_MESSAGE("AINSWORTH_BERNSTEIN_BEZIER_BASE not implemented yer")
    break;
  case USER_BASE:
    for (int ee = 0; ee < MBMAXTYPE; ee++) {
      forder_table[ee] = fNBENTITY_GENERIC;
    }
    break;
  default:
    if (*tag_space_data != NOFIELD) {
      THROW_MESSAGE("unknown approximation base");
    } else {
      for (EntityType t = MBVERTEX; t < MBMAXTYPE; t++) {
        forder_table[t] = fNBENTITYSET_NOFIELD;
      }
    }
  }
  // // Set DOFs orders on entities
  // for(EntityType ee = MBVERTEX;ee!=MBMAXTYPE;ee++) {
  //   getDofOrderMap(ee).resize(MAX_DOFS_ON_ENTITY,-1);
  // }
}

Member Function Documentation

get_E_Base()

MoFEMErrorCode MoFEM::Field::get_E_Base

(

const double

m[]

)

const

Get reference base vectors.

Parameters

Array

where coefficients (covariant) are returned

Returns

Error code

Definition at line 142 of file FieldMultiIndices.hpp.

                                                           {
    MoFEMFunctionBeginHot;
    MoFEMFunctionReturnHot(coordSysPtr->get_E_Base(m));
  }

get_e_Base()

MoFEMErrorCode MoFEM::Field::get_e_Base

(

const double

m[]

)

const

Get current dual base vectors.

Parameters

Array

where coefficients (covariant) are returned

Returns

Error code

Definition at line 162 of file FieldMultiIndices.hpp.

                                                           {
    MoFEMFunctionBeginHot;
    MoFEMFunctionReturnHot(coordSysPtr->get_e_Base(m));
  }

get_E_DualBase()

MoFEMErrorCode MoFEM::Field::get_E_DualBase

(

const double

m[]

)

const

Get reference dual base vectors.

Parameters

Array

where coefficients (contravariant) are returned

Returns

Error code

Definition at line 152 of file FieldMultiIndices.hpp.

                                                               {
    MoFEMFunctionBeginHot;
    MoFEMFunctionReturnHot(coordSysPtr->get_E_DualBase(m));
  }

get_e_DualBase()

MoFEMErrorCode MoFEM::Field::get_e_DualBase

(

const double

m[]

)

const

Get current dual base vectors.

Parameters

Array

where coefficients (covariant) are returned

Returns

Error code

Definition at line 172 of file FieldMultiIndices.hpp.

                                                               {
    MoFEMFunctionBeginHot;
    MoFEMFunctionReturnHot(coordSysPtr->get_e_DualBase(m));
  }

getApproxBase()

FieldApproximationBase MoFEM::Field::getApproxBase

(

)

const

Get approximation base.

Returns

Approximation base

Definition at line 231 of file FieldMultiIndices.hpp.

{ return *tag_base_data; }

getBitNumber()

unsigned int MoFEM::Field::getBitNumber

(

)

const

Get number of set bit in Field ID. Each field has uid, get getBitNumber get number of bit set for given field. Field ID has only one bit set for each field.

Definition at line 256 of file FieldMultiIndices.hpp.

{ return bit_number; }

getBitNumberCalculate()

unsigned int MoFEM::Field::getBitNumberCalculate

(

)

const

Calculate number of set bit in Field ID. Each field has uid, get getBitNumber get number of bit set for given field. Field ID has only one bit set for each field.

Definition at line 263 of file FieldMultiIndices.hpp.

                                                    {
    int b = ffsl(((BitFieldId *)tagId)->to_ulong());
    if (b != 0)
      return b;
    for (int ll = 1; ll < BITFIELDID_SIZE / 32; ll++) {
      BitFieldId id;
      id = (*tagId) >> ll * 32;
      b = ll * 32 + ffsl(id.to_ulong());
      if (b != 0)
        return b;
    }
    return 0;
  }

getCoordSysDim()

int MoFEM::Field::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 133 of file FieldMultiIndices.hpp.

                                                   {
    return coordSysPtr->getDim(d);
  }

getCoordSysMeshSet()

EntityHandle MoFEM::Field::getCoordSysMeshSet

(

)

const

Returns meshset on which Tags defining coordinate system are stored.

Returns

Coordinate system EntityHandle

Definition at line 181 of file FieldMultiIndices.hpp.

                                                 {
    return coordSysPtr->getMeshset();
  }

getCoordSysName()

std::string MoFEM::Field::getCoordSysName

(

)

const

Get coordinate system name.

Returns

Coordinate system name

Definition at line 189 of file FieldMultiIndices.hpp.

{ return coordSysPtr->getName(); }

getCoordSysNameRef()

boost::string_ref MoFEM::Field::getCoordSysNameRef

(

)

const

Get coordinate system name.

Returns

Return string_ref with name.

Definition at line 195 of file FieldMultiIndices.hpp.

                                                    {
    return coordSysPtr->getNameRef();
  }

getDofOrderMap()

std::vector<ApproximationOrder>& MoFEM::Field::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 330 of file FieldMultiIndices.hpp.

                                              {
    return dofOrderMap[type];
  }

getDofSequenceContainer()

boost::shared_ptr<SequenceDofContainer>& MoFEM::Field::getDofSequenceContainer

(

)

const

Get reference to sequence data container.

In sequence data container data are physically stored. The purpose of this is to allocate DofEntity data in bulk, having only one allocation instead each time entity is inserted. That makes code efficient.

The vector in sequence is destroyed if last entity inside that vector is destroyed. All MoFEM::MoFEMEntities have aliased shared_ptr which points to the vector.

Not all DOFs are starred in this way, currently such cases are considered;

• DOFs on vertices. That is exploited that for H1 space, there is some fixed number of DOFs on each vertex

For other cases, DOFs are stored locally in each MoFEM::MoFEMEntities.

Returns

MoFEM::Field::SequenceDofContainer

Definition at line 317 of file FieldMultiIndices.hpp.

                                  {
    return sequenceDofContainer;
  }

getEntSequenceContainer()

boost::shared_ptr<SequenceEntContainer>& MoFEM::Field::getEntSequenceContainer

(

)

const

Get reference to sequence data container.

In sequence data container data are physically stored. The purpose of this is to allocate MoFEMEntities data in bulk, having only one allocation instead each time entity is inserted. That makes code efficient.

The vector in sequence is destroyed if last entity inside that vector is destroyed. All MoFEM::MoFEMEntities have aliased shared_ptr which points to the vector.

Returns

MoFEM::Field::SequenceEntContainer

Definition at line 293 of file FieldMultiIndices.hpp.

                                  {
    return sequenceEntContainer;
  }

getId()

const BitFieldId& MoFEM::Field::getId

(

)

const

Get unique field id.

Returns

Filed ID

Definition at line 203 of file FieldMultiIndices.hpp.

{ return *((BitFieldId *)tagId); }

getMeshset()

EntityHandle MoFEM::Field::getMeshset

(

)

const

Get field meshset.

To meshsets entity are attached Tags which keeps basic information about field. Those information is field name, approximation base, approximation space, id, etc.

In meshset contains entities on which given filed is sparing. Type of entities depended on approximations space.

Returns

EntityHandle

Definition at line 124 of file FieldMultiIndices.hpp.

{ return meshSet; }

getName()

std::string MoFEM::Field::getName

(

)

const

Get field name.

Returns

Field name

Definition at line 217 of file FieldMultiIndices.hpp.

                                   {
    return std::string((char *)tagName, tagNameSize);
  }

getNameRef()

boost::string_ref MoFEM::Field::getNameRef

(

)

const

Get string reference to field name.

Returns

Field name

Definition at line 209 of file FieldMultiIndices.hpp.

                                            {
    return boost::string_ref((char *)tagName, tagNameSize);
  }

getNbOfCoeffs()

FieldCoefficientsNumber MoFEM::Field::getNbOfCoeffs

(

)

const

Get number of field coefficients.

Scalar field has only one coefficient, vector field in 3D has three. In general number determine space needed to keep data on entities. What coefficient means depend on interpretation and associated coordinate system. For example 3 coefficient means could be covariant or contravariant, or mean three temperatures for mixture of solid, air and water, etc.

Definition at line 247 of file FieldMultiIndices.hpp.

                                                       {
    return *tag_nb_coeff_data;
  };

getSpace()

FieldSpace MoFEM::Field::getSpace

(

)

const

Get field approximation space.

Returns

approximation space

Definition at line 225 of file FieldMultiIndices.hpp.

{ return *tag_space_data; }

Friends And Related Function Documentation

operator<<

std::ostream& operator<< ( std::ostream &  os, const Field &  e  )

friend

Definition at line 196 of file CoreDataStructures.cpp.

                                                       {
  os << "name " << e.getNameRef() << " BitFieldId " << e.getId().to_ulong()
     << " bit number " << e.getBitNumber() << " space "
     << FieldSpaceNames[e.getSpace()] << " approximation base "
     << ApproximationBaseNames[e.getApproxBase()] << " rank "
     << e.getNbOfCoeffs() << " meshset " << e.meshSet;
  return os;
}

Member Data Documentation

bit_number

unsigned int MoFEM::Field::bit_number

Field Id is bit set. Each field has only one bit on, bit_number stores number of set bit

Definition at line 100 of file FieldMultiIndices.hpp.

coordSysPtr

boost::shared_ptr<CoordSys> MoFEM::Field::coordSysPtr

Pointer to field coordinate system data structure.

Definition at line 78 of file FieldMultiIndices.hpp.

dofOrderMap

std::map<EntityType, std::vector<int> > MoFEM::Field::dofOrderMap

mutableprivate

Definition at line 338 of file FieldMultiIndices.hpp.

forder_table

FieldOrderTable MoFEM::Field::forder_table

nb. DOFs table for entities

Definition at line 94 of file FieldMultiIndices.hpp.

meshSet

EntityHandle MoFEM::Field::meshSet

keeps entities for this meshset

Definition at line 76 of file FieldMultiIndices.hpp.

moab

moab::Interface& MoFEM::Field::moab

Definition at line 74 of file FieldMultiIndices.hpp.

sequenceDofContainer

boost::shared_ptr<SequenceDofContainer> MoFEM::Field::sequenceDofContainer

mutableprivate

Definition at line 336 of file FieldMultiIndices.hpp.

sequenceEntContainer

boost::shared_ptr<SequenceEntContainer> MoFEM::Field::sequenceEntContainer

mutableprivate

Definition at line 335 of file FieldMultiIndices.hpp.

tag_base_data

FieldApproximationBase* MoFEM::Field::tag_base_data

tag keeps field spacea

Definition at line 85 of file FieldMultiIndices.hpp.

tag_name_prefix_data

const void* MoFEM::Field::tag_name_prefix_data

tag keeps name prefix of the field

Definition at line 91 of file FieldMultiIndices.hpp.

tag_name_prefix_size

int MoFEM::Field::tag_name_prefix_size

number of bits necessary to keep field name prefix

Definition at line 92 of file FieldMultiIndices.hpp.

tag_nb_coeff_data

FieldCoefficientsNumber* MoFEM::Field::tag_nb_coeff_data

tag keeps field rank (dimension, f.e. Temperature field has rank 1, displacements field in 3d has rank 3)

Definition at line 88 of file FieldMultiIndices.hpp.

tag_space_data

FieldSpace* MoFEM::Field::tag_space_data

tag keeps field space

Definition at line 84 of file FieldMultiIndices.hpp.

tagId

BitFieldId* MoFEM::Field::tagId

tag keeps field id

Definition at line 83 of file FieldMultiIndices.hpp.

tagName

const void* MoFEM::Field::tagName

tag keeps name of the field

Definition at line 89 of file FieldMultiIndices.hpp.

tagNameSize

int MoFEM::Field::tagNameSize

number of bits necessary to keep field name

Definition at line 90 of file FieldMultiIndices.hpp.

th_AppOrder

Tag MoFEM::Field::th_AppOrder

Tag storing approximation order on entity.

Definition at line 81 of file FieldMultiIndices.hpp.

th_FieldData

Tag MoFEM::Field::th_FieldData

Tag storing field values on entity in the field.

Definition at line 80 of file FieldMultiIndices.hpp.

---

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

• src/multi_indices/FieldMultiIndices.hpp
• src/multi_indices/impl/CoreDataStructures.cpp