BCInterface.H

Go to the documentation of this file.

#ifndef BCINTERFACE_H
#define BCINTERFACE_H
 
#include "src/core/Field.H"
#include "src/incflo_enums.H"
 
#include "AMReX_BC_TYPES.H"
 
#include <utility>
#include "AMReX_REAL.H"
 
using namespace amrex::literals;

 
namespace kynema_sgf {
class FieldBoundaryMgr;
 
enum class InflowValidationStage : std::uint8_t { configuration, initialized };
 
namespace {
amrex::Vector<std::string> bcnames = {"xlo", "ylo", "zlo", "xhi", "yhi", "zhi"};
}

class BCIface
{
public:
    using IncfloBC = amrex::GpuArray<BC, AMREX_SPACEDIM * 2>;
 
    BCIface(Field& field);
 
    virtual ~BCIface() = default;

    virtual void operator()(amrex::Real value = 0.0_rt);

    amrex::Array<const std::string, 3> get_dirichlet_udfs();

    static void validate_inflow_values(
        const FieldRepo& repo,
        const FieldBoundaryMgr& boundaries,
        InflowValidationStage stage = InflowValidationStage::initialized);
 
protected:
    virtual void set_bcrec() = 0;

    virtual void read_values() = 0;

    virtual void read_bctype();

    virtual void set_bcfuncs();

    void set_default_value(amrex::Real value);
 
    virtual amrex::Array<const std::string, 3> inflow_udfs()
    {
        return get_dirichlet_udfs();
    }
 
    void read_inflow_values();

    void set_bcrec_lo(int dir, amrex::BCType::mathematicalBndryTypes bcrec)
    {
        auto& fbcrec = m_field.bcrec();
        for (int i = 0; i < m_field.num_comp(); ++i) {
            fbcrec[i].setLo(dir, bcrec);
        }
    }

    void set_bcrec_hi(int dir, amrex::BCType::mathematicalBndryTypes bcrec)
    {
        auto& fbcrec = m_field.bcrec();
        for (int i = 0; i < m_field.num_comp(); ++i) {
            fbcrec[i].setHi(dir, bcrec);
        }
    }

    Field& m_field;
};

class BCVelocity : public BCIface
{
public:
    explicit BCVelocity(Field& field) : BCIface(field) {}
 
protected:
    void set_bcrec() override;
    void read_values() override;
};

class BCScalar : public BCIface
{
public:
    explicit BCScalar(Field& field) : BCIface(field) {}
 
protected:
    void set_bcrec() override;
    void read_values() override;
};

class BCPressure : public BCScalar
{
public:
    explicit BCPressure(Field& field) : BCScalar(field) {}
 
protected:
    void read_values() override;
};

class BCSrcTerm : public BCIface
{
public:
    explicit BCSrcTerm(Field& field) : BCIface(field) {}
 
protected:
    void set_bcrec() override;
    void read_values() override
    {
        // No values specified for source terms. empty method to satisfy
        // inheritance
    }
};

class BCFillPatchExtrap : public BCIface
{
public:
    explicit BCFillPatchExtrap(
        Field& field,
        amrex::BCType::mathematicalBndryTypes bctype = amrex::BCType::hoextrap)
        : BCIface(field), m_extrap_type(bctype)
    {}
 
protected:
    void set_bcrec() override;
    void read_values() override
    {
        // No values specified for source terms. empty method to satisfy
        // inheritance
    }
 
    amrex::BCType::mathematicalBndryTypes m_extrap_type;
};
 
} // namespace kynema_sgf
 
#endif /* BCINTERFACE_H */