WaveField.h

#pragma once
 
#include <marenv/marenv.h>
 
#include <memory>
#include <string>
#include <vector>
 
#if defined(_MSC_VER)
#    define RESTRICT __restrict
#else
#    define RESTRICT __restrict__
#endif
 
namespace marenv::wave
{
 
struct WaveComponentData
{
    std::vector<double> zetaA; 
    std::vector<double> epsilon; 
    std::vector<double> omega; 
    std::vector<double> waveNumber; 
    std::vector<double> theta; 
};
class WaveField : private marenv::NoCopyNoMove
{
public:
 
    struct InsecureDatapointers
    {
        const double* RESTRICT zetaA; 
        const double* RESTRICT epsilon; 
        const double* RESTRICT omega; 
        const double* RESTRICT waveNumber; 
        const double* RESTRICT theta; 
        const double* RESTRICT cosTheta; 
        const double* RESTRICT sinTheta; 
        const double* RESTRICT remainingAccumulatedAmplitude; 
        int numWaves; 
    };
    virtual ~WaveField() = default;
    [[nodiscard]] virtual std::string SpectrumName() const = 0;
    [[nodiscard]] virtual std::string WaveTheoryName() const = 0;
    virtual marenv::Status ComputeSurfaceElevation(double time, const double pos[2], double& elevationOut) = 0;
    virtual marenv::Status ComputeDynamicPressure(double time, const double pos[3], double& pressureOut) = 0;
    virtual marenv::Status ComputeTotalPressure(double time, const double pos[3], double& pressureOut) = 0;
    virtual marenv::Status ComputeSurfaceUnitNormal(double time, const double pos[2], double unitNormalOut[3]) = 0;
    virtual marenv::Status ComputeParticleVelocity(double time, const double pos[3], double velOut[3]) = 0;
    virtual marenv::Status ComputeParticleAcceleration(double time, const double pos[3], double accOut[3]) = 0;
 
    virtual marenv::Status ComputePointQuery(double time, const double pos[3], double& surface_elevation, // clang-format off
                                         double surface_unit_normal[3], double particle_velocity[3],
                                         double particle_acceleration[3], double& pressure)                         = 0; // clang-format on
    virtual InsecureDatapointers GetWaveComponents() const = 0;
    virtual marenv::wave::WaveComponentData GetWaveComponentsCopy() const = 0;
 
    virtual marenv::wave::WaveComponentData GetWaveComponentsCopy(double time, size_t maxComponents = 0) const;
 
    [[nodiscard]] virtual double MaxWaveElevation() const;
 
protected:
 
    WaveField() = default;
};
} // namespace marenv::wave