Cantera.Kinetics
index
/usr/local/lib/python2.6/dist-packages/Cantera/Kinetics.py

Kinetics managers.

 
Modules
       
Cantera._cantera

 
Classes
       
Kinetics

 
class Kinetics
    Kinetics managers. Instances of class Kinetics are responsible for
evaluating reaction rates of progress, species production rates,
and other quantities pertaining to a reaction mechanism.
 
parameters -
kintype    - integer specifying the type of kinetics manager to create.
 
  Methods defined here:
__del__(self)
__init__(self, kintype=-1, thrm=0, xml_phase=None, id=None, phases=[])
Build a kinetics manager from an XML specification.
 
root     -- root of a CTML tree
 
id       -- id of the 'kinetics' node within the tree that contains
            the specification of the parameters.
activationEnergies(self)
Activation energies in Kelvin for all reactions.
advanceCoverages(self, dt)
clear(self)
Delete the kinetics manager.
creationRates(self, phase=None)
delta_G(self)
delta_G0(self)
delta_H(self)
delta_H0(self)
delta_S(self)
delta_S0(self)
destructionRates(self, phase=None)
equilibriumConstants(self)
Equilibrium constants in concentration units for all reactions.
fwdRateConstants(self)
Forward rate constants for all reactions.
fwdRatesOfProgress(self)
Forward rates of progress of the reactions.
isReversible(self, i)
True (1) if reaction number 'i' is reversible,
and false (0) otherwise.
kin_index(self)
kineticsSpeciesIndex(self, name, phase)
The index of a species.
name  -- species name
phase -- phase name
 
Kinetics managers for heterogeneous reaction mechanisms
maintain a list of all species in all phases. The order of the
species in this list determines the ordering of the arrays of
production rates. This method returns the index for the
specified species of the specified phase, and is used to
locate the entry for a particular species in the production
rate arrays.
kineticsStart(self, n)
The starting location of phase n in production rate arrays.
kineticsType(self)
Kinetics manager type.
kinetics_hndl(self)
multiplier(self, i)
nPhases(self)
Number of phases.
nReactions(self)
Number of reactions.
netProductionRates(self, phase=None)
netRatesOfProgress(self)
Net rates of progress of the reactions.
phase(self, n)
Return an object representing the nth phase.
productStoichCoeff(self, k, i)
The stoichiometric coefficient of species k as a product in reaction i.
productStoichCoeffs(self)
The array of product stoichiometric coefficients. Element
[k,i] of this array is the product stoichiometric
coefficient of species k in reaction i.
reactantStoichCoeff(self, k, i)
The stoichiometric coefficient of species k as a reactant in reaction i.
reactantStoichCoeffs(self)
The array of reactant stoichiometric coefficients. Element
[k,i] of this array is the reactant stoichiometric
coefficient of species k in reaction i.
reactionEqn(self, i)
The equation for the specified reaction. If a list of equation numbers
is given, then a list of equation strings is returned.
reactionPhaseIndex(self)
The phase in which the reactions take place.
reactionString(self, i)
Reaction string for reaction number 'i'
reactionType(self, i)
Type of reaction 'i'
revRateConstants(self, doIrreversible=0)
Reverse rate constants for all reactions.
revRatesOfProgress(self)
Reverse rates of progress of the reactions.
setMultiplier(self, value=0.0, reaction=-1)
sourceTerms(self)

 
Functions
       
zeros(...)
zeros(shape, dtype=float, order='C')
 
Return a new array of given shape and type, filled with zeros.
 
Parameters
----------
shape : {tuple of ints, int}
    Shape of the new array, e.g., ``(2, 3)`` or ``2``.
dtype : data-type, optional
    The desired data-type for the array, e.g., `numpy.int8`.  Default is
    `numpy.float64`.
order : {'C', 'F'}, optional
    Whether to store multidimensional data in C- or Fortran-contiguous
    (row- or column-wise) order in memory.
 
Returns
-------
out : ndarray
    Array of zeros with the given shape, dtype, and order.
 
See Also
--------
numpy.zeros_like : Return an array of zeros with shape and type of input.
numpy.ones_like : Return an array of ones with shape and type of input.
numpy.empty_like : Return an empty array with shape and type of input.
numpy.ones : Return a new array setting values to one.
numpy.empty : Return a new uninitialized array.
 
Examples
--------
>>> np.zeros(5)
array([ 0.,  0.,  0.,  0.,  0.])
 
>>> np.zeros((5,), dtype=numpy.int)
array([0, 0, 0, 0, 0])
 
>>> np.zeros((2, 1))
array([[ 0.],
       [ 0.]])
 
>>> s = (2,2)
>>> np.zeros(s)
array([[ 0.,  0.],
       [ 0.,  0.]])
 
>>> np.zeros((2,), dtype=[('x', 'i4'), ('y', 'i4')])
array([(0, 0), (0, 0)],
      dtype=[('x', '<i4'), ('y', '<i4')])