Rename TestHydro facade to HydroForces with back-compat alias

Author: dav-og

include/hydroc/hydro_forces.h

@@ -4,11 +4,11 @@
 /*********************************************************************
  * @file  hydro_forces.h
  *
- * @brief Header file of TestHydro main class and helper classes
+ * @brief Header file of HydroForces main class and helper classes
  * ComponentFunc and ForceFunc6d.
  *
  * ARCHITECTURE:
- * TestHydro is a thin adapter over HydroSystem + ChronoHydroCoupler.
+ * HydroForces is a thin adapter over HydroSystem + ChronoHydroCoupler.
  * Force computation is handled internally by HydroSystem, which owns:
  *   - HydrostaticsComponent (restoring forces + buoyancy)
  *   - RadiationComponent (RIRF convolution, owns velocity history)
@@ -19,7 +19,7 @@
  * opposes motion.)
  *
  * MAIN RESPONSIBILITIES:
- * - TestHydro: Façade over HydroSystem; provides Chrono force callbacks
+ * - HydroForces: Façade over HydroSystem; provides Chrono force callbacks
  * - ForceFunc6d: Wraps 6-DOF force/torque callbacks for Chrono bodies
  * - ComponentFunc: Per-DOF force function for Chrono's ChForce system
  *
@@ -31,7 +31,7 @@
  * These are the single source of truth for component configuration.
  *
  * INTERACTIONS:
- * - Used by setup_hydro_from_yaml to create and configure TestHydro instances
+ * - Used by setup_hydro_from_yaml to create and configure HydroForces instances
  * - Called by Chrono during simulation via ChForce callbacks
  * - Reads HDF5 data through H5FileInfo (not directly exposed here)
  * - Uses WaveBase hierarchy for wave excitation (passed in constructor)
@@ -88,7 +88,7 @@ class ChronoHydroCoupler;
 }
 
 class ForceFunc6d;
-class TestHydro;
+class HydroForces;
 
 // ─────────────────────────────────────────────────────────────────────────────
 // Degrees of Freedom Constant
@@ -159,9 +159,9 @@ class ForceFunc6d {
      * @brief Initializes hydro force info from H5FileInfo and the ChBody this force will be applied to.
      *
      * @param object The body in the system to which this 6-dimensional force is being applied.
-     * @param all_hydro_forces_user The TestHydro class where the total force on all bodies is calculated.
+     * @param all_hydro_forces_user The HydroForces class where the total force on all bodies is calculated.
      */
-    ForceFunc6d(std::shared_ptr<chrono::ChBody> object, TestHydro* all_hydro_forces_user);
+    ForceFunc6d(std::shared_ptr<chrono::ChBody> object, HydroForces* all_hydro_forces_user);
 
     /**
      * @brief Copy constructor that ensures the force is only added to a body once.
@@ -208,7 +208,7 @@ class ForceFunc6d {
     std::shared_ptr<ComponentFunc> force_ptrs_[kDofPerBody];  ///< Pointers to the forces.
     std::shared_ptr<chrono::ChForce> chrono_force_;  ///< Chrono force for the body.
     std::shared_ptr<chrono::ChForce> chrono_torque_; ///< Chrono torque for the body.
-    TestHydro* all_hydro_forces_;                   ///< Pointer to TestHydro for calculations.
+    HydroForces* all_hydro_forces_;                 ///< Pointer to HydroForces for calculations.
 };
 
 // Forward declaration of ChLoadAddedMass (defined in added_mass.h, included in .cpp)
@@ -226,22 +226,21 @@ struct HydroProfileStats {
 
 // ═══════════════════════════════════════════════════════════════════════════════
 //
-//  TestHydro — Primary Hydrodynamics Façade / Adapter
+//  HydroForces — Primary Hydrodynamics Façade / Adapter
 //
 // ═══════════════════════════════════════════════════════════════════════════════
 /**
  * @brief Primary hydrodynamics façade for HydroChrono applications.
  *
- * TestHydro is the main user-facing object for attaching hydrodynamic forces to
- * Chrono bodies. Despite its name (a historical artifact), it is NOT a test-only
- * class — it is the production hydrodynamics adapter used by all workflows.
+ * HydroForces is the main user-facing object for attaching hydrodynamic forces to
+ * Chrono bodies. This is the production hydrodynamics adapter used by all workflows.
  *
- * @note The name "TestHydro" is retained for backward compatibility. New code
- *       may use the alias `HydroForces` for clarity (see below).
+ * @note The historical name "TestHydro" is retained as an alias for backward
+ *       compatibility. New code should use `HydroForces`.
  *
  * ## What It Does
  *
- * TestHydro bridges three layers:
+ * HydroForces bridges three layers:
  *   1. **Chrono bodies** — The physical bodies in the Chrono simulation.
  *   2. **HydroSystem (core)** — Chrono-free hydrodynamic force computation.
  *   3. **Chrono force callbacks** — ChForce functions that Chrono calls each timestep.
@@ -256,16 +255,16 @@ struct HydroProfileStats {
  *
  *   // Attach hydrodynamic forces (with or without waves)
  *   std::vector<std::shared_ptr<ChBody>> bodies = {body1};
- *   TestHydro hydro(bodies, "path/to/hydro_data.h5");
+ *   HydroForces hydro(bodies, "path/to/hydro_data.h5");
  *   hydro.AddWaves(std::make_shared<RegularWave>(...));
  *
- *   // Run simulation — Chrono automatically queries TestHydro for forces
+ *   // Run simulation — Chrono automatically queries HydroForces for forces
  * @endcode
  *
  * ## Used By
  *
- *   - **C++ tests and demos** — Directly instantiate TestHydro with bodies and H5 file.
- *   - **YAML runner (hydrochrono.exe)** — SetupHydroFromYAML creates TestHydro internally.
+ *   - **C++ tests and demos** — Directly instantiate HydroForces with bodies and H5 file.
+ *   - **YAML runner (hydrochrono.exe)** — SetupHydroFromYAML creates HydroForces internally.
  *
  * ## Architecture Notes
  *
@@ -279,16 +278,16 @@ struct HydroProfileStats {
  *   to determine body order. Internally, body indices are **1-based** in the callback
  *   interface (CoordinateFuncForBody) to match this naming convention.
  *
- * @see HydroForces (alias below)
+ * @see TestHydro (backwards-compatibility alias)
  * @see HydroSystem (Chrono-free hydrodynamic core)
  * @see ChronoHydroCoupler (extracts state from Chrono bodies)
  */
-class TestHydro {
+class HydroForces {
   public:
-    TestHydro() = delete;
+    HydroForces() = delete;
 
     /**
-     * @brief Main constructor for initializing the TestHydro class.
+     * @brief Main constructor for initializing the HydroForces class.
      *
      * Sets up vector of bodies, h5 file info, and hydro inputs. If no waves are given,
      * this constructor defaults to using NoWave.
@@ -297,16 +296,16 @@ class TestHydro {
      * @param h5_file_name Name of the h5 file where hydro data is stored.
      * @param waves WaveBase object. Defaults to NoWave if not provided.
      */
-    TestHydro(std::vector<std::shared_ptr<chrono::ChBody>> user_bodies,
-              std::string h5_file_name,
-              std::shared_ptr<WaveBase> waves = std::make_shared<NoWave>());
+    HydroForces(std::vector<std::shared_ptr<chrono::ChBody>> user_bodies,
+                std::string h5_file_name,
+                std::shared_ptr<WaveBase> waves = std::make_shared<NoWave>());
 
     // Destructor (defined in .cpp to allow unique_ptr to incomplete type)
-    ~TestHydro();
+    ~HydroForces();
 
     // Deleted copy constructor and assignment operator for safety.
-    TestHydro(const TestHydro& old) = delete;
-    TestHydro& operator=(const TestHydro& rhs) = delete;
+    HydroForces(const HydroForces& old) = delete;
+    HydroForces& operator=(const HydroForces& rhs) = delete;
 
     /**
      * @brief Adds waves class to force calculations depending on if regular or irregular waves.
@@ -518,7 +517,7 @@ class TestHydro {
     std::unique_ptr<hydrochrono::hydro::ExcitationComponent> CreateExcitationComponent() const;
 
     // Factory: creates HydrostaticsComponent with current equilibrium/stiffness data.
-    // Used by both the TestHydro constructor and EnsureHydroSystemAndCoupler()
+    // Used by both the HydroForces constructor and EnsureHydroSystemAndCoupler()
     // to ensure consistent construction.
     std::unique_ptr<hydrochrono::hydro::HydrostaticsComponent> CreateHydrostaticsComponent() const;
 
@@ -534,20 +533,18 @@ class TestHydro {
 };
 
 // ─────────────────────────────────────────────────────────────────────────────
-// Public Alias for Clarity
+// Backwards-Compatibility Alias
 // ─────────────────────────────────────────────────────────────────────────────
 /**
- * @brief Alias for TestHydro — the primary hydrodynamics façade.
+ * @brief Backwards-compatibility alias for HydroForces.
  *
- * HydroForces is the recommended name for new code. The underlying class
- * is TestHydro (historical name retained for backward compatibility).
+ * TestHydro is the historical name for the main hydrodynamics façade.
+ * It is retained as an alias for backward compatibility with existing code.
  *
- * Usage:
- * @code{.cpp}
- *   HydroForces hydro(bodies, "hydro_data.h5");
- *   hydro.AddWaves(my_waves);
- * @endcode
+ * @note Prefer `HydroForces` for new code.
+ *
+ * @deprecated Use HydroForces instead.
  */
-using HydroForces = TestHydro;
+using TestHydro = HydroForces;
 
 #endif

src/hydro/config/setup_from_yaml.cpp

@@ -5,20 +5,20 @@
  *
  * OVERVIEW:
  * Implements the SetupHydroFromYAML function that connects YAML configuration
- * to Chrono bodies and creates a configured TestHydro instance. Handles body
+ * to Chrono bodies and creates a configured HydroForces instance. Handles body
  * matching, wave model creation, and convolution mode setup.
  *
  * MAIN RESPONSIBILITIES:
  * - Match bodies by name between YAML config and Chrono system
  * - Factory function for WaveBase implementations (RegularWave, IrregularWaves, NoWave)
- * - TestHydro initialization with matched bodies and H5 file path
+ * - HydroForces initialization with matched bodies and H5 file path
  * - Configuration of radiation convolution options from YAML
  *
  * INTERACTIONS:
  * - Reads hydro_data (YAMLHydroData) from parser
  * - Accesses Chrono bodies from simulation system
  * - Creates WaveBase instances via factory pattern
- * - Configures TestHydro with convolution settings
+ * - Configures HydroForces with convolution settings
  *
  * KEY ASSUMPTIONS:
  * - All bodies use same H5 file (takes first body's h5_file)
@@ -34,7 +34,7 @@
 
 #include "setup_from_yaml.h"
 #include "config_loader.h"
-#include <hydroc/hydro_forces.h> // For TestHydro
+#include <hydroc/hydro_forces.h> // For HydroForces
 #include <hydroc/waves/wave_base.h>
 #include <hydroc/waves/regular_wave.h>
 #include <hydroc/waves/irregular_wave.h>
@@ -171,9 +171,9 @@ std::vector<std::shared_ptr<ChBody>> MatchBodiesByName(
 // ------------------------------------------------------------
 // SECTION: Main setup function
 // ------------------------------------------------------------
-// Orchestrates body matching, wave creation, and TestHydro initialization.
+// Orchestrates body matching, wave creation, and HydroForces initialization.
 
-std::unique_ptr<TestHydro> SetupHydroFromYAML(
+std::unique_ptr<HydroForces> SetupHydroFromYAML(
     const YAMLHydroData& hydro_data,
     const std::vector<std::shared_ptr<ChBody>>& bodies,
     double timestep,
@@ -192,18 +192,18 @@ std::unique_ptr<TestHydro> SetupHydroFromYAML(
     auto wave = CreateWaveFromSettings(hydro_data.waves, matched_bodies.size(), 
                                       timestep, sim_duration, ramp_duration);
 
-    // Create and initialize TestHydro (multibody: all matched bodies passed in)
-    auto test_hydro = std::make_unique<TestHydro>(matched_bodies, h5_file_path, wave);
+    // Create and initialize HydroForces (multibody: all matched bodies passed in)
+    auto hydro_forces = std::make_unique<HydroForces>(matched_bodies, h5_file_path, wave);
 
-    hydroc::debug::LogDebug(std::string("Initialized TestHydro with ") + std::to_string(matched_bodies.size()) + " bodies");
+    hydroc::debug::LogDebug(std::string("Initialized HydroForces with ") + std::to_string(matched_bodies.size()) + " bodies");
 
     // System-wide convolution settings (applies to all bodies)
     std::string mode = hydro_data.radiation_convolution_mode;
     hydroc::debug::LogDebug("Parsed convolution mode: '" + mode + "'");
     std::transform(mode.begin(), mode.end(), mode.begin(), ::tolower);
     hydroc::debug::LogDebug("Lowercase mode: '" + mode + "'");
     if (mode == "tapereddirect") {
-        test_hydro->SetRadiationConvolutionMode(hydrochrono::hydro::RadiationConvolutionMode::TaperedDirect);
+        hydro_forces->SetRadiationConvolutionMode(hydrochrono::hydro::RadiationConvolutionMode::TaperedDirect);
         hydroc::debug::LogDebug("Radiation convolution mode: TaperedDirect");
         hydrochrono::hydro::TaperedDirectOptions opts;
         opts.smoothing = !hydro_data.td_smoothing.empty() ? hydro_data.td_smoothing : opts.smoothing;
@@ -218,7 +218,7 @@ std::unique_ptr<TestHydro> SetupHydroFromYAML(
         opts.taper_end_percent = hydro_data.td_taper_end_percent;
         opts.taper_final_amplitude = hydro_data.td_taper_final_amplitude;
         opts.export_plot_csv = hydro_data.td_export_plot_csv;
-        test_hydro->SetTaperedDirectOptions(opts);
+        hydro_forces->SetTaperedDirectOptions(opts);
 
         // CLI inline bullets near main summary
         hydroc::cli::LogInfo(hydroc::cli::CreateAlignedLine("•", "Convolution Mode", "TaperedDirect"));
@@ -234,12 +234,12 @@ std::unique_ptr<TestHydro> SetupHydroFromYAML(
             hydroc::cli::LogInfo(hydroc::cli::CreateAlignedLine("•", "Conv Export CSV", (opts.export_plot_csv ? "true" : "false")));
         }
     } else {
-        test_hydro->SetRadiationConvolutionMode(hydrochrono::hydro::RadiationConvolutionMode::Baseline);
+        hydro_forces->SetRadiationConvolutionMode(hydrochrono::hydro::RadiationConvolutionMode::Baseline);
         hydroc::debug::LogDebug("Radiation convolution mode: Baseline");
         hydroc::cli::LogInfo(hydroc::cli::CreateAlignedLine("•", "Convolution Mode", "Baseline"));
     }
 
-    return test_hydro;
+    return hydro_forces;
 }
 
 // ------------------------------------------------------------
@@ -248,7 +248,7 @@ std::unique_ptr<TestHydro> SetupHydroFromYAML(
 // Keeps file parsing and setup logic together for callers that
 // only know the YAML path.
 
-std::unique_ptr<TestHydro> SetupHydroFromYAMLFile(
+std::unique_ptr<HydroForces> SetupHydroFromYAMLFile(
     const std::string& hydro_yaml_path,
     const std::vector<std::shared_ptr<ChBody>>& bodies,
     double timestep,

src/hydro/config/setup_from_yaml.h

@@ -6,18 +6,18 @@
  * OVERVIEW:
  * This file provides the main entry point for configuring hydrodynamic
  * forces from YAML configuration files. It bridges parsed configuration
- * data to the TestHydro force computation system.
+ * data to the HydroForces force computation system.
  *
  * MAIN RESPONSIBILITIES:
  * - Match Chrono bodies with YAML body configurations by name
  * - Create appropriate WaveBase implementations from wave settings
- * - Initialize TestHydro with matched bodies and wave models
+ * - Initialize HydroForces with matched bodies and wave models
  * - Configure radiation convolution options (Baseline/TaperedDirect)
  *
  * INTERACTIONS:
  * - Takes parsed YAMLHydroData from yaml_parser
  * - Takes Chrono bodies from the simulation system
- * - Returns configured TestHydro instance ready for simulation
+ * - Returns configured HydroForces instance ready for simulation
  * - Uses wave_types.h for wave model creation
  *
  * KEY ASSUMPTIONS:
@@ -43,24 +43,24 @@
 #include <string>
 
 // Forward declarations
-class TestHydro;
+class HydroForces;
 
 /**
  * @brief Setup hydrodynamic forces from parsed YAML data.
  *
  * This function connects parsed YAML data (from hydro.yaml) to actual hydrodynamic forces.
  * It builds the appropriate WaveBase subclass from hydro_data.waves, matches body names
- * with their corresponding HDF5 files, and initializes TestHydro with the matched bodies.
+ * with their corresponding HDF5 files, and initializes HydroForces with the matched bodies.
  *
  * @param hydro_data Parsed hydrodynamic configuration from hydro.yaml
  * @param bodies Vector of Chrono bodies that may have hydrodynamic forces
  * @param timestep Simulation timestep (used for irregular wave setup)
  * @param sim_duration Simulation duration (used for irregular wave setup)
  * @param ramp_duration Wave ramp duration (used for irregular wave setup)
- * @return Unique pointer to initialized TestHydro object
+ * @return Unique pointer to initialized HydroForces object
  * @throws std::runtime_error on configuration errors
  */
-std::unique_ptr<TestHydro> SetupHydroFromYAML(
+std::unique_ptr<HydroForces> SetupHydroFromYAML(
     const YAMLHydroData& hydro_data,
     const std::vector<std::shared_ptr<chrono::ChBody>>& bodies,
     double timestep,
@@ -69,7 +69,7 @@ std::unique_ptr<TestHydro> SetupHydroFromYAML(
 );
 
 /**
- * @brief Convenience overload that loads the YAML file and then sets up TestHydro.
+ * @brief Convenience overload that loads the YAML file and then sets up HydroForces.
  *
  * Behaviour matches calling LoadHydroConfigFromYaml followed by SetupHydroFromYAML.
  *
@@ -78,9 +78,9 @@ std::unique_ptr<TestHydro> SetupHydroFromYAML(
  * @param timestep Simulation time step (used for irregular waves).
  * @param sim_duration Simulation duration (irregular waves).
  * @param ramp_duration Wave ramp duration.
- * @return Initialized TestHydro object.
+ * @return Initialized HydroForces object.
  */
-std::unique_ptr<TestHydro> SetupHydroFromYAMLFile(
+std::unique_ptr<HydroForces> SetupHydroFromYAMLFile(
     const std::string& hydro_yaml_path,
     const std::vector<std::shared_ptr<chrono::ChBody>>& bodies,
     double timestep,