chemmisol 0.1
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | List of all members
chemmisol::InvalidSpecies Class Reference

#include <system.h>

Inheritance diagram for chemmisol::InvalidSpecies:
Inheritance graph
[legend]
Collaboration diagram for chemmisol::InvalidSpecies:
Collaboration graph
[legend]

Public Member Functions

const ChemicalSystemgetChemicalSystem () const
 
const std::string & getName () const
 
Phase getPhase () const
 

Protected Member Functions

 InvalidSpecies (const ChemicalSystem *chemical_system, const std::string &name, Phase phase)
 

Detailed Description

Exception thrown when an invalid species is added to a chemical system.

Constructor & Destructor Documentation

◆ InvalidSpecies()

chemmisol::InvalidSpecies::InvalidSpecies ( const ChemicalSystem chemical_system,
const std::string &  name,
Phase  phase 
)
inlineprotected

Defines an InvalidSpecies exception.

Parameters
chemical_systemChemical system to which an invalid species was added.
nameName of the invalid species.
phasePhase of the invalid species.

Member Function Documentation

◆ getChemicalSystem()

const ChemicalSystem & chemmisol::InvalidSpecies::getChemicalSystem ( ) const
inline

Returns a reference to the system to which an invalid component was added.

◆ getName()

const std::string & chemmisol::InvalidSpecies::getName ( ) const
inline

Name of the invalid species.

◆ getPhase()

Phase chemmisol::InvalidSpecies::getPhase ( ) const
inline

Phase of the invalid species.


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