WakeField.h

#pragma once
 
#include <marenv/marenv.h>
#include <marenv/wake/FieldSketch.h>
#include <marenv/wake/WakeSampleParts.h>
#include <marenv/wake/WakeTypes.h>
 
#include <array>
#include <cstddef>
#include <cstdint>
#include <span>
 
namespace marenv::wake
{
struct WakeQueryRegion
{
    double centre[3]; 
    double radius; 
    double tBegin; 
    double tEnd; 
    double cutoff = 0.0; 
};
 
class WakeField : private marenv::NoCopyNoMove
{
public:
    virtual ~WakeField() = default;
 
    virtual Status Sample(double t, const double pos[3], WakeSample& out) const = 0;
 
    virtual WakeSampleParts SampleParts(double t, const double pos[3]) const
    {
        WakeSampleParts parts;
        parts.status = Sample(t, pos, parts.sample);
        return parts;
    }
 
    virtual bool MayReach(const WakeQueryRegion& region) const
    {
        (void)region;
        return true;
    }
 
    // The two virtuals below were added in 2.1.1 (ENV-0107) after every earlier virtual, so the slots of
    // the earlier ones stay where 2.1.0 put them (the ABI still changes: rebuild every class that derives from WakeField).
 
    virtual Status SampleExcluding(double t, const double pos[3], std::span<const int> excludedTags, WakeSample& out) const
    {
        (void)excludedTags;
        return Sample(t, pos, out);
    }
 
    virtual WakeSampleParts SamplePartsExcluding(double t, const double pos[3], std::span<const int> excludedTags) const
    {
        (void)excludedTags;
        return SampleParts(t, pos);
    }
 
    // The four virtuals below were added in 2.1.2 after every earlier virtual (rebuild every class that derives from WakeField).
 
    virtual std::uint64_t Revision() const { return 0; }
 
    virtual bool StaticFrom(double t) const
    {
        (void)t;
        return false;
    }
 
    virtual void SampleMany(double t, std::span<const std::array<double, 3>> positions, std::span<WakeSample> out, std::span<Status> status) const
    {
        for (std::size_t i = 0; i < positions.size(); ++i)
            status[i] = Sample(t, positions[i].data(), out[i]);
    }
 
    virtual void Sketch(double t, FieldSketch& out) const
    {
        (void)t;
        (void)out;
    }
 
protected:
    WakeField() = default;
};
} // namespace marenv::wake