From: Manaswinee Bezbaruah <bezba004@tamu.edu>
Date: Tue, 26 Oct 2021 04:20:21 +0000 (-0500)
Subject: removed separators, added some comments
X-Git-Tag: v9.4.0-rc1~136^2~22
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=aceddc8e56b6ec8b1807c926debded4cdbb945f4;p=dealii.git

removed separators, added some comments
---

diff --git a/examples/step-81/step-81.cc b/examples/step-81/step-81.cc
index 668e5c82ff..7606787fad 100644
--- a/examples/step-81/step-81.cc
+++ b/examples/step-81/step-81.cc
@@ -67,7 +67,25 @@ namespace Step81
   using namespace dealii;
   using namespace std::complex_literals;
 
-
+  /**
+   * The Parameters class inherits ParameterAcceptor, and instantiates all the coefficients in our variational equations.
+   * These coefficients are passed through ParameterAcceptor and are editable through a .prm file
+   *
+   * epsilon is the Electric Permitivitty coefficient and it is a rank 2 tensor. Depending on the material,
+   * we assign the i^th diagonal element of the tensor to the material epsilon value
+   * (one of the private epsilon_1_ or epsilon_2_ variables).
+   *
+   * mu_inv  is the inverese of the Magnetic Permiabillity coefficient and it is a complex number.
+   *
+   * sigma is the Surface Conductivity coefficient between material left and material right
+   * and it is a rank 2 tensor. It is only changed if we are at the interface between two
+   * materials. If we are at an interface, we assign the i^th diagonal element of the
+   * tensor to the private sigma_ value.
+   *
+   * J_a is the strength and orientation of the dipole. It is a rank 1 tensor that depends
+   * on the private dipole_position_, dipole_radius_, dipole_strength_, dipole_orientation_
+   * variables.
+   */
 
   template <int dim>
   class Parameters : public ParameterAcceptor
@@ -110,10 +128,6 @@ namespace Step81
     rank0_type             dipole_strength;
   };
 
-  //////////////////////////////////////////////////////////////////////////////
-  //////////////////////////////////////////////////////////////////////////////
-  //////////////////////////////////////////////////////////////////////////////
-
 
   template <int dim>
   Parameters<dim>::Parameters()
@@ -204,11 +218,11 @@ namespace Step81
     return J_a;
   }
 
-
-  //////////////////////////////////////////////////////////////////////////////
-  //////////////////////////////////////////////////////////////////////////////
-  //////////////////////////////////////////////////////////////////////////////
-
+  /**
+   * The PerfectlyMatchedLayer class inherits ParameterAcceptor, and it modifies our coefficients from Parameters.
+   * The radii and the strength of the PML is specified, and the coefficients will be modified using transformation
+   * matrices within the PML region. The radii and strength of the PML are editable through a .prm file
+  */
 
   template <int dim>
   class PerfectlyMatchedLayer : public ParameterAcceptor
@@ -245,11 +259,6 @@ namespace Step81
   };
 
 
-  //////////////////////////////////////////////////////////////////////////////
-  //////////////////////////////////////////////////////////////////////////////
-  //////////////////////////////////////////////////////////////////////////////
-
-
   template <int dim>
   PerfectlyMatchedLayer<dim>::PerfectlyMatchedLayer()
     : ParameterAcceptor("PerfectlyMatchedLayer")
@@ -340,9 +349,6 @@ namespace Step81
   }
 
 
-  //////////////////////////////////////////////////////////////////////////////
-  //////////////////////////////////////////////////////////////////////////////
-  //////////////////////////////////////////////////////////////////////////////
 
 
   template <int dim>
@@ -383,10 +389,6 @@ namespace Step81
   };
 
 
-  //////////////////////////////////////////////////////////////////////////////
-  //////////////////////////////////////////////////////////////////////////////
-  //////////////////////////////////////////////////////////////////////////////
-
 
   template <int dim>
   Maxwell<dim>::Maxwell()