GerstnerWaves.h

#pragma once
 
#include <marenv/wave/LinearWaveTheory.h>
#include <marenv/wave/WaveEnergySpectrum.h>
 
namespace marenv::wave
{
 
class GerstnerWaves : public LinearWaveTheory
{
public:
    explicit GerstnerWaves(std::shared_ptr<WaveComponents> waveComponents);
    GerstnerWaves(WaveEnergySpectrum::SpectrumParameters spectrumParameters, int numWaves, uint32_t randomSeed);
 
    ~GerstnerWaves() override = default;
 
    Status ComputeSurfaceElevation(double time, const double pos[2], double& elevationOut) override;
    Status ComputeSurfaceElevationAtLagrange(double time, const double lagrangePos[2], double& elevationOut);
 
    Status ComputeSurfaceUnitNormal(double time, const double pos[2], double unitNormalOut[3]) override;
    Status ComputeSurfaceUnitNormalAtLagrange(double time, const double lagrangePos[2], double unitNormalOut[3]);
 
    Status ComputeParticleVelocity(double time, const double pos[3], double velOut[3]) override;
    Status ComputeParticleVelocityAtLagrange(double time, const double lagrangePos[3], double velOut[3]);
 
    Status ComputeParticleAcceleration(double time, const double pos[3], double accOut[3]) override;
    Status ComputeParticleAccelerationAtLagrange(double time, const double lagrangePos[3], double accOut[3]);
 
    Status ComputeDynamicPressure(double time, const double pos[3], double& pressureOut) override;
    Status ComputeDynamicPressureAtLagrange(double time, const double lagrangePos[3], double& pressureOut);
 
    Status ComputeTotalPressure(double time, const double pos[3], double& pressureOut) override;
    Status ComputeTotalPressureWithElevation(double eulerZ, double elevation, double& pressureOut);
 
    Status ComputePointQuery(
        double time,
        const double pos[3],
        double& surface_elevation,
        double surface_unit_normal[3],
        double particle_velocity[3],
        double particle_acceleration[3],
        double& pressure) override;
 
protected:
    bool FindLagrangePoint3D(double time, const double eulerPosIn[3], double* lagrangePosOut);
    bool FindLagrangePoint2D(double time, const double eulerPosIn[2], double* lagrangePosOut);
 
    enum class WaterLocation
    {
        InWater, 
        InAir, 
        NotConverged 
    };
    WaterLocation LocateInWater(double time, const double pos[3], double surfaceLagrangePos[2], double lagrangePos[3]);
    [[nodiscard]] double TotalPressureAtLagrange(const double lagrangePos[3]) const;
 
    void ThrowIfWavesAreTooSteep();
};
} // namespace marenv::wave