Cantera  2.3.0
SpeciesThermoFactory.h
Go to the documentation of this file.
1 /**
2  * @file SpeciesThermoFactory.h
3  * Header for factory functions to build instances of classes that manage the
4  * standard-state thermodynamic properties of a set of species
5  * (see \ref spthermo);
6  */
7 
8 // This file is part of Cantera. See License.txt in the top-level directory or
9 // at http://www.cantera.org/license.txt for license and copyright information.
10 
11 #ifndef SPECIESTHERMO_FACTORY_H
12 #define SPECIESTHERMO_FACTORY_H
13 
15 
16 namespace Cantera
17 {
18 
19 class XML_Node;
20 
21 //! Create a new SpeciesThermoInterpType object given a corresponding constant.
22 /*!
23  * @param type A constant specifying the type to be created
24  * @param tlow The lowest temperature at which the parameterization is valid
25  * @param thigh The highest temperature at which the parameterization is valid
26  * @param pref The reference pressure for the parameterization
27  * @param coeffs The array of coefficients for the parameterization
28  * @returns The pointer to the newly allocated SpeciesThermoInterpType object
29  */
30 SpeciesThermoInterpType* newSpeciesThermoInterpType(int type, double tlow,
31  double thigh, double pref, const double* coeffs);
32 
33 //! Create a new SpeciesThermoInterpType object given a string
34 /*!
35  * @param type String name for the species thermo type
36  * @param tlow The lowest temperature at which the parameterization is valid
37  * @param thigh The highest temperature at which the parameterization is valid
38  * @param pref The reference pressure for the parameterization
39  * @param coeffs The array of coefficients for the parameterization
40  * @returns the pointer to the newly allocated SpeciesThermoInterpType object
41  */
42 SpeciesThermoInterpType* newSpeciesThermoInterpType(const std::string& type,
43  double tlow, double thigh, double pref, const double* coeffs);
44 
45 //! Create a new SpeciesThermoInterpType object from XML_Node
46 /*!
47  * @param thermoNode 'thermo' XML_Node (child of the 'species' node) with child
48  * nodes representing parameterizations for one or more temperature ranges
49  * @returns the pointer to the newly allocated SpeciesThermoInterpType object
50  */
51 SpeciesThermoInterpType* newSpeciesThermoInterpType(const XML_Node& thermoNode);
52 
53 }
54 
55 #endif
SpeciesThermoInterpType * newSpeciesThermoInterpType(int type, double tlow, double thigh, double pref, const double *coeffs)
Create a new SpeciesThermoInterpType object given a corresponding constant.
Pure Virtual Base class for individual species reference state thermodynamic managers and text for th...
Namespace for the Cantera kernel.
Definition: application.cpp:29