DataHolderLib::FemCondition Class Reference

Detailed Description

Base class for boundary conditions, initial conditions and source terms.

Definition at line 39 of file FemCondition.h.

#include <FemCondition.h>

Inheritance diagram for DataHolderLib::FemCondition:

Collaboration diagram for DataHolderLib::FemCondition:

Public Member Functions
	FemCondition (ProcessVariable const &process_var, std::string const &param_name)
virtual	~FemCondition ()=default
std::string const	getProcessVarName () const
	Returns the name of the associated process variable.
ProcessVariable const &	getProcessVar () const
	Returns the numerical order of the process variable.
std::string const	getParamName () const
	Returns the name of the parameter associated with the condition.
BaseObjType	getBaseObjType () const
	Specifies if the condition is set a geometry or on a mesh.
std::string	getBaseObjName () const
	Returns the name of the base object (i.e. geometry or mesh)
std::string const	getObjName () const
	Returns the name of the geometric object.
void	setMesh (std::string const &mesh_name)
	Sets a mesh as corresponding object for the condition.
virtual void	setGeoObject (std::string const &geo_name, std::string const &obj_name)
	Sets a geometric object as corresponding object for the condition.
virtual std::string const	getConditionClassStr () const =0
	Returns the type of condition for displaying purposes.

Private Attributes
BaseObjType	_base_type
ProcessVariable	_process_var
std::string	_param_name
std::string	_base_obj_name
std::string	_obj_name

Constructor & Destructor Documentation

FemCondition()

DataHolderLib::FemCondition::FemCondition	(	ProcessVariable const &	process_var,
		std::string const &	param_name )

Definition at line 16 of file FemCondition.cpp.

    : _process_var(process_var), _param_name(param_name){};

~FemCondition()

virtual DataHolderLib::FemCondition::~FemCondition ( )

virtualdefault

Member Function Documentation

getBaseObjName()

std::string DataHolderLib::FemCondition::getBaseObjName ( ) const

inline

Returns the name of the base object (i.e. geometry or mesh)

Definition at line 59 of file FemCondition.h.

{ return _base_obj_name; }

References _base_obj_name.

Referenced by FemConditionModel::setFemCondition(), and FileIO::XmlPrjInterface::writeCondition().

getBaseObjType()

BaseObjType DataHolderLib::FemCondition::getBaseObjType ( ) const

inline

Specifies if the condition is set a geometry or on a mesh.

Definition at line 56 of file FemCondition.h.

{ return _base_type; }

References _base_type.

Referenced by FemConditionModel::setFemCondition(), and FileIO::XmlPrjInterface::writeCondition().

getConditionClassStr()

virtual std::string const DataHolderLib::FemCondition::getConditionClassStr ( ) const

pure virtual

Returns the type of condition for displaying purposes.

Implemented in DataHolderLib::BoundaryCondition, and DataHolderLib::SourceTerm.

Referenced by ProcessModel::addConditionItem(), and FemConditionModel::setFemCondition().

getObjName()

std::string const DataHolderLib::FemCondition::getObjName ( ) const

inline

Returns the name of the geometric object.

Definition at line 62 of file FemCondition.h.

{ return _obj_name; }

References _obj_name.

Referenced by FemConditionModel::setFemCondition(), and FileIO::XmlPrjInterface::writeCondition().

getParamName()

std::string const DataHolderLib::FemCondition::getParamName ( ) const

inline

Returns the name of the parameter associated with the condition.

Definition at line 53 of file FemCondition.h.

{ return _param_name; }

References _param_name.

Referenced by ProcessModel::addConditionItem(), ProcessModel::removeCondition(), FemConditionModel::setFemCondition(), and FileIO::XmlPrjInterface::writeCondition().

getProcessVar()

ProcessVariable const & DataHolderLib::FemCondition::getProcessVar ( ) const

inline

Returns the numerical order of the process variable.

Definition at line 50 of file FemCondition.h.

{ return _process_var; }

References _process_var.

Referenced by FemConditionModel::setProcessVariable().

getProcessVarName()

std::string const DataHolderLib::FemCondition::getProcessVarName ( ) const

inline

Returns the name of the associated process variable.

Definition at line 47 of file FemCondition.h.

{ return _process_var.name; }

References _process_var, and DataHolderLib::ProcessVariable::name.

Referenced by ProcessModel::addCondition(), and ProcessView::removeCondition().

setGeoObject()

void DataHolderLib::FemCondition::setGeoObject ( std::string const & geo_name, std::string const & obj_name )

virtual

Sets a geometric object as corresponding object for the condition.

Definition at line 27 of file FemCondition.cpp.

{
    _base_type = BaseObjType::GEOMETRY;
    _base_obj_name = geo_name;
    _obj_name = obj_name;
}

References _base_obj_name, _base_type, _obj_name, and DataHolderLib::GEOMETRY.

setMesh()

void DataHolderLib::FemCondition::setMesh

(

std::string const &

mesh_name

)

Sets a mesh as corresponding object for the condition.

Definition at line 20 of file FemCondition.cpp.

{
    _base_type = BaseObjType::MESH;
    _base_obj_name = mesh_name;
    _obj_name = "";
}

References _base_obj_name, _base_type, _obj_name, and DataHolderLib::MESH.

Member Data Documentation

_base_obj_name

std::string DataHolderLib::FemCondition::_base_obj_name

private

Definition at line 78 of file FemCondition.h.

Referenced by getBaseObjName(), setGeoObject(), and setMesh().

_base_type

BaseObjType DataHolderLib::FemCondition::_base_type

private

Definition at line 75 of file FemCondition.h.

Referenced by getBaseObjType(), setGeoObject(), and setMesh().

_obj_name

std::string DataHolderLib::FemCondition::_obj_name

private

Definition at line 79 of file FemCondition.h.

Referenced by getObjName(), setGeoObject(), and setMesh().

_param_name

std::string DataHolderLib::FemCondition::_param_name

private

Definition at line 77 of file FemCondition.h.

Referenced by getParamName().

_process_var

ProcessVariable DataHolderLib::FemCondition::_process_var

private

Definition at line 76 of file FemCondition.h.

Referenced by getProcessVar(), and getProcessVarName().

---

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

• Applications/DataHolderLib/FemCondition.h
• Applications/DataHolderLib/FemCondition.cpp