Cantera 2.6.0

Class Hierarchy
This inheritance list is sorted roughly, but not completely, alphabetically:
[detail level 1 2 3 4 5]

►C AnyBase | Base class defining common data possessed by both AnyMap and AnyValue objects
C AnyMap | A map of string keys to values whose type can vary at runtime
C AnyValue | A wrapper for a variable whose type is determined at runtime
C AnyMap::Iterator | Defined to allow use with range-based for loops
C AnyMap::OrderedIterator | Defined to allow the OrderedProxy class to be used with range-based for loops
C AnyMap::OrderedProxy | Proxy for iterating over an AnyMap in the defined output ordering
C Application | Class to hold global data
C Application::Messages | Class to carry out messages
C Application::ThreadMessages | Class that stores thread messages for each thread, and retrieves them based on the thread id
►C Array2D | A class for 2D arrays stored in column-major (Fortran-compatible) form
C DenseMatrix | A class for full (non-sparse) matrices with Fortran-compatible data storage, which adds matrix operations to class Array2D
C atomicWeightData |
C C1 | Handles one species in a reaction
C C2 | Handles two species in a single reaction
C C3 | Handles three species in a reaction
C C_AnyN | Handles any number of species in a reaction, including fractional stoichiometric coefficients, and arbitrary reaction orders
C CachedValue< T > |
C ChemEquil | Class ChemEquil implements a chemical equilibrium solver for single-phase solutions
C clockWC | The class provides the wall clock timer in seconds
C CoverageDependency | Modifications to an InterfaceReaction2 rate based on a surface species coverage
►C DAE_Solver | Wrapper for DAE solvers
C IDA_Solver | Wrapper for Sundials IDA solver
►C Delegator | Delegate member functions of a C++ class to externally-specified functions
C ReactorDelegator< R > | Delegate methods of the Reactor class to external functions
►C Domain1D | Base class for one-dimensional domains
►C Boundary1D | The base class for boundaries between one-dimensional spatial domains
C Empty1D | A terminator that does nothing
C Inlet1D | An inlet
C Outlet1D | An outlet
C OutletRes1D | An outlet with specified composition
C ReactingSurf1D | A reacting surface
C Surf1D | A non-reacting surface
C Symm1D | A symmetry plane
►C StFlow | This class represents 1D flow domains that satisfy the one-dimensional similarity solution for chemically-reacting, axisymmetric flows
C IonFlow | This class models the ion transportation in a flame
C EquilOpt | Chemical equilibrium options
►C FactoryBase | Base class for factories
►C Factory< Falloff > |
C FalloffFactory | Factory class to construct falloff function calculators
►C Factory< FlowDevice > |
C FlowDeviceFactory | Factory class to create FlowDevice objects
►C Factory< Kinetics > |
C KineticsFactory | Factory for kinetics managers
C Factory< PDSS > |
►C Factory< Reaction, const AnyMap &, const Kinetics & > |
C ReactionFactory | Factory class to construct reaction function calculators
C Factory< Reaction, const XML_Node & > |
►C Factory< ReactionRate, const AnyMap &, const UnitStack & > |
C ReactionRateFactory | Factory class to construct reaction rate calculators
►C Factory< ReactorBase > |
C ReactorFactory | Factory class to create reactor objects
►C Factory< ThermoPhase > |
C ThermoFactory | Factory class for thermodynamic property managers
►C Factory< Transport > |
C TransportFactory | Factory class for creating new instances of classes derived from Transport
►C Factory< WallBase > |
C WallFactory | Factory class to create WallBase objects
C Factory< T, Args > | Factory class that supports registering functions to create objects
C FalloffMgr | A falloff manager that implements any set of falloff functions
►C FlowDevice | Base class for 'flow devices' (valves, pressure regulators, etc.) connecting reactors
C MassFlowController | A class for mass flow controllers
C PressureController | A class for flow controllers where the flow rate is equal to the flow rate of a "master" mass flow controller plus a correction proportional to the pressure difference between the inlet and outlet
C Valve | Supply a mass flow rate that is a function of the pressure drop across the valve
►C Func1 | Base class for 'functor' classes that evaluate a function of one variable
C Arrhenius1 | Sum of Arrhenius terms
C Composite1 | Composite function
C Const1 | Implements a constant
C Cos1 | Implements the cos() function
C Diff1 | Difference of two functions
C Exp1 | Implements the exponential function
C Fourier1 | Fourier cosine/sine series
C Gaussian | A Gaussian
C Periodic1 | Periodic function
C PlusConstant1 | A function plus a constant
C Poly1 | Polynomial of degree n
C Pow1 | Implements the power function (pow)
C Product1 | Product of two functions
C Ratio1 | Ratio of two functions
C Sin1 | Implements the sin() function
C Sum1 | Sum of two functions
C Tabulated1 | Implements a tabulated function
C TimesConstant1 | Product of two functions
►C FuncEval | Virtual base class for ODE right-hand-side function evaluators
C ImplicitSurfChem | Advances the surface coverages of the associated set of SurfacePhase objects in time
C ReactorNet | A class representing a network of connected reactors
►C GeneralMatrix | Generic matrix
►C BandMatrix | A class for banded matrices, involving matrix inversion processes
C MultiJac | Class MultiJac evaluates the Jacobian of a system of equations defined by a residual function supplied by an instance of class OneDim
C Group | Class Group is an internal class used by class ReactionPath
►C Integrator | Abstract base class for ODE system integrators
C CVodesIntegrator | Wrapper class for 'cvodes' integrator from LLNL
C InterfaceKinetics::StickData | Values used for converting sticking coefficients into rate constants
►C InterfaceRateBase | Base class for rate parameterizations that involve interfaces
C InterfaceRate< RateType, DataType > | A class template for interface reaction rate specifications
►C StickingCoverage | Base class for rate parameterizations that implement sticking coefficients
C StickingRate< RateType, DataType > | A class template for interface sticking rate specifications
C isotopeWeightData |
►C Kinetics | Public interface for kinetics managers
►C BulkKinetics | Partial specialization of Kinetics for chemistry in a single bulk phase
C GasKinetics | Kinetics manager for elementary gas-phase chemistry
►C InterfaceKinetics | A kinetics manager for heterogeneous reaction mechanisms
C EdgeKinetics | Heterogeneous reactions at one-dimensional interfaces between multiple adjacent two-dimensional surfaces
►C Logger | Base class for 'loggers' that write text messages to log files
C NoExitLogger | Logger that doesn't exit when an error is thrown
C MMCollisionInt | Calculation of Collision integrals
C MultiNewton | Newton iterator for multi-domain, one-dimensional problems
C MultiPhase | A class for multiphase mixtures
C MultiPhaseEquil |
►C MultiRateBase | An abstract base class for evaluating all reactions of a particular type
C MultiRate< RateType, DataType > | A class template handling ReactionRate specializations
C MultiSpeciesThermo | A species thermodynamic property manager for a phase
►C OneDim | Container class for multiple-domain 1D problems
C Sim1D | One-dimensional simulations
►C PDSS | Virtual base class for a species with a pressure dependent standard state
►C PDSS_Molar | Base class for PDSS classes which compute molar properties directly
C PDSS_HKFT | Class for pressure dependent standard states corresponding to ionic solutes in electrolyte water
C PDSS_Water | Class for the liquid water pressure dependent standard state
►C PDSS_Nondimensional | Base class for PDSS classes which compute nondimensional properties directly
C PDSS_ConstVol | Class for pressure dependent standard states that use a constant volume model
C PDSS_IdealGas | Derived class for pressure dependent standard states of an ideal gas species
C PDSS_IonsFromNeutral | Derived class for pressure dependent standard states of an ideal gas species
C PDSS_SSVol | Class for pressure dependent standard states that uses a standard state volume model of some sort
►C Phase | Class Phase is the base class for phases of matter, managing the species and elements in a phase, as well as the independent variables of temperature, mass density (compressible substances) or pressure (incompressible substances), species mass/mole fraction, and other generalized forces and intrinsic properties (such as electric potential) that define the thermodynamic state
►C ThermoPhase | Base class for a phase with thermodynamic properties
►C IdealGasPhase | Class IdealGasPhase represents low-density gases that obey the ideal gas equation of state
C PlasmaPhase | Base class for a phase with plasma properties
►C IdealSolidSolnPhase | Class IdealSolidSolnPhase represents a condensed phase ideal solution compound
C BinarySolutionTabulatedThermo | Overloads the virtual methods of class IdealSolidSolnPhase to implement tabulated standard state thermodynamics for one species in a binary solution
C LatticePhase | A simple thermodynamic model for a bulk phase, assuming a lattice of solid atoms
C LatticeSolidPhase | A phase that is comprised of a fixed additive combination of other lattice phases
C MetalPhase | Class MetalPhase represents electrons in a metal
►C MixtureFugacityTP | This is a filter class for ThermoPhase that implements some preparatory steps for efficiently handling mixture of gases that whose standard states are defined as ideal gases, but which describe also non-ideal solutions
C PengRobinson | Implementation of a multi-species Peng-Robinson equation of state
C RedlichKwongMFTP | Implementation of a multi-species Redlich-Kwong equation of state
C PureFluidPhase | This phase object consists of a single component that can be a gas, a liquid, a mixed gas-liquid fluid, or a fluid beyond its critical point
►C SingleSpeciesTP | Filter class for ThermoPhase
C StoichSubstance | Class StoichSubstance represents a stoichiometric (fixed composition) incompressible substance
C WaterSSTP | Class for single-component water
►C SurfPhase | A simple thermodynamic model for a surface phase, assuming an ideal solution model
C EdgePhase | A thermodynamic phase representing a one dimensional edge between two surfaces
►C VPStandardStateTP | This is a filter class for ThermoPhase that implements some preparatory steps for efficiently handling a variable pressure standard state for species
►C GibbsExcessVPSSTP |
C IonsFromNeutralVPSSTP |
C MargulesVPSSTP | MargulesVPSSTP is a derived class of GibbsExcessVPSSTP that employs the Margules approximation for the excess Gibbs free energy
C RedlichKisterVPSSTP | RedlichKisterVPSSTP is a derived class of GibbsExcessVPSSTP that employs the Redlich-Kister approximation for the excess Gibbs free energy
C IdealSolnGasVPSS | An ideal solution approximation of a phase
C MaskellSolidSolnPhase | Class MaskellSolidSolnPhase represents a condensed phase non-ideal solution with 2 species following the thermodynamic model described in Maskell, Shaw, and Tye, Manganese Dioxide Electrode – IX, Electrochimica Acta 28(2) pp 231-235, 1983
►C MolalityVPSSTP |
C DebyeHuckel | Class DebyeHuckel represents a dilute liquid electrolyte phase which obeys the Debye Huckel formulation for nonideality
C HMWSoln | Class HMWSoln represents a dilute or concentrated liquid electrolyte phase which obeys the Pitzer formulation for nonideality
C IdealMolalSoln | This phase is based upon the mixing-rule assumption that all molality-based activity coefficients are equal to one
C Rate1< R > | This rate coefficient manager supports one parameterization of the rate constant of any type
►C Reaction | Abstract base class which stores data about a reaction and its rate parameterization so that it can be added to a Kinetics object
C ChebyshevReaction2 | A pressure-dependent reaction parameterized by a bi-variate Chebyshev polynomial in temperature and pressure
C CustomFunc1Reaction | A reaction which follows mass-action kinetics with a custom reaction rate defined in Python
►C ElementaryReaction2 | A reaction which follows mass-action kinetics with a modified Arrhenius reaction rate
►C InterfaceReaction2 | A reaction occurring on an interface (for example, a SurfPhase or an EdgePhase)
C ElectrochemicalReaction2 | An interface reaction which involves charged species
C ThreeBodyReaction2 | A reaction with a non-reacting third body "M" that acts to add or remove energy from the reacting species
►C FalloffReaction2 | A reaction that is first-order in [M] at low pressure, like a third-body reaction, but zeroth-order in [M] as pressure increases
C ChemicallyActivatedReaction2 | A reaction where the rate decreases as pressure increases due to collisional stabilization of a reaction intermediate
C FalloffReaction3 | A falloff reaction that is first-order in [M] at low pressure, like a third-body reaction, but zeroth-order in [M] as pressure increases
C PlogReaction2 | A pressure-dependent reaction parameterized by logarithmically interpolating between Arrhenius rate expressions at various pressures
C ThreeBodyReaction3 | A reaction with a non-reacting third body "M" that acts to add or remove energy from the reacting species
►C ReactionData | Data container holding shared data used for ReactionRate calculation
C ArrheniusData | Data container holding shared data specific to ArrheniusRate
►C BlowersMaselData | Data container holding shared data specific to BlowersMaselRate
C InterfaceData | Data container holding shared data for reaction rate specification with interfaces
C ChebyshevData | Data container holding shared data specific to ChebyshevRate
C FalloffData | Data container holding shared data specific to Falloff rates
C PlogData | Data container holding shared data specific to PlogRate
C TwoTempPlasmaData | Data container holding shared data specific to TwoTempPlasmaRate
C ReactionPathDiagram | Reaction path diagrams (graphs)
►C ReactionRate | Abstract base class for reaction rate definitions; this base class is used by user-facing APIs to access reaction rate objects
►C ArrheniusBase | Base class for Arrhenius-type Parameterizations
►C ArrheniusRate | Arrhenius reaction rate type depends only on temperature
C Arrhenius2 | Arrhenius reaction rate type depends only on temperature
C BlowersMaselRate | Blowers Masel reaction rate type depends on the enthalpy of reaction
C TwoTempPlasmaRate | Two temperature plasma reaction rate type depends on both gas temperature and electron temperature
C ChebyshevRate | Pressure-dependent rate expression where the rate coefficient is expressed as a bivariate Chebyshev polynomial in temperature and pressure
C CustomFunc1Rate | Custom reaction rate depending only on temperature
►C FalloffRate | Base class for falloff rate calculators
C LindemannRate | The Lindemann falloff parameterization
C SriRate | The SRI falloff function
C TroeRate | The 3- or 4-parameter Troe falloff parameterization
C TsangRate | The 1- or 2-parameter Tsang falloff parameterization
C PlogRate | Pressure-dependent reaction rate expressed by logarithmically interpolating between Arrhenius rate expressions at various pressures
►C ReactorAccessor | An abstract base class for providing access to protected capabilities Reactor objects from delegate methods, which would normally only be able to access public Reactor members
C ReactorDelegator< R > | Delegate methods of the Reactor class to external functions
►C ReactorBase | Base class for stirred reactors
►C Reactor | Class Reactor is a general-purpose class for stirred reactors
►C ConstPressureReactor | Class ConstPressureReactor is a class for constant-pressure reactors
C IdealGasConstPressureReactor | Class ConstPressureReactor is a class for constant-pressure reactors
C FlowReactor | Adiabatic flow in a constant-area duct
C IdealGasReactor | Class IdealGasReactor is a class for stirred reactors that is specifically optimized for ideal gases
C Reservoir | A source or sink whose state remains constant regardless of any flows or other interactions with other Reactor objects
C ReactorSurface | A surface where reactions can occur that is in contact with the bulk fluid of a Reactor
C Refiner | Refine Domain1D grids so that profiles satisfy adaptation tolerances
C ResidData | A simple class to hold an array of parameter values and a pointer to an instance of a subclass of ResidEval
►C ResidEval | Virtual base class for DAE residual function evaluators
C ResidJacEval | Wrappers for the function evaluators for Nonlinear solvers and Time steppers
►C Solution | A container class holding managers for all pieces defining a phase
C Interface | A container class holding managers for all pieces defining an interface
C solveSP | Method to solve a pseudo steady state surface problem
C Species | Contains data about a single chemical species
C SpeciesNode | Nodes in reaction path graphs
►C SpeciesThermoInterpType | Abstract Base class for the thermodynamic manager for an individual species' reference state
C ConstCpPoly | A constant-heat capacity species thermodynamic property manager class
C Mu0Poly | Implements an interpolation of the Gibbs free energy based on a piecewise constant heat capacity approximation
C Nasa9Poly1 | The NASA 9 polynomial parameterization for one temperature range
C Nasa9PolyMultiTempRegion | The NASA 9 polynomial parameterization for a single species encompassing multiple temperature regions
C NasaPoly1 | The NASA polynomial parameterization for one temperature range
C NasaPoly2 | The NASA polynomial parameterization for two temperature ranges
C ShomatePoly | The Shomate polynomial parameterization for one temperature range for one species
C ShomatePoly2 | The Shomate polynomial parameterization for two temperature ranges for one species
C StoichManagerN |
C SundialsContext | A wrapper for managing a SUNContext object, need for Sundials >= 6.0
C SurfaceArrhenius | An Arrhenius rate with coverage-dependent terms
C ThirdBody | A class for managing third-body efficiencies, including default values
C ThirdBodyCalc | Calculate and apply third-body effects on reaction rates, including non- unity third-body efficiencies
C ThirdBodyCalc3 | Calculate and apply third-body effects on reaction rates, including non- unity third-body efficiencies
►C Transport | Base class for transport property managers
C DustyGasTransport | Class DustyGasTransport implements the Dusty Gas model for transport in porous media
►C GasTransport | Class GasTransport implements some functions and properties that are shared by the MixTransport and MultiTransport classes
►C MixTransport | Class MixTransport implements mixture-averaged transport properties for ideal gas mixtures
C IonGasTransport | Class IonGasTransport implements Stockmayer-(n,6,4) model for transport of ions
C UnityLewisTransport | Class UnityLewisTransport implements the unity Lewis number approximation for the mixture-averaged species diffusion coefficients
►C MultiTransport | Class MultiTransport implements multicomponent transport properties for ideal gas mixtures
C HighPressureGasTransport | Class MultiTransport implements transport properties for high pressure gas mixtures
C WaterTransport | Transport Parameters for pure water
►C TransportData | Base class for transport data for a single species
C GasTransportData | Transport data for a single gas-phase species which can be used in mixture-averaged or multicomponent transport models
C Unit | Unit conversion utility
C Units | A representation of the units associated with a dimensional quantity
C UnitStack | Unit aggregation utility
C UnitSystem | Unit conversion utility
C ValueCache |
C VCS_COUNTERS | Class to keep track of time and iterations
C vcs_MultiPhaseEquil | Cantera's Interface to the Multiphase chemical equilibrium solver
C VCS_SOLVE | This is the main structure used to hold the internal data used in vcs_solve_TP(), and to solve TP systems
C VCS_SPECIES_THERMO |
C vcs_SpeciesProperties | Properties of a single species
C vcs_VolPhase | Phase information and Phase calculations for vcs
►C WallBase | Base class for 'walls' (walls, pistons, etc.) connecting reactors
C Wall | Represents a wall between between two ReactorBase objects
C WaterProps | Used to house several approximation routines for properties of water
C WaterPropsIAPWS | Class for calculating the equation of state of water
C WaterPropsIAPWSphi | Low level class for the real description of water
C XML_Node | Class XML_Node is a tree-based representation of the contents of an XML file
C XML_Reader | Class XML_Reader reads an XML file into an XML_Node object
C YamlWriter | A class for generating full YAML input files from multiple data sources
C PyFuncInfo | A class to hold information needed to call Python functions from delgated methods (see class Delegator)
C Rate1< Cantera::Arrhenius2 > |
C Rate1< Cantera::ChebyshevRate > |
C Rate1< Cantera::PlogRate > |
C Rate1< Cantera::SurfaceArrhenius > |
►C exception | STL class
►C CanteraError | Base class for exceptions thrown by Cantera classes
C ArraySizeError | Array size error
C IndexError | An array index is out of range
C InputFileError | Error thrown for problems processing information contained in an AnyMap or AnyValue
C NotImplementedError | An error indicating that an unimplemented function has been called
C UnknownKineticsModel |
C UnknownThermoPhaseModel | Specific error to be thrown if the type of Thermo manager is unrecognized
►C XML_Error | Class representing a generic XML error condition
C XML_NoChild | Class representing a specific type of XML file formatting error
C XML_TagMismatch | Class representing a specific type of XML file formatting error
►C Substance |
C CarbonDioxide | Pure species representation of carbon dioxide
C HFC134a | Equation of state for HFC-134a
C Heptane | Pure species representation of heptane
C hydrogen | Pure species representation of hydrogen
C methane | Pure species representation of methane
C nitrogen | Pure species representation of nitrogen
C oxygen | Pure species representation of oxygen
C water | Pure species representation of water