DataHolderLib::BoundaryCondition Class Reference

Detailed Description

Definition at line 17 of file BoundaryCondition.h.

#include <BoundaryCondition.h>

Inheritance diagram for DataHolderLib::BoundaryCondition:

Collaboration diagram for DataHolderLib::BoundaryCondition:

Public Types
enum class	ConditionType { NONE , DIRICHLET , NEUMANN , ROBIN }

Public Member Functions
	BoundaryCondition (ProcessVariable const &process_var, std::string const &param_name, ConditionType type)
	Managing data associated with a boundary condition.
std::string const	getConditionClassStr () const override
	Returns the type of condition for displaying purposes.
ConditionType	getType () const
	Returns the type of boundary condition this is.
Public Member Functions inherited from DataHolderLib::FemCondition
	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.

Static Public Member Functions
static ConditionType	convertStringToType (std::string const &str)
	Converts the type enum into a string.
static std::string	convertTypeToString (ConditionType type)
	Converts a string specifying the type into an enum.

Private Attributes
ConditionType	_type

Member Enumeration Documentation

ConditionType

enum class DataHolderLib::BoundaryCondition::ConditionType

strong

Enumerator
NONE
DIRICHLET
NEUMANN
ROBIN

Definition at line 20 of file BoundaryCondition.h.

    {
        NONE,
        DIRICHLET,
        NEUMANN,
        ROBIN
    };

Constructor & Destructor Documentation

BoundaryCondition()

DataHolderLib::BoundaryCondition::BoundaryCondition	(	ProcessVariable const &	process_var,
		std::string const &	param_name,
		ConditionType	type )

Managing data associated with a boundary condition.

Definition at line 17 of file BoundaryCondition.cpp.

    : FemCondition(process_var, param_name), _type(type)
{
}

References DataHolderLib::FemCondition::FemCondition(), and _type.

Member Function Documentation

convertStringToType()

BoundaryCondition::ConditionType DataHolderLib::BoundaryCondition::convertStringToType ( std::string const & str )

static

Converts the type enum into a string.

Definition at line 24 of file BoundaryCondition.cpp.

{
    if (str == "Dirichlet")
    {
        return ConditionType::DIRICHLET;
    }
    if (str == "Neumann")
    {
        return ConditionType::NEUMANN;
    }
    if (str == "Robin")
    {
        return ConditionType::ROBIN;
    }
 
    return ConditionType::NONE;
}

References DIRICHLET, NEUMANN, NONE, and ROBIN.

convertTypeToString()

std::string DataHolderLib::BoundaryCondition::convertTypeToString ( ConditionType type )

static

Converts a string specifying the type into an enum.

Definition at line 43 of file BoundaryCondition.cpp.

{
    if (type == ConditionType::DIRICHLET)
    {
        return "Dirichlet";
    }
    if (type == ConditionType::NEUMANN)
    {
        return "Neumann";
    }
    if (type == ConditionType::ROBIN)
    {
        return "Robin";
    }
 
    return "";
}

References DIRICHLET, NEUMANN, and ROBIN.

Referenced by FemConditionModel::setFemCondition().

getConditionClassStr()

std::string const DataHolderLib::BoundaryCondition::getConditionClassStr ( ) const

inlineoverridevirtual

Returns the type of condition for displaying purposes.

Implements DataHolderLib::FemCondition.

Definition at line 31 of file BoundaryCondition.h.

    {
        return "Boundary Condition";
    }

getType()

ConditionType DataHolderLib::BoundaryCondition::getType ( ) const

inline

Returns the type of boundary condition this is.

Definition at line 37 of file BoundaryCondition.h.

{ return _type; }

References _type.

Member Data Documentation

_type

ConditionType DataHolderLib::BoundaryCondition::_type

private

Definition at line 46 of file BoundaryCondition.h.

Referenced by BoundaryCondition(), and getType().

---

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

• Applications/DataHolderLib/BoundaryCondition.h
• Applications/DataHolderLib/BoundaryCondition.cpp