Skip to content

Commit 6cacd7c

Browse files
spethdecaluwe
andcommitted
[Doc] Adopt more review suggestions for science docs
Co-authored-by: Steven C. DeCaluwe <[email protected]>
1 parent 88b19f6 commit 6cacd7c

File tree

6 files changed

+41
-29
lines changed

6 files changed

+41
-29
lines changed

doc/sphinx/develop/reactor-integration.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -88,9 +88,9 @@ function are:
8888
- `tout` is the desired integrator output time. CVODES will not necessarily reach this
8989
time when operating in "one step" mode, but it is used in the selection of the initial
9090
step size.
91-
- After execution, {ct}`CVodesIntegrator::m_y` will contain the computed solution
92-
vector, and will later be used to update the {ct}`ReactorNet` to its time-integrated
93-
state.
91+
- After execution, {ct}`CVodesIntegrator::m_y` will contain the computed system state
92+
at the time reached by the integrator, and will later be used to update the
93+
{ct}`ReactorNet` to its time-integrated state.
9494
- After execution, {ct}`CVodesIntegrator::m_tInteg` will contain the time reached by the
9595
integrator.
9696
- The `CV_ONE_STEP` option tells the solver to take a single internal step.

doc/sphinx/reference/kinetics/rate-constants.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ An Arrhenius rate is described by the
1212
$$ k_f = A T^b e^{-E_a / RT} $$
1313

1414
where $A$ is the pre-exponential factor, $T$ is the temperature, $b$ is the temperature
15-
exponent, $E_a$ is the activation energy, and $R$ is the gas constant.
15+
exponent, $E_a$ is the activation energy, and $R$ is the universal gas constant.
1616

1717
:::{admonition} YAML Usage
1818
:class: tip
@@ -140,11 +140,11 @@ $$ \t{Si + SiH_4 (+M) \leftrightarrow Si_2H_4 (+M)} $$
140140

141141
Like falloff reactions, chemically-activated reactions are described by blending between
142142
a low-pressure and a high-pressure rate expression. The difference is that the forward
143-
rate constant is written as being proportional to the *low-pressure* rate constant:
143+
rate constant is written as proportional to the *low-pressure* rate constant:
144144

145145
$$ k_f(T, P_r) = k_0 \left(\frac{1}{1 + P_r}\right) F(T, P_r) $$
146146

147-
and the optional blending function $F$ may described by any of the parameterizations
147+
and the optional blending function $F$ may be described by any of the parameterizations
148148
allowed for falloff reactions.
149149

150150
```{admonition} YAML Usage
@@ -242,10 +242,11 @@ In some circumstances like thermodynamic sensitivity analysis, or modeling heter
242242
reactions from one catalyst surface to another, the enthalpy change of a reaction
243243
($\Delta H$) can be modified. Due to the change in $\Delta H$, the activation energy of
244244
the reaction must be adjusted accordingly to provide accurate simulation results. To
245-
adjust the activation energy due to changes in the reaction enthalpy, the Blowers-Masel
245+
adjust the activation energy due to changes in the reaction enthalpy, the Blowers-Masel
246246
rate expression is available. This approximation was proposed by {cite:t}`blowers2000`
247247
to automatically scale activation energy as the reaction enthalpy is changed. The
248-
activation energy estimation can be written as:
248+
_intrinsic activation energy_ $E_a^0$ is defined as the activation energy when
249+
$\Delta H = 0$. The activation energy can then be written as a function of $\Delta H$:
249250

250251
$$
251252
E_a = \begin{cases}
@@ -260,10 +261,9 @@ where
260261

261262
$$ V_P = 2 w \frac{w + E_a^0}{w - E_a^0}, $$
262263

263-
$w$ is the average of the bond dissociation energy of the bond breaking and that being
264-
formed, $E_a^0$ is the intrinsic activation energy, and $\Delta H$ is the enthalpy
265-
change of the reaction. Note that the expression is insensitive to $w$ as long as $w \ge
266-
2 E_a^0$, so we can use an arbitrarily high value of $w = 1000\text{ kJ/mol}$.
264+
and $w$ is the average of the bond dissociation energy of the bond breaking and that
265+
being formed. Note that the expression is insensitive to $w$ as long as $w \ge 2 E_a^0$,
266+
so we can use an arbitrarily high value of $w = 1000\text{ kJ/mol}$.
267267

268268
After $E_a$ is evaluated, the reaction rate can be calculated using the modified
269269
Arrhenius expression

doc/sphinx/reference/kinetics/reaction-rates.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,14 @@ types.
99
The basic reaction type is a homogeneous reaction with a pressure-independent
1010
rate coefficient and mass action kinetics. For example:
1111

12-
$$ \t{A + B \rightleftharpoons C + D} $$
12+
$$ a\t{A} + b\t{B} \rightleftharpoons c\t{C} + d\t{D} $$
13+
14+
where A and B are reactant species, C and D are product species, and $a, b, c, $ and $d$
15+
are stoichiometric coefficients.
1316

1417
The forward reaction rate is then calculated as:
1518

16-
$$ R_f = [\t{A}] [\t{B}] k_f $$
19+
$$ R_f = [\t{A}]^a [\t{B}]^b k_f $$
1720

1821
where $k_f$ is the forward rate constant, calculated using one of the available rate
1922
parameterizations such as the [modified Arrhenius](sec-arrhenius-rate) form.

doc/sphinx/reference/thermo/phase-thermo.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,13 @@ Ideal Gas Mixture
1515
Implemented by class {ct}`IdealGasPhase`.
1616

1717
(sec-Redlich-Kwong-phase)=
18-
Redlich-Kwong Real Gas
18+
Redlich-Kwong Real Gas Mixture
1919
: A multi-species real gas following the Redlich-Kwong equation of state. Defined in the
2020
YAML format by specifying [`Redlich-Kwong`](sec-yaml-Redlich-Kwong) in the `thermo`
2121
field of the phase definition. Implemented by class {ct}`RedlichKwongMFTP`.
2222

2323
(sec-Peng-Robinson-phase)=
24-
Peng-Robinson Real Gas
24+
Peng-Robinson Real Gas Mixture
2525
: A multi-species real gas following the Peng-Robinson equation of state. Defined in the
2626
YAML format by specifying [`Peng-Robinson`](sec-yaml-Peng-Robinson) in the `thermo`
2727
field of the phase definition. Implemented by class {ct}`PengRobinson`.
@@ -99,9 +99,10 @@ Ideal Molal Solution
9999

100100
(sec-ideal-condensed-phase)=
101101
Ideal Condensed Phase
102-
: An ideal liquid or solid solution. Defined in the YAML format by specifying
103-
[`ideal-condensed`](sec-yaml-ideal-condensed) in the `thermo` field of the
104-
phase definition. Implemented by class {ct}`IdealSolidSolnPhase`.
102+
: An ideal liquid or solid solution based on the mixing-rule assumption that all molar
103+
concentration-based activity coefficients are equal to one. Defined in the YAML format
104+
by specifying [`ideal-condensed`](sec-yaml-ideal-condensed) in the `thermo` field of
105+
the phase definition. Implemented by class {ct}`IdealSolidSolnPhase`.
105106

106107
(sec-ideal-solution-VPSS-phase)=
107108
Ideal Condensed Phase with VPSS Species

doc/sphinx/reference/thermo/species-thermo.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ the thermodynamic properties appropriate for the type of phase or interface they
55
represent. Although each one may use different expressions to compute the properties,
66
they all require thermodynamic property information for the individual species.
77

8-
Generally, the phase models require a parameterization of the standard state heat
8+
Generally, the phase models require a parameterization of the _standard state_ heat
99
capacity, enthalpy, and entropy for each species at a fixed pressure $p^\circ$ as a
1010
function of $T$. In addition, phase models may require information describing how each
1111
species affects the equation of state, either in terms of the species standard molar
@@ -19,16 +19,21 @@ Many of Cantera's phase thermodynamic models are formulated to make use of the
1919
for individual species, defined at a standard pressure $p^\circ$ and for the composition
2020
specified by the phase model. For example, this could include a pure gas in the case of
2121
the ideal gas model, or an ion at infinite dilution in water in the case of aqueous
22-
solutions.
22+
solutions. The value of $p^\circ$ is not fixed by Cantera, and may vary among different
23+
sources of thermodynamic data.
2324

2425
```{caution}
25-
In some parts of the Cantera documentation, properties calculated at the standard
26-
pressure $p^\circ$ are referred to as *reference-state* thermodynamic properties, while
27-
properties calculated using the composition defining the standard state but at any
28-
pressure are referred to as *standard state* properties. This nomenclature is fairly
29-
unique to Cantera, based on the desire to distinguish these different steps in the
30-
calculation of the full thermodynamic properties, and is not often seen in other
31-
descriptions of solution thermodynamics.
26+
In some parts of the Cantera documentation, properties calculated at the user-specified
27+
standard pressure $p^\circ$ are referred to as *reference-state* thermodynamic
28+
properties, as they represent a well-known reference state and properties for all other
29+
states are calculated according to their departure from this known reference condition.
30+
In these same parts of the documentation, the term _standard-state properties_ refers to
31+
properties calculated using the composition defining the standard state but at the
32+
mixture's current pressure.
33+
34+
This nomenclature is fairly unique to Cantera, based on the desire to distinguish these
35+
different steps in the calculation of the full thermodynamic properties, and is not
36+
often seen in other descriptions of solution thermodynamics.
3237
```
3338

3439
The necessary properties are:

src/kinetics/PlogRate.cpp

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,10 @@ void PlogRate::validate(const string& equation, const Kinetics& kin)
149149
}
150150
if (err_reactions.size()) {
151151
throw InputFileError("PlogRate::validate", m_input,
152-
"\nInvalid rate coefficient for reaction '{}'\n{}",
152+
"\nInvalid rate coefficient for reaction '{}'\n{}\n"
153+
"To fix this error, remove this reaction or contact the author of the\n"
154+
"reaction/mechanism in question, because the rate expression is\n"
155+
"mathematically unsound at the temperatures and pressures noted above.\n",
153156
equation, to_string(err_reactions));
154157
}
155158
}

0 commit comments

Comments
 (0)