GreenPolyProducts/cantera
5
0
Fork 0
mirror of https://github.com/Cantera/cantera.git synced 2024-07-07 04:53:34 -05:00
Code Issues Packages Projects Releases Wiki Activity

[Doc] Eliminate 'i.e.' and 'e.g.'

Browse Source
This commit is contained in:
Ray Speth 2022-04-29 21:44:16 -04:00 committed by Bryan Weber
parent 65b82b9c37
commit 0a7b436683
106 changed files with 228 additions and 226 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
CONTRIBUTING.md
View File

@ -21,9 +21,9 @@
followed by a blank line and a more detailed summary, if any)
* Make related changes in a single commit, and unrelated changes in separate
commits
* Make sure that your commits do not include any undesired files, e.g., files
* Make sure that your commits do not include any undesired files, such as files
produced as part of the build process or other temporary files.
* Use Git's history-rewriting features (i.e., `git rebase -i`; see
* Use Git's history-rewriting features (such as `git rebase -i`; see
https://help.github.com/articles/about-git-rebase/) to organize your commits
and squash "fixup" commits and reversions.
* Do not merge your branch with `main`. If needed, you should rebase your branch
@ -60,11 +60,13 @@
(`&&`/`||`/...), and comparisons (`<`/`>`/`==`/...); before and after equality
signs `=` unless used for the assignment of a default parameter)
* Do not go out of your way to change formatting in otherwise unmodified code
* Write 'for example', 'such as', or 'that is' instead of using the Latin
abbreviations 'i.e.' and 'e.g.'.
## C++
* All classes, member variables, and methods should have Doxygen-style comments
(e.g., comment lines starting with `//!` or comment blocks starting with `/*!`)
(for example, comment lines starting with `//!` or comment blocks starting with `/*!`)
* Avoid defining non-trivial functions in header files
* Header files should include an 'include guard'
* Protected and private member variable names are generally prefixed with
@ -74,7 +76,7 @@
* Do not indent the contents of namespaces
* Code should follow the C++11 standard, with minimum required compiler versions
GCC 4.8, Clang 3.4, MSVC 14.0 (2015) and Intel 15.0.
* Avoid manual memory management (i.e. `new` and `delete`), preferring to use
* Avoid manual memory management (that is, `new` and `delete`), preferring to use
standard library containers, as well as `std::unique_ptr` and
`std::shared_ptr` when dynamic allocation is required.
* Portions of Boost which are "header only" may be used. If possible, include

4
INSTALL.md
View File

@ -5,11 +5,11 @@
To compile using the default options, run `scons build` followed by
`scons install`.
Configuration options are specified with `name=value` on the command line, e.g.:
Configuration options are specified with `name=value` on the command line, for example:
`scons build optimize=n prefix=/home/$USER/cantera`
The full list of configuration options and their default values can be shown by running
`scons help --options`. The list of available `scons` commands (e.g. `build`) can be
`scons help --options`. The list of available `scons` commands (such as `build`) can be
shown by running `scons help`.

8
SConstruct
View File

@ -528,7 +528,7 @@ config_options = [
{"mingw": False, "default": True}),
BoolOption(
"use_rpath_linkage",
"""If enabled, link to all shared libraries using 'rpath', i.e., a fixed
"""If enabled, link to all shared libraries using 'rpath', that is, a fixed
run-time search path for dynamic library loading.""",
True),
Option(
@ -1324,7 +1324,7 @@ if env['system_sundials'] == 'y':
config_error("Failed to determine Sundials version.")
sundials_version = sundials_version.strip(' "\n')
# Ignore the minor version, e.g. 2.4.x -> 2.4
# Ignore the minor version, for example 2.4.x -> 2.4
env['sundials_version'] = '.'.join(sundials_version.split('.')[:2])
sundials_ver = parse_version(env['sundials_version'])
if sundials_ver < parse_version("2.4") or sundials_ver >= parse_version("7.0"):
@ -1656,7 +1656,7 @@ if env["matlab_toolbox"] == "y":
if env['blas_lapack_libs']:
logger.error(
"The Matlab toolbox is incompatible with external BLAS "
"and LAPACK libraries. Unset blas_lapack_libs (e.g. 'scons "
"and LAPACK libraries. Unset blas_lapack_libs (for example, 'scons "
"build blas_lapack_libs=') in order to build the Matlab "
"toolbox, or set 'matlab_toolbox=n' to use the specified BLAS/"
"LAPACK libraries and skip building the Matlab toolbox.")
@ -1665,7 +1665,7 @@ if env["matlab_toolbox"] == "y":
if env["system_sundials"] == "y":
logger.error(
"The Matlab toolbox is incompatible with external SUNDIALS "
"libraries. Set system_sundials to no (e.g., 'scons build "
"libraries. Set system_sundials to no (for example, 'scons build "
"system_sundials=n') in order to build the Matlab "
"toolbox, or set 'matlab_toolbox=n' to use the specified "
"SUNDIALS libraries and skip building the Matlab toolbox.")

2
data/inputs/sofc.cti
View File

@ -9,7 +9,7 @@
#########################################################################
# These units will be used by default for any quantities entered
# without units. Quantities with compound units (e.g. concentration)
# without units. Quantities with compound units (such as concentration)
# will be constructed from these - the units of concentration will be
# mol/cm^3, etc.
units(length = "cm", time = "s", quantity = "mol", act_energy = "kJ/mol")

2
data/sofc.yaml
View File

@ -294,7 +294,7 @@ tpb-reactions:
# this reaction is commented out, but you can explore its effects by
# uncommenting it. Be careful, if you are not solving for the OH'
# concentration that the system does not become overdetermined
# (i.e. impossible for all reactions to be simultaneously in
# (that is, impossible for all reactions to be simultaneously in
# equilibrium). If this happens, the wrong OCVs will result.
# - equation: H(m) + OH'(ox) <=> H2O(ox) + (m) + electron

10
doc/doxygen/thermoprops.dox
View File

@ -29,9 +29,9 @@
* calculated for
* the reference state of each species, the standard state values for
* each species, the thermodynamic functions for solution values, both
* on a per mole of solution basis (i.e., enthalpy_mole()), on a per kg of
* on a per mole of solution basis (such as enthalpy_mole()), on a per kg of
* solution basis, and on a
* partial molar basis for each species (i.e.,
* partial molar basis for each species (such as
* getPartialMolarEnthalpies(double *hbar)).
* At each level, functions for the enthalpy, entropy, Gibbs free energy,
* internal energy, and volume are provided. So, 5 levels (reference state,
@ -415,7 +415,7 @@
* The actual units used in a kinetics expression depend
* on the context or the relative field of study. For example, in
* gas phase kinetics, species in kinetics expressions are expressed in
* terms of concentrations, i.e., gmol cm-3. In solid phase studies,
* terms of concentrations, for example, gmol cm-3. In solid phase studies,
* however, kinetics is usually expressed in terms of unitless activities,
* which most often equate to solid phase mole fractions. In order to
* accommodate variability here, %Cantera has come up with the idea
@ -483,14 +483,14 @@
* one of its arguments.
*
* Within importPhase(), a decision is made as to what type of
* standard state, i.e.,
* standard state, that is,
* either a reference state (just T dependent) or a standard state
* (both P and T dependent), is to be used to calculate the
* standard state properties of the species within the phase.
* If only a reference state is needed
* then a call to newSpeciesThermoMgr()
* is made in order
* pick a manager, i.e., a derivative of the SpeciesThermo
* pick a manager, that is, a derivative of the SpeciesThermo
* object, to use.
*
* Once these determinations are made, the %ThermoPhase object is

2
doc/sphinx/yaml/general.rst
View File

@ -10,7 +10,7 @@ Sections
The top level of a Cantera `YAML <https://yaml.org/spec/1.2/spec.html#Introduction>`__
input file is a mapping that defines different input file sections. Each
section consists of a list of mappings that define objects of the same type,
e.g., reactions, species, phases, or elements. The ``phases`` section of an input
such as reactions, species, phases, or elements. The ``phases`` section of an input
file contains all of the phase definitions. Multiple sections containing
reaction, species, or element definitions can be used. The specific names
``reactions``, ``species``, and ``elements`` are used as defaults when looking

2
doc/sphinx/yaml/reactions.rst
View File

@ -9,7 +9,7 @@ Reactions
The fields common to all ``reaction`` entries are:
``equation``
The stoichiometric equation for the reaction. Each term (i.e.,
The stoichiometric equation for the reaction. Each term (that is,
stoichiometric coefficient, species name, ``+`` or ``<=>``) in the equation
must be separated by a space.

4
doc/sphinx/yaml/species.rst
View File

@ -13,7 +13,7 @@ The fields of a ``species`` entry are:
``composition``
Mapping that specifies the elemental composition of the species,
e.g., ``{C: 1, H: 4}``. Required.
for example, ``{C: 1, H: 4}``. Required.
``thermo``
Mapping containing the reference state thermodynamic model specification
@ -219,7 +219,7 @@ Additional fields of a ``piecewise-Gibbs`` entry are:
``dimensionless``
A boolean flag indicating whether the values of the Gibbs free energy are
given in a dimensionless form, i.e., divided by :math:`RT`. Defaults to
given in a dimensionless form, that is, divided by :math:`RT`. Defaults to
``false``.
``data``

20
include/cantera/base/AnyMap.h
View File

@ -128,7 +128,7 @@ public:
template<class T>
bool is() const;
//! Returns `true` if the held value is a scalar type (e.g. `double`, `long
//! Returns `true` if the held value is a scalar type (such as `double`, `long
//! int`, `string`, or `bool`).
bool isScalar() const;
@ -284,12 +284,12 @@ private:
static bool eq_comparer(const boost::any& lhs, const boost::any& rhs);
//! Helper function for comparing vectors of different (but comparable)
//! types, e.g. `vector<double>` and `vector<long int>`
//! types, for example `vector<double>` and `vector<long int>`
template<class T, class U>
static bool vector_eq(const boost::any& lhs, const boost::any& rhs);
//! Helper function for comparing nested vectors of different (but
//! comparable) types, e.g. `vector<vector<double>>` and
//! comparable) types, for example `vector<vector<double>>` and
//! `vector<vector<long int>>`
template<class T, class U>
static bool vector2_eq(const boost::any& lhs, const boost::any& rhs);
@ -443,8 +443,8 @@ public:
//! this AnyMap, the `keepExisting` option determines which item is used.
void update(const AnyMap& other, bool keepExisting=true);
//! Return a string listing the keys in this AnyMap, e.g. for use in error
//! messages
//! Return a string listing the keys in this AnyMap, for use in error
//! messages, for example
std::string keys_str() const;
//! Set a metadata value that applies to this AnyMap and its children.
@ -472,15 +472,15 @@ public:
//! Convert the item stored by the given `key` to the units specified in
//! `units`. If the stored value is a double, convert it using the default
//! units. If the input is a string, treat this as a dimensioned value, e.g.
//! '988 kg/m^3' and convert from the specified units.
//! units. If the input is a string, treat this as a dimensioned value, such
//! as '988 kg/m^3' and convert from the specified units.
double convert(const std::string& key, const std::string& units) const;
double convert(const std::string& key, const Units& units) const;
//! Convert the item stored by the given `key` to the units specified in
//! `units`. If the stored value is a double, convert it using the default
//! units. If the input is a string, treat this as a dimensioned value, e.g.
//! '988 kg/m^3' and convert from the specified units. If the key is
//! units. If the input is a string, treat this as a dimensioned value, such
//! as '988 kg/m^3' and convert from the specified units. If the key is
//! missing, the `default_` value is returned.
double convert(const std::string& key, const std::string& units,
double default_) const;
@ -489,7 +489,7 @@ public:
/*!
* For each item in the vector, if the stored value is a double, convert it
* using the default units. If the value is a string, treat it as a
* dimensioned value, e.g. '988 kg/m^3', and convert from the specified
* dimensioned value, such as '988 kg/m^3', and convert from the specified
* units.
*
* @param key Location of the vector in this AnyMap

2
include/cantera/base/FactoryBase.h
View File

@ -65,7 +65,7 @@ private:
//!
//! Template arguments for the class are the base type created by the factory,
//! followed by the types of any arguments which need to be passed to the
//! functions used to create objects, e.g. arguments to the constructor.
//! functions used to create objects, that is, arguments to the constructor.
template <class T, typename ... Args>
class Factory : public FactoryBase {
public:

2
include/cantera/base/Interface.h
View File

@ -84,7 +84,7 @@ shared_ptr<Interface> newInterface(const std::string& infile,
/*!
* This constructor wraps newPhase() and newKinetics()
*
* @param phaseNode the node containing the phase definition (i.e. thermo model,
* @param phaseNode the node containing the phase definition (that is, thermo model,
* list of species, and initial state)
* @param rootNode the root node of the tree containing the phase definition, which
* will be used as the default location from which to read species definitions.

2
include/cantera/base/Solution.h
View File

@ -148,7 +148,7 @@ shared_ptr<Solution> newSolution(const std::string& infile,
* This constructor wraps newPhase(), newKinetics() and
* newTransportMgr() routines for initialization.
*
* @param phaseNode the node containing the phase definition (i.e. thermo model,
* @param phaseNode the node containing the phase definition (that is, thermo model,
* list of species, and initial state)
* @param rootNode the root node of the tree containing the phase definition, which
* will be used as the default location from which to read species definitions.

10
include/cantera/base/Units.h
View File

@ -138,7 +138,7 @@ struct UnitStack
* Provides functions for converting dimensional values from a given unit system.
* The main use is for converting values specified in input files to Cantera's
* native unit system, which is SI units except for the use of kmol as the base
* unit of quantity, i.e. kilogram, meter, second, kelvin, ampere, and kmol.
* unit of quantity, that is, kilogram, meter, second, kelvin, ampere, and kmol.
*
* String representations of units can be written using multiplication,
* division, and exponentiation. Spaces are ignored. Positive, negative, and
@ -149,10 +149,10 @@ struct UnitStack
* m*s^-2
* J/kg/K
*
* Metric prefixes are recognized for all units, e.g. nm, hPa, mg, EJ, mL, kcal.
* Metric prefixes are recognized for all units, such as nm, hPa, mg, EJ, mL, kcal.
*
* Special functions for converting activation energies allow these values to be
* expressed as either energy per quantity, energy (e.g. eV), or temperature by
* expressed as either energy per quantity, energy (for example, eV), or temperature by
* applying a factor of the Avogadro number or the gas constant where needed.
*
* @ingroup inputfiles
@ -215,7 +215,7 @@ public:
//! Convert a generic AnyValue node to the units specified in `dest`. If the
//! input is a double, convert it using the default units. If the input is a
//! string, treat this as a dimensioned value, e.g. '988 kg/m^3' and convert
//! string, treat this as a dimensioned value, such as '988 kg/m^3' and convert
//! from the specified units.
double convert(const AnyValue& val, const std::string& dest) const;
double convert(const AnyValue& val, const Units& dest) const;
@ -244,7 +244,7 @@ public:
//! Convert a generic AnyValue node to the units specified in `dest`. If the
//! input is a double, convert it using the default units. If the input is a
//! string, treat this as a dimensioned value, e.g. '2.7e4 J/kmol' and
//! string, treat this as a dimensioned value, such as '2.7e4 J/kmol', and
//! convert from the specified units.
double convertActivationEnergy(const AnyValue& val,
const std::string& dest) const;

6
include/cantera/base/ValueCache.h
View File

@ -24,7 +24,7 @@ namespace Cantera
* to recompute the cached values.
*
* References to CachedValue objects are returned by the "get" methods of
* ValueCache, e.g. ValueCache::getScalar. Functions accessing cached values
* ValueCache, for example ValueCache::getScalar. Functions accessing cached values
* should use the typedefs CachedScalar and CachedArray. See ValueCache for
* details on how these classes should be used together.
*/
@ -103,11 +103,11 @@ struct CachedValue {
}
//! Value of the first state variable for the state at which #value was
//! evaluated, e.g. temperature.
//! evaluated, for example temperature.
double state1;
//! Value of the second state variable for the state at which #value was
//! evaluated, e.g. density or pressure.
//! evaluated, for example density or pressure.
double state2;
//! A surrogate for the composition. For cached properties of Phase,

2
include/cantera/base/config.h.in
View File

@ -5,7 +5,7 @@
// Cantera version -> this will be a double-quoted string value
{CANTERA_VERSION!s}
// Just the major + minor version (i.e. 2.2 instead of 2.2.0)
// Just the major + minor version (that is, 2.2 instead of 2.2.0)
{CANTERA_SHORT_VERSION!s}
//------------------------ Fortran settings -------------------//

8
include/cantera/base/ctexceptions.h
View File

@ -45,7 +45,7 @@ namespace Cantera
* Their first argument is a boolean. If the boolean is not true, a CanteraError
* is thrown, with descriptive information indicating where the error occurred.
* The Assert* checks are skipped if the NDEBUG preprocessor symbol is defined,
* e.g. with the compiler option -DNDEBUG.
* for example with the compiler option -DNDEBUG.
*/
@ -66,10 +66,10 @@ public:
* generated. For member functions, this should be written as
* `ClassName::functionName`. For constructors, this should be
* `ClassName::ClassName`. Arguments can be specified to
* disambiguate overloaded functions, e.g.
* disambiguate overloaded functions, such as
* `ClassName::functionName(int, int)`.
* @param msg Descriptive string describing the type of error message. This
* can be a fmt-style format string (i.e. using curly braces to indicate
* can be a fmt-style format string (that is, using curly braces to indicate
* fields), which will be used with additional arguments to generate a
* formatted error message
* @param args Arguments which will be used to interpolate the format string
@ -186,7 +186,7 @@ private:
class NotImplementedError : public CanteraError
{
public:
//! @param func Name of the unimplemented function, e.g.
//! @param func Name of the unimplemented function, such as
//! `ClassName::functionName`
NotImplementedError(const std::string& func) :
CanteraError(func, "Not implemented.") {}

2
include/cantera/base/global.h
View File

@ -48,7 +48,7 @@ class Logger;
*
* On any platform, if environment variable CANTERA_DATA is set to a directory
* name or a list of directory names separated with the OS-dependent path
* separator (i.e. ";" on Windows, ":" elsewhere), then these directories will
* separator (that is, ";" on Windows, ":" elsewhere), then these directories will
* be added to the search path.
*
* Finally, the location where the data files were installed when

4
include/cantera/equil/ChemEquil.h
View File

@ -72,8 +72,8 @@ public:
* MultiPhaseEquil for many single-phase equilibrium problems (particularly if
* there are only a few elements but very many species), but can be less stable.
* Problem situations include low temperatures where only a few species have
* non-zero mole fractions, precisely stoichiometric compositions (e.g. 2 H2 +
* O2). In general, if speed is important, this solver should be tried first,
* non-zero mole fractions, precisely stoichiometric compositions (for example,
* 2 H2 + O2). In general, if speed is important, this solver should be tried first,
* and if it fails then use MultiPhaseEquil.
* @ingroup equil
*/

2
include/cantera/equil/MultiPhase.h
View File

@ -67,7 +67,7 @@ public:
MultiPhase();
//! Destructor. Does nothing. Class MultiPhase does not take "ownership"
//! (i.e. responsibility for destroying) the phase objects.
//! (that is, responsibility for destroying) the phase objects.
virtual ~MultiPhase() {}
//! Add a vector of phases to the mixture

4
include/cantera/equil/vcs_VolPhase.h
View File

@ -364,7 +364,7 @@ public:
* - VCS_PHASE_EXIST_ALWAYS = 3: Always exists because it contains inerts
* which can't exist in any other phase. Or, the phase exists always
* because it consists of a single species, which is identified with the
* voltage, i.e., it's an electron metal phase.
* voltage, for example, it's an electron metal phase.
*/
int exists() const;
@ -647,7 +647,7 @@ private:
* - VCS_PHASE_EXIST_ALWAYS = 3: Always exists because it contains inerts
* which can't exist in any other phase. Or, the phase exists always
* because it consists of a single species, which is identified with the
* voltage, i.e., its an electron metal phase.
* voltage, for example, its an electron metal phase.
*/
int m_existence;

4
include/cantera/equil/vcs_solve.h
View File

@ -291,7 +291,7 @@ public:
*
* @param stateCalc Determines whether z is old or new or tentative:
* - 1: Use the tentative values for the total number of
* moles in the phases, i.e., use TG1 instead of TG etc.
* moles in the phases, that is, use TG1 instead of TG etc.
* - 0: Use the base values of the total number of
* moles in each system.
*
@ -887,7 +887,7 @@ private:
* - s2 = slope of Gibbs function at al = 1, which is the current
* solution = d(Gibbs)/d(al).
*
* Only if there has been an inflection point (i.e., s1 < 0 and s2 > 0),
* Only if there has been an inflection point (that is, s1 < 0 and s2 > 0),
* does this code section kick in. It finds the point on the parabola
* where the slope is equal to zero.
*/

2
include/cantera/kinetics/BlowersMaselRate.h
View File

@ -137,7 +137,7 @@ public:
protected:
//! Return the effective activation energy (a function of the delta H of reaction)
//! divided by the gas constant (i.e. the activation temperature) [K]
//! divided by the gas constant (that is, the activation temperature) [K]
//! @internal The enthalpy change of reaction is not an independent parameter
double effectiveActivationEnergy_R(double deltaH_R) const {
if (deltaH_R < -4 * m_Ea_R) {

4
include/cantera/kinetics/InterfaceKinetics.h
View File

@ -25,7 +25,7 @@ class InterfaceReaction2;
/*!
* There are some important additions to the behavior of the kinetics class due
* to the presence of multiple phases and a heterogeneous interface. If a
* reactant phase doesn't exists, i.e., has a mole number of zero, a
* reactant phase doesn't exists, that is, has a mole number of zero, a
* heterogeneous reaction can not proceed from reactants to products. Note it
* could perhaps proceed from products to reactants if all of the product phases
* exist.
@ -33,7 +33,7 @@ class InterfaceReaction2;
* In order to make the determination of whether a phase exists or not actually
* involves the specification of additional information to the kinetics object.,
* which heretofore has only had access to intrinsic field information about the
* phases (i.e., temperature pressure, and mole fraction).
* phases (for example, temperature, pressure, and mole fraction).
*
* The extrinsic specification of whether a phase exists or not must be
* specified on top of the intrinsic calculation of the reaction rate. This

2
include/cantera/kinetics/InterfaceRate.h
View File

@ -115,7 +115,7 @@ public:
//! Add a coverage dependency for species *sp*, with exponential dependence
//! *a*, power-law exponent *m*, and activation energy dependence *e*,
//! where *e* is in Kelvin, i.e. energy divided by the molar gas constant.
//! where *e* is in Kelvin, that is, energy divided by the molar gas constant.
void addCoverageDependence(const std::string& sp, double a, double m, double e);
//! Boolean indicating whether rate uses exchange current density formulation

4
include/cantera/kinetics/Kinetics.h
View File

@ -317,7 +317,7 @@ public:
/**
* This function takes as an argument the kineticsSpecies index
* (i.e., the list index in the list of species in the kinetics
* (that is, the list index in the list of species in the kinetics
* manager) and returns the species' owning ThermoPhase object.
*
* @param k Species index
@ -327,7 +327,7 @@ public:
}
/**
* This function takes as an argument the kineticsSpecies index (i.e., the
* This function takes as an argument the kineticsSpecies index (that is, the
* list index in the list of species in the kinetics manager) and returns
* the index of the phase owning the species.
*

4
include/cantera/kinetics/KineticsFactory.h
View File

@ -64,7 +64,7 @@ public:
* calculate the reaction mechanism.
* @param th Vector of phases. The first phase is the phase in which
* the reactions occur, and the subsequent phases (if any)
* are e.g. bulk phases adjacent to a reacting surface.
* are for example bulk phases adjacent to a reacting surface.
* @return Pointer to the new kinetics manager.
*
* @deprecated The XML input format is deprecated and will be removed in
@ -135,7 +135,7 @@ unique_ptr<Kinetics> newKinetics(const std::vector<ThermoPhase*>& phases,
* phase) listed first.
* @param filename File containing the phase definition for the phase where
* the reactions occur. Searches the Cantera data for this file.
* @param phase_name The name of the reacting phase in the input file (i.e. the
* @param phase_name The name of the reacting phase in the input file (that is, the
* name of the first phase in the `phases` vector)
*/
unique_ptr<Kinetics> newKinetics(const std::vector<ThermoPhase*>& phases,

4
include/cantera/kinetics/Reaction.h
View File

@ -414,7 +414,7 @@ struct CoverageDependency
};
//! A reaction occurring on an interface (i.e. a SurfPhase or an EdgePhase)
//! A reaction occurring on an interface (for example, a SurfPhase or an EdgePhase)
class InterfaceReaction2 : public ElementaryReaction2
{
public:
@ -593,7 +593,7 @@ unique_ptr<Reaction> newReaction(const AnyMap& rxn_node,
//!
//! - The rate constants are expressed in (kmol, meter, second) units
//! - A `units` directive is included **and** all reactions take place in
//! bulk (e.g. gas) phases
//! bulk (for example, gas) phases
//!
//! @deprecated The XML input format is deprecated and will be removed in
//! Cantera 3.0.

2
include/cantera/kinetics/ReactionPath.h
View File

@ -320,7 +320,7 @@ protected:
std::vector<std::string> m_elementSymbols;
//! m_transfer[reaction][reactant number][product number] where "reactant
//! number" means the number of the reactant in the reaction equation, e.g.
//! number" means the number of the reactant in the reaction equation. For example,
//! for "A+B -> C+D", "B" is reactant number 1 and "C" is product number 0.
std::map<size_t, std::map<size_t, std::map<size_t, Group> > > m_transfer;

6
include/cantera/kinetics/RxnRates.h
View File

@ -99,7 +99,7 @@ public:
return "Arrhenius2";
}
//! Return the activation energy divided by the gas constant (i.e. the
//! Return the activation energy divided by the gas constant (that is, the
//! activation temperature) [K]
double activationEnergy_R() const {
return m_Ea_R;
@ -140,7 +140,7 @@ public:
//! Add a coverage dependency for species *k*, with exponential dependence
//! *a*, power-law exponent *m*, and activation energy dependence *e*,
//! where *e* is in Kelvin, i.e. energy divided by the molar gas constant.
//! where *e* is in Kelvin, that is, energy divided by the molar gas constant.
void addCoverageDependence(size_t k, doublereal a,
doublereal m, doublereal e);
@ -187,7 +187,7 @@ public:
return m_b;
}
//! Return the activation energy divided by the gas constant (i.e. the
//! Return the activation energy divided by the gas constant (that is, the
//! activation temperature) [K], accounting coverage dependence.
doublereal activationEnergy_R() const {
return m_E + m_ecov;

2
include/cantera/kinetics/StoichManager.h
View File

@ -450,7 +450,7 @@ private:
/*!
* This is used within the interface to select the array position to read
* and write to Normally this is associated with the reaction number in an
* array of quantities indexed by the reaction number, e.g., ROP[irxn].
* array of quantities indexed by the reaction number, for example, ROP[irxn].
*/
size_t m_rxn;

4
include/cantera/kinetics/importKinetics.h
View File

@ -3,7 +3,7 @@
* Definitions of global routines for the importing
* of data from XML files (see \ref inputfiles).
*
* This file contains routines which are global routines, i.e.,
* This file contains routines which are global routines, that is,
* not part of any object. These routine take as input, ctml
* pointers to data, and pointers to %Cantera objects. The purpose
* of these routines is to initialize the %Cantera objects with data
@ -125,7 +125,7 @@ bool buildSolutionFromXML(XML_Node& root, const std::string& id,
//! Check to ensure that all electrochemical reactions are specified correctly
/*!
* This function ensures the user has correctly specified all electrochemical
* reactions. The routine counts the amount of charge (i.e. number of electron
* reactions. The routine counts the amount of charge (that is, number of electron
* elements specified for each species in each phase) for both reactants and
* products. If net charge transfer phases during a reaction, the reaction is
* electrochemical. If not already specified as such, the function defines the

2
include/cantera/kinetics/solveSP.h
View File

@ -435,7 +435,7 @@ private:
//! Vector containing the indices of the largest species
//! in each surface phase
/*!
* `k = m_spSurfLarge[i]` where `k` is the local species index, i.e., it
* `k = m_spSurfLarge[i]` where `k` is the local species index, that is, it
* varies from 0 to (num species in phase - 1) and `i` is the surface
* phase index in the problem. Length is equal to #m_numSurfPhases.
*/

8
include/cantera/oneD/Domain1D.h
View File

@ -277,7 +277,7 @@ public:
/*!
* Set this if something has changed in the governing
* equations (e.g. the value of a constant has been changed,
* equations (for example, the value of a constant has been changed,
* so that the last-computed Jacobian is no longer valid.
*/
void needJacUpdate();
@ -375,7 +375,7 @@ public:
}
/**
* The index of the first (i.e., left-most) grid point belonging to this
* The index of the first (that is, left-most) grid point belonging to this
* domain.
*/
size_t firstPoint() const {
@ -383,7 +383,7 @@ public:
}
/**
* The index of the last (i.e., right-most) grid point belonging to this
* The index of the last (that is, right-most) grid point belonging to this
* domain.
*/
size_t lastPoint() const {
@ -491,7 +491,7 @@ public:
virtual void _finalize(const doublereal* x) {}
/**
* In some cases, for computational efficiency some properties (e.g.
* In some cases, for computational efficiency some properties (such as
* transport coefficients) may not be updated during Jacobian evaluations.
* Set this to `true` to force these properties to be udpated even while
* calculating Jacobian elements.

4
include/cantera/oneD/OneDim.h
View File

@ -194,7 +194,7 @@ public:
*/
Domain1D* pointDomain(size_t i);
//! Call after one or more grids has changed size, e.g. after being refined.
//! Call after one or more grids has changed size, for example after being refined.
virtual void resize();
vector_int& transientMask() {
@ -375,7 +375,7 @@ private:
vector_int m_funcEvals;
vector_fp m_funcElapsed;
//! Number of time steps taken in each call to solve() (e.g. for each
//! Number of time steps taken in each call to solve() (for example, for each
//! successive grid refinement)
vector_int m_timeSteps;
};

4
include/cantera/oneD/Sim1D.h
View File

@ -31,7 +31,7 @@ public:
/**
* Standard constructor.
* @param domains A vector of pointers to the domains to be linked together.
* The domain pointers must be entered in left-to-right order --- i.e.,
* The domain pointers must be entered in left-to-right order --- that is,
* the pointer to the leftmost domain is domain[0], the pointer to the
* domain to its right is domain[1], etc.
*/
@ -148,7 +148,7 @@ public:
/**
* Get the grid refinement criteria. dom must be greater than
* or equal to zero (i.e., the domain must be specified).
* or equal to zero (that is, the domain must be specified).
* @see Refiner::getCriteria
*/
vector_fp getRefineCriteria(int dom);

2
include/cantera/oneD/refine.h
View File

@ -24,7 +24,7 @@ public:
//! Set grid refinement criteria
/*!
* @param ratio Maximum ratio between grid spacing at adjacent intervals.
* E.g. `(x[j+1] - x[j]) / (x[j] - x[j-1]) < ratio`
* That is, `(x[j+1] - x[j]) / (x[j] - x[j-1]) < ratio`
* @param slope Maximum fractional change in the value of each solution
* component between adjacent grid points
* @param curve Maximum fractional change in the derivative of each

4
include/cantera/thermo/DebyeHuckel.h
View File

@ -95,7 +95,7 @@ class PDSS_Water;
* solutes. The molar volume for the water solvent, however, is obtained from a
* pure water equation of state, waterSS. Therefore, the water standard state
* varies with both T and P. It is an error to request standard state water
* properties at a T and P where the water phase is not a stable phase, i.e.,
* properties at a T and P where the water phase is not a stable phase, that is,
* beyond its spinodal curve.
*
* ## Specification of Solution Thermodynamic Properties
@ -629,7 +629,7 @@ public:
//! Return the standard concentration for the kth species
/*!
* The standard concentration \f$ C^0_k \f$ used to normalize the activity
* (i.e., generalized) concentration in kinetics calculations.
* (that is, generalized) concentration in kinetics calculations.
*
* For the time being, we will use the concentration of pure solvent for the
* the standard concentration of all species. This has the effect of making

4
include/cantera/thermo/GibbsExcessVPSSTP.h
View File

@ -138,7 +138,7 @@ public:
* for all species in a phase - for example, for an ideal gas
* \f$ C^0_k = P/\hat R T \f$. For this reason, this method returns a single
* value, instead of an array. However, for phases in which the standard
* concentration is species-specific (e.g. surface species of different
* concentration is species-specific (for example, surface species of different
* sizes), this method may be called with an optional parameter indicating
* the species.
*
@ -190,7 +190,7 @@ public:
* This function is a virtual method. For ideal mixtures (unity activity
* coefficients), this can return zero. Implementations should take the
* derivative of the logarithm of the activity coefficient with respect to
* the logarithm of the concentration-like variable (i.e. number of moles in
* the logarithm of the concentration-like variable (for example, number of moles in
* in a unit volume. ) that represents the standard state. This quantity is
* to be used in conjunction with derivatives of that concentration-like
* variable when the derivative of the chemical potential is taken.

8
include/cantera/thermo/HMWSoln.h
View File

@ -122,7 +122,7 @@ class WaterProps;
* solutes. The molar volume for the water solvent, however, is obtained from a
* pure water equation of state, waterSS. Therefore, the water standard state
* varies with both T and P. It is an error to request standard state water
* properties at a T and P where the water phase is not a stable phase, i.e.,
* properties at a T and P where the water phase is not a stable phase, that is,
* beyond its spinodal curve.
*
* ## Specification of Solution Thermodynamic Properties
@ -1198,7 +1198,7 @@ public:
//! Return the standard concentration for the kth species
/*!
* The standard concentration \f$ C^0_k \f$ used to normalize the activity
* (i.e., generalized) concentration for use
* (that is, generalized) concentration for use
*
* We have set the standard concentration for all solute species in this
* phase equal to the default concentration of the solvent at the system
@ -1938,7 +1938,7 @@ private:
* Array of 2D data used in the Pitzer/HMW formulation. Lambda_nj[n][j]
* represents the lambda coefficient for the ij interaction. This is a
* general interaction representing neutral species. The neutral species
* occupy the first index, i.e., n. The charged species occupy the j
* occupy the first index, that is, n. The charged species occupy the j
* coordinate. neutral, neutral interactions are also included here.
*/
mutable Array2D m_Lambda_nj;
@ -1957,7 +1957,7 @@ private:
* Array of 2D data used in the Pitzer/HMW formulation. Lambda_ij[i][j]
* represents the lambda coefficient for the ij interaction. This is a
* general interaction representing neutral species. The neutral species
* occupy the first index, i.e., i. The charged species occupy the j
* occupy the first index, that is, i. The charged species occupy the j
* coordinate. Neutral, neutral interactions are also included here.
*
* n = j + m_kk * i

2
include/cantera/thermo/IdealSolidSolnPhase.h
View File

@ -450,7 +450,7 @@ public:
//! current T and P of the solution.
/*!
* Note, this is equal to the reference state entropies due to the zero
* volume expansivity: i.e., (dS/dP)_T = (dV/dT)_P = 0.0
* volume expansivity: that is, (dS/dP)_T = (dV/dT)_P = 0.0
*
* @param sr Vector of length m_kk, which on return sr[k] will contain the
* nondimensional standard state entropy for species k.

4
include/cantera/thermo/IonsFromNeutralVPSSTP.h
View File

@ -205,7 +205,7 @@ public:
//! Calculate neutral molecule mole fractions
/*!
* This routine calculates the neutral molecule mole fraction given the
* vector of ion mole fractions, i.e., the mole fractions from this
* vector of ion mole fractions, that is, the mole fractions from this
* ThermoPhase. Note, this routine basically assumes that there is charge
* neutrality. If there isn't, then it wouldn't make much sense.
*
@ -252,7 +252,7 @@ public:
//! Calculate neutral molecule mole fractions
/*!
* This routine calculates the neutral molecule mole fraction given the
* vector of ion mole fractions, i.e., the mole fractions from this
* vector of ion mole fractions, that is, the mole fractions from this
* ThermoPhase. Note, this routine basically assumes that there is charge
* neutrality. If there isn't, then it wouldn't make much sense.
*

2
include/cantera/thermo/LatticePhase.h
View File

@ -372,7 +372,7 @@ public:
//! Return the standard concentration for the kth species
/*!
* The standard concentration \f$ C^0_k \f$ used to normalize
* the activity (i.e., generalized) concentration for use
* the activity (that is, generalized) concentration for use
*
* For the time being, we will use the concentration of pure solvent for the
* the standard concentration of all species. This has the effect of making

2
include/cantera/thermo/MultiSpeciesThermo.h
View File

@ -19,7 +19,7 @@ namespace Cantera
/*!
* This is a general manager that can handle a wide variety of species
* thermodynamic polynomials for individual species and compute their
* nondimensional, reference-state thermodynamic properties (i.e. as a function
* nondimensional, reference-state thermodynamic properties (that is, as a function
* of temperature only).
*
* The ThermoPhase object relies on MultiSpeciesThermo to calculate the

6
include/cantera/thermo/PDSS.h
View File

@ -26,7 +26,7 @@ namespace Cantera
* necessary to know something about the thermodynamic properties of the
* individual species present in the solution. Exactly what sort of species
* properties are required depends on the thermodynamic model for the solution.
* For a gaseous solution (i.e., a gas mixture), the species properties required
* For a gaseous solution (that is, a gas mixture), the species properties required
* are usually ideal gas properties at the mixture temperature and at a
* reference pressure (almost always at 1 bar). For other types of solutions,
* however, it may not be possible to isolate the species in a "pure" state. For
@ -113,7 +113,7 @@ namespace Cantera
* represent a duplication of work. Additionally, when evaluating thermodynamic
* properties at higher pressures and temperatures, near the critical point,
* evaluation of the thermodynamics at a pressure of 1 bar may lead to
* situations where the liquid is unstable, i.e., beyond the spinodal curve
* situations where the liquid is unstable, that is, beyond the spinodal curve
* leading to potentially wrong evaluation results.
*
* @ingroup thermoprops
@ -414,7 +414,7 @@ public:
*/
virtual void initThermo() {}
//! Set model parameters from an AnyMap phase description, e.g. from the
//! Set model parameters from an AnyMap phase description, for example from the
//! `equation-of-state` field of a species definition.
void setParameters(const AnyMap& node) {
m_input = node;

18
include/cantera/thermo/Phase.h
View File

@ -141,8 +141,8 @@ public:
*
* However, the name field may be changed to another value during the
* course of a calculation. For example, if duplicates of a phase object
* are instantiated and used in multiple places (e.g. a ReactorNet), they
* will have the same constitutive input, i.e. the names of the phases will
* are instantiated and used in multiple places (such as a ReactorNet), they
* will have the same constitutive input, that is, the names of the phases will
* be the same. Note that this is not a problem for Cantera internally;
* however, a user may want to rename phase objects in order to clarify.
*/
@ -312,7 +312,7 @@ public:
//! Full states list combinations of properties that allow for the
//! specification of a thermodynamic state based on user input.
//! Properties and states are represented by single letter acronyms, and
//! combinations of letters, respectively (e.g. "TDY", "TPX", "SVX").
//! combinations of letters, respectively (for example, "TDY", "TPX", "SVX").
//! Supported property acronyms are:
//! "T": temperature
//! "P": pressure
@ -330,7 +330,7 @@ public:
//! Return a vector of settable partial property sets within a phase.
//! Partial states encompass all valid combinations of properties that allow
//! for the specification of a state while ignoring species concentrations
//! (e.g. "TD", "TP", "SV").
//! (such as "TD", "TP", "SV").
virtual std::vector<std::string> partialStates() const;
//! Return size of vector defining internal state of the phase.
@ -775,7 +775,7 @@ public:
//! which is interpreted as an unknown, and if used will cause
//! %Cantera to throw an error.
//! @param elem_type Specifies the type of the element constraint
//! equation. This defaults to CT_ELEM_TYPE_ABSPOS, i.e., an element.
//! equation. This defaults to CT_ELEM_TYPE_ABSPOS, that is, an element.
//! @return index of the element added
size_t addElement(const std::string& symbol, doublereal weight=-12345.0,
int atomicNumber=0, doublereal entropy298=ENTROPY298_UNKNOWN,
@ -802,12 +802,12 @@ public:
*/
virtual void modifySpecies(size_t k, shared_ptr<Species> spec);
//! Add a species alias (i.e. user-defined alternative species name).
//! Add a species alias (that is, a user-defined alternative species name).
//! Aliases are case-sensitive.
//! @param name original species name std::string.
//! @param alias alternate name std::string.
//! @return `true` if the alias was successfully added
//! (i.e. the original species name is found)
//! (that is, the original species name is found)
void addSpeciesAlias(const std::string& name, const std::string& alias);
//! Return a vector with isomers names matching a given composition map
@ -869,7 +869,7 @@ public:
}
//! Set flag that determines whether case sensitive species are enforced
//! in look-up operations, e.g. speciesIndex
//! in look-up operations, for example speciesIndex
void setCaseSensitiveSpecies(bool cflag = true) {
m_caseSensitiveSpecies = cflag;
}
@ -911,7 +911,7 @@ protected:
//! Set the internally stored constant density (kg/m^3) of the phase.
//! Used for incompressible phases where the density is not an independent
//! variable, e.g. density does not affect pressure in state calculations.
//! variable, that is, density does not affect pressure in state calculations.
//! @param[in] density_ density (kg/m^3).
void assignDensity(const double density_);

2
include/cantera/thermo/RedlichKisterVPSSTP.h
View File

@ -425,7 +425,7 @@ private:
//! coefficients with respect to the log of the mole fractions.
/*!
* This function will be called to update the internally stored vector of
* the total derivatives (i.e. not assuming other mole fractions are
* the total derivatives (that is, not assuming other mole fractions are
* constant) of the natural logarithm of the activity coefficients with
* respect to the log of the mole fraction.
*/

4
include/cantera/thermo/ShomatePoly.h
View File

@ -51,7 +51,7 @@ namespace Cantera
* http://webbook.nist.gov/
*
* Before being used within Cantera, the dimensions must be adjusted to those
* used by Cantera (i.e., Joules and kmol).
* used by Cantera (for example, Joules and kmol).
*
* @ingroup spthermo
*/
@ -224,7 +224,7 @@ protected:
* http://webbook.nist.gov/
*
* Before being used within Cantera, the dimensions must be adjusted to those
* used by Cantera (i.e., Joules and kmol).
* used by Cantera (for example, Joules and kmol).
*
* This function uses two temperature regions, each with a Shomate polynomial
* representation to represent the thermo functions. There are 15 coefficients,

2
include/cantera/thermo/SingleSpeciesTP.h
View File

@ -44,7 +44,7 @@ namespace Cantera
*
* Note, this class can handle the thermodynamic description of one phase of one
* species. It can not handle the description of phase equilibrium between two
* phases of a stoichiometric compound (e.g. water liquid and water vapor, below
* phases of a stoichiometric compound (such as water liquid and water vapor, below
* the critical point). However, it may be used to describe the thermodynamics
* of one phase of such a compound even past the phase equilibrium point, up to
* the point where the phase itself ceases to be a stable phase.

2
include/cantera/thermo/Species.h
View File

@ -57,7 +57,7 @@ public:
//! Thermodynamic data for the species
shared_ptr<SpeciesThermoInterpType> thermo;
//! Input parameters used to define a species, e.g. from a YAML input file.
//! Input parameters used to define a species, for example from a YAML input file.
AnyMap input;
};

2
include/cantera/thermo/SpeciesThermoFactory.h
View File

@ -56,7 +56,7 @@ SpeciesThermoInterpType* newSpeciesThermoInterpType(const XML_Node& thermoNode);
//! Create a new SpeciesThermoInterpType object using the specified parameters
/*!
* @param thermo_node An AnyMap specifying the model type (e.g. "NASA") and any
* @param thermo_node An AnyMap specifying the model type (for example, "NASA") and any
* model parameters necessary to instantiate the object
*/
unique_ptr<SpeciesThermoInterpType> newSpeciesThermo(const AnyMap& thermo_node);

2
include/cantera/thermo/SpeciesThermoInterpType.h
View File

@ -28,7 +28,7 @@ class PDSS;
* necessary to know something about the thermodynamic properties of the
* individual species present in the solution. Exactly what sort of species
* properties are required depends on the thermodynamic model for the solution.
* For a gaseous solution (i.e., a gas mixture), the species properties
* For a gaseous solution (that is, a gas mixture), the species properties
* required are usually ideal gas properties at the mixture temperature and at
* a reference pressure (almost always at 1 bar). For other types of solutions,
* however, it may not be possible to isolate the species in a "pure" state.

2
include/cantera/thermo/StoichSubstance.h
View File

@ -235,7 +235,7 @@ public:
//! Return the standard concentration for the kth species
/*!
* The standard concentration \f$ C^0_k \f$ used to normalize the activity
* (i.e., generalized) concentration. This phase assumes that the kinetics
* (that is, generalized) concentration. This phase assumes that the kinetics
* operator works on an dimensionless basis. Thus, the standard
* concentration is equal to 1.0.
*

2
include/cantera/thermo/SurfPhase.h
View File

@ -224,7 +224,7 @@ public:
//! Return the standard concentration for the kth species
/*!
* The standard concentration \f$ C^0_k \f$ used to normalize the activity
* (i.e., generalized) concentration. For this phase, the standard
* (that is, generalized) concentration. For this phase, the standard
* concentration is species- specific
*
* \f[

6
include/cantera/thermo/ThermoFactory.h
View File

@ -133,7 +133,7 @@ ThermoPhase* newPhase(XML_Node& phase);
//! Create a new ThermoPhase object and initialize it
/*!
* @param phaseNode The node containing the phase definition (i.e. thermo
* @param phaseNode The node containing the phase definition (that is, thermo
* model, list of species, and initial state)
* @param rootNode The root node of the tree containing the phase definition,
* which will be used as the default location from which to read species
@ -197,7 +197,7 @@ ThermoPhase* newPhase(const std::string& infile, std::string id="");
* Finally, we call initThermoXML(), a member function of the ThermoPhase
* object, to "finish" the description. Now that the species are known,
* additional information may be read in about the thermodynamics of the phase,
* (e.g., virial coefficients, which are binary or ternary interaction
* (for example, virial coefficients, which are binary or ternary interaction
* parameters between species).
*
* @param phase This object must be the phase node of a complete XML tree
@ -219,7 +219,7 @@ void importPhase(XML_Node& phase, ThermoPhase* th);
//! Initialize a ThermoPhase object
/*!
* @param phase The ThermoPhase object to be initialized
* @param phaseNode The node containing the phase definition (i.e. thermo
* @param phaseNode The node containing the phase definition (that is, thermo
* model, list of species, and initial state)
* @param rootNode The root node of the tree containing the phase definition,
* which will be used as the default location from which to read species

6
include/cantera/thermo/ThermoPhase.h
View File

@ -408,11 +408,11 @@ public:
//! Return the standard concentration for the kth species
/*!
* The standard concentration \f$ C^0_k \f$ used to normalize the activity
* (i.e., generalized) concentration. In many cases, this quantity will be
* (that is, generalized) concentration. In many cases, this quantity will be
* the same for all species in a phase - for example, for an ideal gas \f$
* C^0_k = P/\hat R T \f$. For this reason, this method returns a single
* value, instead of an array. However, for phases in which the standard
* concentration is species-specific (e.g. surface species of different
* concentration is species-specific (such as surface species of different
* sizes), this method may be called with an optional parameter indicating
* the species.
*
@ -1809,7 +1809,7 @@ public:
* For ideal mixtures (unity activity coefficients), this can return zero.
* Implementations should take the derivative of the logarithm of the
* activity coefficient with respect to the logarithm of the concentration-
* like variable (i.e. moles) that represents the standard state. This
* like variable (for example, moles) that represents the standard state. This
* quantity is to be used in conjunction with derivatives of that species
* mole number variable when the derivative of the chemical potential is
* taken.

2
include/cantera/thermo/WaterPropsIAPWS.h
View File

@ -76,7 +76,7 @@ namespace Cantera
* density over its entire range.
*
* Note, the base thermodynamic state for this class is the one used in the
* steam tables, i.e., the liquid at the triple point for water has the
* steam tables, such that the liquid at the triple point for water has the
* following properties:
*
* - u(273.16, rho) = 0.0

2
include/cantera/transport/TransportBase.h
View File

@ -256,7 +256,7 @@ public:
*
* mobRat(i,j) = mu_i / mu_j
*
* It is returned in fortran-ordering format. i.e. it is returned as
* It is returned in fortran-ordering format. That is, it is returned as
* mobRat[k], where
*
* k = j * nsp + i

6
include/cantera/zeroD/ReactorNet.h
View File

@ -19,7 +19,7 @@ class Integrator;
/*!
* This class is used to integrate the time-dependent governing equations for
* a network of reactors (Reactor, ConstPressureReactor) connected by various
* means, e.g. Wall, MassFlowController, Valve, PressureController.
* means, for example Wall, MassFlowController, Valve, or PressureController.
*
* @ingroup ZeroD
*/
@ -197,13 +197,13 @@ public:
//! Return the name of the i-th component of the global state vector. The
//! name returned includes both the name of the reactor and the specific
//! component, e.g. `'reactor1: CH4'`.
//! component, for example `'reactor1: CH4'`.
std::string componentName(size_t i) const;
//! Used by Reactor and Wall objects to register the addition of
//! sensitivity parameters so that the ReactorNet can keep track of the
//! order in which sensitivity parameters are added.
//! @param name A name describing the parameter, e.g. the reaction string
//! @param name A name describing the parameter, for example the reaction string
//! @param value The nominal value of the parameter
//! @param scale A scaling factor to be applied to the sensitivity
//! coefficient

6
include/cantera/zeroD/Wall.h
View File

@ -39,7 +39,7 @@ public:
//! Rate of volume change (m^3/s) for the adjacent reactors.
/*!
* This method is called by Reactor::evalWalls(). Base class method
* does nothing (i.e. constant volume), but may be overloaded.
* does nothing (that is, constant volume), but may be overloaded.
*/
virtual double vdot(double t) {
return 0.0;
@ -48,7 +48,7 @@ public:
//! Heat flow rate through the wall (W).
/*!
* This method is called by Reactor::evalWalls(). Base class method
* does nothing (i.e. adiabatic wall), but may be overloaded.
* does nothing (that is, an adiabatic wall), but may be overloaded.
*/
virtual double Q(double t) {
return 0.0;
@ -108,7 +108,7 @@ public:
return "Wall";
}
//! Set the wall velocity to a specified function of time, i.e. \f$ v(t) \f$.
//! Set the wall velocity to a specified function of time, \f$ v(t) \f$.
void setVelocity(Func1* f=0) {
if (f) {
m_vf = f;

8
interfaces/cython/cantera/ck2yaml.py
View File

@ -39,9 +39,9 @@ The '--single-intermediate-temperature' option should be used with thermo data w
only a single break temperature is used and the last value in the first line of each
species thermo entry is the molecular weight instead.
The '--permissive' option allows certain recoverable parsing errors (e.g.
The '--permissive' option allows certain recoverable parsing errors (such as
duplicate transport data) to be ignored. The '--name=<name>' option
is used to override default phase names (i.e. 'gas').
is used to override default phase names (that is, 'gas').
The '--extra=<filename>' option takes a YAML file as input. This option can be
used to add to the file description, or to define custom fields that are
@ -317,7 +317,7 @@ class Reaction:
def __str__(self):
"""
Return a string representation of the reaction, e.g. 'A + B <=> C + D'.
Return a string representation of the reaction, such as 'A + B <=> C + D'.
"""
return '{}{}{}'.format(self._coeff_string(self.reactants),
' <=> ' if self.reversible else ' => ',
@ -1384,7 +1384,7 @@ class Parser:
efficiencies=efficiencies)
elif reaction.third_body:
raise InputError('Reaction equation implies pressure '
'dependence but no alternate rate parameters (i.e. HIGH or '
'dependence but no alternate rate parameters (such as HIGH or '
'LOW) were given for reaction {}.', reaction)
elif surface:
reaction.kinetics = SurfaceRate(rate=arrhenius,

24
interfaces/cython/cantera/composite.py
View File

@ -375,7 +375,7 @@ class SolutionArray:
Computed properties are returned as *NumPy* arrays with the same shape as the
array of states, with additional dimensions appended as necessary for non-
scalar output (e.g. per-species or per-reaction properties)::
scalar output (for example, per-species or per-reaction properties)::
>>> h = states.enthalpy_mass
>>> h[i,j] # -> enthalpy at P[i] and T[j]
@ -401,10 +401,10 @@ class SolutionArray:
>>> states[0].TP = 400, None # set the temperature of the first row to 400 K
>>> cp = states[:,1].cp_mass # heat capacity of the second column
If many slices or elements of a property are going to be accessed (i.e.
If many slices or elements of a property are going to be accessed (for example,
within a loop), it is generally more efficient to compute the property array
once and access this directly, rather than repeatedly slicing the
`SolutionArray` object, e.g.::
`SolutionArray` object, for example::
>>> mu = states.viscosity
>>> for i,j in np.ndindex(mu.shape):
@ -668,7 +668,7 @@ class SolutionArray:
mystates.append(gas.state)
- as a tuple of three elements that corresponds to any of the full-state
setters of `Solution`, e.g. `TPY` or `HPX`::
setters of `Solution`, such as `TPY` or `HPX`::
mystates.append(TPX=(300, 101325, 'O2:1.0, N2:3.76'))
@ -805,7 +805,7 @@ class SolutionArray:
`collect_data`.
:param data: Dictionary holding data to be restored, where keys
refer to thermodynamic states (e.g. ``T``, ``density``) or extra
refer to thermodynamic states (for example, ``T``, ``density``) or extra
entries, and values contain corresponding data.
:param normalize: If True, mole or mass fractions are normalized
so that they sum up to 1.0. If False, mole or mass fractions
@ -938,7 +938,7 @@ class SolutionArray:
# labels may include calculated properties that must not be restored:
# compare column labels to names that are reserved for SolutionArray
# attributes (see `SolutionArray.collect_data`), i.e. scalar values,
# attributes (see `SolutionArray.collect_data`), such as scalar values,
# arrays with number of species, and arrays with number of reactions.
exclude = [lab for lab in labels
if any([lab in self._scalar,
@ -1039,7 +1039,7 @@ class SolutionArray:
:param threshold: Relative tolerance for including a particular column
if tabular output is enabled. The tolerance is applied by comparing
the maximum absolute value for a particular column to the maximum
absolute value in all columns for the same variable (e.g. mass
absolute value in all columns for the same variable (for example, mass
fraction).
:param species: Specifies whether to use mass ('Y') or mole ('X')
fractions for individual species specified in 'cols'
@ -1337,9 +1337,9 @@ class SolutionArray:
Optional name identifier for a subgroup representing a `SolutionArray`
object to be read. If 'None', no subgroup is assumed to exist.
:param force: If False, matching `SolutionArray` source identifiers are
enforced (e.g. input file used for the creation of the underlying
`Solution` object), with an error being raised if the current source
does not match the original source. If True, the error is
enforced (for example, the input file used for the creation of the
underlying `Solution` object), with an error being raised if the current
source does not match the original source. If True, the error is
suppressed.
:param normalize: Passed on to `restore_data`. If True, mole or mass
fractions are normalized so that they sum up to 1.0. If False, mole
@ -1430,7 +1430,7 @@ class SolutionArray:
def _state2_prop(name, doc_source):
# Factory for creating properties which consist of a tuple of two variables,
# e.g. 'TP' or 'SV'
# such as 'TP' or 'SV'
def getter(self):
a = np.empty(self._shape)
b = np.empty(self._shape)
@ -1452,7 +1452,7 @@ def _state2_prop(name, doc_source):
def _state3_prop(name, doc_source, scalar=False):
# Factory for creating properties which consist of a tuple of three
# variables, e.g. 'TPY' or 'UVX'
# variables, such as 'TPY' or 'UVX'
def getter(self):
a = np.empty(self._shape)
b = np.empty(self._shape)

2
interfaces/cython/cantera/cti2yaml.py
View File

@ -646,7 +646,7 @@ class reaction:
:param order:
Override the default reaction orders implied by the reactant
stoichiometric coefficients. Given as a string of key:value pairs,
e.g., ``"CH4:0.25 O2:1.5"``.
for example, ``"CH4:0.25 O2:1.5"``.
:param options:
Processing options, as described in
`Options <https://cantera.org/tutorials/cti/reactions.html#options>`__.

22
interfaces/cython/cantera/ctml2yaml.py
View File

@ -832,8 +832,8 @@ class Phase:
instance ``attribs`` dictionary because the attribute could be a mapping or
a list of mappings, whereas this argument is always a list of mappings.
:param species_data:
Mapping of species data sources (i.e., ``id`` attributes on ``speciesData``
nodes) to lists of `Species` instances.
Mapping of species data sources (that is, ``id`` attributes on
``speciesData`` nodes) to lists of `Species` instances.
Some species include a charge node that adds an electron to the species
composition. The `Phase`s that include these species don't necessarily include
@ -874,8 +874,8 @@ class Phase:
:param activity_coeffs:
XML ``activityCoefficients`` node.
:param species_data:
Mapping of species data sources (i.e., ``id`` attributes on ``speciesData``
nodes) to lists of `Species` instances.
Mapping of species data sources (that is, ``id`` attributes on
``speciesData`` nodes) to lists of `Species` instances.
The YAML format moves the specification of Redlich-Kwong binary interaction
parameters from the `Phase` node into the `Species` nodes. This modifies the
@ -996,8 +996,8 @@ class Phase:
:param phase_thermo:
XML ``thermo`` node.
:param species_data:
Mapping of species data sources (i.e., ``id`` attributes on ``speciesData``
nodes) to lists of `Species` instances.
Mapping of species data sources (that is, ``id`` attributes on
``speciesData`` nodes) to lists of `Species` instances.
The YAML format moves the specification of density for ``StoichSubstance``
phase-thermo types from the `Phase` node into the `Species` nodes. This modifies
@ -1144,7 +1144,7 @@ class Phase:
The text specified in the ``filter`` node telling which reactions are being
filtered.
:param reaction_data:
Mapping of reaction data sources (i.e., ``id`` attributes on
Mapping of reaction data sources (that is, ``id`` attributes on
``reactionData`` nodes) to lists of `Reaction` instances.
The YAML format does not support filtering reactions by setting options in the
@ -1320,8 +1320,8 @@ class Phase:
:param activity_node:
XML ``activityCoefficients`` node.
:param species_data:
Mapping of species data sources (i.e., ``id`` attributes on ``speciesData``
nodes) to lists of `Species` instances.
Mapping of species data sources (that is, ``id`` attributes on
``speciesData`` nodes) to lists of `Species` instances.
"""
model_map = {
"dilute_limit": "dilute-limit",
@ -2215,7 +2215,7 @@ class Reaction:
troe_names = ["A", "T3", "T1", "T2"]
reaction_attribs["Troe"] = FlowMap()
# zip stops when the shortest iterable is exhausted. If T2 is not present
# in the Troe parameters (i.e., troe_params is three elements long), it
# in the Troe parameters (that is, troe_params is three elements long), it
# will be omitted here as well.
for name, param in zip(troe_names, troe_params):
reaction_attribs["Troe"].update({name: float(param)}) # type: ignore
@ -2254,7 +2254,7 @@ class Reaction:
troe_names = ["A", "T3", "T1", "T2"]
reaction_attribs["Troe"] = FlowMap()
# zip stops when the shortest iterable is exhausted. If T2 is not present
# in the Troe parameters (i.e., troe_params is three elements long), it
# in the Troe parameters (that is, troe_params is three elements long), it
# will be omitted here as well.
for name, param in zip(troe_names, troe_params):
reaction_attribs["Troe"].update({name: float(param)})

2
interfaces/cython/cantera/examples/reactors/NonIdealShockTube.py
View File

@ -7,7 +7,7 @@ In this example we illustrate how to setup and use a constant volume,
adiabatic reactor to simulate reflected shock tube experiments. This reactor
will then be used to compute the ignition delay of a gas at a specified
initial temperature and pressure. The example is written in a general way,
i.e., no particular EoS is presumed and ideal and real gas EoS can be used
that is, no particular EoS is presumed and ideal and real gas EoS can be used
equally easily.
The reactor (system) is simply an 'insulated box,' and can technically be used

4
interfaces/cython/cantera/func1.pyx
View File

@ -24,10 +24,10 @@ cdef double func_callback(double t, void* obj, void** err):
cdef class Func1:
"""
This class is used as a wrapper for a function of one variable, i.e.
This class is used as a wrapper for a function of one variable,
:math:`y = f(t)`, that is defined in Python and can be called by the
Cantera C++ core. `Func1` objects are constructed from callable Python
objects, e.g. functions or classes which implement the `__call__` method::
objects, for example functions or classes which implement the `__call__` method::
>>> f1 = Func1(math.sin)
>>> f1(math.pi/4)

4
interfaces/cython/cantera/kinetics.pyx
View File

@ -5,7 +5,7 @@ from ctypes import c_int
# NOTE: These cdef functions cannot be members of Kinetics because they would
# cause "layout conflicts" when creating derived classes with multiple bases,
# e.g. class Solution. [Cython 0.16]
# such as class Solution. [Cython 0.16]
cdef np.ndarray get_species_array(Kinetics kin, kineticsMethod1d method):
cdef np.ndarray[np.double_t, ndim=1] data = np.empty(kin.n_total_species)
if kin.n_total_species == 0:
@ -164,7 +164,7 @@ cdef class Kinetics(_SolutionBase):
"""
Modify the `Reaction` with index ``irxn`` to have the same rate
parameters as ``rxn``. ``rxn`` must have the same reactants and products
and be of the same type (i.e. `ElementaryReaction`, `FalloffReaction`,
and be of the same type (for example, `ElementaryReaction`, `FalloffReaction`,
`PlogReaction`, etc.) as the existing reaction. This method does not
modify the third-body efficiencies, reaction orders, or reversibility of
the reaction.

8
interfaces/cython/cantera/onedim.py
View File

@ -296,7 +296,7 @@ class FlameBase(Sim1D):
@property
def spread_rate(self):
"""
Array containing the tangential velocity gradient [1/s] (e.g. radial
Array containing the tangential velocity gradient [1/s] (that is, radial
velocity divided by radius) at each point.
"""
return self.profile(self.flame, 'spread_rate')
@ -387,7 +387,7 @@ class FlameBase(Sim1D):
:param filename:
Output file name
:param species:
Attribute to use obtaining species profiles, e.g. ``X`` for
Attribute to use obtaining species profiles, for example ``X`` for
mole fractions or ``Y`` for mass fractions.
:param normalize:
Boolean flag to indicate whether the mole/mass fractions should
@ -459,7 +459,7 @@ class FlameBase(Sim1D):
Return the solution vector as a `pandas.DataFrame`.
:param species:
Attribute to use obtaining species profiles, e.g. ``X`` for
Attribute to use obtaining species profiles, for example ``X`` for
mole fractions or ``Y`` for mass fractions.
:param normalize:
Boolean flag to indicate whether the mole/mass fractions should
@ -542,7 +542,7 @@ class FlameBase(Sim1D):
Identifier for the group in the container file. A group may contain
multiple `SolutionArray` objects.
:param species:
Attribute to use obtaining species profiles, e.g. ``X`` for
Attribute to use obtaining species profiles, for example ``X`` for
mole fractions or ``Y`` for mass fractions.
:param mode:
Mode *h5py* uses to open the output file {'a' to read/write if file

8
interfaces/cython/cantera/onedim.pyx
View File

@ -27,7 +27,7 @@ cdef class Domain1D:
property phase:
"""
Phase describing the domain (i.e. gas phase or surface phase).
Phase describing the domain (that is, a gas phase or surface phase).
"""
def __get__(self):
return self.gas
@ -736,7 +736,7 @@ cdef class Sim1D:
def phase(self, domain=None):
"""
Return phase describing a domain (i.e. gas phase or surface phase).
Return phase describing a domain (that is, a gas phase or surface phase).
:param domain: Index of domain within `Sim1D.domains` list; the default
is to return the phase of the parent `Sim1D` object.
@ -1015,7 +1015,7 @@ cdef class Sim1D:
Derived classes set default values for ``domain`` and ``other``, where
defaults describe flow domain and essential non-thermodynamic solution
components of the configuration, respectively. An alternative ``domain``
(e.g. inlet, outlet, etc.), can be specified either by name or the
(such as inlet, outlet, etc.), can be specified either by name or the
corresponding Domain1D object itself.
"""
idom = self.domain_index(domain)
@ -1520,7 +1520,7 @@ cdef class Sim1D:
A function with the signature ``value = g(sim)`` which computes the
value of :math:`g(x,p)` at the current system state. This is used to
compute :math:`\partial g/\partial p`. If this is identically zero
(i.e. :math:`g` is independent of :math:`p`) then this argument may
(that is, :math:`g` is independent of :math:`p`) then this argument may
be omitted.
:param dp:
A relative value by which to perturb each parameter

10
interfaces/cython/cantera/reaction.pyx
View File

@ -1354,8 +1354,8 @@ cdef class Reaction:
property reactants:
"""
Get/Set the reactants in this reaction as a dict where the keys are
species names and the values, are the stoichiometric coefficients, e.g.
``{'CH4':1, 'OH':1}``, or as a composition string, e.g.
species names and the values, are the stoichiometric coefficients, for example
``{'CH4':1, 'OH':1}``, or as a composition string, for example
``'CH4:1, OH:1'``.
"""
def __get__(self):
@ -1366,8 +1366,8 @@ cdef class Reaction:
property products:
"""
Get/Set the products in this reaction as a dict where the keys are
species names and the values, are the stoichiometric coefficients, e.g.
``{'CH3':1, 'H2O':1}``, or as a composition string, e.g.
species names and the values, are the stoichiometric coefficients, for example
``{'CH3':1, 'H2O':1}``, or as a composition string, for example
``'CH3:1, H2O:1'``.
"""
def __get__(self):
@ -2836,7 +2836,7 @@ cdef class ChebyshevReaction(Reaction):
cdef class InterfaceReaction(ElementaryReaction):
"""
A reaction occurring on an `Interface` (i.e. a surface or an edge)
A reaction occurring on an `Interface` (that is, a surface or an edge)
rxn = InterfaceReaction(
equation="H(S) + O(S) <=> OH(S) + PT(S)",

2
interfaces/cython/cantera/reactionpath.pyx
View File

@ -180,7 +180,7 @@ cdef class ReactionPathDiagram:
def build(self, verbose=False):
"""
Build the reaction path diagram. Called automatically by methods which
return representations of the diagram, e.g. write_dot().
return representations of the diagram, for example write_dot().
"""
self.builder.build(deref(self.kinetics.kinetics),
stringify(self.element), deref(self._log),

12
interfaces/cython/cantera/reactor.pyx
View File

@ -159,7 +159,7 @@ cdef class Reactor(ReactorBase):
A homogeneous zero-dimensional reactor. By default, they are closed
(no inlets or outlets), have fixed volume, and have adiabatic,
chemically-inert walls. These properties may all be changed by adding
appropriate components, e.g. `Wall`, `MassFlowController` and `Valve`.
appropriate components such as `Wall`, `MassFlowController` and `Valve`.
"""
reactor_type = "Reactor"
@ -302,7 +302,7 @@ cdef class Reactor(ReactorBase):
"""
Get the state vector of the reactor.
The order of the variables (i.e. rows) is:
The order of the variables (that is, rows) is:
`Reactor` or `IdealGasReactor`:
@ -1030,7 +1030,7 @@ cdef class Valve(FlowDevice):
self.set_pressure_function(K)
property valve_coeff:
r"""Set valve coefficient, i.e. the proportionality constant between mass
r"""Set valve coefficient, that is, the proportionality constant between mass
flow rate and pressure drop [kg/s/Pa].
>>> V = Valve(res1, reactor1)
@ -1164,7 +1164,7 @@ cdef class ReactorNet:
property max_time_step:
"""
Get/set the maximum time step *t* [s] that the integrator is
allowed to use. The default value is set to zero, i.e. no time
allowed to use. The default value is set to zero, so that no time
step maximum is used.
"""
def __get__(self):
@ -1254,7 +1254,7 @@ cdef class ReactorNet:
"""
Return the name of the i-th component of the global state vector. The
name returned includes both the name of the reactor and the specific
component, e.g. `'reactor1: CH4'`.
component, for example `'reactor1: CH4'`.
"""
return pystr(self.net.componentName(i))
@ -1289,7 +1289,7 @@ cdef class ReactorNet:
The sensitivities are returned in an array with dimensions *(n_vars,
n_sensitivity_params)*, unless no timesteps have been taken, in which
case the shape is *(0, n_sensitivity_params)*. The order of the
variables (i.e., rows) is:
variables (that is, rows) is:
`Reactor` or `IdealGasReactor`:

2
interfaces/cython/cantera/speciesthermo.pyx
View File

@ -236,7 +236,7 @@ cdef class ShomatePoly2(SpeciesThermo):
- `coeffs[8:15]`: The 7 coefficients of the high-temperature
parameterization
These coefficients should be provided in their customary units (i.e.
These coefficients should be provided in their customary units (that is,
such that :math:`c_p^o` is in J/gmol-K and :math:`H^o` is in kJ/gmol,
as in the NIST Chemistry WebBook).
"""

2
interfaces/cython/cantera/test/test_onedim.py
View File

@ -502,7 +502,7 @@ class TestFreeFlame(utilities.CanteraTest):
self.assertLess(N2, N1)
# TODO: check that the solution is actually correct (i.e. that the
# TODO: check that the solution is actually correct (that is, that the
# residual satisfies the error tolerances) on the new grid.
@pytest.mark.usefixtures("allow_deprecated")

2
interfaces/cython/cantera/test/test_thermo.py
View File

@ -1203,7 +1203,7 @@ class ImportTest(utilities.CanteraTest):
@pytest.mark.usefixtures("allow_deprecated")
def test_import_phase_cti2(self):
# This should import the first phase, i.e. 'air'
# This should import the first phase, that is, 'air'
gas = ct.Solution('air-no-reactions.cti')
self.check(gas, 'air', 300, 101325, 8, 3)

4
interfaces/cython/cantera/thermo.pyx
View File

@ -31,10 +31,10 @@ cdef class Species:
underlying `ThermoPhase` and `Transport` objects).
:param name:
A string giving the name of the species, e.g. ``'CH4'``
A string giving the name of the species, such as ``'CH4'``
:param composition:
The elemental composition of the species, given either as a dict or a
composition string, e.g. ``{'C':1, 'H':4}`` or ``'C:1, H:4'``.
composition string, such as ``{'C':1, 'H':4}`` or ``'C:1, H:4'``.
:param charge:
The electrical charge, in units of the elementary charge. Default 0.0.
:param size:

2
interfaces/cython/cantera/transport.pyx
View File

@ -3,7 +3,7 @@
# NOTE: These cdef functions cannot be members of Transport because they would
# cause "layout conflicts" when creating derived classes with multiple bases,
# e.g. class Solution. [Cython 0.16]
# such as class Solution. [Cython 0.16]
cdef np.ndarray get_transport_1d(Transport tran, transportMethod1d method):
cdef np.ndarray[np.double_t, ndim=1] data = np.empty(tran.thermo.nSpecies())
method(tran.transport, &data[0])

2
interfaces/cython/cantera/units.pyx
View File

@ -36,7 +36,7 @@ cdef class UnitSystem:
The `UnitSystem` class is used to specify dimensional values for a given unit
system. The main use is for converting values specified in input files to Cantera's
native unit system, which is SI units except for the use of kmol as the base
unit of quantity, i.e. kilogram, meter, second, kelvin, ampere, and kmol.
unit of quantity, that is, kilogram, meter, second, kelvin, ampere, and kmol.
The default unit system used by Cantera is SI+kmol::

2
interfaces/matlab/testpath.m
View File

@ -1,7 +1,7 @@
% testpath.m
% Set up environment for testing the Cantera Matlab interface
% from within the Cantera source tree. Run this file from the
% root of the Cantera source tree, e.g.:
% root of the Cantera source tree, for example:
%
% cd ~/src/cantera
% run interfaces/matlab/testpath.m

2
platform/posix/man/ck2yaml.1
View File

@ -72,7 +72,7 @@ with the same name as the input file, with the extension changed to
\fB.yaml\fR.
.TP
.B --permissive
Allows certain recoverable parsing errors (e.g. duplicate transport
Allows certain recoverable parsing errors (such as duplicate transport
data) to be ignored.
.TP
.B --quiet

2
samples/cxx/openmp_ignition/openmp_ignition.cpp
View File

@ -59,7 +59,7 @@ void run()
// This option causes points [0, nThreads, 2*nThreads, ...] to be handled by
// the same thread, rather than the default behavior of one thread handling
// points [0 ... nPoints/nThreads]. This helps balance the workload for each
// thread in cases where the workload is biased, e.g. calculations for low
// thread in cases where the workload is biased. For example, calculations for low
// T0 take longer than calculations for high T0.
#pragma omp parallel for schedule(static, 1)
for (int i = 0; i < nPoints; i++) {

2
samples/matlab/tut2.m
View File

@ -81,7 +81,7 @@ diamond = Solution('diamond.yaml','diamond'); % bulk diamond
diamonnd_surf = importInterface('diamond.yaml','diamond_100',...
gas2, diamond);
% Note that the bulk (i.e., 3D) phases that participate in the surface
% Note that the bulk (that is, 3D) phases that participate in the surface
% reactions must also be passed as arguments to importInterface.
% Converting CK-format files

2
site_scons/site_tools/recursiveInstall.py
View File

@ -14,7 +14,7 @@ def RecursiveInstall(env, target, dir, exclude=None):
and if any thing in dir_source is updated the install is rerun
'exclude' is a list of regular expression patterns for files
to skip, e.g. ['\\.o$', '^~']
to skip, for example ['\\.o$', '^~']
It behaves similar to the env.Install builtin. However it expects
two directories and correctly sets up the dependencies between each

2
src/base/AnyMap.cpp
View File

@ -486,7 +486,7 @@ struct convert<Cantera::AnyValue> {
std::string nodestr = node.as<std::string>();
if (node.Tag() == "!") {
// Prevent quoted strings from being implicitly converted to
// numeric types, e.g. the quoted YAML string '12345' should not
// numeric types. For example, the quoted YAML string '12345' should not
// be interpreted as an integer
target = nodestr;
} else if (isInt(nodestr)) {

2
src/base/Units.cpp
View File

@ -606,7 +606,7 @@ double UnitSystem::convertFrom(double value, const Units& src) const
static std::pair<double, std::string> split_unit(const AnyValue& v) {
if (v.is<std::string>()) {
// Should be a value and units, separated by a space, e.g. '2e4 J/kmol'
// Should be a value and units, separated by a space, for example '2e4 J/kmol'
std::string val_units = v.asString();
size_t space = val_units.find(" ");
if (space == npos) {

2
src/base/application.h
View File

@ -389,7 +389,7 @@ public:
}
//! Globally disable printing of warnings about problematic thermo data,
//! e.g. NASA polynomials with discontinuities at the midpoint temperature.
//! such as NASA polynomials with discontinuities at the midpoint temperature.
void suppress_thermo_warnings(bool suppress=true) {
m_suppress_thermo_warnings = suppress;
}

2
src/clib/Cabinet.h
View File

@ -26,7 +26,7 @@
* non-C++ calling routine, as some other interfacing schemes do.
*
* The Cabinet<M> class can be used to store pointers to any class
* that is default-constructible (i.e., has a constructor that takes
* that is default-constructible (that is, has a constructor that takes
* no arguments). The requirement that the class be
* default-constructible arises since the Cabinet constructor always
* creates an instance of M by invoking 'new M', and stores a pointer

2
src/equil/BasisOptimize.cpp
View File

@ -218,7 +218,7 @@ size_t BasisOptimize(int* usedZeroedSpecies, bool doFormRxn, MultiPhase* mphase,
// Then, the first row in sm[], below will be identically zero. bleh.
//
// What needs to be done is to perform a rearrangement of the ELEMENTS ->
// i.e. rearrange, FormulaMatrix, sp, and gai, such that the first nc
// that is, rearrange, FormulaMatrix, sp, and gai, such that the first nc
// elements form in combination with the nc components create an invertible
// sm[]. not a small project, but very doable.
//

2
src/equil/ChemEquil.cpp
View File

@ -1024,7 +1024,7 @@ int ChemEquil::estimateEP_Brinkley(ThermoPhase& s, vector_fp& x,
//
// The way around rank-deficiency is to lump-sum the corresponding
// row of the matrix. Note, lump-summing seems to work very well in
// terms of its stability properties, i.e., it heads in the right
// terms of its stability properties, that is, it heads in the right
// direction, albeit with lousy convergence rates.
//
// NOTE: This probably should be extended to a full blown Gauss-

2
src/equil/vcs_solve.cpp
View File

@ -469,7 +469,7 @@ VCS_SOLVE::VCS_SOLVE(MultiPhase* mphase, int printLvl) :
// We assume here that species 0 is the solvent. The solvent isn't
// on a unity activity basis The activity for the solvent assumes
// that the it goes to one as the species mole fraction goes to one;
// i.e., it's really on a molarity framework. So
// that is, it's really on a molarity framework. So
// SpecLnMnaught[iSolvent] = 0.0, and the loop below starts at 1,
// not 0.
size_t iSolvent = Vphase->spGlobalIndexVCS(0);

4
src/equil/vcs_solve_TP.cpp
View File

@ -2294,7 +2294,7 @@ L_END_LOOP:
// Then, the first row in sm[], below will be identically zero. bleh.
//
// What needs to be done is to perform a rearrangement of the ELEMENTS ->
// i.e. rearrange, m_formulaMatrix, sp, and m_elemAbundancesGoal, such that
// that is, rearrange, m_formulaMatrix, sp, and m_elemAbundancesGoal, such that
// the first nc elements form in combination with the nc components create
// an invertible sm[]. not a small project, but very doable.
//
@ -2669,7 +2669,7 @@ int VCS_SOLVE::vcs_species_type(const size_t kspec) const
// Check to see whether the current species is a major component of its
// phase. If it is, it is a major component. This is consistent with the
// above rule about single species phases. A major component i.e., a species
// above rule about single species phases. A major component that is, a species
// with a high mole fraction) in any phase is always treated as a major
// species
if (m_molNumSpecies_old[kspec] > (m_tPhaseMoles_old[iph] * 0.001)) {

2
src/fortran/cantera.f90
View File

@ -1,4 +1,4 @@
! This module is the only 'public' one - i.e., the only one visible in
! This module is the only 'public' one - that is, the only one visible in
! an application program. It's primary purpose is to provide generic
! procedure names that map to specific procedures depending on the
! argument types.

2
src/kinetics/Falloff.cpp
View File

@ -234,7 +234,7 @@ void TroeRate::setFalloffCoeffs(const vector_fp& c)
"for T2 from the input file. In the unlikely case that the "
"exp(T2/T) term should be included with T2 effectively equal "
"to 0, set T2 to a sufficiently small value "
"(i.e. T2 < 1e-16).");
"(for example, T2 < 1e-16).");
}
m_t2 = c[3];
} else {

6
src/kinetics/Reaction.cpp
View File

@ -504,7 +504,7 @@ bool Reaction::checkSpecies(const Kinetics& kin) const
"defines reaction orders for undeclared species: '{}'",
equation(), boost::algorithm::join(undeclared, "', '"));
}
// Error for empty input AnyMap (e.g. XML)
// Error for empty input AnyMap (that is, XML)
throw InputFileError("Reaction::checkSpecies", input, "Reaction '{}'\n"
"defines reaction orders for undeclared species: '{}'",
equation(), boost::algorithm::join(undeclared, "', '"));
@ -1575,12 +1575,12 @@ void parseReactionEquation(Reaction& R, const std::string& equation,
double stoich;
if (last_used != npos && tokens[last_used] == "(+") {
// Falloff third body with space, e.g. "(+ M)"
// Falloff third body with space, such as "(+ M)"
species = "(+" + species;
stoich = -1;
} else if (last_used == i-1 && ba::starts_with(species, "(+")
&& ba::ends_with(species, ")")) {
// Falloff 3rd body written without space, e.g. "(+M)"
// Falloff 3rd body written without space, such as "(+M)"
stoich = -1;
} else if (last_used == i-2) { // Species with no stoich. coefficient
stoich = 1.0;

2
src/kinetics/importKinetics.cpp
View File

@ -3,7 +3,7 @@
* Declarations of global routines for the importing
* of kinetics data from XML files (see \ref inputfiles).
*
* This file contains routines which are global routines, i.e.,
* This file contains routines which are global routines, that is,
* not part of any object. These routine take as input, ctml
* pointers to data, and pointers to %Cantera objects. The purpose
* of these routines is to initialize the %Cantera objects with data

2
src/numerics/IDA_Solver.cpp
View File

@ -70,7 +70,7 @@ extern "C" {
* residual routines:
*
* A IDAResFn res should return a value of 0 if successful, a positive value
* if a recoverable error occurred (e.g. yy has an illegal value), or a
* if a recoverable error occurred (for example, yy has an illegal value), or a
* negative value if a nonrecoverable error occurred. In the latter case, the
* program halts. If a recoverable error occurred, the integrator will
* attempt to correct and retry.

2
src/oneD/IonFlow.cpp
View File

@ -118,7 +118,7 @@ void IonFlow::frozenIonMethod(const double* x, size_t j0, size_t j1)
}
// flux for ions
// Set flux to zero to prevent some fast charged species (e.g. electron)
// Set flux to zero to prevent some fast charged species (such electrons)
// to run away
for (size_t k : m_kCharge) {
m_flux(k,j) = 0;

2
src/thermo/DebyeHuckel.cpp
View File

@ -470,7 +470,7 @@ void DebyeHuckel::initThermoXML(XML_Node& phaseNode, const std::string& id_)
// code to read in these parameters.
if (m_formDH == DHFORM_BDOT_AK) {
// Define a string-string map, and interpret the value of the
// XML element as binary pairs separated by colons, e.g.:
// XML element as binary pairs separated by colons, for example:
// Na+:3.0
// Cl-:4.0
// H+:9.0

6
src/thermo/HMWSoln.cpp
View File

@ -2901,7 +2901,7 @@ void HMWSoln::s_updatePitzer_dlnMolalityActCoeff_dT() const
}
// Both species have a non-zero charge, and they
// have the same sign, e.g., both positive or both negative.
// have the same sign, that is, both positive or both negative.
if (charge(i)*charge(j) > 0) {
dFdT += molality[i]*molality[j] * m_Phiprime_IJ[counterIJ];
}
@ -3414,7 +3414,7 @@ void HMWSoln::s_updatePitzer_d2lnMolalityActCoeff_dT2() const
}
// Both species have a non-zero charge, and they
// have the same sign, e.g., both positive or both negative.
// have the same sign, that is, both positive or both negative.
if (charge(i)*charge(j) > 0) {
d2FdT2 += molality[i]*molality[j] * m_Phiprime_IJ[counterIJ];
}
@ -3924,7 +3924,7 @@ void HMWSoln::s_updatePitzer_dlnMolalityActCoeff_dP() const
}
// Both species have a non-zero charge, and they
// have the same sign, e.g., both positive or both negative.
// have the same sign, that is, both positive or both negative.
if (charge(i)*charge(j) > 0) {
dFdP += molality[i]*molality[j] * m_Phiprime_IJ[counterIJ];
}

4
src/thermo/MixtureFugacityTP.cpp
View File

@ -948,9 +948,9 @@ int MixtureFugacityTP::solveCubic(double T, double pres, double a, double b,
}
}
} else if (disc == 0.0) {
//Three equal roots are obtained, i.e. alpha = beta = gamma
//Three equal roots are obtained, that is, alpha = beta = gamma
if (yN < 1e-18 && h < 1e-18) {
// yN = 0.0 and h = 0 i.e. disc = 0
// yN = 0.0 and h = 0 (that is, disc = 0)
Vroot[0] = xN;
Vroot[1] = xN;
Vroot[2] = xN;

Some files were not shown because too many files have changed in this diff Show More