belfem::mesh::Field Class Reference

#include <cl_Mesh_Field.hpp>

Collaboration diagram for belfem::mesh::Field:

Public Member Functions
	Field (Mesh &aParent, const string &aLabel, const index_t &aIndex, const id_t &aID, const EntityType aEntityType=EntityType::NODE, const FieldType aFieldType=FieldType::SCALAR)
virtual	~Field ()=default
const string &	label () const
const EntityType &	entity_type ()
const FieldType &	field_type ()
Vector< real > &	data ()
const id_t &	id () const
real &	value (const index_t aIndex)
const index_t &	index () const
	returns the index of the field on the mesh
void	fill (const id_t aID, const real aValue)
	reset a field based on a sideset or block id
void	fill (const Vector< id_t > &aIDs, const real aValue)
	reset a field based on a sideset or block ids
bool	write_field_to_file () const
void	set_write_to_file_flag (const bool aFlag)
size_t	memory () const

Protected Attributes
Mesh &	mParent
string	mLabel
const index_t	mIndex
const id_t	mID
const EntityType	mEntityType
const FieldType	mFieldType
Vector< real >	mData
bool	mWriteToFile = true

Constructor & Destructor Documentation

Field()

belfem::mesh::Field::Field	(	Mesh &	aParent,
		const string &	aLabel,
		const index_t &	aIndex,
		const id_t &	aID,
		const EntityType	aEntityType = EntityType::NODE,
		const FieldType	aFieldType = FieldType::SCALAR )

~Field()

virtual belfem::mesh::Field::~Field ( )

virtualdefault

Member Function Documentation

data()

Vector< real > & belfem::mesh::Field::data

(

)

entity_type()

const EntityType & belfem::mesh::Field::entity_type

(

)

field_type()

const FieldType & belfem::mesh::Field::field_type

(

)

fill() [1/2]

void belfem::mesh::Field::fill	(	const id_t	aID,
		const real	aValue )

reset a field based on a sideset or block id

fill() [2/2]

void belfem::mesh::Field::fill	(	const Vector< id_t > &	aIDs,
		const real	aValue )

reset a field based on a sideset or block ids

id()

const id_t & belfem::mesh::Field::id

(

)

const

index()

const index_t & belfem::mesh::Field::index ( ) const

inline

returns the index of the field on the mesh

Returns

label()

const string & belfem::mesh::Field::label

(

)

const

memory()

size_t belfem::mesh::Field::memory ( ) const

inline

set_write_to_file_flag()

void belfem::mesh::Field::set_write_to_file_flag ( const bool aFlag )

inline

value()

real & belfem::mesh::Field::value ( const index_t aIndex )

inline

write_field_to_file()

bool belfem::mesh::Field::write_field_to_file ( ) const

inline

Member Data Documentation

mData

Vector< real > belfem::mesh::Field::mData

protected

mEntityType

const EntityType belfem::mesh::Field::mEntityType

protected

mFieldType

const FieldType belfem::mesh::Field::mFieldType

protected

mID

const id_t belfem::mesh::Field::mID

protected

mIndex

const index_t belfem::mesh::Field::mIndex

protected

mLabel

string belfem::mesh::Field::mLabel

protected

mParent

Mesh& belfem::mesh::Field::mParent

protected

mWriteToFile

bool belfem::mesh::Field::mWriteToFile = true

protected

---

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

• src/mesh/cl_Mesh_Field.hpp
• src/mesh/cl_Mesh_Field.cpp