ABLStatsBase.H

Go to the documentation of this file.

#ifndef ABLSTATSBASE_H
#define ABLSTATSBASE_H
 
#include <cstdint>
#include "src/core/Factory.H"
#include "src/CFDSim.H"
#include "src/wind_energy/ABLWallFunction.H"
 
namespace kynema_sgf {
namespace pde::icns {
class ABLForcing;
class ABLMesoForcingMom;
} // namespace pde::icns
namespace pde::temperature {
class ABLMesoForcingTemp;
}
 
enum class ABLStatsMode : std::uint8_t {
    computed = 0, 
    prescribed    
};
 
class ABLStatsBase
    : public Factory<ABLStatsBase, CFDSim&, ABLWallFunction&, int, int>
{
public:
    static std::string base_identifier() { return "ABLStatsBase"; }
 
    ABLStatsBase() = default;
 
    ~ABLStatsBase() override = default;

    [[nodiscard]] virtual ABLStatsMode abl_mode() const = 0;

    [[nodiscard]] virtual const int& max_level() const = 0;

    [[nodiscard]] virtual const VelPlaneAveraging&
    vel_profile_coarse() const = 0;
    [[nodiscard]] virtual const VelPlaneAveraging& vel_profile() const = 0;

    [[nodiscard]] virtual const FieldPlaneAveraging& theta_profile() const = 0;
    [[nodiscard]] virtual const FieldPlaneAveraging&
    theta_profile_fine() const = 0;

    virtual void post_init_actions() = 0;

    virtual void pre_advance_work() = 0;

    virtual void post_advance_work() = 0;
 
    virtual void
    register_forcing_term(pde::icns::ABLForcing* forcing) const = 0;
 
    virtual void
    register_meso_mom_forcing(pde::icns::ABLMesoForcingMom* forcing) const = 0;
 
    virtual void register_meso_temp_forcing(
        pde::temperature::ABLMesoForcingTemp* forcing) const = 0;
};
 
} // namespace kynema_sgf
 
#endif /* ABLSTATSBASE_H */