Flow123d  master-f44eb46
Public Member Functions | Static Public Member Functions | Protected Attributes | Friends | List of all members
Substance Class Reference

#include <substance.hh>

Collaboration diagram for Substance:
Collaboration graph
[legend]

Public Member Functions

 Substance ()
 Default constructor. More...
 
 Substance (const Input::Record &in_rec)
 Initialization from input tree. More...
 
std::string name () const
 Getter for substance name. More...
 
double molar_mass () const
 Getter for molar mass. More...
 

Static Public Member Functions

static const Input::Type::Recordget_input_type ()
 Input type for a substance. More...
 

Protected Attributes

std::string name_
 Name of a chemical substance. More...
 
double molar_mass_
 Molar mass [kg/mol] of the substance. More...
 

Friends

class SubstanceList
 

Detailed Description

Class Substance is a storage for data which are specific for a (chemical) substance. The purpose is to easily share them among equations (e.g. between transport and reactions).

Definition at line 32 of file substance.hh.

Constructor & Destructor Documentation

◆ Substance() [1/2]

Substance::Substance ( )

Default constructor.

Definition at line 40 of file substance.cc.

◆ Substance() [2/2]

Substance::Substance ( const Input::Record in_rec)

Initialization from input tree.

Definition at line 46 of file substance.cc.

Member Function Documentation

◆ get_input_type()

const Record & Substance::get_input_type ( )
static

Input type for a substance.

Definition at line 29 of file substance.cc.

Here is the caller graph for this function:

◆ molar_mass()

double Substance::molar_mass ( ) const
inline

Getter for molar mass.

Definition at line 46 of file substance.hh.

◆ name()

std::string Substance::name ( ) const
inline

Getter for substance name.

Definition at line 43 of file substance.hh.

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ SubstanceList

friend class SubstanceList
friend

Definition at line 60 of file substance.hh.

Member Data Documentation

◆ molar_mass_

double Substance::molar_mass_
protected

Molar mass [kg/mol] of the substance.

Definition at line 58 of file substance.hh.

◆ name_

std::string Substance::name_
protected

Name of a chemical substance.

Definition at line 55 of file substance.hh.


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