TurbulenceModel.H

Go to the documentation of this file.

#ifndef TURBULENCEMODEL_H
#define TURBULENCEMODEL_H
 
#include <unordered_map>
 
#include "amr-wind/core/Factory.H"
#include "amr-wind/core/FieldDescTypes.H"
#include "amr-wind/incflo.H"
 
namespace amr_wind {
 
class CFDSim;
class ScratchField;
class Field;
 
namespace turbulence {
 
class TurbulenceModel : public Factory<TurbulenceModel, CFDSim&>
{
public:
    using CoeffsDictType = std::unordered_map<std::string, amrex::Real>;
 
    static std::string base_identifier() { return "TurbulenceModel"; }
 
    ~TurbulenceModel() override = default;
 
    virtual void update_turbulent_viscosity(
        const FieldState fstate, const DiffusionType diff_type) = 0;
 
    virtual void post_advance_work() = 0;
 
    virtual void register_mueff_field(Field& mueff) = 0;
 
    virtual void register_alphaeff_field(Field& alphaeff) = 0;
 
    virtual std::string model_name() const = 0;
 
    virtual std::unique_ptr<ScratchField> mu() = 0;
 
    virtual std::unique_ptr<ScratchField> alpha() = 0;
 
    virtual std::unique_ptr<ScratchField>
    scalar_diffusivity(const std::string& name) = 0;
 
    virtual Field& mu_turb() = 0;
 
    virtual Field& alpha_turb() = 0;
 
    virtual Field& mueff() = 0;
 
    virtual Field& alphaeff() = 0;
 
    virtual bool is_turbulent() const { return true; }
 
    virtual void update_mueff(Field& mueff) = 0;
 
    virtual void update_alphaeff(Field& alphaeff) = 0;
 
    virtual void update_scalar_diff(Field& deff, const std::string& name) = 0;
 
    virtual void parse_model_coeffs() = 0;
 
    virtual CoeffsDictType model_coeffs() const = 0;
};
 
} // namespace turbulence
} // namespace amr_wind
 
#endif /* TURBULENCEMODEL_H */