Skip to content

Commit

Permalink
Grammatical Revisions
Browse files Browse the repository at this point in the history
Co-authored-by: Grayson Gall <66559200+gsgall@users.noreply.github.com>

Update doc/content/source/auxkernels/Sigma.md

Co-authored-by: Grayson Gall <66559200+gsgall@users.noreply.github.com>

Update doc/content/source/auxkernels/PowerDep.md

Co-authored-by: Grayson Gall <66559200+gsgall@users.noreply.github.com>

Update doc/content/source/auxkernels/Current.md

Co-authored-by: Grayson Gall <66559200+gsgall@users.noreply.github.com>

Update src/auxkernels/TotalFlux.C

Co-authored-by: Grayson Gall <66559200+gsgall@users.noreply.github.com>

Update src/auxkernels/Current.C

Co-authored-by: Grayson Gall <66559200+gsgall@users.noreply.github.com>

Update src/auxkernels/TM0CylindricalEzAux.C

Co-authored-by: Grayson Gall <66559200+gsgall@users.noreply.github.com>

Update src/auxkernels/TM0CylindricalErAux.C

Co-authored-by: Grayson Gall <66559200+gsgall@users.noreply.github.com>

Update src/auxkernels/ProcRateForRateCoeffThreeBody.C

Co-authored-by: Grayson Gall <66559200+gsgall@users.noreply.github.com>

Update src/auxkernels/ProcRateForRateCoeff.C

Co-authored-by: Grayson Gall <66559200+gsgall@users.noreply.github.com>

Update src/auxkernels/ProcRate.C

Co-authored-by: Grayson Gall <66559200+gsgall@users.noreply.github.com>

Addressing moosebuild precheck

Update include/auxkernels/TotalFlux.h

Co-authored-by: Grayson Gall <66559200+gsgall@users.noreply.github.com>

Update include/auxkernels/EFieldAdvAux.h

Co-authored-by: Grayson Gall <66559200+gsgall@users.noreply.github.com>

Update include/auxkernels/DiffusiveFlux.h

Co-authored-by: Grayson Gall <66559200+gsgall@users.noreply.github.com>

Update include/auxkernels/Current.h

Co-authored-by: Grayson Gall <66559200+gsgall@users.noreply.github.com>

Update doc/content/source/auxkernels/TotalFlux.md

Co-authored-by: Grayson Gall <66559200+gsgall@users.noreply.github.com>

Update doc/content/source/auxkernels/TotalFlux.md

Co-authored-by: Grayson Gall <66559200+gsgall@users.noreply.github.com>

Update doc/content/source/auxkernels/TotalFlux.md

Co-authored-by: Grayson Gall <66559200+gsgall@users.noreply.github.com>

Update doc/content/source/auxkernels/ProcRateForRateCoeffThreeBody.md

Co-authored-by: Grayson Gall <66559200+gsgall@users.noreply.github.com>

Update doc/content/source/auxkernels/ProcRateForRateCoeffThreeBody.md

Co-authored-by: Grayson Gall <66559200+gsgall@users.noreply.github.com>

Update doc/content/source/auxkernels/ProcRateForRateCoeffThreeBody.md

Co-authored-by: Grayson Gall <66559200+gsgall@users.noreply.github.com>

Update doc/content/source/auxkernels/ProcRateForRateCoeffThreeBody.md

Co-authored-by: Grayson Gall <66559200+gsgall@users.noreply.github.com>

Update doc/content/source/auxkernels/ProcRateForRateCoeff.md

Co-authored-by: Grayson Gall <66559200+gsgall@users.noreply.github.com>

Update doc/content/source/auxkernels/ProcRateForRateCoeff.md

Co-authored-by: Grayson Gall <66559200+gsgall@users.noreply.github.com>

Update doc/content/source/auxkernels/ProcRateForRateCoeff.md

Co-authored-by: Grayson Gall <66559200+gsgall@users.noreply.github.com>

Update doc/content/source/auxkernels/ProcRateForRateCoeff.md

Co-authored-by: Grayson Gall <66559200+gsgall@users.noreply.github.com>

Update doc/content/source/auxkernels/ProcRate.md

Co-authored-by: Grayson Gall <66559200+gsgall@users.noreply.github.com>

Update doc/content/source/auxkernels/ProcRate.md

Co-authored-by: Grayson Gall <66559200+gsgall@users.noreply.github.com>

Update doc/content/source/auxkernels/PowerDep.md

Co-authored-by: Grayson Gall <66559200+gsgall@users.noreply.github.com>

Update doc/content/source/auxkernels/PowerDep.md

Co-authored-by: Grayson Gall <66559200+gsgall@users.noreply.github.com>

Update doc/content/source/auxkernels/PowerDep.md

Co-authored-by: Grayson Gall <66559200+gsgall@users.noreply.github.com>

Update doc/content/source/auxkernels/PowerDep.md

Co-authored-by: Grayson Gall <66559200+gsgall@users.noreply.github.com>

Update doc/content/source/auxkernels/Efield.md

Co-authored-by: Grayson Gall <66559200+gsgall@users.noreply.github.com>

Update doc/content/source/auxkernels/Efield.md

Co-authored-by: Grayson Gall <66559200+gsgall@users.noreply.github.com>

Update doc/content/source/auxkernels/EFieldAdvAux.md

Co-authored-by: Grayson Gall <66559200+gsgall@users.noreply.github.com>

Update doc/content/source/auxkernels/EFieldAdvAux.md

Co-authored-by: Grayson Gall <66559200+gsgall@users.noreply.github.com>

Update doc/content/source/auxkernels/DiffusiveFlux.md

Co-authored-by: Grayson Gall <66559200+gsgall@users.noreply.github.com>

Update doc/content/source/auxkernels/EFieldAdvAux.md

Co-authored-by: Grayson Gall <66559200+gsgall@users.noreply.github.com>

Update doc/content/source/auxkernels/DriftDiffusionFluxAux.md

Co-authored-by: Grayson Gall <66559200+gsgall@users.noreply.github.com>

Update doc/content/source/auxkernels/DiffusiveFlux.md

Co-authored-by: Grayson Gall <66559200+gsgall@users.noreply.github.com>

Update doc/content/source/auxkernels/DensityMoles.md

Co-authored-by: Grayson Gall <66559200+gsgall@users.noreply.github.com>

Update doc/content/source/auxkernels/DensityMoles.md

Co-authored-by: Grayson Gall <66559200+gsgall@users.noreply.github.com>

Update doc/content/source/auxkernels/DiffusiveFlux.md

Co-authored-by: Grayson Gall <66559200+gsgall@users.noreply.github.com>

Update doc/content/source/auxkernels/ProcRate.md

Co-authored-by: Grayson Gall <66559200+gsgall@users.noreply.github.com>

Update doc/content/source/auxkernels/ProcRate.md

Co-authored-by: Grayson Gall <66559200+gsgall@users.noreply.github.com>

Rephrasing 'defined species' to 'specified species'
  • Loading branch information
csdechant committed Jan 4, 2024
1 parent 2581247 commit 3fa64a0
Show file tree
Hide file tree
Showing 27 changed files with 59 additions and 56 deletions.
2 changes: 1 addition & 1 deletion doc/content/source/auxkernels/Current.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ assumes the electrostatic approximation for the electric field.
The electrostatic current density is defined as

\begin{equation}
J_{j} = q_{j} (\text{sign}_{j} \mu_{j} \ \text{-} \nabla (V) n_{j} - D_{j} \nabla (n_{j}))
J_{j} = q_{j} (\text{sign}_{j} \mu_{j} \left( \text{-} \nabla V\right) n_{j} - D_{j} \nabla (n_{j}))
\end{equation}

Where $J_{j}$ is the current density, $q_{j}$ is the charge of the species, $\text{sign}_{j}$ indicates the advection behavior ($\text{+}1$ for positively charged species and $\text{-}1$ for negatively charged species), $\mu_{j}$ is the mobility coefficient, $V$ is the potential, $n_{j}$ is the density, and $D_{j}$ is the diffusion coefficient. When converting the density to logarithmic form and applying a scaling factor of the mesh, `Current` is defined as
Expand Down
4 changes: 2 additions & 2 deletions doc/content/source/auxkernels/DensityMoles.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@

## Overview

`DensityMoles` converts the density value of a coupled species from a logarithmic molar density into units of $\frac{\#}{m^{3}}$, such that:
`DensityMoles` converts the density value of a coupled species from a logarithmic molar density into units of #$/m^{3}$, such that:

\begin{equation}
n_{j} = N_{A} exp(N_{j})
n_{j} = N_{A} \exp(N_{j})
\end{equation}

Where $n_{j}$ is the density, $N_{j}$ is the molar density of the specie in logarithmic form, and $N_{A}$ is Avogadro's number. This is often needed due to Zapdos solving densities using a logarithmic molar formulation to help avoid negative densities and ill-conditioned matrices.
Expand Down
6 changes: 3 additions & 3 deletions doc/content/source/auxkernels/DiffusiveFlux.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@
The diffusive flux is defined as

\begin{equation}
\Gamma_{Diffusion} = \text{-}D_{j} \nabla (n_{j})
\Gamma_{\text{Diffusion}} = \text{-}D_{j} \nabla (n_{j})
\end{equation}

Where $\Gamma$ is the diffusive flux, $D_{j}$ is the diffusion coefficient and $n_{j}$ is the density.
Where $\Gamma_{\text{Diffusion}}$ is the diffusive flux, $D_{j}$ is the diffusion coefficient and $n_{j}$ is the density.
When converting the density to logarithmic form and applying a scaling factor of the mesh,
`DiffusiveFlux` is defined as

\begin{equation}
\Gamma_{Diffusion} = \text{-}D_{j} N_{A} \exp(N_{j}) \frac{\nabla (N_{j})}{l_{c}}
\Gamma_{\text{Diffusion}} = \text{-}D_{j} N_{A} \exp(N_{j}) \frac{\nabla (N_{j})}{l_{c}}
\end{equation}

Where $N_{j}$ is the molar density of the specie in logarithmic form, $N_{A}$ is Avogadro's
Expand Down
2 changes: 1 addition & 1 deletion doc/content/source/auxkernels/DriftDiffusionFluxAux.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ assumes a mobility and diffusion coefficient of unity, the electrostatic approxi
The electrostatic flux is defined as

\begin{equation}
\Gamma_{j} = \text{sign}_{j} \ \text{-} \nabla (V) n_{j} - \nabla (n_{j})
\Gamma_{j} = \text{sign}_{j} \left( \text{-}\nabla V\right) n_{j} - \nabla (n_{j})
\end{equation}

Where $\Gamma_{j}$ is the flux assuming drift-diffusion formulation, $\text{sign}_{j}$ indicates the advection behavior ($\text{+}1$ for positively charged species and $\text{-}1$ for negatively charged species),
Expand Down
6 changes: 3 additions & 3 deletions doc/content/source/auxkernels/EFieldAdvAux.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@ assumes the electrostatic approximation for the electric field.
The advective flux is defined as

\begin{equation}
\Gamma_{Advection} = \text{sign}_{j} \mu_{j} \ \text{-} \nabla (V) n_{j}
\Gamma_{\text{Advection}} = \text{sign}_{j} \mu_{j} \left( \text{-} \nabla V\right) n_{j}
\end{equation}

Where $\Gamma$ is the advective flux, $\text{sign}_{j}$ indicates the advection behavior ($\text{+}1$ for positively charged species and $\text{-}1$ for negatively charged species), $\mu_{j}$ is the mobility coefficient, $V$ is the potential, and $n_{j}$ is the density. When converting the density to logarithmic form and applying a scaling factor of the mesh,
Where $\Gamma_{\text{Advection}}$ is the advective flux, $\text{sign}_{j}$ indicates the advection behavior ($\text{+}1$ for positively charged species and $\text{-}1$ for negatively charged species), $\mu_{j}$ is the mobility coefficient, $V$ is the potential, and $n_{j}$ is the density. When converting the density to logarithmic form and applying a scaling factor of the mesh,
`EFieldAdvAux` is defined as

\begin{equation}
\Gamma_{Advection} = N_{A} \text{sign}_{j} \mu_{j} \frac{\text{-} \nabla (V)}{l_{c}} \exp(N_{j})
\Gamma_{\text{Advection}} = N_{A} \text{sign}_{j} \mu_{j} \frac{\text{-} \nabla (V)}{l_{c}} \exp(N_{j})
\end{equation}

Where $N_{j}$ is the molar density of the specie in logarithmic form, $N_{A}$ is Avogadro's
Expand Down
4 changes: 2 additions & 2 deletions doc/content/source/auxkernels/Efield.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@
The formulation of `Efield` is defined as

\begin{equation}
E_{comp.} = \frac{\text{-} \nabla_{comp.} (V) \ V_{c}}{l_{c}}
E_{\text{comp.}} = \frac{\text{-} \nabla_{\text{comp.}} (V) \ V_{c}}{l_{c}}
\end{equation}

Where $E_{comp.}$ is a component of the electric field, $V$ is the potential, $V_{c}$ is the
Where $E_{\text{comp.}}$ is a component of the electric field, $V$ is the potential, $V_{c}$ is the
scaling factor of the potential , and $l_{c}$ is the scaling factor of the mesh.

## Example Input File Syntax
Expand Down
10 changes: 5 additions & 5 deletions doc/content/source/auxkernels/PowerDep.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,18 @@ assumes the electrostatic approximation for the electric field.
The power deposited by Joule Heating is defined as

\begin{equation}
P_{Joule Heating} = \Gamma_{j} \cdot \text{-} \nabla (V) \\
P_{\text{Joule Heating}} = \Gamma_{j} \cdot \text{-} \nabla (V) \\
\\[10pt]
\Gamma_{j} = q_{j} (\text{sign}_{j} \mu_{j} \ \text{-} \nabla (V) n_{j} - D_{j} \nabla (n_{j}))
\Gamma_{j} = q_{j} (\text{sign}_{j} \mu_{j} \left( \text{-} \nabla V\right) n_{j} - D_{j} \nabla (n_{j}))
\end{equation}

Where $P$ is the power deposited by Joule heating, $q_{j}$ is the charge of the species, $\text{sign}_{j}$ indicates the advection behavior ($\text{+}1$ for positively charged species and $\text{-}1$ for negatively charged species), $\mu_{j}$ is the mobility coefficient,
Where $P_{\text{Joule Heating}}$ is the power deposited by Joule heating, $q_{j}$ is the charge of the species, $\text{sign}_{j}$ indicates the advection behavior ($\text{+}1$ for positively charged species and $\text{-}1$ for negatively charged species), $\mu_{j}$ is the mobility coefficient,
$V$ is the potential, $n_{j}$ is the density, and $D_{j}$ is the diffusion coefficient.
When converting the density to log form and applying a scaling factor of the mesh / voltage,
`PowerDep` is defined as

\begin{equation}
P_{Joule Heating} = \Gamma_{j} \cdot \frac{\text{-} \nabla (V) V_{c}}{l_{c}} \\
P_{\text{Joule Heating}} = \Gamma_{j} \cdot \frac{\text{-} \nabla (V) V_{c}}{l_{c}} \\
\\[10pt]
\Gamma_{j} = q_{j} N_{A} \left( \text{sign}_{j} \mu_{j} \frac{\text{-} \nabla (V)}{l_{c}} \exp(N_{j}) - D_{j} \exp(N_{j}) \frac{\nabla (N_{j})}{l_{c}} \right)
\end{equation}
Expand All @@ -34,7 +34,7 @@ of the potential.
For the case where artificial diffusion is introduced to the charge specie flux, an additional term is included, such that:

\begin{equation}
\Gamma_{j Total} = \Gamma_{j} + q_{j} N_{A} \mu_{j} \frac{\text{-}\lVert \nabla (V) \rVert_{2}}{l_{c}} \frac{h_{max}}{2} \exp(N_{j}) \frac{\nabla (N_{j})}{l_{c}}
\Gamma_{j\text{, Total}} = \Gamma_{j} + q_{j} N_{A} \mu_{j} \frac{\text{-}\lVert \nabla (V) \rVert_{2}}{l_{c}} \frac{h_{max}}{2} \exp(N_{j}) \frac{\nabla (N_{j})}{l_{c}}
\end{equation}

Where $h_{max}$ is the max length of the current element.
Expand Down
8 changes: 4 additions & 4 deletions doc/content/source/auxkernels/ProcRate.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,22 @@

## Overview

`ProcRate` returns the production rate for chemistry reactions determined by Townsend coefficients in units of $\frac{\#}{m^{3}s}$. `ProcRate`
`ProcRate` returns the production rate for chemistry reactions determined by Townsend coefficients in units of #/m$^{3}$s. `ProcRate`
assumes the electrostatic approximation for the current.

The production rate is defined as

\begin{equation}
S_{Townsend} = \alpha_{j} (\mu_{e} \nabla (V) n_{e} - D_{e} \nabla (n_{e}))
S_{\text{Townsend}} = \alpha_{j} (\mu_{e} \left( \nabla -V\right) n_{e} - D_{e} \nabla (n_{e}))
\end{equation}

Where $S_{Townsend}$ is the production rate determined by Townsend coefficients, $\alpha_{j}$ is the Townsend coefficient for the reaction, $\mu_{e}$ is the mobility coefficient,
Where $S_{\text{Townsend}}$ is the production rate determined by Townsend coefficients, $\alpha_{j}$ is the Townsend coefficient for the reaction, $\mu_{e}$ is the mobility coefficient,
$V$ is the potential, $n_{e}$ is the electron density, and $D_{e}$ is the diffusion coefficient.
When converting the density to logarithmic form and applying a scaling factor of the mesh,
`ProcRate` is defined as

\begin{equation}
S_{Townsend} = \alpha_{j} N_{A} \left(\mu_{e} \frac{\nabla (V)}{l_{c}} \exp(N_{e}) - D_{e} \exp(N_{e}) \frac{\nabla (N_{e})}{l_{c}} \right)
S_{\text{Townsend}} = \alpha_{j} N_{A} \left(\mu_{e} \frac{-\nabla (V)}{l_{c}} \exp(N_{e}) - D_{e} \exp(N_{e}) \frac{\nabla (N_{e})}{l_{c}} \right)
\end{equation}

Where $N_{e}$ is the molar density of the electrons in logarithmic form, $N_{A}$ is Avogadro's
Expand Down
8 changes: 4 additions & 4 deletions doc/content/source/auxkernels/ProcRateForRateCoeff.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,20 @@

## Overview

`ProcRateForRateCoeff` returns the production rate for a two body reactions determined by rate coefficients in units of $\frac{\#}{m^{3}s}$.
`ProcRateForRateCoeff` returns the production rate for a two body reactions determined by rate coefficients in units of #/m$^{3}$s.

The production rate is defined as

\begin{equation}
S_{Rate} = k n_{i} n_{j}
S_{\text{Rate}} = k n_{i} n_{j}
\end{equation}

Where $S_{Rate}$ is the production rate determined by rate coefficients, $k$ is the rate coefficient for the reaction, $n_{j}$ is the density for the first species, and $n_{j}$ is the density for the second species.
Where $S_{\text{Rate}}$ is the production rate determined by rate coefficients, $k$ is the rate coefficient for the reaction, $n_{j}$ is the density for the first species, and $n_{j}$ is the density for the second species.
When converting the density to logarithmic form,
`ProcRateForRateCoeff` is defined as

\begin{equation}
S_{Rate} = k N_{A} \exp(N_{i}) \exp(N_{j})
S_{\text{Rate}} = k N_{A} \exp(N_{i}) \exp(N_{j})
\end{equation}

Where $N_{i}$ and $N_{j}$ is the molar density of the species in logarithmic form, and $N_{A}$ is Avogadro's
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,20 @@

## Overview

`ProcRateForRateCoeffThreeBody` returns the production rate for a three body reactions determined by rate coefficients in units of $\frac{\#}{m^{3}s}$.
`ProcRateForRateCoeffThreeBody` returns the production rate for a three body reactions determined by rate coefficients in units of #/m$^{3}$s.

The production rate is defined as

\begin{equation}
S_{Rate} = k n_{i} n_{j} n_{k}
S_{\text{Rate}} = k n_{i} n_{j} n_{k}
\end{equation}

Where $S_{Rate}$ is the production rate determined by rate coefficients, $k$ is the rate coefficient for the reaction, $n_{j}$ is the density for the first species, $n_{j}$ is the density for the second species, and $n_{k}$ is the density for the third species.
Where $S_{\text{Rate}}$ is the production rate determined by rate coefficients, $k$ is the rate coefficient for the reaction, $n_{j}$ is the density for the first species, $n_{j}$ is the density for the second species, and $n_{k}$ is the density for the third species.
When converting the density to logarithmic form,
`ProcRateForRateCoeffThreeBody` is defined as

\begin{equation}
S_{Rate} = k N_{A} \exp(N_{i}) \exp(N_{j}) \exp(N_{k})
S_{\text{Rate}} = k N_{A} \exp(N_{i}) \exp(N_{j}) \exp(N_{k})
\end{equation}

Where $N_{k}$, $N_{j}$ and $N_{k}$ is the molar density of the species in logarithmic form, and $N_{A}$ is Avogadro's
Expand Down
2 changes: 1 addition & 1 deletion doc/content/source/auxkernels/Sigma.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Where $\sigma$ is the surface charge, $\Gamma_{i}$ is the advective flux of the
Using the midpoint method for integration, the surface charge calculation becomes

\begin{equation}
\sigma_{t} = \sigma_{t-1} + \text{-} \nabla (V) n_{i} \cdot \textbf{n} \ \text{d}t
\sigma_{t} = \sigma_{t-1} - \nabla (V) n_{i} \cdot \textbf{n} \ \text{d}t
\end{equation}

Where $\sigma_{t}$ is the surface charge of the current time step, $\sigma_{t-1}$ is the surface of the previous time step, and $\text{d}t$ is the difference between time steps.
Expand Down
6 changes: 3 additions & 3 deletions doc/content/source/auxkernels/TotalFlux.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@ assumes the electrostatic approximation for the electric field.
The electrostatic flux is usually defined as

\begin{equation}
\Gamma = \text{sign}_{j} \mu_{j} \ \text{-} \nabla (V) n_{j} - D_{j} \nabla (n_{j})
\Gamma_{j} = \text{sign}_{j} \mu_{j} \left( \text{-} \nabla V \right) n_{j} - D_{j} \nabla (n_{j})
\end{equation}

Where $\Gamma$ is the flux assuming drift-diffusion formulation, $\mu_{j}$ is the mobility coefficient, $\text{sign}_{j}$ indicates the advection behavior ($\text{+}1$ for positively charged species, $\text{-}1$ for negatively charged species and $\text{0}$ for neutral species), $V$ is the potential, $n_{j}$ is the density, and $D_{j}$ is the diffusion coefficient. When converting the density to logarithmic form, `TotalFlux` is defined as
Where $\Gamma_{j}$ is the flux assuming drift-diffusion formulation, $\mu_{j}$ is the mobility coefficient, $\text{sign}_{j}$ indicates the advection behavior ($\text{+}1$ for positively charged species, $\text{-}1$ for negatively charged species and $\text{0}$ for neutral species), $V$ is the potential, $n_{j}$ is the density, and $D_{j}$ is the diffusion coefficient. When converting the density to logarithmic form, `TotalFlux` is defined as

\begin{equation}
\Gamma = \text{sign}_{j} \mu_{j} \text{-} \nabla (V) \exp(N_{j}) - D_{j} \exp(N_{j}) \nabla (N_{j})
\Gamma_{j} = \text{sign}_{j} \mu_{j} \left(\text{-} \nabla V\right) \exp(N_{j}) - D_{j} \exp(N_{j}) \nabla (N_{j})
\end{equation}

Where $N_{j}$ is the molar density of the specie in logarithmic form.
Expand Down
6 changes: 3 additions & 3 deletions include/auxkernels/Current.h
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@ class CurrentTempl : public AuxKernel
virtual Real computeValue() override;

protected:
int _component;
Real _r_units;
const int _component;
const Real _r_units;

MooseVariable & _density_var;
const MooseVariable & _density_var;
const VariableValue & _density_log;
const VariableGradient & _grad_density_log;
const VariableGradient & _grad_potential;
Expand Down
4 changes: 2 additions & 2 deletions include/auxkernels/DiffusiveFlux.h
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ class DiffusiveFluxTempl : public AuxKernel
protected:
virtual Real computeValue() override;

int _component;
Real _r_units;
const int _component;
const Real _r_units;

// Coupled variables

Expand Down
4 changes: 2 additions & 2 deletions include/auxkernels/EFieldAdvAux.h
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ class EFieldAdvAuxTempl : public AuxKernel
protected:
virtual Real computeValue() override;

int _component;
Real _r_units;
const int _component;
const Real _r_units;

// Coupled variables

Expand Down
4 changes: 2 additions & 2 deletions include/auxkernels/TotalFlux.h
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ class TotalFluxTempl : public AuxKernel
virtual Real computeValue() override;

protected:
int _component;
MooseVariable & _density_var;
const int _component;
const MooseVariable & _density_var;
const VariableValue & _density_log;
const VariableGradient & _grad_density_log;
const VariableGradient & _grad_potential;
Expand Down
2 changes: 1 addition & 1 deletion src/auxkernels/AbsValueAux.C
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ AbsValueAux::validParams()
{
InputParameters params = AuxKernel::validParams();
params.addRequiredCoupledVar("u", "Variable we want absolute value of.");
params.addClassDescription("Returns the absolute value of variable");
params.addClassDescription("Returns the absolute value of the specified variable");
return params;
}

Expand Down
5 changes: 3 additions & 2 deletions src/auxkernels/Current.C
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,13 @@ CurrentTempl<is_ad>::validParams()

params.addRequiredCoupledVar("density_log", "The electron density");
params.addRequiredCoupledVar("potential", "The potential");
params.addParam<int>("component", 0, "The component of position. (0 = x, 1 = y, 2 = z)");
params.addParam<int>(
"component", 0, "The component of the Current vector. (0 = x, 1 = y, 2 = z)");
params.addParam<bool>(
"art_diff", false, "Whether there is a current contribution from artificial diffusion.");
params.addRequiredParam<Real>("position_units", "Units of position.");
params.addClassDescription(
"Returns the electric current associated with the flux of defined species");
"Returns the electric current associated with the flux of the specified species");
return params;
}

Expand Down
2 changes: 1 addition & 1 deletion src/auxkernels/DiffusiveFlux.C
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ DiffusiveFluxTempl<is_ad>::validParams()
params.addRequiredCoupledVar("density_log", "The variable representing the log of the density.");
params.addRequiredParam<Real>("position_units", "Units of position.");
params.addParam<int>("component", 0, "The component of position. (0 = x, 1 = y, 2 = z)");
params.addClassDescription("Returns the diffusive flux of defined species");
params.addClassDescription("Returns the diffusive flux of the specified species");
return params;
}

Expand Down
2 changes: 1 addition & 1 deletion src/auxkernels/DriftDiffusionFluxAux.C
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ DriftDiffusionFluxAux::validParams()
"negative.");
params.addRequiredCoupledVar("u", "The drift-diffusing species.");
params.addParam<int>("component", 0, "The flux component you want to see.");
params.addClassDescription("Returns the drift-diffusion flux of defined species");
params.addClassDescription("Returns the drift-diffusion flux of the specified species");
return params;
}

Expand Down
5 changes: 3 additions & 2 deletions src/auxkernels/EFieldAdvAux.C
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,9 @@ EFieldAdvAuxTempl<is_ad>::validParams()
"potential", "The gradient of the potential will be used to compute the advection velocity.");
params.addRequiredCoupledVar("density_log", "The variable representing the log of the density.");
params.addRequiredParam<Real>("position_units", "Units of position.");
params.addParam<int>("component", 0, "The component of position. (0 = x, 1 = y, 2 = z)");
params.addClassDescription("Returns the electric field driven advective flux of defined species");
params.addParam<int>("component", 0, "The component the EField Vector. (0 = x, 1 = y, 2 = z)");
params.addClassDescription(
"Returns the electric field driven advective flux of the specified species");
return params;
}

Expand Down
2 changes: 1 addition & 1 deletion src/auxkernels/ProcRate.C
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ ProcRateTempl<is_ad>::validParams()
"The process that we want to get the townsend coefficient for. Options are iz, ex, and el.");
params.addRequiredParam<Real>("position_units", "Units of position.");
params.addClassDescription(
"Reaction rate for electron impact collisions in units of #/m^3s. User can pass "
"Reaction rate for electron impact collisions in units of #/m$^{3}$s. User can pass "
"choice of elastic, excitation, or ionization Townsend coefficients");
return params;
}
Expand Down
2 changes: 1 addition & 1 deletion src/auxkernels/ProcRateForRateCoeff.C
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ ProcRateForRateCoeffTempl<is_ad>::validParams()
params.addCoupledVar("w", "The second variable that is reacting to create u.");
params.addRequiredParam<std::string>("reaction", "The full reaction equation.");
params.addClassDescription(
"Reaction rate for two body collisions in units of #/m^3s. User can pass "
"Reaction rate for two body collisions in units of #/m$^{3}$s. User can pass "
"choice of elastic, excitation, or ionization reaction rate coefficients");

return params;
Expand Down
2 changes: 1 addition & 1 deletion src/auxkernels/ProcRateForRateCoeffThreeBody.C
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ ProcRateForRateCoeffThreeBodyTempl<is_ad>::validParams()
params.addCoupledVar("x", "The second variable that is reacting to create u.");
params.addRequiredParam<std::string>("reaction", "The full reaction equation.");
params.addClassDescription(
"Reaction rate for three body collisions in units of #/m^3s. User can pass "
"Reaction rate for three body collisions in units of #/m$^{3}$s. User can pass "
"choice of elastic, excitation, or ionization reaction rate coefficients");

return params;
Expand Down
2 changes: 1 addition & 1 deletion src/auxkernels/TM0CylindricalErAux.C
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ TM0CylindricalErAux::validParams()
params.addRequiredCoupledVar("Hphi", "Magnetic field component Hphi.");
params.addRequiredParam<Real>("f", "The drive frequency.");
params.addParam<Real>("eps_r", 1., "The relative permittivity of the medium.");
params.addClassDescription("Calculates the radial E-field for a axisymmetric "
params.addClassDescription("Calculates the radial E-field for an axisymmetric "
"TM$_{0}$ wave.");
return params;
}
Expand Down
2 changes: 1 addition & 1 deletion src/auxkernels/TM0CylindricalEzAux.C
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ TM0CylindricalEzAux::validParams()
params.addRequiredCoupledVar("Hphi", "Magnetic field component Hphi.");
params.addRequiredParam<Real>("f", "The drive frequency.");
params.addParam<Real>("eps_r", 1., "The relative permittivity of the medium.");
params.addClassDescription("Calculates the axial E-field for a axisymmetric "
params.addClassDescription("Calculates the axial E-field for an axisymmetric "
"TM$_{0}$ wave.");
return params;
}
Expand Down
Loading

0 comments on commit 3fa64a0

Please sign in to comment.