v0.14.0
Public Member Functions | Public Attributes | List of all members
MoFEM::GenericCubitBcData Struct Referenceabstract

Generic bc data structure. More...

#include <src/multi_indices/BCData.hpp>

Inheritance diagram for MoFEM::GenericCubitBcData:
[legend]
Collaboration diagram for MoFEM::GenericCubitBcData:
[legend]

Public Member Functions

virtual MoFEMErrorCode fill_data (const std::vector< char > &bc_data)
 get data from structure More...
 
virtual MoFEMErrorCode set_data (void *tag_ptr, unsigned int size) const
 set data on structure More...
 
virtual std::size_t getSizeOfData () const =0
 get data structure size More...
 
virtual const void * getDataPtr () const =0
 get pointer to data structure More...
 
virtual const CubitBCTypegetType () const
 get data type More...
 
 GenericCubitBcData (const CubitBCType type)
 
virtual ~GenericCubitBcData ()
 

Public Attributes

const CubitBCType tYpe
 Type of boundary condition. More...
 

Detailed Description

Generic bc data structure.

Definition at line 20 of file BCData.hpp.

Constructor & Destructor Documentation

◆ GenericCubitBcData()

MoFEM::GenericCubitBcData::GenericCubitBcData ( const CubitBCType  type)
inline

Definition at line 67 of file BCData.hpp.

67 : tYpe(type) {}

◆ ~GenericCubitBcData()

virtual MoFEM::GenericCubitBcData::~GenericCubitBcData ( )
inlinevirtual

Definition at line 69 of file BCData.hpp.

69 {}

Member Function Documentation

◆ fill_data()

virtual MoFEMErrorCode MoFEM::GenericCubitBcData::fill_data ( const std::vector< char > &  bc_data)
inlinevirtual

get data from structure

Parameters
attributesvector of doubles
Returns
error code

Reimplemented in MoFEM::CfgCubitBcData, MoFEM::HeatFluxCubitBcData, MoFEM::PressureCubitBcData, MoFEM::TemperatureCubitBcData, MoFEM::AccelerationCubitBcData, MoFEM::VelocityCubitBcData, MoFEM::ForceCubitBcData, and MoFEM::DisplacementCubitBcData.

Definition at line 27 of file BCData.hpp.

27  {
29  SETERRQ(PETSC_COMM_SELF, MOFEM_DATA_INCONSISTENCY,
30  "It makes no sense for the generic bc type");
32  }

◆ getDataPtr()

virtual const void* MoFEM::GenericCubitBcData::getDataPtr ( ) const
pure virtual

◆ getSizeOfData()

virtual std::size_t MoFEM::GenericCubitBcData::getSizeOfData ( ) const
pure virtual

◆ getType()

virtual const CubitBCType& MoFEM::GenericCubitBcData::getType ( ) const
inlinevirtual

get data type

Returns
data type, see CubitBC

Definition at line 65 of file BCData.hpp.

65 { return tYpe; }

◆ set_data()

virtual MoFEMErrorCode MoFEM::GenericCubitBcData::set_data ( void *  tag_ptr,
unsigned int  size 
) const
inlinevirtual

set data on structure

Parameters
tag_ptrpointer to tag on meshset
sizesize of data in bytes
Returns
error code

Reimplemented in MoFEM::CfgCubitBcData, MoFEM::HeatFluxCubitBcData, MoFEM::PressureCubitBcData, MoFEM::TemperatureCubitBcData, MoFEM::AccelerationCubitBcData, MoFEM::VelocityCubitBcData, MoFEM::ForceCubitBcData, and MoFEM::DisplacementCubitBcData.

Definition at line 40 of file BCData.hpp.

40  {
42  SETERRQ(PETSC_COMM_SELF, MOFEM_ATOM_TEST_INVALID,
43  "It makes no sense for the generic bc type");
45  }

Member Data Documentation

◆ tYpe

const CubitBCType MoFEM::GenericCubitBcData::tYpe

Type of boundary condition.

Definition at line 59 of file BCData.hpp.


The documentation for this struct was generated from the following file:
MoFEMFunctionReturnHot
#define MoFEMFunctionReturnHot(a)
Last executable line of each PETSc function used for error handling. Replaces return()
Definition: definitions.h:447
MoFEM::GenericCubitBcData::tYpe
const CubitBCType tYpe
Type of boundary condition.
Definition: BCData.hpp:59
convert.type
type
Definition: convert.py:64
MOFEM_DATA_INCONSISTENCY
@ MOFEM_DATA_INCONSISTENCY
Definition: definitions.h:31
MOFEM_ATOM_TEST_INVALID
@ MOFEM_ATOM_TEST_INVALID
Definition: definitions.h:40
MoFEMFunctionBeginHot
#define MoFEMFunctionBeginHot
First executable line of each MoFEM function, used for error handling. Final line of MoFEM functions ...
Definition: definitions.h:440