Skip to content

Commit

Permalink
Grammar corrections and fixing documentation error
Browse files Browse the repository at this point in the history
  • Loading branch information
csdechant committed Nov 5, 2024
1 parent 1d4e1b4 commit 0148c94
Show file tree
Hide file tree
Showing 8 changed files with 30 additions and 14 deletions.
1 change: 1 addition & 0 deletions doc/content/bib/documentation.bib
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ @article{greenberg1993electron
pages={8126--8133},
year={1993},
publisher={American Institute of Physics}
}
@article{hagelaar2000boundary,
Expand Down
2 changes: 1 addition & 1 deletion doc/content/source/bcs/ElectronAdvectionDoNothingBC.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
## Overview

`ElectronAdvectionDoNothingBC` is an outflow boundary condition where the outflow at the
boundary is equal to the bulk election advection equation.
boundary is equal to the bulk electron advection equation.
`ElectronAdvectionDoNothingBC` assumes the electrostatic approximation for the electric field.

The outflow is defined as
Expand Down
9 changes: 7 additions & 2 deletions doc/content/source/bcs/NeumannCircuitVoltageMoles_KV.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,15 @@ Where $V_\text{source}$ is the driven potential, $V_\text{cathode}$ is the poten
$e$ is the elemental charge , $\Gamma_i$ and $\Gamma_e$ are the ion and and electron particle fluxes, respectively, $A$ is the cross-sectional area of the plasma, and $R$ is the ballast resistance. Within `NeumannCircuitVoltageMoles_KV`, the charged species' flux at the boundary is assumed to be given by:

\begin{equation}
a =
a_{e} =
\begin{cases}
1, & \mu_{e} \left( \nabla (V) \right) \cdot \textbf{n} > 0\\
0, & \mu_{i} \left( \text{-} \nabla (V) \right)\cdot \textbf{n} \leq 0\\
0, & \mu_{e} \left( \nabla (V) \right)\cdot \textbf{n} \leq 0\\
\end{cases} \\[10pt]
a_{i} =
\begin{cases}
1, & \mu_{i} \left( - \nabla (V) \right) \cdot \textbf{n} > 0\\
0, & \mu_{i} \left( - \nabla (V) \right)\cdot \textbf{n} \leq 0\\
\end{cases} \\[10pt]
\Gamma_{e} \cdot \textbf{n} = \frac{1-r_{e}}{1+r_{e}} \left[ -(2 a_{e}-1) \ \mu_{e}
\left(\text{-} \nabla (V) \right)
Expand Down
11 changes: 8 additions & 3 deletions doc/content/source/bcs/SecondaryElectronBC.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,15 @@
`SecondaryElectronBC` assumes the electrostatic approximation for the electric field.

\begin{equation}
a =
a_{e} =
\begin{cases}
1, & \mu_{e} \left( \nabla (V) \right) \cdot \textbf{n} > 0\\
0, & \mu_{j} \left( \text{-} \nabla (V) \right) \cdot \textbf{n} \leq 0\\
1, & \mu_{e} \left( \nabla (V) \right) \cdot \textbf{n} > 0\\
0, & \mu_{e} \left( \nabla (V) \right)\cdot \textbf{n} \leq 0\\
\end{cases} \\[10pt]
a_{i} =
\begin{cases}
1, & \mu_{i} \left( - \nabla (V) \right) \cdot \textbf{n} > 0\\
0, & \mu_{i} \left( - \nabla (V) \right)\cdot \textbf{n} \leq 0\\
\end{cases} \\[10pt]
\Gamma_{e} \cdot \textbf{n} = \frac{1 - r_{e}}{1 + r_{e}} \frac{\text{-}1}{2} v_{\text{th},e} n_{\gamma} - \frac{2}{1+r} (1 - a_{e}) \gamma \Gamma_{j} \cdot \textbf{n} \\[10pt]
\Gamma_{j} \cdot \textbf{n} = \frac{1-r_{j}}{1+r_{j}} \left[ (2 a_{j}-1) \ \mu_{j}
Expand Down
9 changes: 7 additions & 2 deletions doc/content/source/bcs/SecondaryElectronEnergyBC.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,15 @@
`SecondaryElectronEnergyBC` assumes the electrostatic approximation for the electric field.

\begin{equation}
a =
a_{e} =
\begin{cases}
1, & \mu_{e} \left( \nabla (V) \right) \cdot \textbf{n} > 0\\
0, & \mu_{j} \left( \text{-} \nabla (V) \right) \cdot \textbf{n} \leq 0\\
0, & \mu_{e} \left( \nabla (V) \right)\cdot \textbf{n} \leq 0\\
\end{cases} \\[10pt]
a_{i} =
\begin{cases}
1, & \mu_{i} \left( - \nabla (V) \right) \cdot \textbf{n} > 0\\
0, & \mu_{i} \left( - \nabla (V) \right)\cdot \textbf{n} \leq 0\\
\end{cases} \\[10pt]
\Gamma_{\epsilon} \cdot \textbf{n} = \frac{1 - r_{e}}{1 + r_{e}} \frac{\text{-}5}{6} v_{\text{th},e} n_{\gamma} \varepsilon_{\gamma} - \frac{5}{3} \frac{2}{1+r} (1 - a_{e}) \gamma \Gamma_{j} \cdot \textbf{n} \\[10pt]
\Gamma_{j} \cdot \textbf{n} = \frac{1-r_{j}}{1+r_{j}} \left[ (2 a_{j}-1) \ \mu_{j}
Expand Down
4 changes: 2 additions & 2 deletions doc/tutorial_pdf/Zapdos_Tutorial.tex
Original file line number Diff line number Diff line change
Expand Up @@ -541,7 +541,7 @@

\begin{verbatim}
[InterfaceKernels]
#Defining election advection to the water
#Defining electron advection to the water
[em_advection]
type = InterfaceAdvection
mean_en_neighbor = mean_en
Expand All @@ -552,7 +552,7 @@
position_units = ${dom1Scale}
neighbor_position_units = ${dom0Scale}
[]
#Defining election diffusion to the water
#Defining electron diffusion to the water
[em_diffusion]
type = InterfaceLogDiffusionElectrons
mean_en_neighbor = mean_en
Expand Down
4 changes: 2 additions & 2 deletions src/bcs/ElectronAdvectionDoNothingBC.C
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ ElectronAdvectionDoNothingBC::validParams()
params.addRequiredCoupledVar(
"potential", "The gradient of the potential will be used to compute the advection velocity.");
params.addRequiredParam<Real>("position_units", "The units of position.");
params.addClassDescription("Boundary condition where the election advection flux at the boundary "
"is equal to the bulk election advection equation");
params.addClassDescription("Boundary condition where the electron advection flux at the boundary "
"is equal to the bulk electron advection equation");
return params;
}

Expand Down
4 changes: 2 additions & 2 deletions src/bcs/ElectronDiffusionDoNothingBC.C
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ ElectronDiffusionDoNothingBC::validParams()
{
InputParameters params = ADIntegratedBC::validParams();
params.addRequiredParam<Real>("position_units", "Units of position");
params.addClassDescription("Boundary condition where the election diffusion flux at the boundary "
"is equal to the bulk election diffusion equation");
params.addClassDescription("Boundary condition where the electron diffusion flux at the boundary "
"is equal to the bulk electron diffusion equation");
return params;
}

Expand Down

0 comments on commit 0148c94

Please sign in to comment.