commentary

include/tug/Boundary.hpp

@@ -66,8 +66,7 @@ class Boundary {
         /**
          * @brief Construct a new Boundary object
          * 
-         * @param grid
-         * @param type  
+         * @param grid 
          */
         Boundary(Grid grid);
 

include/tug/Grid.hpp

@@ -6,10 +6,10 @@ class Grid {
     public:
 
         /**
-        * @brief Construct a new Grid object
-        * 
-        * @param col 
-        */
+         * @brief Construct a new 1D Grid object, which represents the fields holding the concentrations.
+         * 
+         * @param col Defines the length of the grid in terms of cells. Input must be an integer > 3. 
+         */
         Grid(int col);
 
         /**
@@ -33,7 +33,7 @@ class Grid {
         /**
          * @brief Get the Concentrations object
          * 
-         * @return auto 
+         * @return MatrixXd 
          */
         MatrixXd getConcentrations();
 

include/tug/Simulation.hpp

@@ -4,8 +4,8 @@
 using namespace std;
 
 enum APPROACH {
-    FTCS_APPROACH,
-    BTCS_APPROACH
+    FTCS_APPROACH, // Forward Time-Centered Space
+    BTCS_APPROACH // Backward Time-Centered Space
 };
 
 enum CSV_OUTPUT {
@@ -23,7 +23,7 @@ enum CONSOLE_OUTPUT {
 
 enum TIME_MEASURE {
     TIME_MEASURE_OFF, // do not print any time measures
-    TIME_MEASURE_ON, // print one time measure after all iterations
+    TIME_MEASURE_ON, // print time measure after last iteration
     TIME_MEASURE_VERBOSE // print time measures after each iteration
 };