MaterialPropertyLib::Component Class Reference

Detailed Description

This class defines components (substances).

The Component class is a base class used for not further specified components. Components are specified by the property 'name'. For specified components we derive special classes from this class (for clarity they are located in the 'components' subfolder).

Definition at line 17 of file Component.h.

#include <Component.h>

Inheritance diagram for MaterialPropertyLib::Component:

Public Member Functions
	Component ()
	Component (std::string const &component_name, std::unique_ptr< PropertyArray > &&properties)
	Constructor for a custom component.
virtual	~Component ()=default
Property const &	property (PropertyType const &) const
	A get-function for retrieving a certain property.
Property const &	operator[] (PropertyType const &p) const
bool	hasProperty (PropertyType const &p) const
template<typename T>
T	value (PropertyType const p) const
template<typename T>
T	value (PropertyType const p, VariableArray const &variable_array) const
template<typename T>
T	dValue (PropertyType const p, VariableArray const &variable_array, Variable const variable) const
template<typename T>
T	d2Value (PropertyType const p, VariableArray const &variable_array, Variable const variable1, Variable const variable2) const
std::string	description () const
	Short description of the component with its name.

Public Attributes
std::string const	name

Protected Attributes
PropertyArray	properties_
	The property array of the component.

Constructor & Destructor Documentation

Component() [1/2]

MaterialPropertyLib::Component::Component

(

)

Default constructor of Component. This constructor is used when the component is not specified via the 'name'-tag.

Definition at line 12 of file Component.cpp.

{}

Referenced by MaterialPropertyLib::Water::Water().

Component() [2/2]

MaterialPropertyLib::Component::Component	(	std::string const &	component_name,
		std::unique_ptr< PropertyArray > &&	properties )

Constructor for a custom component.

Definition at line 14 of file Component.cpp.

    : name(component_name)
{
    if (properties)
    {
        overwriteExistingProperties(properties_, *properties, this);
    }
}

References name, MaterialPropertyLib::overwriteExistingProperties(), and properties_.

~Component()

virtual MaterialPropertyLib::Component::~Component ( )

virtualdefault

Member Function Documentation

d2Value()

template<typename T>

T MaterialPropertyLib::Component::d2Value ( PropertyType const p, VariableArray const & variable_array, Variable const variable1, Variable const variable2 ) const

inline

Definition at line 57 of file Component.h.

    {
        return property(p).template d2Value<T>(variable_array, variable1,
                                               variable2);
    }

References d2Value(), and property().

Referenced by d2Value().

description()

std::string MaterialPropertyLib::Component::description

(

)

const

Short description of the component with its name.

Definition at line 46 of file Component.cpp.

{
    return "component '" + name + "'";
}

References name.

Referenced by property().

dValue()

template<typename T>

T MaterialPropertyLib::Component::dValue ( PropertyType const p, VariableArray const & variable_array, Variable const variable ) const

inline

Definition at line 49 of file Component.h.

    {
        return property(p).template dValue<T>(variable_array, variable);
    }

References dValue(), and property().

Referenced by dValue().

hasProperty()

bool MaterialPropertyLib::Component::hasProperty

(

PropertyType const &

p

)

const

Definition at line 41 of file Component.cpp.

{
    return properties_[p] != nullptr;
}

References properties_.

operator[]()

Property const & MaterialPropertyLib::Component::operator[]

(

PropertyType const &

p

)

const

Definition at line 36 of file Component.cpp.

{
    return property(p);
}

References property().

property()

Property const & MaterialPropertyLib::Component::property

(

PropertyType const &

p

)

const

A get-function for retrieving a certain property.

Definition at line 24 of file Component.cpp.

{
    Property const* const property = properties_[p].get();
    if (property == nullptr)
    {
        OGS_FATAL("Trying to access undefined property '{:s}' of {:s}",
                  property_enum_to_string[p], description());
    }
 
    return *properties_[p];
}

References description(), OGS_FATAL, properties_, property(), and MaterialPropertyLib::property_enum_to_string.

Referenced by d2Value(), dValue(), operator[](), property(), value(), and value().

value() [1/2]

template<typename T>

T MaterialPropertyLib::Component::value ( PropertyType const p ) const

inline

Definition at line 37 of file Component.h.

    {
        return property(p).template value<T>();
    }

References property(), and value().

Referenced by value(), and value().

value() [2/2]

template<typename T>

T MaterialPropertyLib::Component::value ( PropertyType const p, VariableArray const & variable_array ) const

inline

Definition at line 43 of file Component.h.

    {
        return property(p).template value<T>(variable_array);
    }

References property(), and value().

Member Data Documentation

name

std::string const MaterialPropertyLib::Component::name

Definition at line 70 of file Component.h.

Referenced by Component(), and description().

properties_

PropertyArray MaterialPropertyLib::Component::properties_

protected

The property array of the component.

Definition at line 74 of file Component.h.

Referenced by Component(), hasProperty(), and property().

---

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

• Component.h
• Component.cpp