fixed some style issues and variable name selection

ORNL · Jan 16, 2025 · 3b6e568 · 3b6e568
1 parent fb88866
commit 3b6e568
Show file tree

Hide file tree

Showing 6 changed files with 84 additions and 83 deletions.
diff --git a/ComponentLib/PowerElectronics/CircuitComponent.hpp b/ComponentLib/PowerElectronics/CircuitComponent.hpp
@@ -46,7 +46,7 @@ namespace ModelLib
         }
 
         /**
-         * @brief Create the mappings from local to global indexes
+         * @brief Create the mappings from local to global indices
          * 
          * @param local_index 
          * @param global_index 

diff --git a/Examples/Microgrid/Microgrid.cpp b/Examples/Microgrid/Microgrid.cpp
@@ -24,10 +24,10 @@ int main(int argc, char const *argv[])
     double abstol = 1.0e-8;
     double reltol = 1.0e-8;
     size_t max_step_amount = 3000;
-    bool usejac = true;
+    bool use_jac = true;
 
     //Create model
-    ModelLib::PowerElectronicsModel<double, size_t>* sysmodel = new ModelLib::PowerElectronicsModel<double, size_t>(reltol, abstol, usejac, max_step_amount);
+    ModelLib::PowerElectronicsModel<double, size_t>* sysmodel = new ModelLib::PowerElectronicsModel<double, size_t>(reltol, abstol, use_jac, max_step_amount);
 
     //Modeled after the problem in the paper
     double RN = 1.0e4;

diff --git a/Examples/RLCircuit/RLCircuit.cpp b/Examples/RLCircuit/RLCircuit.cpp
@@ -20,11 +20,11 @@ int main(int argc, char const *argv[])
 {
     double abstol = 1.0e-8;
     double reltol = 1.0e-8;
-    bool usejac = true;
+    bool use_jac = true;
 
     //TODO:setup as named parameters
     //Create circuit model
-    ModelLib::PowerElectronicsModel<double, size_t>* sysmodel = new ModelLib::PowerElectronicsModel<double, size_t>(reltol, abstol, usejac);
+    ModelLib::PowerElectronicsModel<double, size_t>* sysmodel = new ModelLib::PowerElectronicsModel<double, size_t>(reltol, abstol, use_jac);
 
     size_t idoff = 0;
 

diff --git a/Examples/ScaleMicrogrid/ScaleMicrogrid.cpp b/Examples/ScaleMicrogrid/ScaleMicrogrid.cpp
@@ -66,7 +66,7 @@ int test(index_type Nsize, real_type error_tol, bool debug_output)
 {
     using namespace ModelLib;
 
-    bool usejac = true;
+    bool use_jac = true;
 
     real_type t_init  = 0.0;
     real_type t_final = 1.0;
@@ -77,7 +77,7 @@ int test(index_type Nsize, real_type error_tol, bool debug_output)
     // Create circuit model
     auto* sysmodel = new PowerElectronicsModel<real_type, index_type>(reltol,
                                                                       abstol,
-                                                                      usejac,
+                                                                      use_jac,
                                                                       SCALE_MICROGRID_MAX_STEPS);
 
     const std::vector<real_type>* true_vec = &answer_key_N8;

diff --git a/PowerElectronicsModel.hpp b/PowerElectronicsModel.hpp
@@ -51,21 +51,21 @@ namespace ModelLib
             rtol_ = 1e-4;
             atol_ = 1e-4;
             this->max_steps_ = 2000;
-            // By default not use jacobian
-            usejac_ = false;
+            // By default don't use the jacobian
+            use_jac_ = false;
         }
 
         /**
          * @brief Constructor for the system model
          */
-        PowerElectronicsModel(double rt = 1e-4, double at = 1e-4, bool ju = false, IdxT msa = 2000) : ModelEvaluatorImpl<ScalarT, IdxT>(0, 0, 0)
+        PowerElectronicsModel(double rtol = 1e-4, double atol = 1e-4, bool use_jac = false, IdxT max_steps = 2000) : ModelEvaluatorImpl<ScalarT, IdxT>(0, 0, 0)
         {
             // Set system model tolerances from input
-            rtol_ = rt;
-            atol_ = at;
-            this->max_steps_ = msa;
-            // Can choose if to use jacobain
-            usejac_ = ju;
+            rtol_ = rtol;
+            atol_ = atol;
+            this->max_steps_ = max_steps;
+            // Can choose if to use jacobian
+            use_jac_ = use_jac;
         }
 
         /**
@@ -91,15 +91,15 @@ namespace ModelLib
         }
 
         /**
-         * @brief Will check if each component has jacobian avalible. If one doesn't then jacobain is false.
+         * @brief Will check if each component has jacobian avalible. If one doesn't have it, return false.
          *
          *
          * @return true
          * @return false
          */
         bool hasJacobian()
         {
-            if (!this->usejac_)
+            if (!this->use_jac_)
                 return false;
 
             for (const auto &component : components_)
@@ -234,7 +234,7 @@ namespace ModelLib
             {
                 component->evaluateJacobian();
 
-                // get references to local jacobain
+                // get references to local jacobian
                 std::tuple<std::vector<IdxT>&, std::vector<IdxT>&, std::vector<ScalarT>&> tpm = component->getJacobian().getEntries();
                 const auto& [r, c, v] = tpm;
 
@@ -325,7 +325,7 @@ namespace ModelLib
         static constexpr IdxT neg1_ = static_cast<IdxT>(-1);
 
         std::vector<component_type*> components_;
-        bool usejac_;
+        bool use_jac_;
 
     }; // class PowerElectronicsModel