Addressing BCs documentation for issue shannon-lab#260 and addressing…

… Clang format

src/bcs/EconomouDielectricBC.C

@@ -29,9 +29,8 @@ EconomouDielectricBC::validParams()
       "The secondary electron emission coefficient for each ion provided in `ions`");
   params.addRequiredParam<std::string>("potential_units", "The potential units.");
 
-  params.addClassDescription(
-      "Dielectric boundary condition"
-      " (Based on [!cite](lymberopoulos1994modeling))");
+  params.addClassDescription("Dielectric boundary condition"
+                             " (Based on [!cite](lymberopoulos1994modeling))");
   return params;
 }
 

src/bcs/HagelaarElectronAdvectionBC.C

@@ -19,9 +19,8 @@ HagelaarElectronAdvectionBC::validParams()
   params.addRequiredParam<Real>("r", "The reflection coefficient");
   params.addRequiredCoupledVar("potential", "The electric potential");
   params.addRequiredParam<Real>("position_units", "Units of position.");
-  params.addClassDescription(
-      "Kinetic advective electron boundary condition"
-      " (Based on [!cite](hagelaar2000boundary))");
+  params.addClassDescription("Kinetic advective electron boundary condition"
+                             " (Based on [!cite](hagelaar2000boundary))");
   return params;
 }
 

src/bcs/HagelaarElectronBC.C

@@ -21,9 +21,8 @@ HagelaarElectronBC::validParams()
   params.addRequiredCoupledVar("electron_energy", "The mean electron energy density in log form");
 
   params.addRequiredParam<Real>("position_units", "Units of position.");
-  params.addClassDescription(
-      "Kinetic electron boundary condition"
-      " (Based on [!cite](hagelaar2000boundary))");
+  params.addClassDescription("Kinetic electron boundary condition"
+                             " (Based on [!cite](hagelaar2000boundary))");
   return params;
 }
 

src/bcs/HagelaarEnergyAdvectionBC.C

@@ -24,9 +24,8 @@ HagelaarEnergyAdvectionBC::validParams()
       "The species-dependent secondary electron emission coefficients for this boundary");
   params.addRequiredParam<Real>("position_units", "Units of position.");
   params.addRequiredParam<Real>("secondary_electron_energy", "The secondary electron energy in eV");
-  params.addClassDescription(
-      "Kinetic advective electron energy boundary condition"
-      " (Based on [!cite](hagelaar2000boundary))");
+  params.addClassDescription("Kinetic advective electron energy boundary condition"
+                             " (Based on [!cite](hagelaar2000boundary))");
   return params;
 }
 

src/bcs/HagelaarEnergyBC.C

@@ -20,9 +20,8 @@ HagelaarEnergyBC::validParams()
   params.addRequiredCoupledVar("potential", "The electric potential");
   params.addRequiredCoupledVar("electrons", "The electron density in log form");
   params.addRequiredParam<Real>("position_units", "Units of position.");
-  params.addClassDescription(
-      "Kinetic electron mean energy boundary condition"
-      " (Based on [!cite](hagelaar2000boundary))");
+  params.addClassDescription("Kinetic electron mean energy boundary condition"
+                             " (Based on [!cite](hagelaar2000boundary))");
   return params;
 }
 

src/bcs/HagelaarIonAdvectionBC.C

@@ -19,9 +19,8 @@ HagelaarIonAdvectionBC::validParams()
   params.addRequiredParam<Real>("r", "The reflection coefficient");
   params.addRequiredCoupledVar("potential", "The electric potential");
   params.addRequiredParam<Real>("position_units", "Units of position.");
-  params.addClassDescription(
-      "Kinetic advective ion boundary condition"
-      " (Based on [!cite](hagelaar2000boundary))");
+  params.addClassDescription("Kinetic advective ion boundary condition"
+                             " (Based on [!cite](hagelaar2000boundary))");
   return params;
 }
 

src/bcs/HagelaarIonDiffusionBC.C

@@ -20,9 +20,8 @@ HagelaarIonDiffusionBC::validParams()
   params.addRequiredParam<Real>("position_units", "Units of position.");
   params.addParam<Real>(
       "user_velocity", -1., "Optional parameter if user wants to specify the thermal velocity.");
-  params.addClassDescription(
-      "Kinetic electron boundary condition"
-      " (Based on [!cite](hagelaar2000boundary))");
+  params.addClassDescription("Kinetic electron boundary condition"
+                             " (Based on [!cite](hagelaar2000boundary))");
   return params;
 }
 

src/bcs/LymberopoulosElectronBC.C

@@ -22,9 +22,8 @@ LymberopoulosElectronBC::validParams()
   params.addRequiredCoupledVar("potential", "The electric potential");
   params.addRequiredCoupledVar("ions", "A list of ion densities in log form");
   params.addRequiredParam<Real>("position_units", "Units of position.");
-  params.addClassDescription(
-      "Simpified kinetic electron boundary condition"
-      " (Based on [!cite](Lymberopoulos1993))");
+  params.addClassDescription("Simpified kinetic electron boundary condition"
+                             " (Based on [!cite](Lymberopoulos1993))");
   return params;
 }
 

src/bcs/LymberopoulosIonBC.C

@@ -18,9 +18,8 @@ LymberopoulosIonBC::validParams()
   InputParameters params = ADIntegratedBC::validParams();
   params.addRequiredCoupledVar("potential", "The electric potential");
   params.addRequiredParam<Real>("position_units", "Units of position.");
-  params.addClassDescription(
-      "Simpified kinetic ion boundary condition"
-      " (Based on [!cite](Lymberopoulos1993))");
+  params.addClassDescription("Simpified kinetic ion boundary condition"
+                             " (Based on [!cite](Lymberopoulos1993))");
   return params;
 }
 

src/bcs/SakiyamaElectronDiffusionBC.C

@@ -18,9 +18,8 @@ SakiyamaElectronDiffusionBC::validParams()
   InputParameters params = ADIntegratedBC::validParams();
   params.addRequiredCoupledVar("electron_energy", "The mean electron energy density in log form");
   params.addRequiredParam<Real>("position_units", "Units of position.");
-  params.addClassDescription(
-      "Kinetic electron boundary condition"
-      " (Based on [!cite](sakiyama2006corona))");
+  params.addClassDescription("Kinetic electron boundary condition"
+                             " (Based on [!cite](sakiyama2006corona))");
   return params;
 }
 

src/bcs/SakiyamaEnergyDiffusionBC.C

@@ -18,9 +18,8 @@ SakiyamaEnergyDiffusionBC::validParams()
   InputParameters params = ADIntegratedBC::validParams();
   params.addRequiredCoupledVar("electrons", "The electron density in log form");
   params.addRequiredParam<Real>("position_units", "Units of position.");
-  params.addClassDescription(
-      "Kinetic advective electron energy boundary condition"
-      " (Based on [!cite](sakiyama2007nonthermal))");
+  params.addClassDescription("Kinetic advective electron energy boundary condition"
+                             " (Based on [!cite](sakiyama2007nonthermal))");
   return params;
 }
 

src/bcs/SakiyamaIonAdvectionBC.C

@@ -18,9 +18,8 @@ SakiyamaIonAdvectionBC::validParams()
   InputParameters params = ADIntegratedBC::validParams();
   params.addRequiredCoupledVar("potential", "The electric potential");
   params.addRequiredParam<Real>("position_units", "Units of position.");
-  params.addClassDescription(
-      "Kinetic advective ion boundary condition"
-      " (Based on [!cite](sakiyama2006corona))");
+  params.addClassDescription("Kinetic advective ion boundary condition"
+                             " (Based on [!cite](sakiyama2006corona))");
   return params;
 }
 

src/bcs/SakiyamaSecondaryElectronBC.C

@@ -21,9 +21,8 @@ SakiyamaSecondaryElectronBC::validParams()
   params.addRequiredParam<Real>("position_units", "Units of position.");
   params.addRequiredParam<std::vector<std::string>>(
       "emission_coeffs", "A list of species-dependent secondary electron emission coefficients");
-  params.addClassDescription(
-      "Kinetic secondary electron boundary condition"
-      " (Based on [!cite](sakiyama2006corona))");
+  params.addClassDescription("Kinetic secondary electron boundary condition"
+                             " (Based on [!cite](sakiyama2006corona))");
   return params;
 }