MultiPhase.H

Go to the documentation of this file.

#ifndef MULTIPHASE_H
#define MULTIPHASE_H
 
#include <cstdint>
#include "amr-wind/core/Physics.H"
#include "amr-wind/core/Field.H"
#include "amr-wind/core/IntField.H"
#include "amr-wind/core/ScratchField.H"
#include "AMReX_REAL.H"
 
using namespace amrex::literals;

namespace amr_wind {
 
enum class InterfaceCapturingMethod : std::uint8_t {
    VOF, 
    LS   
};
 
class MultiPhase : public Physics::Register<MultiPhase>
{
public:
    static std::string identifier() { return "MultiPhase"; }
 
    explicit MultiPhase(CFDSim& sim);
 
    ~MultiPhase() override = default;
 
    void
    initialize_fields(int /*level*/, const amrex::Geometry& /*geom*/) override
    {}
 
    void post_init_actions() override;
 
    void post_regrid_actions() override;
 
    void pre_advance_work() override;
 
    void post_advance_work() override;
 
    void set_density_via_levelset();
 
    void set_density_via_vof(
        amr_wind::FieldState fstate = amr_wind::FieldState::New);
 
    void set_nph_density();
 
    void calculate_advected_facedensity();
 
    void levelset2vof();
 
    void levelset2vof(const IntField& iblank_cell, ScratchField& vof_scr);
 
    amrex::Real volume_fraction_sum();
 
    amrex::Real momentum_sum(int n);
 
    [[nodiscard]] InterfaceCapturingMethod interface_capturing_method() const;
 
    [[nodiscard]] amrex::Real rho1() const { return m_rho1; }
 
    [[nodiscard]] amrex::Real rho2() const { return m_rho2; }
 
    [[nodiscard]] amrex::Vector<amrex::Real> gravity() const
    {
        return m_gravity;
    }
 
    [[nodiscard]] amrex::Real water_level() const { return m_water_level0; }
 
    [[nodiscard]] bool perturb_pressure() const
    {
        return m_use_perturb_pressure;
    }
 
    [[nodiscard]] bool reconstruct_true_pressure() const
    {
        return m_reconstruct_true_pressure;
    }
 
private:
    const CFDSim& m_sim;
 
    Field& m_velocity;
    Field& m_density;
 
    // Pointer to the levelset
    Field* m_levelset{nullptr};
 
    // Pointer to VOF
    Field* m_vof{nullptr};
 
    // Density value for Fluid 1
    amrex::Real m_rho1{10.0_rt};
 
    // Density value for Fluid 2
    amrex::Real m_rho2{1.0_rt};
 
    // Bools according to ICNS settings
    // Turning on perturbational density and pressure
    bool m_use_perturb_pressure{false};
    // Reconstructing true pressure field at end of timestep
    bool m_reconstruct_true_pressure{false};
 
    bool m_init_p{false};
 
    // Info to create rho0
    amrex::Real m_water_level0{0.0_rt};
    // Info to reconstruct true pressure
    amrex::Vector<amrex::Real> m_gravity{0.0_rt, 0.0_rt, -9.81_rt};
 
    // Multiphase model enum
    std::string m_interface_model{"vof"};
    InterfaceCapturingMethod m_interface_capturing_method =
        InterfaceCapturingMethod::VOF;
 
    // Verbose flag for multiphase
    int m_verbose{0};
 
    // sum of volume fractions (for vof only)
    amrex::Real m_total_volfrac{0.0_rt};
 
    amrex::Real m_q0{0.0_rt};
    amrex::Real m_q1{0.0_rt};
    amrex::Real m_q2{0.0_rt};
    amrex::Real m_sumvof0{0.0_rt};
};
 
} // namespace amr_wind
 
#endif /* MULTIPHASE_H */