FreeSurfaceSampler.H

Go to the documentation of this file.

#ifndef FREESURFACESAMPLER_H
#define FREESURFACESAMPLER_H
 
#include "amr-wind/CFDSim.H"
#include "amr-wind/utilities/sampling/SamplerBase.H"
 
namespace amr_wind::sampling {
 
class FreeSurfaceSampler : public SamplerBase::Register<FreeSurfaceSampler>
{
public:
    static std::string identifier() { return "FreeSurfaceSampler"; }
 
    FreeSurfaceSampler(CFDSim& /*sim*/);
 
    ~FreeSurfaceSampler() 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);
    }

    bool update_sampling_locations() override;

    void post_regrid_actions() override;
 
    void
    define_netcdf_metadata(const ncutils::NCGroup& /*unused*/) const override;
    void
    populate_netcdf_metadata(const ncutils::NCGroup& /*unused*/) const override;
    void output_netcdf_data(
        const ncutils::NCGroup& /*unused*/, size_t /*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]] int num_gridpoints() const { return m_npts; }
    [[nodiscard]] int num_instances() const { return m_ninst; }
    [[nodiscard]] long num_points() const override
    {
        return static_cast<long>(m_npts) * m_ninst;
    }
    [[nodiscard]] long num_output_points() const override
    {
        return static_cast<long>(m_npts) * m_ninst;
    }

    [[nodiscard]] amrex::Vector<amrex::Array<amrex::Real, 2>>
    grid_locations() const
    {
        return m_grid_locs;
    }

    [[nodiscard]] amrex::Vector<amrex::Real> heights() const { return m_out; }
 
private:
    CFDSim& m_sim;

    const Field& m_vof;

    amrex::Vector<int> m_npts_dir;
    int m_npts{0};
    int m_ninst{1};

    int m_coorddir{2};
    int m_gc0 = 0;
    int m_gc1 = 1;

    amrex::Vector<amrex::Real> m_start, m_end;
    amrex::Vector<amrex::Array<amrex::Real, 2>> m_grid_locs;
    amrex::Vector<amrex::Real> m_out;

    bool m_use_linear{false};
    amrex::Real m_lx_linear{0.};

    int m_ncomp{1};
    int m_ncmax{8};
 
    std::string m_label;
    int m_id{-1};
};
 
} // namespace amr_wind::sampling
 
#endif /* FREESURFACESAMPLER_H */