Vast formatting changes for consistency everywhere more or less in at least fcn capitalization

For anything that is not IO related (anything but src/options and src/utilities/unified_logger.*) all the function signatures have been converted to "PascalCase" in-order to be consistent with how MFEM does things and just standardize things.

IO related files (src/options/* and src/utilities/unified_logger.*) all of the functions were set to "snake_case" as this was cleaner looking for the options work and then for the loggers it better matched what the STDLIB is doing which makes things easier to read / reason about. I honestly would prefer all functions signatures look like this but with how MFEM does things that just clashed too much everywhere else :(

Now there were also some member variable name changes any member variable that ended with the postfix "_" had that postfix removed. This addition is something that Claude just loves to add... and I finally got a round to removing them. I still need to make the member variable names consistent everywhere but that will likely be a fight for another day...

Note, I did try using clang-tidy to enforce this automatically but it kept getting too many things wrong or changing too much. So, I just abandonded that idea of using it as a tool to automatically do this for us. I might still look into using it for other things though as well as leveraging like clang-format.

Author: rcarson3

src/boundary_conditions/BCData.cpp

@@ -12,7 +12,7 @@ BCData::~BCData()
    // TODO destructor stub
 }
 
-void BCData::setDirBCs(mfem::Vector& y)
+void BCData::SetDirBCs(mfem::Vector& y)
 {
    // When doing the velocity based methods we only
    // need to do the below.
@@ -22,7 +22,7 @@ void BCData::setDirBCs(mfem::Vector& y)
    y[2] = essVel[2] * scale[2];
 }
 
-void BCData::setScales()
+void BCData::SetScales()
 {
    switch (compID) {
       case 7:
@@ -68,7 +68,7 @@ void BCData::setScales()
    }
 }
 
-void BCData::getComponents(int id, mfem::Array<bool> &component)
+void BCData::GetComponents(int id, mfem::Array<bool> &component)
 {
    switch (id) {
       case  0:

src/boundary_conditions/BCData.hpp

@@ -64,7 +64,7 @@ class BCData
        * 
        * This is used during the assembly process to enforce velocity boundary conditions.
        */
-      void setDirBCs(mfem::Vector& y);
+      void SetDirBCs(mfem::Vector& y);
 
       /**
        * @brief Set scaling factors based on component ID
@@ -80,7 +80,7 @@ class BCData
        * - compID = 6: X,Z components (1,0,1)
        * - compID = 7: All components (1,1,1)
        */
-      void setScales();
+      void SetScales();
 
       /**
        * @brief Static utility to decode component ID into boolean flags
@@ -92,7 +92,7 @@ class BCData
        * velocity components are active. This is used throughout the boundary condition
        * system to determine which degrees of freedom should be constrained.
        * 
-       * The mapping follows the same pattern as setScales():
+       * The mapping follows the same pattern as SetScales():
        * - id = 0: (false, false, false)
        * - id = 1: (true, false, false)  
        * - id = 2: (false, true, false)
@@ -102,6 +102,6 @@ class BCData
        * - id = 6: (true, false, true)
        * - id = 7: (true, true, true)
        */
-      static void getComponents(int id, mfem::Array<bool> &component);
+      static void GetComponents(int id, mfem::Array<bool> &component);
 };
 #endif

src/boundary_conditions/BCManager.cpp

@@ -6,7 +6,7 @@
 
 #include <fstream>
 
-void BCManager::updateBCData(std::unordered_map<std::string, mfem::Array<int>> & ess_bdr, 
+void BCManager::UpdateBCData(std::unordered_map<std::string, mfem::Array<int>> & ess_bdr,
                              mfem::Array2D<double> & scale,
                              mfem::Vector & vgrad, 
                              std::unordered_map<std::string, mfem::Array2D<bool>> & component)
@@ -28,19 +28,19 @@ void BCManager::updateBCData(std::unordered_map<std::string, mfem::Array<int>> &
       if (ess_comp[i] != 0) {
          const int bcID = ess_id[i] - 1;
          ess_bdr["total"][bcID] = 1;
-         BCData::getComponents(std::abs(ess_comp[i]), cmp_row);
+         BCData::GetComponents(std::abs(ess_comp[i]), cmp_row);
 
          component["total"](bcID, 0) = cmp_row[0];
          component["total"](bcID, 1) = cmp_row[1];
          component["total"](bcID, 2) = cmp_row[2];
       }
    }
 
-   updateBCData(ess_bdr["ess_vel"], scale, component["ess_vel"]);
-   updateBCData(ess_bdr["ess_vgrad"], vgrad, component["ess_vgrad"]);
+   UpdateBCData(ess_bdr["ess_vel"], scale, component["ess_vel"]);
+   UpdateBCData(ess_bdr["ess_vgrad"], vgrad, component["ess_vgrad"]);
 }
 
-void BCManager::updateBCData(mfem::Array<int> & ess_bdr, mfem::Array2D<double> & scale, mfem::Array2D<bool> & component)
+void BCManager::UpdateBCData(mfem::Array<int> & ess_bdr, mfem::Array2D<double> & scale, mfem::Array2D<bool> & component)
 {
    m_bcInstances.clear();
    ess_bdr = 0;
@@ -80,7 +80,7 @@ void BCManager::updateBCData(mfem::Array<int> & ess_bdr, mfem::Array2D<double> &
          bc.compID = ess_comp[i];
 
          // set the boundary condition scales
-         bc.setScales();
+         bc.SetScales();
 
          scale(bcID - 1, 0) = bc.scale[0];
          scale(bcID - 1, 1) = bc.scale[1];
@@ -94,15 +94,15 @@ void BCManager::updateBCData(mfem::Array<int> & ess_bdr, mfem::Array2D<double> &
       if (ess_comp[i] != 0) {
          const int bcID = ess_id[i] - 1;
          ess_bdr[bcID] = 1;
-         BCData::getComponents(ess_comp[i], cmp_row);
+         BCData::GetComponents(ess_comp[i], cmp_row);
          component(bcID, 0) = cmp_row[0];
          component(bcID, 1) = cmp_row[1];
          component(bcID, 2) = cmp_row[2];
       }
    }
 }
 
-void BCManager::updateBCData(mfem::Array<int> & ess_bdr, mfem::Vector & vgrad, mfem::Array2D<bool> & component)
+void BCManager::UpdateBCData(mfem::Array<int> & ess_bdr, mfem::Vector & vgrad, mfem::Array2D<bool> & component)
 {
    ess_bdr = 0;
    vgrad.HostReadWrite();
@@ -134,7 +134,7 @@ void BCManager::updateBCData(mfem::Array<int> & ess_bdr, mfem::Vector & vgrad, m
       if (ess_comp[i] != 0) {
          const int bcID = ess_id[i] - 1;
          ess_bdr[bcID] = 1;
-         BCData::getComponents(ess_comp[i], cmp_row);
+         BCData::GetComponents(ess_comp[i], cmp_row);
          component(bcID, 0) = cmp_row[0];
          component(bcID, 1) = cmp_row[1];
          component(bcID, 2) = cmp_row[2];

src/boundary_conditions/BCManager.hpp

@@ -43,7 +43,7 @@ class BCManager
        * @details Implements the Meyer's singleton pattern for thread-safe initialization.
        * The instance is created on first call and persists for the lifetime of the program.
        */
-      static BCManager & getInstance()
+      static BCManager & GetInstance()
       {
          static BCManager bcManager;
          return bcManager;
@@ -67,7 +67,7 @@ class BCManager
        * where the outer key is the BC type ("ess_vel", "ess_vgrad", "total") and the inner
        * key is the time step number.
        */
-      void init(const std::vector<int> &uStep,
+      void Init(const std::vector<int> &uStep,
                 const std::unordered_map<int, std::vector<double>> &ess_vel,
                 const std::unordered_map<int, std::vector<double>> &ess_vgrad,
                 const map_of_imap &ess_comp,
@@ -154,7 +154,7 @@ class BCManager
        * 
        * This is called at the beginning of each time step where boundary conditions change.
        */
-      void updateBCData(std::unordered_map<std::string, mfem::Array<int>> & ess_bdr, 
+      void UpdateBCData(std::unordered_map<std::string, mfem::Array<int>> & ess_bdr,
                         mfem::Array2D<double> & scale,
                         mfem::Vector & vgrad, 
                         std::unordered_map<std::string, mfem::Array2D<bool>> & component);
@@ -169,7 +169,7 @@ class BCManager
        * time step by checking against the list of update steps provided during initialization.
        * If an update is needed, the internal step counter is also updated.
        */
-      bool getUpdateStep(int step_)
+      bool GetUpdateStep(int step_)
       {
          if(std::find(updateStep.begin(), updateStep.end(), step_) != updateStep.end()) {
             step = step_;
@@ -219,7 +219,7 @@ class BCManager
        * Processes the velocity gradient data for the current time step and sets up
        * the appropriate data structures for finite element assembly.
        */
-      void updateBCData(mfem::Array<int> & ess_bdr, mfem::Vector & vgrad, mfem::Array2D<bool> & component);
+      void UpdateBCData(mfem::Array<int> & ess_bdr, mfem::Vector & vgrad, mfem::Array2D<bool> & component);
 
       /**
        * @brief Update velocity boundary condition data
@@ -236,7 +236,7 @@ class BCManager
        * 3. Creates BCData objects with appropriate velocity and component settings
        * 4. Sets up scaling and boundary activation arrays
        */
-      void updateBCData(mfem::Array<int> & ess_bdr, mfem::Array2D<double> & scale, mfem::Array2D<bool> & component);
+      void UpdateBCData(mfem::Array<int> & ess_bdr, mfem::Array2D<double> & scale, mfem::Array2D<bool> & component);
 
       /** @brief Thread-safe initialization flag */
       std::once_flag init_flag;

src/fem_operators/mechanics_operator.cpp

@@ -21,7 +21,7 @@ NonlinearMechOperator::NonlinearMechOperator(mfem::Array<int> &ess_bdr,
    mfem::Vector* rhs;
    rhs = nullptr;
 
-   const auto& options = m_sim_state->getOptions();
+   const auto& options = m_sim_state->GetOptions();
    auto loc_fe_space = m_sim_state->GetMeshParFiniteElementSpace(); 
 
    // Define the parallel nonlinear form
@@ -191,7 +191,7 @@ void NonlinearMechOperator::Setup(const mfem::Vector &k) const
 void NonlinearMechOperator::SetupJacobianTerms() const
 {
 
-   auto mesh = m_sim_state->getMesh();
+   auto mesh = m_sim_state->GetMesh();
    auto fe_space = m_sim_state->GetMeshParFiniteElementSpace();
    const mfem::FiniteElement &el = *fe_space->GetFE(0);
    const mfem::IntegrationRule *ir = &(mfem::IntRules.Get(el.GetGeomType(), 2 * el.GetOrder() + 1));;
@@ -234,7 +234,7 @@ void NonlinearMechOperator::SetupJacobianTerms() const
 
 void NonlinearMechOperator::CalculateDeformationGradient(mfem::QuadratureFunction &def_grad) const
 {
-   auto mesh = m_sim_state->getMesh();
+   auto mesh = m_sim_state->GetMesh();
    auto fe_space = m_sim_state->GetMeshParFiniteElementSpace();
    const mfem::FiniteElement &el = *fe_space->GetFE(0);
    const mfem::IntegrationRule *ir = &(mfem::IntRules.Get(el.GetGeomType(), 2 * el.GetOrder() + 1));;
@@ -243,8 +243,8 @@ void NonlinearMechOperator::CalculateDeformationGradient(mfem::QuadratureFunctio
    const int nelems = fe_space->GetNE();
    const int ndofs = fe_space->GetFE(0)->GetDof();
 
-   auto x_ref = m_sim_state->getRefCoords();
-   auto x_cur = m_sim_state->getCurrentCoords();
+   auto x_ref = m_sim_state->GetRefCoords();
+   auto x_cur = m_sim_state->GetCurrentCoords();
    //Since we never modify our mesh nodes during this operations this is okay.
    mfem::GridFunction *nodes = x_ref.get(); // set a nodes grid function to global current configuration
    int owns_nodes = 0;
@@ -259,7 +259,7 @@ void NonlinearMechOperator::CalculateDeformationGradient(mfem::QuadratureFunctio
    elem_restrict_lex->Mult(px, el_x);
 
    def_grad = 0.0;
-   exaconstit::kernel::grad_calc(nqpts, nelems, ndofs, el_jac.Read(), qpts_dshape.Read(), el_x.Read(), def_grad.ReadWrite());
+   exaconstit::kernel::GradCalc(nqpts, nelems, ndofs, el_jac.Read(), qpts_dshape.Read(), el_x.Read(), def_grad.ReadWrite());
 
    //We're returning our mesh nodes to the original object they were pointing to.
    //So, we need to cast away the const here.
@@ -274,7 +274,7 @@ void NonlinearMechOperator::CalculateDeformationGradient(mfem::QuadratureFunctio
 // Update the end coords used in our model
 void NonlinearMechOperator::UpdateEndCoords(const mfem::Vector& vel) const
 {
-   m_sim_state->getPrimalField()->operator=(vel);
+   m_sim_state->GetPrimalField()->operator=(vel);
    m_sim_state->UpdateNodalEndCoords();
 }
 

src/mechanics_driver.cpp

@@ -169,7 +169,7 @@ int main(int argc, char *argv[])
    ExaOptions toml_opt;
    toml_opt.parse_options(toml_file, myid);
 
-   exaconstit::UnifiedLogger& logger = exaconstit::UnifiedLogger::getInstance();
+   exaconstit::UnifiedLogger& logger = exaconstit::UnifiedLogger::get_instance();
    logger.initialize(toml_opt);
 
    toml_opt.print_options();
@@ -233,7 +233,7 @@ int main(int argc, char *argv[])
     */
    auto sim_state = std::make_shared<SimulationState>(toml_opt);
 
-   auto pmesh = sim_state->getMesh();
+   auto pmesh = sim_state->GetMesh();
 
    CALI_MARK_END("main_driver_init");
    /*
@@ -263,8 +263,8 @@ int main(int argc, char *argv[])
     * - Prepare fields for time-stepping algorithm
     */
 
-   auto x_diff = sim_state->getDisplacement();
-   auto v_cur = sim_state->getVelocity();
+   auto x_diff = sim_state->GetDisplacement();
+   auto v_cur = sim_state->GetVelocity();
 
    x_diff->operator=(0.0);
    v_cur->operator=(0.0);
@@ -305,13 +305,13 @@ int main(int argc, char *argv[])
     * - Performs material state updates and post-processing at each step
     */
    int ti = 0;
-   auto v_sol = sim_state->getPrimalField();
-   while (!sim_state->isFinished()) {
+   auto v_sol = sim_state->GetPrimalField();
+   while (!sim_state->IsFinished()) {
       ti++;
       // Print timestep information and timing statistics
       if (myid == 0) {
          std::cout << "Simulation cycle: " << ti << std::endl;
-         sim_state->printTimeStats();
+         sim_state->PrintTimeStats();
       }
       /*
        * Current Time Step Processing:
@@ -326,7 +326,7 @@ int main(int argc, char *argv[])
        * - Apply corrector step (SolveInit) for smooth BC transitions
        * - This prevents convergence issues with sudden load changes
        */
-      if (BCManager::getInstance().getUpdateStep(ti)) {
+      if (BCManager::GetInstance().GetUpdateStep(ti)) {
          if (myid == 0) {
             std::cout << "Changing boundary conditions this step: " << ti << std::endl;
          }
@@ -351,9 +351,9 @@ int main(int argc, char *argv[])
        * - Update material state variables with converged solution
        * - Perform post-processing calculations and output generation
        */
-      sim_state->finishCycle();
+      sim_state->FinishCycle();
       oper.UpdateModel();
-      post_process.Update(ti, sim_state->getTrueCycleTime());
+      post_process.Update(ti, sim_state->GetTrueCycleTime());
    } // end loop over time steps
 
    /**

src/mfem_expt/partial_qspace.hpp

@@ -281,7 +281,7 @@ class PartialQuadratureSpace : public mfem::QuadratureSpaceBase {
      * with -1 indicating elements not in the partial set. For optimization,
      * when the partial space covers all elements, this array has size 1.
      */
-    const mfem::Array<int>& getGlobal2Local() const { return global2local; }
+    const mfem::Array<int>& GetGlobal2Local() const { return global2local; }
 
     /**
      * @brief Get read-only access to the local-to-global mapping array.
@@ -291,7 +291,7 @@ class PartialQuadratureSpace : public mfem::QuadratureSpaceBase {
      * The returned array provides the mapping from local element indices
      * (within the partial space) to global element indices (in the full mesh).
      */
-    const mfem::Array<int>& getLocal2Global() const { return local2global; }
+    const mfem::Array<int>& GetLocal2Global() const { return local2global; }
 
     /**
      * @brief Get read-only access to the global offset array.
@@ -302,7 +302,7 @@ class PartialQuadratureSpace : public mfem::QuadratureSpaceBase {
      * for all elements in the global mesh, facilitating efficient data
      * transfer between partial and full quadrature spaces.
      */
-    const mfem::Array<int>& getGlobalOffset() const { return global_offsets; }
+    const mfem::Array<int>& GetGlobalOffset() const { return global_offsets; }
 
     /**
      * @brief Get the number of elements in the local partial space.
@@ -313,7 +313,7 @@ class PartialQuadratureSpace : public mfem::QuadratureSpaceBase {
      * in this PartialQuadratureSpace, which may be less than the total
      * number of elements in the underlying mesh.
      */
-    int getNumLocalElements() const { return local2global.Size(); }
+    int GetNumLocalElements() const { return local2global.Size(); }
 
     /**
      * @brief Check if this partial space covers the entire mesh.
@@ -324,7 +324,7 @@ class PartialQuadratureSpace : public mfem::QuadratureSpaceBase {
      * to a full quadrature space, enabling certain optimizations in data
      * handling and memory management.
      */
-    bool isFullSpace() const { return (global2local.Size() == 1); }
+    bool IsFullSpace() const { return (global2local.Size() == 1); }
 
     /**
      * @brief Get the element transformation for a local entity index.