[Doc] Fix spelling errors
This commit is contained in:
parent
2b8a597037
commit
51c8d7365a
17 changed files with 31 additions and 31 deletions
|
|
@ -229,7 +229,7 @@ The Transport Model
|
|||
|
||||
A *transport model* is a set of equations used to compute transport
|
||||
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.
|
||||
|
||||
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
|
||||
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
|
||||
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.
|
||||
|
||||
|
|
|
|||
|
|
@ -80,7 +80,7 @@ Make
|
|||
Cantera is distributed with an "include Makefile" that can be used with
|
||||
Make-based build systems. This file ``Cantera.mak`` is located in the
|
||||
``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
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
(in terms of the speed of execution) has been paid to an ideal gas phase
|
||||
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
|
||||
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
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ Reactions
|
|||
---------
|
||||
|
||||
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='')
|
||||
:no-undoc-members:
|
||||
|
|
|
|||
|
|
@ -120,8 +120,8 @@ should be replaced with::
|
|||
>>> w = ct.Water()
|
||||
>>> 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
|
||||
following::
|
||||
|
|
@ -268,7 +268,7 @@ should be replaced with::
|
|||
>>> f.flame.set_transient_tolerances(default=tol_ts)
|
||||
>>> 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::
|
||||
|
||||
>>> gas.addTransportModel('Multi')
|
||||
|
|
|
|||
|
|
@ -240,7 +240,7 @@ protected:
|
|||
* on input:
|
||||
*
|
||||
* 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_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_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
|
||||
* factor. This value is a ratio of the computed
|
||||
* error norms. The premultiplying constants
|
||||
|
|
|
|||
|
|
@ -110,7 +110,7 @@ public:
|
|||
|
||||
//! 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);
|
||||
|
||||
|
|
@ -249,7 +249,7 @@ protected:
|
|||
//! Maximum value of the timestep allowed
|
||||
doublereal m_hmax;
|
||||
|
||||
//! Minimum value of the timestep allowd
|
||||
//! Minimum value of the timestep allowed
|
||||
doublereal m_hmin;
|
||||
|
||||
//! Value of the initial time step
|
||||
|
|
|
|||
|
|
@ -102,7 +102,7 @@ private:
|
|||
//! Create a new thermo manager instance.
|
||||
/*!
|
||||
* @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
|
||||
* Returns a pointer to a new ThermoPhase instance matching the
|
||||
|
|
|
|||
|
|
@ -63,7 +63,7 @@ namespace Cantera
|
|||
* defined in terms of the species mole fraction,
|
||||
* temperature and pressure. Charged species are expected
|
||||
* and quantities like the electric current are computed
|
||||
* based on a combined electrochemcial potential.
|
||||
* based on a combined electrochemical potential.
|
||||
*
|
||||
*
|
||||
* @ingroup tranprops
|
||||
|
|
@ -657,7 +657,7 @@ protected:
|
|||
* \f]
|
||||
*
|
||||
* 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
|
||||
* implemented in MargulesVPSSTP.cpp (LiquidTransport.h doxygen)
|
||||
*/
|
||||
|
|
@ -690,7 +690,7 @@ protected:
|
|||
* The gradient in the activity coefficient requires the use of thermophase
|
||||
* getdlnActCoeff that calculates its change based on a change in the state
|
||||
* 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
|
||||
* 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
|
||||
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
|
||||
/*!
|
||||
* These subclasses of LTPspecies evaluate the species-specific
|
||||
|
|
@ -1239,7 +1239,7 @@ private:
|
|||
*/
|
||||
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;
|
||||
|
||||
//! Flag to indicate that the pure species ionic conductivities
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@ cdef extern from "cantera/base/ct_defs.h" namespace "Cantera":
|
|||
#: Avogadro's Number, /kmol
|
||||
avogadro = CxxAvogadro
|
||||
|
||||
#: The ideal gas constant in J/kmo-K
|
||||
#: The ideal gas constant in J/kmol-K
|
||||
gas_constant = CxxGasConstant
|
||||
|
||||
#: One atmosphere in Pascals
|
||||
|
|
|
|||
|
|
@ -130,7 +130,7 @@ for p in p_range:
|
|||
', reaction mechanism ' + reaction_mechanism)
|
||||
p_previous = p
|
||||
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
|
||||
f.restore(filename=data_directory + file_name, name='solution',
|
||||
loglevel=0)
|
||||
|
|
|
|||
|
|
@ -61,6 +61,6 @@ for m in range(gas.n_reactions):
|
|||
m, (Su-Su0)/(Su0*dk), gas.reaction_equation(m)))
|
||||
|
||||
# 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:')
|
||||
f.show_stats()
|
||||
|
|
|
|||
|
|
@ -208,7 +208,7 @@ class FlameBase(Sim1D):
|
|||
def solution(self, component, point=None):
|
||||
"""
|
||||
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.
|
||||
"""
|
||||
if point is None:
|
||||
|
|
|
|||
|
|
@ -489,7 +489,7 @@ cdef class Wall:
|
|||
|
||||
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`.
|
||||
"""
|
||||
cdef Func1 f
|
||||
|
|
@ -671,7 +671,7 @@ cdef class Valve(FlowDevice):
|
|||
|
||||
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
|
||||
[kg/s/Pa]. If a function is given, it should compute the mass flow
|
||||
rate [kg/s] given the pressure drop [Pa].
|
||||
|
|
@ -871,9 +871,9 @@ cdef class ReactorNet:
|
|||
|
||||
def sensitivities(self):
|
||||
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
|
||||
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:
|
||||
|
||||
.. math:: S_{ki} = \frac{p_i}{y_k} \frac{\partial y_k}{\partial p_i}
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
import warnings
|
||||
|
||||
cdef enum Thermasis:
|
||||
cdef enum ThermoBasis:
|
||||
mass_basis = 0
|
||||
molar_basis = 1
|
||||
|
||||
|
|
|
|||
|
|
@ -1460,7 +1460,7 @@ void NonlinearSolver::setupDoubleDogleg()
|
|||
*/
|
||||
/*
|
||||
* 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
|
||||
* 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
|
||||
/*
|
||||
* 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_dot_new
|
||||
* 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 (retnDamp > NSOLN_RETN_CONTINUE) {
|
||||
|
|
|
|||
|
|
@ -614,7 +614,7 @@ SpeciesThermoInterpType* newSpeciesThermoInterpType(const XML_Node& thermo)
|
|||
for (size_t i = 1; i < tp.size(); i++) {
|
||||
if (lowercase(tp[i]->name()) != thermoType) {
|
||||
throw CanteraError("newSpeciesThermoInterpType",
|
||||
"Encounterd unsupported mixed species thermo parameterizations");
|
||||
"Encountered unsupported mixed species thermo parameterizations");
|
||||
}
|
||||
}
|
||||
if ((tp.size() > 2 && thermoType != "nasa9") ||
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue