research/cantera
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

[Doc] Fix spelling errors

Browse source
This commit is contained in:
Ray Speth 2015-05-25 16:08:04 -04:00
parent 2b8a597037
commit 51c8d7365a
17 changed files with 31 additions and 31 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
doc/sphinx/cti/phases.rst
View file

@ -229,7 +229,7 @@ The Transport Model
A *transport model* is a set of equations used to compute transport A *transport model* is a set of equations used to compute transport
properties. For :class:`ideal_gas` phases, multiple transport models are properties. For :class:`ideal_gas` phases, multiple transport models are
available; the one desired can be selected by assiging a string to this available; the one desired can be selected by assigning a string to this
field. See :ref:`sec-gas-transport-models` for more details. field. See :ref:`sec-gas-transport-models` for more details.
The Initial State The Initial State
@ -460,7 +460,7 @@ Defining an interface is much like defining a phase. There are two new fields:
participate in the heterogeneous reactions. Although in most cases this string participate in the heterogeneous reactions. Although in most cases this string
will list one or two phases, no limit is placed on the number. This is will list one or two phases, no limit is placed on the number. This is
particularly useful in some electrochemical problems, where reactions take place particularly useful in some electrochemical problems, where reactions take place
near the triple-phase bounday where a gas, an electrolyte, and a metal all meet. near the triple-phase boundary where a gas, an electrolyte, and a metal all meet.
The ``site_density`` field is the number of adsorption sites per unit area. The ``site_density`` field is the number of adsorption sites per unit area.

2
doc/sphinx/cxx-guide/compiling.rst
View file

@ -80,7 +80,7 @@ Make
Cantera is distributed with an "include Makefile" that can be used with Cantera is distributed with an "include Makefile" that can be used with
Make-based build systems. This file ``Cantera.mak`` is located in the Make-based build systems. This file ``Cantera.mak`` is located in the
``samples`` subdirectory of the Cantera installation directory. To use it, add a ``samples`` subdirectory of the Cantera installation directory. To use it, add a
line referincing this file to the top of your Makefile:: line referencing this file to the top of your Makefile::
include path/to/Cantera.mak include path/to/Cantera.mak

2
doc/sphinx/cxx-guide/thermo.rst
View file

@ -42,7 +42,7 @@ specific attributes of each type of phase are specified by deriving a class from
Cantera has a wide variety of models for bulk phase currently. Special attention Cantera has a wide variety of models for bulk phase currently. Special attention
(in terms of the speed of execution) has been paid to an ideal gas phase (in terms of the speed of execution) has been paid to an ideal gas phase
implementation, where the species thermodynamic polynomial representations implementation, where the species thermodynamic polynomial representations
adhere to either the NASA polynomial form or to the Shomate polynomoial adhere to either the NASA polynomial form or to the Shomate polynomial
form. This is widely used in combustion applications, the original application form. This is widely used in combustion applications, the original application
that Cantera was designed for. Recently, a lot of effort has been placed into that Cantera was designed for. Recently, a lot of effort has been placed into
constructing non-ideal liquid phase thermodynamics models that are used in constructing non-ideal liquid phase thermodynamics models that are used in

2
doc/sphinx/cython/kinetics.rst
View file

@ -11,7 +11,7 @@ Reactions
--------- ---------
These classes contain the definition of a single reaction and its associated These classes contain the definition of a single reaction and its associated
rate expression, indepenent of a specific `Kinetics` object. rate expression, independent of a specific `Kinetics` object.
.. autoclass:: Reaction(reactants='', products='') .. autoclass:: Reaction(reactants='', products='')
:no-undoc-members: :no-undoc-members:

6
doc/sphinx/cython/migrating.rst
View file

@ -120,8 +120,8 @@ should be replaced with::
>>> w = ct.Water() >>> w = ct.Water()
>>> w.TX = 400, 0.5 >>> w.TX = 400, 0.5
Setting Thermodyamic State Setting Thermodynamic State
-------------------------- ---------------------------
The ``set`` method has been removed in favor of property pairs or triplets. The The ``set`` method has been removed in favor of property pairs or triplets. The
following:: following::
@ -268,7 +268,7 @@ should be replaced with::
>>> f.flame.set_transient_tolerances(default=tol_ts) >>> f.flame.set_transient_tolerances(default=tol_ts)
>>> f.set_refine_criteria(ratio=4, slope=0.2, curve=0.3, prune=0.04) >>> f.set_refine_criteria(ratio=4, slope=0.2, curve=0.3, prune=0.04)
To change the transport model and enbale calculation of the Soret diffusion To change the transport model and enable calculation of the Soret diffusion
term, the following:: term, the following::
>>> gas.addTransportModel('Multi') >>> gas.addTransportModel('Multi')

4
include/cantera/numerics/BEulerInt.h
View file

@ -240,7 +240,7 @@ protected:
* on input: * on input:
* *
* abs_error - Generic absolute error tolerance * abs_error - Generic absolute error tolerance
* rel_error - Generic realtive error tolerance * rel_error - Generic relative error tolerance
* x_coor[] - Solution vector from the implicit corrector * x_coor[] - Solution vector from the implicit corrector
* x_pred_n[] - Solution vector from the explicit predictor * x_pred_n[] - Solution vector from the explicit predictor
* *
@ -270,7 +270,7 @@ protected:
* *
* delta_t_n - Magnitude of time step at time t_n * delta_t_n - Magnitude of time step at time t_n
* delta_t_nm1 - Magnitude of time step at time t_n-1 * delta_t_nm1 - Magnitude of time step at time t_n-1
* rel_error - Generic realtive error tolerance * rel_error - Generic relative error tolerance
* time_error_factor - Estimated value of the time step truncation error * time_error_factor - Estimated value of the time step truncation error
* factor. This value is a ratio of the computed * factor. This value is a ratio of the computed
* error norms. The premultiplying constants * error norms. The premultiplying constants

4
include/cantera/numerics/IDA_Solver.h
View file

@ -110,7 +110,7 @@ public:
//! Set the maximum number of nonlinear iterations on a timestep //! Set the maximum number of nonlinear iterations on a timestep
/*! /*!
* @param n Set the max iterations. The default is 4, which seems awefully low to me. * @param n Set the max iterations. The default is 4, which seems awfully low to me.
*/ */
virtual void setMaxNonlinIterations(int n); virtual void setMaxNonlinIterations(int n);
@ -249,7 +249,7 @@ protected:
//! Maximum value of the timestep allowed //! Maximum value of the timestep allowed
doublereal m_hmax; doublereal m_hmax;
//! Minimum value of the timestep allowd //! Minimum value of the timestep allowed
doublereal m_hmin; doublereal m_hmin;
//! Value of the initial time step //! Value of the initial time step

2
include/cantera/thermo/ThermoFactory.h
View file

@ -102,7 +102,7 @@ private:
//! Create a new thermo manager instance. //! Create a new thermo manager instance.
/*! /*!
* @param model String to look up the model against * @param model String to look up the model against
* @param f ThermoFactor instance to use in matching the string * @param f ThermoFactory instance to use in matching the string
* *
* @return * @return
* Returns a pointer to a new ThermoPhase instance matching the * Returns a pointer to a new ThermoPhase instance matching the

10
include/cantera/transport/LiquidTransport.h
View file

@ -63,7 +63,7 @@ namespace Cantera
* defined in terms of the species mole fraction, * defined in terms of the species mole fraction,
* temperature and pressure. Charged species are expected * temperature and pressure. Charged species are expected
* and quantities like the electric current are computed * and quantities like the electric current are computed
* based on a combined electrochemcial potential. * based on a combined electrochemical potential.
* *
* *
* @ingroup tranprops * @ingroup tranprops
@ -657,7 +657,7 @@ protected:
* \f] * \f]
* *
* The gradient in the activity coefficient requires the use of thermophase * The gradient in the activity coefficient requires the use of thermophase
* getdlnActCoeff that calculates its change based on a chane in the state * getdlnActCoeff that calculates its change based on a change in the state
* (i.e. temperature and composition of each species) which was first * (i.e. temperature and composition of each species) which was first
* implemented in MargulesVPSSTP.cpp (LiquidTransport.h doxygen) * implemented in MargulesVPSSTP.cpp (LiquidTransport.h doxygen)
*/ */
@ -690,7 +690,7 @@ protected:
* The gradient in the activity coefficient requires the use of thermophase * The gradient in the activity coefficient requires the use of thermophase
* getdlnActCoeff that calculates its change based on a change in the state * getdlnActCoeff that calculates its change based on a change in the state
* i.e. temperature and composition of each species. * i.e. temperature and composition of each species.
* First implemented in MargulesVPSSTP.cppmeter. * First implemented in MargulesVPSSTP.cpp.
* *
* One of the Stefan Maxwell equations is replaced by the appropriate * One of the Stefan Maxwell equations is replaced by the appropriate
* definition of the mass-averaged velocity, the mole-averaged velocity * definition of the mass-averaged velocity, the mole-averaged velocity
@ -836,7 +836,7 @@ private:
//! Type def for LTPvector equating it with a vector of pointers to LTPspecies //! Type def for LTPvector equating it with a vector of pointers to LTPspecies
typedef std::vector<LTPspecies*> LTPvector; typedef std::vector<LTPspecies*> LTPvector;
//! Mobility ratio for the binary cominations of each species in each //! Mobility ratio for the binary combinations of each species in each
//! pure phase expressed as an appropriate subclass of LTPspecies //! pure phase expressed as an appropriate subclass of LTPspecies
/*! /*!
* These subclasses of LTPspecies evaluate the species-specific * These subclasses of LTPspecies evaluate the species-specific
@ -1239,7 +1239,7 @@ private:
*/ */
bool m_ionCond_mix_ok; bool m_ionCond_mix_ok;
//! Boolean indicating that weight factors wrt ionic conductivty is current //! Boolean indicating that weight factors wrt ionic conductivity is current
bool m_ionCond_temp_ok; bool m_ionCond_temp_ok;
//! Flag to indicate that the pure species ionic conductivities //! Flag to indicate that the pure species ionic conductivities

2
interfaces/cython/cantera/constants.pyx
View file

@ -15,7 +15,7 @@ cdef extern from "cantera/base/ct_defs.h" namespace "Cantera":
#: Avogadro's Number, /kmol #: Avogadro's Number, /kmol
avogadro = CxxAvogadro avogadro = CxxAvogadro
#: The ideal gas constant in J/kmo-K #: The ideal gas constant in J/kmol-K
gas_constant = CxxGasConstant gas_constant = CxxGasConstant
#: One atmosphere in Pascals #: One atmosphere in Pascals

2
interfaces/cython/cantera/examples/onedim/diffusion_flame_batch.py
View file

@ -130,7 +130,7 @@ for p in p_range:
', reaction mechanism ' + reaction_mechanism) ', reaction mechanism ' + reaction_mechanism)
p_previous = p p_previous = p
except Exception as e: except Exception as e:
print('Error occured while solving:', e, 'Try next pressure level') print('Error occurred while solving:', e, 'Try next pressure level')
# If solution failed: Restore the last successful solution and continue # If solution failed: Restore the last successful solution and continue
f.restore(filename=data_directory + file_name, name='solution', f.restore(filename=data_directory + file_name, name='solution',
loglevel=0) loglevel=0)

2
interfaces/cython/cantera/examples/onedim/flamespeed_sensitivity.py
View file

@ -61,6 +61,6 @@ for m in range(gas.n_reactions):
m, (Su-Su0)/(Su0*dk), gas.reaction_equation(m))) m, (Su-Su0)/(Su0*dk), gas.reaction_equation(m)))
# Sensitivity analysis requires additional function evaluations on the final # Sensitivity analysis requires additional function evaluations on the final
# grid, but no additonal Jacobian evaluations. # grid, but no additional Jacobian evaluations.
print('\nInitial Solution + Sensitivity calculations:') print('\nInitial Solution + Sensitivity calculations:')
f.show_stats() f.show_stats()

2
interfaces/cython/cantera/onedim.py
View file

@ -208,7 +208,7 @@ class FlameBase(Sim1D):
def solution(self, component, point=None): def solution(self, component, point=None):
""" """
Get the solution at one point or for the full flame domain (if Get the solution at one point or for the full flame domain (if
`point=None`) for the specified *component*. The *compnent* can be `point=None`) for the specified *component*. The *component* can be
specified by name or index. specified by name or index.
""" """
if point is None: if point is None:

8
interfaces/cython/cantera/reactor.pyx
View file

@ -489,7 +489,7 @@ cdef class Wall:
def set_velocity(self, v): def set_velocity(self, v):
""" """
The wall velocity [m/s]. May be either a constant or an arbirary The wall velocity [m/s]. May be either a constant or an arbitrary
function of time. See `Func1`. function of time. See `Func1`.
""" """
cdef Func1 f cdef Func1 f
@ -671,7 +671,7 @@ cdef class Valve(FlowDevice):
def set_valve_coeff(self, k): def set_valve_coeff(self, k):
""" """
Set the relationship betwen mass flow rate and the pressure drop across Set the relationship between mass flow rate and the pressure drop across
the valve. If a number is given, it is the proportionality constant the valve. If a number is given, it is the proportionality constant
[kg/s/Pa]. If a function is given, it should compute the mass flow [kg/s/Pa]. If a function is given, it should compute the mass flow
rate [kg/s] given the pressure drop [Pa]. rate [kg/s] given the pressure drop [Pa].
@ -871,9 +871,9 @@ cdef class ReactorNet:
def sensitivities(self): def sensitivities(self):
r""" r"""
Returns the senstivities of all of the solution variables with respect Returns the sensitivities of all of the solution variables with respect
to all of the registered parameters. The normalized sensitivity to all of the registered parameters. The normalized sensitivity
coefficient :math:`S_{ki}` of the solution varible :math:`y_k` with coefficient :math:`S_{ki}` of the solution variable :math:`y_k` with
respect to sensitivity parameter :math:`p_i` is defined as: respect to sensitivity parameter :math:`p_i` is defined as:
.. math:: S_{ki} = \frac{p_i}{y_k} \frac{\partial y_k}{\partial p_i} .. math:: S_{ki} = \frac{p_i}{y_k} \frac{\partial y_k}{\partial p_i}

2
interfaces/cython/cantera/thermo.pyx
View file

@ -1,6 +1,6 @@
import warnings import warnings
cdef enum Thermasis: cdef enum ThermoBasis:
mass_basis = 0 mass_basis = 0
molar_basis = 1 molar_basis = 1

6
src/numerics/NonlinearSolver.cpp
View file

@ -1460,7 +1460,7 @@ void NonlinearSolver::setupDoubleDogleg()
*/ */
/* /*
* This hasn't worked. so will do it heuristically. One issue is that the newton * This hasn't worked. so will do it heuristically. One issue is that the newton
* direction is not the inverse of the Hessian times the gradient. The Hession * direction is not the inverse of the Hessian times the gradient. The Hessian
* is the matrix squared. Until I have the inverse of the Hessian from QR factorization * is the matrix squared. Until I have the inverse of the Hessian from QR factorization
* I may not be able to do it this way. * I may not be able to do it this way.
*/ */
@ -2854,7 +2854,7 @@ int NonlinearSolver::solve_nonlinear_problem(int SolnType, doublereal* const y_c
// Damp the Newton step // Damp the Newton step
/* /*
* On return the recommended new solution and derivatisve is located in: * On return the recommended new solution and derivatives is located in:
* y_new * y_new
* y_dot_new * y_dot_new
* The update delta vector is located in * The update delta vector is located in
@ -2873,7 +2873,7 @@ int NonlinearSolver::solve_nonlinear_problem(int SolnType, doublereal* const y_c
/* /*
* Impose the minimum number of newton iterations critera * Impose the minimum number of newton iterations criteria
*/ */
if (num_newt_its < m_min_newt_its) { if (num_newt_its < m_min_newt_its) {
if (retnDamp > NSOLN_RETN_CONTINUE) { if (retnDamp > NSOLN_RETN_CONTINUE) {

2
src/thermo/SpeciesThermoFactory.cpp
View file

@ -614,7 +614,7 @@ SpeciesThermoInterpType* newSpeciesThermoInterpType(const XML_Node& thermo)
for (size_t i = 1; i < tp.size(); i++) { for (size_t i = 1; i < tp.size(); i++) {
if (lowercase(tp[i]->name()) != thermoType) { if (lowercase(tp[i]->name()) != thermoType) {
throw CanteraError("newSpeciesThermoInterpType", throw CanteraError("newSpeciesThermoInterpType",
"Encounterd unsupported mixed species thermo parameterizations"); "Encountered unsupported mixed species thermo parameterizations");
} }
} }
if ((tp.size() > 2 && thermoType != "nasa9") || if ((tp.size() > 2 && thermoType != "nasa9") ||