WaveComponents.h

#pragma once
 
#include "marenv/marenv.h"
#include <marenv/wave/WaveField.h>
 
#include <memory>
#include <string>
#include <vector>
#include <xsimd/xsimd.hpp>
 
namespace marenv::wave
{
// [1] alignedvec is an internal implementation detail; it is defined in WaveComponents.cpp
//     and is NOT part of the public API.  Only the std::vector<double> constructor is public.
 
enum class SpectrumType
{
    JONSWAP,
    ISSC,
    Components
};
 
class WaveComponents : private marenv::MoveNoCopy
{
public:
    WaveComponents(std::vector<double> amplitude, std::vector<double> phaseAngle, std::vector<double> frequency, std::vector<double> direction, SpectrumType spectrumType);
 
    ~WaveComponents() = default;
 
 
    void Sort();
 
    [[nodiscard]] std::string GetSpectrumType() const;
 
    [[nodiscard]] WaveField::InsecureDatapointers GetInsecureDatapointers() const;
 
private:
    // [1] alignedvec is a typedef for std::vector<double, xsimd::aligned_allocator<double,64>>.
    //     It is defined in WaveComponents.cpp. The private constructor below (used by
    //     WaveEnergySpectrum) takes pre-built aligned vectors to avoid an extra copy.
    friend class WaveEnergySpectrum;
    using alignedvec = std::vector<double, xsimd::aligned_allocator<double, 64>>;
    WaveComponents(alignedvec amplitude, alignedvec phaseAngle, alignedvec frequency, alignedvec direction, SpectrumType spectrumType);
 
    alignedvec zetaA; 
    alignedvec epsilon; 
    alignedvec omega; 
    alignedvec waveNumber; 
    alignedvec theta; 
    alignedvec cosTheta; 
    alignedvec sinTheta; 
    alignedvec remainingAccumulatedAmplitude; 
    // [3] numWaves mirrors the sizes of the above vectors. It is stored as int (not size_t)
    //     because SIMD loop indices are int and sign-mixing warnings are undesirable.
    //     The constructor throws for more than 52 components (see the constructor).
    int numWaves; 
    SpectrumType spectrumType; 
};
} // namespace marenv::wave