Cantera  2.5.1
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
Solution Class Reference

A container class holding managers for all pieces defining a phase. More...

#include <Solution.h>

Inherits enable_shared_from_this< Solution >.

Public Member Functions

 Solution (const Solution &)=delete
 
Solutionoperator= (const Solution &)=delete
 
std::string name () const
 Return the name of this Solution object. More...
 
void setName (const std::string &name)
 Set the name of this Solution object. More...
 
void setThermo (shared_ptr< ThermoPhase > thermo)
 Set the ThermoPhase object. More...
 
void setKinetics (shared_ptr< Kinetics > kinetics)
 Set the Kinetics object. More...
 
void setTransport (shared_ptr< Transport > transport)
 Set the Transport object. More...
 
shared_ptr< ThermoPhasethermo ()
 Accessor for the ThermoPhase pointer. More...
 
shared_ptr< Kineticskinetics ()
 Accessor for the Kinetics pointer. More...
 
shared_ptr< Transporttransport ()
 Accessor for the Transport pointer. More...
 

Static Public Member Functions

static shared_ptr< Solutioncreate ()
 Create an empty Solution object. More...
 

Protected Attributes

shared_ptr< ThermoPhasem_thermo
 ThermoPhase manager. More...
 
shared_ptr< Kineticsm_kinetics
 Kinetics manager. More...
 
shared_ptr< Transportm_transport
 Transport manager. More...
 

Detailed Description

A container class holding managers for all pieces defining a phase.

Definition at line 19 of file Solution.h.

Member Function Documentation

◆ create()

static shared_ptr<Solution> create ( )
inlinestatic

Create an empty Solution object.

Definition at line 30 of file Solution.h.

Referenced by Cantera::newSolution().

◆ name()

std::string name ( ) const

Return the name of this Solution object.

Definition at line 22 of file Solution.cpp.

References Solution::m_thermo.

Referenced by Solution::setName().

◆ setName()

void setName ( const std::string &  name)

Set the name of this Solution object.

Definition at line 31 of file Solution.cpp.

References Solution::m_thermo, and Solution::name().

◆ setThermo()

void setThermo ( shared_ptr< ThermoPhase thermo)

Set the ThermoPhase object.

Definition at line 40 of file Solution.cpp.

References Solution::m_thermo, and Solution::thermo().

◆ setKinetics()

void setKinetics ( shared_ptr< Kinetics kinetics)

Set the Kinetics object.

Definition at line 47 of file Solution.cpp.

References Solution::kinetics(), and Solution::m_kinetics.

◆ setTransport()

void setTransport ( shared_ptr< Transport transport)

Set the Transport object.

Definition at line 54 of file Solution.cpp.

References Solution::m_transport, and Solution::transport().

◆ thermo()

shared_ptr<ThermoPhase> thermo ( )
inline

Accessor for the ThermoPhase pointer.

Definition at line 50 of file Solution.h.

References Solution::m_thermo.

Referenced by Solution::setThermo().

◆ kinetics()

shared_ptr<Kinetics> kinetics ( )
inline

Accessor for the Kinetics pointer.

Definition at line 55 of file Solution.h.

References Solution::m_kinetics.

Referenced by Solution::setKinetics().

◆ transport()

shared_ptr<Transport> transport ( )
inline

Accessor for the Transport pointer.

Definition at line 60 of file Solution.h.

References Solution::m_transport.

Referenced by Solution::setTransport().

Member Data Documentation

◆ m_thermo

shared_ptr<ThermoPhase> m_thermo
protected

ThermoPhase manager.

Definition at line 65 of file Solution.h.

Referenced by Solution::name(), Solution::setName(), Solution::setThermo(), and Solution::thermo().

◆ m_kinetics

shared_ptr<Kinetics> m_kinetics
protected

Kinetics manager.

Definition at line 66 of file Solution.h.

Referenced by Solution::kinetics(), and Solution::setKinetics().

◆ m_transport

shared_ptr<Transport> m_transport
protected

Transport manager.

Definition at line 67 of file Solution.h.

Referenced by Solution::setTransport(), and Solution::transport().


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