LineSampler.H

Go to the documentation of this file.

#ifndef LINESAMPLER_H
#define LINESAMPLER_H
 
#include "amr-wind/utilities/sampling/SamplerBase.H"
 
namespace amr_wind::sampling {

class LineSampler : public SamplerBase::Register<LineSampler>
{
public:
    static std::string identifier() { return "LineSampler"; }
 
    explicit LineSampler(const CFDSim& /*sim*/);
 
    ~LineSampler() override;

    void initialize(const std::string& key) override;

    void check_bounds() override;

    void sampling_locations(SampleLocType& /*sample_locs*/) const override;

    void sampling_locations(
        SampleLocType& /*sample_locs*/,
        const amrex::Box& /*box*/) const override;
 
    void output_locations(SampleLocType& sample_locs) const override
    {
        sampling_locations(sample_locs);
    }
 
    void
    define_netcdf_metadata(const ncutils::NCGroup& /*unused*/) const override;
    void
    populate_netcdf_metadata(const ncutils::NCGroup& /*unused*/) const override;

    [[nodiscard]] std::string label() const override { return m_label; }
    std::string& label() override { return m_label; }

    [[nodiscard]] std::string sampletype() const override
    {
        return identifier();
    }

    [[nodiscard]] int id() const override { return m_id; }
    int& id() override { return m_id; }

    [[nodiscard]] long num_points() const override { return m_npts; }

    [[nodiscard]] long num_output_points() const override { return m_npts; }
 
protected:
    const CFDSim& m_sim;
 
    amrex::Vector<amrex::Real> m_start;
    amrex::Vector<amrex::Real> m_end;
 
    std::string m_label;
    int m_id{-1};
    int m_npts{0};
};
 
} // namespace amr_wind::sampling
 
#endif /* LINESAMPLER_H */