Reaktoro
A unified framework for modeling chemically reactive systems
ChemicalScalarBase< V, N > Class Template Reference

A template base class to represent a chemical scalar and its partial derivatives. More...

#include <ChemicalScalar.hpp>

Public Member Functions

 ChemicalScalarBase ()
 Construct a default ChemicalScalarBase instance.
 
 ChemicalScalarBase (Index nspecies)
 Construct a ChemicalScalarBase instance with given number of species. More...
 
 ChemicalScalarBase (Index nspecies, double val)
 Construct a ChemicalScalarBase instance with given number of species and a constant value. More...
 
 ChemicalScalarBase (const V &val, const V &ddT, const V &ddP, const N &ddn)
 Construct a ChemicalScalarBase instance with given values and derivatives. More...
 
template<typename VR , typename NR >
 ChemicalScalarBase (ChemicalScalarBase< VR, NR > &other)
 Construct a ChemicalScalarBase instance from another.
 
template<typename VR , typename NR >
 ChemicalScalarBase (const ChemicalScalarBase< VR, NR > &other)
 Construct a ChemicalScalarBase instance from another.
 
auto operator= (ChemicalScalarBase< V, N > &other) -> ChemicalScalarBase &
 Assign another ChemicalScalarBase instance to this.
 
template<typename VR , typename NR >
auto operator= (const ChemicalScalarBase< VR, NR > &other) -> ChemicalScalarBase &
 Assign another ChemicalScalarBase instance to this.
 
template<typename VR >
auto operator= (const ThermoScalarBase< VR > &other) -> ChemicalScalarBase &
 Assign a ThermoScalarBase instance to this.
 
auto operator= (double other) -> ChemicalScalarBase &
 Assign a scalar to this.
 
template<typename VR , typename NR >
auto operator+= (const ChemicalScalarBase< VR, NR > &other) -> ChemicalScalarBase &
 Assign-addition of a ChemicalScalarBase instance to this.
 
template<typename VR >
auto operator+= (const ThermoScalarBase< VR > &other) -> ChemicalScalarBase &
 Assign-addition of a ThermoScalarBase instance to this.
 
auto operator+= (double other) -> ChemicalScalarBase &
 Assign-addition of a scalar to this.
 
template<typename VR , typename NR >
auto operator-= (const ChemicalScalarBase< VR, NR > &other) -> ChemicalScalarBase &
 Assign-subtraction of a ChemicalScalarBase instance to this.
 
template<typename VR >
auto operator-= (const ThermoScalarBase< VR > &other) -> ChemicalScalarBase &
 Assign-subtraction of a ThermoScalarBase instance to this.
 
auto operator-= (double other) -> ChemicalScalarBase &
 Assign-subtraction of a scalar to this.
 
template<typename VR , typename NR >
auto operator*= (const ChemicalScalarBase< VR, NR > &other) -> ChemicalScalarBase &
 Assign-multiplication of a ChemicalScalarBase instance to this.
 
auto operator*= (double other) -> ChemicalScalarBase &
 Assign-multiplication of a scalar to this.
 
auto operator/= (double other) -> ChemicalScalarBase &
 Assign-division of a scalar to this.
 
 operator double () const
 Explicitly converts this ChemicalScalarBase instance into a double.
 

Public Attributes

val
 The value of the chemical scalar.
 
ddT
 The partial temperature derivative of the chemical scalar.
 
ddP
 The partial pressure derivative of the chemical scalar.
 
ddn
 The partial mole derivatives of the chemical scalar.
 

Detailed Description

template<typename V, typename N>
class Reaktoro::ChemicalScalarBase< V, N >

A template base class to represent a chemical scalar and its partial derivatives.

A chemical scalar is a quantity that depends on temperature, pressure, and mole amounts of species.

See also
ThermoScalar, ChemicalVector, ThermoVector

Constructor & Destructor Documentation

◆ ChemicalScalarBase() [1/3]

ChemicalScalarBase ( Index  nspecies)
inlineexplicit

Construct a ChemicalScalarBase instance with given number of species.

Parameters
nspeciesThe number of species for the molar derivatives

◆ ChemicalScalarBase() [2/3]

ChemicalScalarBase ( Index  nspecies,
double  val 
)
inline

Construct a ChemicalScalarBase instance with given number of species and a constant value.

Parameters
nspeciesThe number of species for the molar derivatives
valThe constant value

◆ ChemicalScalarBase() [3/3]

ChemicalScalarBase ( const V &  val,
const V &  ddT,
const V &  ddP,
const N &  ddn 
)
inline

Construct a ChemicalScalarBase instance with given values and derivatives.

Parameters
valThe value of the chemical scalar
ddTThe partial temperature derivative of the chemical scalar
ddPThe partial pressure derivative of the chemical scalar
ddnThe vector of partial mole derivatives of the chemical scalar

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