File List

Here is a list of all documented files with brief descriptions:
Array.h [code]Header file for class Array2D
BasisOptimize.cpp [code]Functions which calculation optimized basis of the stoichiometric coefficient matrix (see /ref equil functions)
clockWC.cpp [code]Definitions for a simple class that implements an Ansi C wall clock timer (see Cantera::clockWC)
clockWC.h [code]Declarations for a simple class that implements an Ansi C wall clock timer (see Cantera::clockWC)
ConstCpPoly.cpp [code]Declarations for the SpeciesThermoInterpType object that employs a constant heat capacity assumption (see Species Reference-State Thermodynamic Properties and ConstCpPoly )
ConstCpPoly.h [code]Headers for the SpeciesThermoInterpType object that employs a constant heat capacity assumption (see Species Reference-State Thermodynamic Properties and ConstCpPoly)
ConstDensityThermo.cpp [code]Declarations for a Thermo manager for incompressible ThermoPhases (see Thermodynamic Properties and ConstDensityThermo )
ConstDensityThermo.h [code]Header for a Thermo manager for incompressible ThermoPhases (see Thermodynamic Properties and ConstDensityThermo)
Constituents.cpp [code]Header file Class Constitutents which manages a set of elements and species (see Models of Phases of Matter)
Constituents.h [code]Header file Class Constitutents which manages a set of elements and species (see Models of Phases of Matter)
ct2ctml.cpp [code]Driver for the system call to the python executable that converts cti files to ctml files (see Input File Handling)
ct_defs.h [code]This file contains definitions of terms that are used in internal routines and are unlikely to need modifying (text for module physConstants (see Physical Constants) is found here)
ctexceptions.h [code]Definitions for the classes that are thrown when Cantera experiences an error condition (also contains errorhandling module text - see Error Handling)
ctml.cpp [code]Definitions for functions to read and write CTML
ctml.h [code]CTML ("Cantera Markup Language") is the variant of XML that Cantera uses to store data
DebyeHuckel.cpp [code]Declarations for the DebyeHuckel ThermoPhase object, which models dilute electrolyte solutions (see Thermodynamic Properties and DebyeHuckel )
DebyeHuckel.h [code]Headers for the DebyeHuckel ThermoPhase object, which models dilute electrolyte solutions (see Thermodynamic Properties and DebyeHuckel )
EdgePhase.h [code]Declarations for the EdgePhase ThermoPhase object, which models the interface between two surfaces (see Thermodynamic Properties and EdgePhase)
Elements.cpp [code]Declaration file for class, Elements, which contains the elements that make up species (see Models of Phases of Matter and Elements)
Elements.h [code]Header file for class, Elements, which contains the elements that make up species (see Models of Phases of Matter and Elements)
equil.h [code]This file contains the definition of some high level general equilibration routines and the text for the module Equilibrium Solver Capability
equilibrium.h [code]Cxx layer - Header file providing support for chemical equilibrium calculations (see Equilibrium Solver Capability)
FactoryBase.h [code]File contains the FactoryBase class declarations
FalloffFactory.cpp [code]
FalloffFactory.h [code]Parameterizations for reaction falloff functions
GeneralSpeciesThermo.cpp [code]Declarations for a completely general species thermodynamic property manager for a phase (see Species Reference-State Thermodynamic Properties and GeneralSpeciesThermo)
GeneralSpeciesThermo.h [code]Headers for a completely general species thermodynamic property manager for a phase (see Managers for Calculating Reference-State Thermodynamics and GeneralSpeciesThermo)
global.h [code]This file contains definitions for utility functions and text for modules, inputfiles, logs, textlogs, HTML_logs (see Input File Handling, Diagnostic Output, Writing messages to the screen and Writing HTML Logfiles)
HMWSoln.cpp [code]Definitions for the HMWSoln ThermoPhase object, which models concentrated electrolyte solutions (see Thermodynamic Properties and HMWSoln )
HMWSoln.h [code]Headers for the HMWSoln ThermoPhase object, which models concentrated electrolyte solutions (see Thermodynamic Properties and HMWSoln )
HMWSoln_input.cpp [code]Definitions for the HMWSoln ThermoPhase object, which models concentrated electrolyte solutions (see Thermodynamic Properties and HMWSoln )
IdealGasPhase.cpp [code]ThermoPhase object for the ideal gas equation of state - workhorse for Cantera (see Thermodynamic Properties and class IdealGasPhase)
IdealGasPhase.h [code]ThermoPhase object for the ideal gas equation of state - workhorse for Cantera (see Thermodynamic Properties and class IdealGasPhase)
IdealMolalSoln.cpp [code]ThermoPhase object for the ideal molal equation of state (see Thermodynamic Properties and class IdealMolalSoln)
IdealMolalSoln.h [code]ThermoPhase object for the ideal molal equation of state (see Thermodynamic Properties and class IdealMolalSoln)
IdealSolidSolnPhase.cpp [code]Implementation file for an ideal solid solution model with incompressible thermodynamics (see Thermodynamic Properties and IdealSolidSolnPhase)
IdealSolidSolnPhase.h [code]Header file for an ideal solid solution model with incompressible thermodynamics (see Thermodynamic Properties and IdealSolidSolnPhase)
IdealSolnGasVPSS.cpp [code]Definition file for a derived class of ThermoPhase that assumes either an ideal gas or ideal solution approximation and handles variable pressure standard state methods for calculating thermodynamic properties (see Thermodynamic Properties and class IdealSolnGasVPSS)
IdealSolnGasVPSS.h [code]Definition file for a derived class of ThermoPhase that assumes either an ideal gas or ideal solution approximation and handles variable pressure standard state methods for calculating thermodynamic properties (see Thermodynamic Properties and class IdealSolnGasVPSS)
Kinetics.cpp [code]Declarations for the base class for kinetics managers (see Kinetics Managers and class Kinetics)
Kinetics.h [code]Base class for kinetics managers and also contains the kineticsmgr module documentation (see Kinetics Managers and class Kinetics)
LatticePhase.cpp [code]Definitions for a simple thermodynamics model of a bulk phase derived from ThermoPhase, assuming a lattice of solid atoms (see Thermodynamic Properties and class LatticePhase)
LatticePhase.h [code]Header for a simple thermodynamics model of a bulk phase derived from ThermoPhase, assuming a lattice of solid atoms (see Thermodynamic Properties and class LatticePhase)
logger.h [code]Header for Base class for 'loggers' that write text messages to log files (see Writing messages to the screen and class Logger)
LogPrintCtrl.cpp [code]Declarations for a simple class that augments the logfile printing capabilities (see Cantera::LogPrintCtrl)
LogPrintCtrl.h [code]Declarations for a simple class that augments the logfile printing capabilities (see Cantera::LogPrintCtrl)
MetalSHEelectrons.cpp [code]Definition file for the MetalSHEElectrons class, which represents the electrons in a metal that are consistent with the SHE electrode (see Thermodynamic Properties and class MetalSHEelectrons)
MetalSHEelectrons.h [code]Header file for the MetalSHEElectrons class, which represents the electrons in a metal that are consistent with the SHE electrode (see Thermodynamic Properties and class MetalSHEelectrons)
MineralEQ3.cpp [code]Definition file for the MineralEQ3 class, which represents a fixed-composition incompressible substance (see Thermodynamic Properties and class MineralEQ3)
MineralEQ3.h [code]Header file for the MineralEQ3 class, which represents a fixed-composition incompressible substance based on EQ3's parameterization (see Thermodynamic Properties and class MineralEQ3)
misc.cpp [code]This file contains a miscellaneous collection of global data functions and text for the globalData module (see Global Data), the logs module (see Diagnostic Output), and the HTML_logs module (see Writing HTML Logfiles)
MolalityVPSSTP.cpp [code]Definitions for intermediate ThermoPhase object for phases which employ molality based activity coefficient formulations (see Thermodynamic Properties and class MolalityVPSSTP)
MolalityVPSSTP.h [code]Header for intermediate ThermoPhase object for phases which employ molality based activity coefficient formulations (see Thermodynamic Properties and class MolalityVPSSTP)
Mu0Poly.cpp [code]Definitions for a single-species standard state object derived from SpeciesThermoInterpType based on a piecewise constant mu0 interpolation (see Species Reference-State Thermodynamic Properties and class Mu0Poly)
Mu0Poly.h [code]Header for a single-species standard state object derived from SpeciesThermoInterpType based on a piecewise constant mu0 interpolation (see Species Reference-State Thermodynamic Properties and class Mu0Poly)
MultiPhase.cpp [code]Definitions for the MultiPhase object that is used to set up multiphase equilibrium problems (see Equilibrium Solver Capability)
MultiPhase.h [code]Headers for the MultiPhase object that is used to set up multiphase equilibrium problems (see Equilibrium Solver Capability)
Nasa9Poly1.cpp [code]Definitions for a single-species standard state object derived from SpeciesThermoInterpType based on the NASA 9 coefficient temperature polynomial form applied to one temperature region (see Species Reference-State Thermodynamic Properties and class Nasa9Poly1)
Nasa9Poly1.h [code]Header for a single-species standard state object derived from SpeciesThermoInterpType based on the NASA 9 coefficient temperature polynomial form applied to one temperature region (see Species Reference-State Thermodynamic Properties and class Nasa9Poly1)
Nasa9PolyMultiTempRegion.cpp [code]Definitions for a single-species standard state object derived from SpeciesThermoInterpType based on the NASA 9 coefficient temperature polynomial form applied to one temperature region (see Species Reference-State Thermodynamic Properties and class Nasa9Poly1)
Nasa9PolyMultiTempRegion.h [code]Header for a single-species standard state object derived from SpeciesThermoInterpType based on the NASA 9 coefficient temperature polynomial form applied to multiple temperature regions (see Species Reference-State Thermodynamic Properties and class Nasa9PolyMultiTempRegion)
NasaPoly1.h [code]Header for a single-species standard state object derived from SpeciesThermoInterpType based on the NASA temperature polynomial form applied to one temperature region (see Species Reference-State Thermodynamic Properties and class NasaPoly1)
NasaPoly2.h [code]Header for a single-species standard state object derived from SpeciesThermoInterpType based on the NASA temperature polynomial form applied to two temperature regions (see Species Reference-State Thermodynamic Properties and class NasaPoly2)
NasaThermo.h [code]Header for the 2 regime 7 coefficient Nasa thermodynamic polynomials for multiple species in a phase, derived from the SpeciesThermo base class (see Managers for Calculating Reference-State Thermodynamics and NasaThermo)
PDSS.cpp [code]Implementation of a pressure dependent standard state virtual function (see class PDSS)
PDSS.h [code]Declarations for the virtual base class PDSS (pressure dependent standard state) which handles calculations for a single species in a phase (see Species Standard-State Thermodynamic Properties and class PDSS)
PDSS_ConstVol.cpp [code]Implementation of a pressure dependent standard state virtual function
PDSS_ConstVol.h [code]Declarations for the class PDSS_ConstVol (pressure dependent standard state) which handles calculations for a single species with a constant molar volume in a phase (see class Species Standard-State Thermodynamic Properties and PDSS_ConstVol)
PDSS_HKFT.cpp [code]Definitions for the class PDSS_HKFT (pressure dependent standard state) which handles calculations for a single species in a phase using the HKFT standard state (see Species Standard-State Thermodynamic Properties and class PDSS_HKFT)
PDSS_HKFT.h [code]Declarations for the class PDSS_HKFT (pressure dependent standard state) which handles calculations for a single species in a phase using the HKFT standard state (see Species Standard-State Thermodynamic Properties and class PDSS_HKFT)
PDSS_IdealGas.cpp [code]Implementation of a pressure dependent standard state virtual function
PDSS_IdealGas.h [code]Declarations for the class PDSS_IdealGas (pressure dependent standard state) which handles calculations for a single ideal gas species in a phase (see Species Standard-State Thermodynamic Properties and class PDSS_IdealGas)
PDSS_SSVol.cpp [code]Implementation of a pressure dependent standard state virtual function
PDSS_SSVol.h [code]Declarations for the class PDSS_SSVol (pressure dependent standard state) which handles calculations for a single species with an expression for the standard state molar volume in a phase given by an enumerated data type (see class Species Standard-State Thermodynamic Properties and PDSS_SSVol)
PDSS_Water.cpp [code]
PDSS_Water.h [code]Implementation of a pressure dependent standard state virtual function for a Pure Water Phase (see Species Standard-State Thermodynamic Properties and class PDSS_Water)
Phase.cpp [code]Definition file for class, Phase, which contains functions for setting the state of a phase, and for referencing species by name (see Models of Phases of Matter and class Phase)
Phase.h [code]Header file for class, Phase, which contains functions for setting the state of a phase, and for referencing species by name, and also contains text for the module phases (see Models of Phases of Matter and class Phase)
phasereport.cpp [code]Output routines for phases
plots.cpp [code]
plots.h [code]Contains declarations for utility functions for outputing to plotting programs
PrintCtrl.cpp [code]Definitions for a simple class that augments the streams printing capabilities (see Cantera::PrintCtrl)
PrintCtrl.h [code]Declarations for a simple class that augments the streams printing capabilities (see Cantera::PrintCtrl)
PureFluidPhase.cpp [code]Definitions for a ThermoPhase object for a pure fluid phase consisting of gas, liquid, mixed-gas-liquid and supercritical fluid (see Thermodynamic Properties and class PureFluidPhase)
PureFluidPhase.h [code]Header for a ThermoPhase class for a pure fluid phase consisting of gas, liquid, mixed-gas-liquid and supercrit fluid (see Thermodynamic Properties and class PureFluidPhase)
ShomatePoly.h [code]Header for a single-species standard state object derived from SpeciesThermoInterpType based on the Shomate temperature polynomial form applied to one temperature region (see Species Reference-State Thermodynamic Properties and class ShomatePoly and ShomatePoly2)
ShomateThermo.h [code]Header for the 2 regions Shomate polynomial for multiple species in a phase, derived from the SpeciesThermo base class (see Managers for Calculating Reference-State Thermodynamics and ShomateThermo)
SimpleThermo.h [code]Header for the SimpleThermo (constant heat capacity) species reference-state model for multiple species in a phase, derived from the SpeciesThermo base class (see Species Reference-State Thermodynamic Properties and SimpleThermo)
SingleSpeciesTP.cpp [code]Definitions for the SingleSpeciesTP class, which is a filter class for ThermoPhase, that eases the construction of single species phases ( see Thermodynamic Properties and class SingleSpeciesTP)
SingleSpeciesTP.h [code]Header for the SingleSpeciesTP class, which is a filter class for ThermoPhase, that eases the construction of single species phases ( see Thermodynamic Properties and class SingleSpeciesTP)
SpeciesThermo.h [code]Virtual base class for the calculation of multiple-species thermodynamic reference-state property managers and text for the mgrsrefcalc module (see Managers for Calculating Reference-State Thermodynamics and class SpeciesThermo)
SpeciesThermoFactory.cpp [code]Definitions for factory to build instances of classes that manage the standard-state thermodynamic properties of a set of species (see Species Reference-State Thermodynamic Properties and class SpeciesThermoFactory);
SpeciesThermoFactory.h [code]Header for factory to build instances of classes that manage the standard-state thermodynamic properties of a set of species (see Species Reference-State Thermodynamic Properties and class SpeciesThermoFactory);
SpeciesThermoInterpType.h [code]Pure Virtual Base class for individual species reference state themodynamic managers and text for the spthermo module (see Species Reference-State Thermodynamic Properties and class SpeciesThermoInterpType )
SpeciesThermoMgr.h [code]This file contains descriptions of templated subclasses of the virtual base class, SpeciesThermo, which include SpeciesThermoDuo and SpeciesThermo1 (see Managers for Calculating Reference-State Thermodynamics and classes SpeciesThermoDuo and SpeciesThermo1)
speciesThermoTypes.h [code]Contains const definitions for types of species reference-state thermodynamics managers (see Species Reference-State Thermodynamic Properties)
State.cpp [code]Definitions for the class State, that manages the independent variables of temperature, mass density, and species mass/mole fraction that define the thermodynamic state (see Models of Phases of Matter and class State)
State.h [code]Header for the class State, that manages the independent variables of temperature, mass density, and species mass/mole fraction that define the thermodynamic state (see Models of Phases of Matter and class State)
StoichSubstanceSSTP.cpp [code]Definition file for the StoichSubstanceSSTP class, which represents a fixed-composition incompressible substance (see Thermodynamic Properties and class StoichSubstanceSSTP)
StoichSubstanceSSTP.h [code]Header file for the StoichSubstanceSSTP class, which represents a fixed-composition incompressible substance (see Thermodynamic Properties and class StoichSubstanceSSTP)
stringUtils.cpp [code]Contains definitions for string manipulation functions within Cantera
stringUtils.h [code]Contains declarations for string manipulation functions within Cantera
SurfPhase.cpp [code]Definitions for a simple thermoydnamics model of a surface phase derived from ThermoPhase, assuming an ideal solution model (see Thermodynamic Properties and class SurfPhase)
SurfPhase.h [code]Header for a simple thermodynamics model of a surface phase derived from ThermoPhase, assuming an ideal solution model (see Thermodynamic Properties and class SurfPhase)
ThermoFactory.cpp [code]Definitions for the factory class that can create known ThermoPhase objects (see Thermodynamic Properties and class ThermoFactory)
ThermoFactory.h [code]Headers for the factory class that can create known ThermoPhase objects (see Thermodynamic Properties and class ThermoFactory)
ThermoPhase.cpp [code]Definition file for class ThermoPhase, the base class for phases with thermodynamic properties (see class ThermoPhase)
ThermoPhase.h [code]Header file for class ThermoPhase, the base class for phases with thermodynamic properties, and the text for the Module thermoprops (see Thermodynamic Properties and class ThermoPhase)
units.h [code]Header for units conversion utilities, which are used to translate user input from input files (See Input File Handling and class Unit)
utilities.h [code]Various templated functions that carry out common vector operations (see Global Utility Functions)
vcs_defs.h [code]Defines and definitions within the vcs package
vcs_internal.h [code]Internal declarations for the VCSnonideal package
vcs_MultiPhaseEquil.cpp [code]Driver routine for the VCSnonideal equilibrium solver package
vcs_MultiPhaseEquil.h [code]Interface class for the vcsnonlinear solver
vec_functions.h [code]Templates for operations on vector-like objects
VPSSMgr.cpp [code]Definition file for a virtual base class that manages the calculation of standard state properties for all of the species in a single phase, assuming a variable P and T standard state (see Managers for Calculating Standard-State Thermodynamics and class VPSSMgr)
VPSSMgr.h [code]Declaration file for a virtual base class that manages the calculation of standard state properties for all of the species in a single phase, assuming a variable P and T standard state (see Managers for Calculating Standard-State Thermodynamics and class VPSSMgr)
VPSSMgr_ConstVol.cpp [code]Definition file for a derived class that handles the calculation of standard state thermo properties for a set of species which have a constant molar volume pressure dependence (see Thermodynamic Properties and class VPSSMgr_ConstVol)
VPSSMgr_ConstVol.h [code]Declarations for a derived class for the calculation of multiple-species thermodynamic property managers for variable temperature and pressure standard states assuming constant volume (see class VPSSMgr_ConstVol )
VPSSMgr_General.cpp [code]Definition file for a derived class that handles the calculation of standard state thermo properties for a set of species belonging to a single phase in a completely general but slow way (see Thermodynamic Properties and class VPSSMgr_General)
VPSSMgr_General.h [code]Declaration file for a derived class that handles the calculation of standard state thermo properties for a set of species belonging to a single phase in a completely general but slow way (see Managers for Calculating Standard-State Thermodynamics and class VPSSMgr_General)
VPSSMgr_IdealGas.cpp [code]Definition file for a derived class that handles the calculation of standard state thermo properties for a set of species which have an Ideal Gas dependence (see Thermodynamic Properties and class VPSSMgr_IdealGas)
VPSSMgr_IdealGas.h [code]Declaration file for a derived class that handles the calculation of standard state thermo properties for a set of species which have an Ideal Gas dependence (see Managers for Calculating Standard-State Thermodynamics and class VPSSMgr_IdealGas)
VPSSMgr_types.h [code]Contains const definitions for types of calculation managers that are responsible for calculating the species standard state thermodynamic managers and reference-state thermodynamics managers (see class VPSSMgr)
VPSSMgr_Water_ConstVol.cpp [code]Definition file for a derived class that handles the calculation of standard state thermo properties for pure water and a set of species which have a constant molar volume pressure dependence
VPSSMgr_Water_ConstVol.h [code]Declaration file for a derived class that handles the calculation of standard state thermo properties for real water and a set of species which have a constant molar volume pressure dependence (see Managers for Calculating Standard-State Thermodynamics and class VPSSMgr_ConstVol)
VPSSMgr_Water_HKFT.cpp [code]Definition file for a derived class that handles the calculation of standard state thermo properties for pure water and a set of species which obey the HKFT standard state dependence (see Thermodynamic Properties and class VPSSMgr_Water_HKFT)
VPSSMgr_Water_HKFT.h [code]Declaration file for a derived class that handles the calculation of standard state thermo properties for real water and a set of species which have the HKFT equation of state (see Managers for Calculating Standard-State Thermodynamics and class VPSSMgr_Water_HKFT)
VPSSMgrFactory.cpp [code]Definitions for factory to build instances of classes that manage the calculation of standard state properties for all the species in a phase (see Species Reference-State Thermodynamic Properties and class VPSSMgrFactory);
VPSSMgrFactory.h [code]Header for factory to build instances of classes that manage the standard-state thermodynamic properties of a set of species (see Managers for Calculating Standard-State Thermodynamics and class VPSSMgrFactory);
VPStandardStateTP.cpp [code]Definition file for a derived class of ThermoPhase that handles variable pressure standard state methods for calculating thermodynamic properties (see Thermodynamic Properties and class VPStandardStateTP)
VPStandardStateTP.h [code]Header file for a derived class of ThermoPhase that handles variable pressure standard state methods for calculating thermodynamic properties (see Thermodynamic Properties and class VPStandardStateTP)
WaterProps.cpp [code]
WaterProps.h [code]Header for a class used to house several approximation routines for properties of water
WaterPropsIAPWS.cpp [code]Definitions for a class for calculating the equation of state of water from the IAPWS 1995 Formulation based on the steam tables thermodynamic basis (See class WaterPropsIAPWS)
WaterPropsIAPWS.h [code]Headers for a class for calculating the equation of state of water from the IAPWS 1995 Formulation based on the steam tables thermodynamic basis (See class WaterPropsIAPWS)
WaterPropsIAPWSphi.cpp [code]Definitions for Lowest level of the classes which support a real water model (see class WaterPropsIAPWS and class WaterPropsIAPWSphi)
WaterPropsIAPWSphi.h [code]Header for Lowest level of the classes which support a real water model (see class WaterPropsIAPWS and class WaterPropsIAPWSphi)
WaterSSTP.cpp [code]Definitions for a ThermoPhase class consisting of pure water (see Thermodynamic Properties and class WaterSSTP)
WaterSSTP.h [code]Declares a ThermoPhase class consisting of pure water (see Thermodynamic Properties and class WaterSSTP)
xml.cpp [code]Classes providing support for XML data files
xml.h [code]Classes providing support for XML data files
Generated by  doxygen 1.6.3