Skip to content

Commit a8a7474

Browse files
csdechantcsdechant
committed
Updating docstring for new objects and cleaning up mms test input files
closes #257
1 parent 0635d00 commit a8a7474

27 files changed

+2094
-4262
lines changed

Diff for: ‎include/bcs/DielectricBCWithEffEfield.h

+46-7
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
1-
//* This file is part of the MOOSE framework
2-
//* https://www.mooseframework.org
1+
//* This file is part of Zapdos, an open-source
2+
//* application for the simulation of plasmas
3+
//* https://github.com/shannon-lab/zapdos
34
//*
4-
//* All rights reserved, see COPYRIGHT for full restrictions
5-
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
5+
//* Zapdos is powered by the MOOSE Framework
6+
//* https://www.mooseframework.org
67
//*
78
//* Licensed under LGPL 2.1, please see LICENSE for details
89
//* https://www.gnu.org/licenses/lgpl-2.1.html
@@ -12,8 +13,7 @@
1213
#include "ADIntegratedBC.h"
1314

1415
/**
15-
* Implements a simple constant Neumann BC where grad(u)=value on the boundary.
16-
* Uses the term produced from integrating the diffusion operator by parts.
16+
* Time integrated dielectric boundary condition
1717
*/
1818
class DielectricBCWithEffEfield : public ADIntegratedBC
1919
{
@@ -25,51 +25,90 @@ class DielectricBCWithEffEfield : public ADIntegratedBC
2525
protected:
2626
virtual ADReal computeQpResidual() override;
2727

28+
/// Scaling units for the position
2829
Real _r_units;
2930

31+
/// Variable value during previous time step
3032
const VariableValue & _u_old;
33+
/// Gradient of variable during previous time step
3134
const VariableGradient & _grad_u_old;
3235

36+
/// Electron mean energy density value
3337
const ADVariableValue & _mean_en;
38+
/// Electron mean energy density variable
3439
MooseVariable & _mean_en_var;
40+
/// Electron mean energy density value during previous time step
3541
const VariableValue & _mean_en_old;
42+
/// Electron density value
3643
const ADVariableValue & _em;
44+
/// Electron density variable
3745
MooseVariable & _em_var;
46+
/// Electron density value during previous time step
3847
const VariableValue & _em_old;
48+
/// Ion density value
3949
const ADVariableValue & _ip;
50+
/// Ion density variable
4051
MooseVariable & _ip_var;
52+
/// Ion density value during previous time step
4153
const VariableValue & _ip_old;
4254

55+
/// x-component of the electric field value
4356
const ADVariableValue & _Ex;
57+
/// x-component of the electric field variable
4458
MooseVariable & _Ex_var;
59+
/// x-component of the electric field value during previous time step
4560
const VariableValue & _Ex_old;
61+
/// y-component of the electric field value
4662
const ADVariableValue & _Ey;
63+
/// y-component of the electric field variable
4764
MooseVariable & _Ey_var;
65+
/// y-component of the electric field value during previous time step
4866
const VariableValue & _Ey_old;
67+
/// z-component of the electric field value
4968
const ADVariableValue & _Ez;
69+
/// z-component of the electric field variable
5070
MooseVariable & _Ez_var;
71+
/// z-component of the electric field value during previous time step
5172
const VariableValue & _Ez_old;
5273

74+
/// Elementary charge
5375
const MaterialProperty<Real> & _e;
76+
/// Permittivity of free space
5477
const ADMaterialProperty<Real> & _epsilon_0;
78+
/// Avogadro's number
5579
const MaterialProperty<Real> & _N_A;
5680

81+
/// Charge sign of the ions
5782
const MaterialProperty<Real> & _sgnip;
83+
/// Mobility coefficient of the ions
5884
const ADMaterialProperty<Real> & _muip;
85+
/// Mass of electrons
5986
const MaterialProperty<Real> & _massem;
87+
/// Secondary electron coefficient
6088
Real _user_se_coeff;
6189

90+
/// Permittivity of the dielectric
6291
const Real & _epsilon_d;
92+
/// Thickness of the dielectric
6393
const Real & _thickness;
94+
/// Equal to 1 when the drift velocity is direct towards the wall and zero otherwise
6495
Real _a;
96+
/// Value of "_a" during previous time step
6597
Real _a_old;
98+
/// Value of ion flux
6699
ADRealVectorValue _ion_flux;
100+
/// Value of ion flux during previous time step
67101
ADRealVectorValue _ion_flux_old;
102+
/// Electron thermal velocity
68103
ADReal _v_thermal;
104+
/// Value of electron thermal velocity during previous time step
69105
Real _v_thermal_old;
106+
/// Electron flux
70107
ADRealVectorValue _em_flux;
108+
/// Value of electron flux during previous time step
71109
ADRealVectorValue _em_flux_old;
110+
/// Scaling units for the potential (V or kV)
72111
std::string _potential_units;
73-
112+
/// Scaling value for the potential
74113
Real _voltage_scaling;
75114
};

Diff for: ‎include/bcs/SakiyamaEnergySecondaryElectronWithEffEfieldBC.h

+20-8
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,10 @@
1212

1313
#include "ADIntegratedBC.h"
1414

15+
/**
16+
* Kinetic secondary electron for mean electron energy boundary condition
17+
* with an effective electric field for ions
18+
*/
1519
class SakiyamaEnergySecondaryElectronWithEffEfieldBC : public ADIntegratedBC
1620
{
1721
public:
@@ -22,28 +26,36 @@ class SakiyamaEnergySecondaryElectronWithEffEfieldBC : public ADIntegratedBC
2226
protected:
2327
virtual ADReal computeQpResidual() override;
2428

29+
/// Scaling units for the position
2530
Real _r_units;
31+
/// If true, secondary electron energy is equal to electron energy
2632
bool Te_dependent;
27-
28-
// Coupled variables
33+
/// x-component of the electric field
2934
const ADVariableValue & _Ex;
35+
/// y-component of the electric field
3036
const ADVariableValue & _Ey;
37+
/// z-component of the electric field
3138
const ADVariableValue & _Ez;
32-
39+
/// Electron density
3340
const ADVariableValue & _em;
41+
/// Ion density variables
3442
std::vector<MooseVariable *> _ip_var;
43+
/// Ion density values
3544
std::vector<const ADVariableValue *> _ip;
36-
45+
/// Charge sign of the ions
3746
std::vector<const MaterialProperty<Real> *> _sgnip;
47+
/// Mobility coefficient of the ions
3848
std::vector<const ADMaterialProperty<Real> *> _muip;
49+
/// Secondary electron coefficient
3950
Real _se_coeff;
51+
/// Custom secondary electron energy
4052
Real _user_se_energy;
41-
53+
/// Equal to 1 when the drift velocity is direct towards the wall and zero otherwise
4254
Real _a;
55+
/// Term for secondary electron energy
4356
ADReal _se_energy;
57+
/// Ion flux
4458
ADRealVectorValue _ion_flux;
45-
59+
/// Number of ions defined
4660
unsigned int _num_ions;
47-
unsigned int _ip_index;
48-
std::vector<unsigned int>::iterator _iter;
4961
};

Diff for: ‎include/bcs/SakiyamaIonAdvectionWithEffEfieldBC.h

+11-5
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,10 @@
1212

1313
#include "ADIntegratedBC.h"
1414

15+
/**
16+
* Kinetic advective ion boundary condition
17+
* with an effective electric field for ions
18+
*/
1519
class SakiyamaIonAdvectionWithEffEfieldBC : public ADIntegratedBC
1620
{
1721
public:
@@ -22,16 +26,18 @@ class SakiyamaIonAdvectionWithEffEfieldBC : public ADIntegratedBC
2226
protected:
2327
virtual ADReal computeQpResidual() override;
2428

29+
/// Scaling units for the position
2530
Real _r_units;
26-
27-
// Coupled variables
28-
31+
/// x-component of the electric field
2932
const ADVariableValue & _Ex;
33+
/// y-component of the electric field
3034
const ADVariableValue & _Ey;
35+
/// z-component of the electric field
3136
const ADVariableValue & _Ez;
32-
37+
/// Mobility coefficient
3338
const ADMaterialProperty<Real> & _mu;
39+
/// Charge sign of the species
3440
const MaterialProperty<Real> & _sgn;
35-
41+
/// Equal to 1 when the drift velocity is direct towards the wall and zero otherwise
3642
Real _a;
3743
};

Diff for: ‎include/bcs/SakiyamaSecondaryElectronWithEffEfieldBC.h

+15-6
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,10 @@
1212

1313
#include "ADIntegratedBC.h"
1414

15+
/**
16+
* Kinetic secondary electron boundary condition
17+
* with an effective electric field for ions
18+
*/
1519
class SakiyamaSecondaryElectronWithEffEfieldBC : public ADIntegratedBC
1620
{
1721
public:
@@ -22,21 +26,26 @@ class SakiyamaSecondaryElectronWithEffEfieldBC : public ADIntegratedBC
2226
protected:
2327
virtual ADReal computeQpResidual() override;
2428

29+
/// Scaling units for the position
2530
Real _r_units;
26-
27-
// Coupled variables
28-
31+
/// x-component of the electric field
2932
const ADVariableValue & _Ex;
33+
/// y-component of the electric field
3034
const ADVariableValue & _Ey;
35+
/// z-component of the electric field
3136
const ADVariableValue & _Ez;
37+
/// Ion density values
3238
std::vector<const ADVariableValue *> _ip;
33-
39+
/// Equal to 1 when the drift velocity is direct towards the wall and zero otherwise
3440
Real _a;
41+
/// Ion flux
3542
ADRealVectorValue _ion_flux;
43+
/// Secondary electron coefficient
3644
Real _user_se_coeff;
37-
45+
/// Charge sign of the ions
3846
std::vector<const MaterialProperty<Real> *> _sgnip;
47+
/// Mobility coefficient of the ions
3948
std::vector<const ADMaterialProperty<Real> *> _muip;
40-
49+
/// Number of ions defined
4150
unsigned int _num_ions;
4251
};

Diff for: ‎include/kernels/EffectiveEField.h

+6-3
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@
1212

1313
#include "ADKernel.h"
1414

15+
/**
16+
* Supplies the source term of the time derivative calculation of the effective electric field for ions
17+
*/
1518
class EffectiveEField : public ADKernel
1619
{
1720
public:
@@ -20,15 +23,15 @@ class EffectiveEField : public ADKernel
2023
EffectiveEField(const InputParameters & parameters);
2124

2225
protected:
23-
// virtual ADRealVectorValue precomputeQpResidual() override;
2426
virtual ADReal computeQpResidual();
2527

26-
// // using ADKernelGrad::getPostprocessorValue;
27-
2828
private:
2929
/// Position units
3030
const Real _r_units;
31+
/// Momentum-transfer frequency of ions
3132
const Real _nu;
33+
/// Component of the electric field
3234
unsigned _component;
35+
/// Electric field provided as a material property
3336
const ADMaterialProperty<RealVectorValue> & _electric_field;
3437
};

Diff for: ‎include/kernels/EffectiveEFieldAdvection.h

+9-5
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,10 @@
1212

1313
#include "ADKernel.h"
1414

15+
/*
16+
* Effective electric field driven advection term. The effective electric
17+
* field is supplied as scalar components of the field
18+
*/
1519
class EffectiveEFieldAdvection : public ADKernel
1620
{
1721
public:
@@ -20,20 +24,20 @@ class EffectiveEFieldAdvection : public ADKernel
2024
EffectiveEFieldAdvection(const InputParameters & parameters);
2125

2226
protected:
23-
// virtual ADRealVectorValue precomputeQpResidual() override;
2427
virtual ADReal computeQpResidual();
2528

26-
// // using ADKernelGrad::getPostprocessorValue;
27-
2829
private:
2930
/// Position units
3031
const Real _r_units;
3132

32-
/// The diffusion coefficient (either constant or mixture-averaged)
33+
/// Mobility coefficient
3334
const ADMaterialProperty<Real> & _mu;
35+
/// Charge sign of the species
3436
const MaterialProperty<Real> & _sign;
35-
37+
/// x-component of the electric field
3638
const ADVariableValue & _u_Efield;
39+
/// y-component of the electric field
3740
const ADVariableValue & _v_Efield;
41+
/// z-component of the electric field
3842
const ADVariableValue & _w_Efield;
3943
};

Diff for: ‎include/kernels/ThermalConductivityDiffusion.h

+11-2
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,11 @@
1212

1313
#include "ADKernel.h"
1414

15+
/**
16+
* Electron energy diffusion term
17+
* that assumes a thermal conductivity of
18+
* K = 3/2 D_e n_e
19+
*/
1520
class ThermalConductivityDiffusion : public ADKernel
1621
{
1722
public:
@@ -23,11 +28,15 @@ class ThermalConductivityDiffusion : public ADKernel
2328
virtual ADReal computeQpResidual() override;
2429

2530
private:
31+
32+
/// Position units
2633
Real _r_units;
34+
/// Coefficient relating diffusion coefficient * density to thermal conductivity
2735
Real _coeff;
28-
36+
/// Diffusion coefficient
2937
const ADMaterialProperty<Real> & _diffem;
30-
38+
/// Electron density
3139
const ADVariableValue & _em;
40+
/// Gradient of electron density
3241
const ADVariableGradient & _grad_em;
3342
};

0 commit comments

Comments
 (0)