Cantera  2.5.1
TransportParams.h
Go to the documentation of this file.
1 /**
2  * @file TransportParams.h
3  * Class that holds the data that is read in from the input file, and which is used for
4  * processing of the transport object
5  * (see \ref tranprops and \link Cantera::TransportParams TransportParams \endlink).
6  */
7 
8 // This file is part of Cantera. See License.txt in the top-level directory or
9 // at https://cantera.org/license.txt for license and copyright information.
10 
11 #ifndef CT_TRANSPORTPARAMS_H
12 #define CT_TRANSPORTPARAMS_H
13 
15 #include "TransportBase.h"
16 
17 namespace Cantera
18 {
19 
20 //! Base structure to hold transport model parameters.
21 /*!
22  * This structure is used by TransportFactory.
23  *
24  * @deprecated Unused. To be removed after Cantera 2.5.
25  */
27 {
28 public:
30  virtual ~TransportParams() {}
31 
32  //! Local storage of the number of species
33  size_t nsp_;
34 
35  //! Pointer to the ThermoPhase object: shallow pointer
37 
38  //! Local storage of the molecular weights of the species
39  /*!
40  * Length is nsp_ and units are kg kmol-1.
41  */
43 
44  //! A basis for the average velocity can be specified.
45  /*!
46  * Valid bases include "mole", "mass", and "species" names.
47  */
49 
50  //! Maximum temperatures for parameter fits
51  doublereal tmax;
52 
53  //! Minimum temperatures for parameter fits
54  doublereal tmin;
55 
56  //! Mode parameter
57  int mode_;
58 
59  //! Log level
60  int log_level;
61 };
62 
63 } // End of namespace Cantera
64 
65 #endif //CT_TRANSPORTPARAMS_H
Cantera::TransportParams::nsp_
size_t nsp_
Local storage of the number of species.
Definition: TransportParams.h:33
Cantera::TransportParams
Base structure to hold transport model parameters.
Definition: TransportParams.h:26
Cantera::vector_fp
std::vector< double > vector_fp
Turn on the use of stl vectors for the basic array type within cantera Vector of doubles.
Definition: ct_defs.h:180
Cantera::VelocityBasis
int VelocityBasis
The diffusion fluxes must be referenced to a particular reference fluid velocity.
Definition: TransportBase.h:57
Cantera::TransportParams::log_level
int log_level
Log level.
Definition: TransportParams.h:60
DenseMatrix.h
Cantera::TransportParams::mode_
int mode_
Mode parameter.
Definition: TransportParams.h:57
Cantera::ThermoPhase
Base class for a phase with thermodynamic properties.
Definition: ThermoPhase.h:101
Cantera::TransportParams::tmax
doublereal tmax
Maximum temperatures for parameter fits.
Definition: TransportParams.h:51
Cantera::TransportParams::thermo
thermo_t * thermo
Pointer to the ThermoPhase object: shallow pointer.
Definition: TransportParams.h:36
Cantera::TransportParams::tmin
doublereal tmin
Minimum temperatures for parameter fits.
Definition: TransportParams.h:54
Cantera::TransportParams::mw
vector_fp mw
Local storage of the molecular weights of the species.
Definition: TransportParams.h:42
Cantera::TransportParams::velocityBasis_
VelocityBasis velocityBasis_
A basis for the average velocity can be specified.
Definition: TransportParams.h:48
Cantera
Namespace for the Cantera kernel.
Definition: AnyMap.cpp:263
TransportBase.h