OGS
MaterialPropertyLib::Water Struct Referencefinal

Detailed Description

A class for Water derived from Component.

This class can holds material constants and default properties of ordinary water.

Definition at line 22 of file Water.h.

#include <Water.h>

Inheritance diagram for MaterialPropertyLib::Water:
[legend]
Collaboration diagram for MaterialPropertyLib::Water:
[legend]

Public Member Functions

 Water (std::unique_ptr< PropertyArray > &&properties)
 
- Public Member Functions inherited from MaterialPropertyLib::Component
 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 >
value (PropertyType const p) const
 
template<typename T >
value (PropertyType const p, VariableArray const &variable_array) const
 
template<typename T >
dValue (PropertyType const p, VariableArray const &variable_array, Variable const variable) const
 
template<typename 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.
 

Additional Inherited Members

- Public Attributes inherited from MaterialPropertyLib::Component
std::string const name
 
- Protected Attributes inherited from MaterialPropertyLib::Component
PropertyArray properties_
 The property array of the component.
 

Constructor & Destructor Documentation

◆ Water()

MaterialPropertyLib::Water::Water ( std::unique_ptr< PropertyArray > && properties)
explicit

Definition at line 19 of file Water.cpp.

20 : Component{"Water", std::move(properties)}
21{
22}

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