Waves simulation optimisation - part 2

gz-waves/include/gz/waves/WaveSimulation.hh

@@ -31,35 +31,35 @@ namespace waves
 
     WaveSimulation();
 
-    virtual void SetWindVelocity(double _ux, double _uy) = 0;
+    virtual void SetWindVelocity(double ux, double uy) = 0;
 
-    virtual void SetTime(double _value) = 0;
+    virtual void SetTime(double value) = 0;
 
     virtual void ComputeElevation(
-        Eigen::Ref<Eigen::MatrixXd> _h) = 0;
+        Eigen::Ref<Eigen::MatrixXd> h) = 0;
 
     virtual void ComputeElevationDerivatives(
-        Eigen::Ref<Eigen::MatrixXd> _dhdx,
-        Eigen::Ref<Eigen::MatrixXd> _dhdy) = 0;
+        Eigen::Ref<Eigen::MatrixXd> dhdx,
+        Eigen::Ref<Eigen::MatrixXd> dhdy) = 0;
 
     virtual void ComputeDisplacements(
-        Eigen::Ref<Eigen::MatrixXd> _sx,
-        Eigen::Ref<Eigen::MatrixXd> _sy) = 0;
+        Eigen::Ref<Eigen::MatrixXd> sx,
+        Eigen::Ref<Eigen::MatrixXd> sy) = 0;
 
     virtual void ComputeDisplacementsDerivatives(
-        Eigen::Ref<Eigen::MatrixXd> _dsxdx,
-        Eigen::Ref<Eigen::MatrixXd> _dsydy,
-        Eigen::Ref<Eigen::MatrixXd> _dsxdy) = 0;
+        Eigen::Ref<Eigen::MatrixXd> dsxdx,
+        Eigen::Ref<Eigen::MatrixXd> dsydy,
+        Eigen::Ref<Eigen::MatrixXd> dsxdy) = 0;
 
     virtual void ComputeDisplacementsAndDerivatives(
-        Eigen::Ref<Eigen::MatrixXd> _h,
-        Eigen::Ref<Eigen::MatrixXd> _sx,
-        Eigen::Ref<Eigen::MatrixXd> _sy,
-        Eigen::Ref<Eigen::MatrixXd> _dhdx,
-        Eigen::Ref<Eigen::MatrixXd> _dhdy,
-        Eigen::Ref<Eigen::MatrixXd> _dsxdx,
-        Eigen::Ref<Eigen::MatrixXd> _dsydy,
-        Eigen::Ref<Eigen::MatrixXd> _dsxdy) = 0;
+        Eigen::Ref<Eigen::MatrixXd> h,
+        Eigen::Ref<Eigen::MatrixXd> sx,
+        Eigen::Ref<Eigen::MatrixXd> sy,
+        Eigen::Ref<Eigen::MatrixXd> dhdx,
+        Eigen::Ref<Eigen::MatrixXd> dhdy,
+        Eigen::Ref<Eigen::MatrixXd> dsxdx,
+        Eigen::Ref<Eigen::MatrixXd> dsydy,
+        Eigen::Ref<Eigen::MatrixXd> dsxdy) = 0;
   };
 }
 }

gz-waves/include/gz/waves/WaveSimulationFFT2.hh

@@ -16,12 +16,10 @@
 #ifndef GZ_WAVES_WAVESIMULATIONFFT2_HH_
 #define GZ_WAVES_WAVESIMULATIONFFT2_HH_
 
-#include "WaveSimulation.hh"
-
-using Eigen::MatrixXd;
-
 #include <memory>
 
+#include "WaveSimulation.hh"
+
 using Eigen::MatrixXd;
 
 namespace gz
@@ -35,45 +33,45 @@ namespace waves
     public:
       virtual ~WaveSimulationFFT2();
 
-      WaveSimulationFFT2(double _lx, double _ly, int _nx, int _ny);
+      WaveSimulationFFT2(double lx, double ly, int nx, int ny);
 
-      void SetUseVectorised(bool _value);
+      void SetUseVectorised(bool value);
 
       /// \brief Set lambda which controls the horizontal wave displacement.
-      void SetLambda(double _lambda);
+      void SetLambda(double lambda);
 
-      virtual void SetWindVelocity(double _ux, double _uy) override;
+      virtual void SetWindVelocity(double ux, double uy) override;
 
-      virtual void SetTime(double _value) override;
+      virtual void SetTime(double value) override;
 
       virtual void ComputeElevation(
-          Eigen::Ref<Eigen::MatrixXd> _h) override;
+          Eigen::Ref<Eigen::MatrixXd> h) override;
 
       virtual void ComputeElevationDerivatives(
-          Eigen::Ref<Eigen::MatrixXd> _dhdx,
-          Eigen::Ref<Eigen::MatrixXd> _dhdy) override;
+          Eigen::Ref<Eigen::MatrixXd> dhdx,
+          Eigen::Ref<Eigen::MatrixXd> dhdy) override;
 
       virtual void ComputeDisplacements(
-          Eigen::Ref<Eigen::MatrixXd> _sx,
-          Eigen::Ref<Eigen::MatrixXd> _sy) override;
+          Eigen::Ref<Eigen::MatrixXd> sx,
+          Eigen::Ref<Eigen::MatrixXd> sy) override;
 
       virtual void ComputeDisplacementsDerivatives(
-          Eigen::Ref<Eigen::MatrixXd> _dsxdx,
-          Eigen::Ref<Eigen::MatrixXd> _dsydy,
-          Eigen::Ref<Eigen::MatrixXd> _dsxdy) override;
+          Eigen::Ref<Eigen::MatrixXd> dsxdx,
+          Eigen::Ref<Eigen::MatrixXd> dsydy,
+          Eigen::Ref<Eigen::MatrixXd> dsxdy) override;
 
       virtual void ComputeDisplacementsAndDerivatives(
-          Eigen::Ref<Eigen::MatrixXd> _h,
-          Eigen::Ref<Eigen::MatrixXd> _sx,
-          Eigen::Ref<Eigen::MatrixXd> _sy,
-          Eigen::Ref<Eigen::MatrixXd> _dhdx,
-          Eigen::Ref<Eigen::MatrixXd> _dhdy,
-          Eigen::Ref<Eigen::MatrixXd> _dsxdx,
-          Eigen::Ref<Eigen::MatrixXd> _dsydy,
-          Eigen::Ref<Eigen::MatrixXd> _dsxdy) override;
+          Eigen::Ref<Eigen::MatrixXd> h,
+          Eigen::Ref<Eigen::MatrixXd> sx,
+          Eigen::Ref<Eigen::MatrixXd> sy,
+          Eigen::Ref<Eigen::MatrixXd> dhdx,
+          Eigen::Ref<Eigen::MatrixXd> dhdy,
+          Eigen::Ref<Eigen::MatrixXd> dsxdx,
+          Eigen::Ref<Eigen::MatrixXd> dsydy,
+          Eigen::Ref<Eigen::MatrixXd> dsxdy) override;
 
     private:
-      std::unique_ptr<WaveSimulationFFT2Impl> impl;
+      std::unique_ptr<WaveSimulationFFT2Impl> impl_;
   };
 }
 }

gz-waves/include/gz/waves/WaveSimulationSinusoid.hh

@@ -16,11 +16,11 @@
 #ifndef GZ_WAVES_WAVESIMULATIONSINUSOID_HH_
 #define GZ_WAVES_WAVESIMULATIONSINUSOID_HH_
 
-#include "WaveSimulation.hh"
+#include <memory>
 
 #include <Eigen/Dense>
 
-#include <memory>
+#include "WaveSimulation.hh"
 
 using Eigen::MatrixXd;
 
@@ -45,49 +45,49 @@ namespace waves
     public:
       ~WaveSimulationSinusoid();
 
-      WaveSimulationSinusoid(double _lx, double _ly, int _nx, int _ny);
+      WaveSimulationSinusoid(double lx, double ly, int nx, int ny);
 
-      void SetUseVectorised(bool _value);
+      void SetUseVectorised(bool value);
 
-      void SetDirection(double _dir_x, double _dir_y);
+      void SetDirection(double dir_x, double dir_y);
 
-      void SetAmplitude(double _value);
+      void SetAmplitude(double value);
 
-      void SetPeriod(double _value);
+      void SetPeriod(double value);
 
-      virtual void SetWindVelocity(double _ux, double _uy) override;
+      virtual void SetWindVelocity(double ux, double uy) override;
 
-      virtual void SetTime(double _value) override;
+      virtual void SetTime(double value) override;
 
       virtual void ComputeElevation(
-          Eigen::Ref<Eigen::MatrixXd> _h) override;
+          Eigen::Ref<Eigen::MatrixXd> h) override;
 
       virtual void ComputeElevationDerivatives(
-          Eigen::Ref<Eigen::MatrixXd> _dhdx,
-          Eigen::Ref<Eigen::MatrixXd> _dhdy) override;
+          Eigen::Ref<Eigen::MatrixXd> dhdx,
+          Eigen::Ref<Eigen::MatrixXd> dhdy) override;
 
       virtual void ComputeDisplacements(
-          Eigen::Ref<Eigen::MatrixXd> _sx,
-          Eigen::Ref<Eigen::MatrixXd> _sy) override;
+          Eigen::Ref<Eigen::MatrixXd> sx,
+          Eigen::Ref<Eigen::MatrixXd> sy) override;
 
       virtual void ComputeDisplacementsDerivatives(
-          Eigen::Ref<Eigen::MatrixXd> _dsxdx,
-          Eigen::Ref<Eigen::MatrixXd> _dsydy,
-          Eigen::Ref<Eigen::MatrixXd> _dsxdy) override;
+          Eigen::Ref<Eigen::MatrixXd> dsxdx,
+          Eigen::Ref<Eigen::MatrixXd> dsydy,
+          Eigen::Ref<Eigen::MatrixXd> dsxdy) override;
 
       virtual void ComputeDisplacementsAndDerivatives(
-          Eigen::Ref<Eigen::MatrixXd> _h,
-          Eigen::Ref<Eigen::MatrixXd> _sx,
-          Eigen::Ref<Eigen::MatrixXd> _sy,
-          Eigen::Ref<Eigen::MatrixXd> _dhdx,
-          Eigen::Ref<Eigen::MatrixXd> _dhdy,
-          Eigen::Ref<Eigen::MatrixXd> _dsxdx,
-          Eigen::Ref<Eigen::MatrixXd> _dsydy,
-          Eigen::Ref<Eigen::MatrixXd> _dsxdy) override;
+          Eigen::Ref<Eigen::MatrixXd> h,
+          Eigen::Ref<Eigen::MatrixXd> sx,
+          Eigen::Ref<Eigen::MatrixXd> sy,
+          Eigen::Ref<Eigen::MatrixXd> dhdx,
+          Eigen::Ref<Eigen::MatrixXd> dhdy,
+          Eigen::Ref<Eigen::MatrixXd> dsxdx,
+          Eigen::Ref<Eigen::MatrixXd> dsydy,
+          Eigen::Ref<Eigen::MatrixXd> dsxdy) override;
 
     private:
       class Impl;
-      std::unique_ptr<Impl> impl;
+      std::unique_ptr<Impl> impl_;
   };
 }
 }

gz-waves/include/gz/waves/WaveSimulationTrochoid.hh

@@ -16,11 +16,11 @@
 #ifndef GZ_WAVES_WAVESIMULATIONTROCHOID_HH_
 #define GZ_WAVES_WAVESIMULATIONTROCHOID_HH_
 
-#include "WaveSimulation.hh"
+#include <memory>
 
 #include <Eigen/Dense>
 
-#include <memory>
+#include "WaveSimulation.hh"
 
 using Eigen::MatrixXd;
 
@@ -37,42 +37,42 @@ namespace waves
     virtual ~WaveSimulationTrochoid();
 
     WaveSimulationTrochoid(
-      int _N,
-      double _L,
-      std::shared_ptr<WaveParameters> _params);
+      int nx,
+      double lx,
+      std::shared_ptr<WaveParameters> params);
 
-    virtual void SetWindVelocity(double _ux, double _uy) override;
+    virtual void SetWindVelocity(double ux, double uy) override;
 
-    virtual void SetTime(double _time) override;
+    virtual void SetTime(double time) override;
 
     virtual void ComputeElevation(
-        Eigen::Ref<Eigen::MatrixXd> _h) override;
+        Eigen::Ref<Eigen::MatrixXd> h) override;
 
     virtual void ComputeElevationDerivatives(
-        Eigen::Ref<Eigen::MatrixXd> _dhdx,
-        Eigen::Ref<Eigen::MatrixXd> _dhdy) override;
+        Eigen::Ref<Eigen::MatrixXd> dhdx,
+        Eigen::Ref<Eigen::MatrixXd> dhdy) override;
 
     virtual void ComputeDisplacements(
-        Eigen::Ref<Eigen::MatrixXd> _sx,
-        Eigen::Ref<Eigen::MatrixXd> _sy) override;
+        Eigen::Ref<Eigen::MatrixXd> sx,
+        Eigen::Ref<Eigen::MatrixXd> sy) override;
 
     virtual void ComputeDisplacementsDerivatives(
-        Eigen::Ref<Eigen::MatrixXd> _dsxdx,
-        Eigen::Ref<Eigen::MatrixXd> _dsydy,
-        Eigen::Ref<Eigen::MatrixXd> _dsxdy) override;
+        Eigen::Ref<Eigen::MatrixXd> dsxdx,
+        Eigen::Ref<Eigen::MatrixXd> dsydy,
+        Eigen::Ref<Eigen::MatrixXd> dsxdy) override;
 
     virtual void ComputeDisplacementsAndDerivatives(
-        Eigen::Ref<Eigen::MatrixXd> _h,
-        Eigen::Ref<Eigen::MatrixXd> _sx,
-        Eigen::Ref<Eigen::MatrixXd> _sy,
-        Eigen::Ref<Eigen::MatrixXd> _dhdx,
-        Eigen::Ref<Eigen::MatrixXd> _dhdy,
-        Eigen::Ref<Eigen::MatrixXd> _dsxdx,
-        Eigen::Ref<Eigen::MatrixXd> _dsydy,
-        Eigen::Ref<Eigen::MatrixXd> _dsxdy) override;
+        Eigen::Ref<Eigen::MatrixXd> h,
+        Eigen::Ref<Eigen::MatrixXd> sx,
+        Eigen::Ref<Eigen::MatrixXd> sy,
+        Eigen::Ref<Eigen::MatrixXd> dhdx,
+        Eigen::Ref<Eigen::MatrixXd> dhdy,
+        Eigen::Ref<Eigen::MatrixXd> dsxdx,
+        Eigen::Ref<Eigen::MatrixXd> dsydy,
+        Eigen::Ref<Eigen::MatrixXd> dsxdy) override;
 
   private:
-    std::unique_ptr<WaveSimulationTrochoidImpl> impl;
+    std::unique_ptr<WaveSimulationTrochoidImpl> impl_;
   };
 }
 }

gz-waves/include/gz/waves/WaveSpectrum.hh

@@ -31,37 +31,37 @@ inline namespace v2
   public:
     virtual ~OmniDirectionalWaveSpectrum();
 
-    virtual double Evaluate(double _k) const = 0;
+    virtual double Evaluate(double k) const = 0;
 
     virtual void Evaluate(
-        Eigen::Ref<Eigen::MatrixXd> _spectrum,
-        const Eigen::Ref<const Eigen::MatrixXd> &_k) const = 0;
+        Eigen::Ref<Eigen::MatrixXd> spectrum,
+        const Eigen::Ref<const Eigen::MatrixXd> &k) const = 0;
   };
 
   class PiersonMoskowitzWaveSpectrum : public OmniDirectionalWaveSpectrum
   {
   public:
     virtual ~PiersonMoskowitzWaveSpectrum();
 
-    PiersonMoskowitzWaveSpectrum(double _u19=5.0, double _gravity=9.81);
+    PiersonMoskowitzWaveSpectrum(double u19=5.0, double gravity=9.81);
 
-    virtual double Evaluate(double _k) const override;
+    virtual double Evaluate(double k) const override;
 
     virtual void Evaluate(
-        Eigen::Ref<Eigen::MatrixXd> _spectrum,
-        const Eigen::Ref<const Eigen::MatrixXd> &_k) const override;
+        Eigen::Ref<Eigen::MatrixXd> spectrum,
+        const Eigen::Ref<const Eigen::MatrixXd> &k) const override;
 
     double Gravity() const;
 
-    void SetGravity(double _value);
+    void SetGravity(double value);
 
     double U19() const;
 
-    void SetU19(double _value);
+    void SetU19(double value);
 
   private:
-    double _gravity{9.81};
-    double _u19{5.0};
+    double gravity_{9.81};
+    double u19_{5.0};
   };
 
   class ECKVWaveSpectrum : public OmniDirectionalWaveSpectrum
@@ -70,32 +70,32 @@ inline namespace v2
     virtual ~ECKVWaveSpectrum();
 
     ECKVWaveSpectrum(
-        double _u10=5.0,
-        double _cap_omega_c=0.84,
-        double _gravity=9.81);
+        double u10=5.0,
+        double cap_omega_c=0.84,
+        double gravity=9.81);
 
-    virtual double Evaluate(double _k) const override;
+    virtual double Evaluate(double k) const override;
 
     virtual void Evaluate(
-        Eigen::Ref<Eigen::MatrixXd> _spectrum,
-        const Eigen::Ref<const Eigen::MatrixXd> &_k) const override;
+        Eigen::Ref<Eigen::MatrixXd> spectrum,
+        const Eigen::Ref<const Eigen::MatrixXd> &k) const override;
 
     double Gravity() const;
 
-    void SetGravity(double _value);
+    void SetGravity(double value);
 
     double U10() const;
 
-    void SetU10(double _value);
+    void SetU10(double value);
 
     double CapOmegaC() const;
 
-    void SetCapOmegaC(double _value);
+    void SetCapOmegaC(double value);
 
   private:
-    double _gravity{9.81};
-    double _u10{5.0};
-    double _cap_omega_c{0.84};
+    double gravity_{9.81};
+    double u10_{5.0};
+    double cap_omega_c_{0.84};
   };
 
 }