ERF_ReadBndryPlanes.H

Go to the documentation of this file.

/**
 * \file ERF_ReadBndryPlanes.H
 */
#ifndef ERF_BOUNDARYPLANE_H
#define ERF_BOUNDARYPLANE_H
 
#include "AMReX_Gpu.H"
#include "AMReX_AmrCore.H"
#include <AMReX_BndryRegister.H>
#include "ERF_IndexDefines.H"
#include "ERF_DataStruct.H"
 
#include <string>
 
using PlaneVector = amrex::Vector<amrex::FArrayBox>;
 
/** Collection of data structures and operations for reading data
 *
 *  This class contains the inlet data structures and operations to
 *  read and interpolate inflow data.
 */
class ReadBndryPlanes
{
 
public:
    /// The slot (BCVars) a plane of variable var_name is stored in, the same slot
    /// fill_from_bndryregs reads it from (cons_bc_comp of the component it
    /// fills); -1 for a name that is not a plane variable.
    static int plane_slot (const std::string& var_name)
    {
        if (var_name == "density")     { return BCVars::Rho_bc_comp; }
        if (var_name == "theta")       { return BCVars::RhoTheta_bc_comp; }
        if (var_name == "temperature") { return BCVars::RhoTheta_bc_comp; }
        if (var_name == "ke")          { return BCVars::RhoKE_bc_comp; }
        if (var_name == "scalar")      { return BCVars::RhoScalar_bc_comp; }
        if (var_name == "qv")          { return BCVars::RhoQ1_bc_comp; }
        if (var_name == "qc")          { return BCVars::RhoQ2_bc_comp; }
        if (var_name == "velocity")    { return BCVars::xvel_bc; }
        return -1;
    }
 
    explicit ReadBndryPlanes (const amrex::Geometry& geom,
                              const amrex::Real& rdOcp_in);
 
    void define_level_data (int lev);
 
    void read_time_file ();
 
    void read_input_files (double time,
                           double dt,
                           amrex::Array<amrex::Array<amrex::Real, AMREX_SPACEDIM*2>, AMREX_SPACEDIM+NBCVAR_max> m_bc_extdir_vals);
 
    void read_file (int idx,
                    amrex::Vector<std::unique_ptr<PlaneVector>>& data_to_fill,
                    amrex::Array<amrex::Array<amrex::Real, AMREX_SPACEDIM*2>, AMREX_SPACEDIM+NBCVAR_max> m_bc_extdir_vals);
 
    // Return the pointer to PlaneVectors at time "time"
    amrex::Vector<std::unique_ptr<PlaneVector>>& interp_in_time (const double& time);
 
    // Return the pointer to PlaneVectors that have the tendency
    amrex::Vector<std::unique_ptr<PlaneVector>>& get_tendency (const double& time);
 
    [[nodiscard]] double tinterp () const { return m_tinterp; }
 
    [[nodiscard]] int ingested_velocity () const {return is_velocity_read;}
    [[nodiscard]] int ingested_theta ()    const {return (is_temperature_read || is_theta_read);}
    [[nodiscard]] int ingested_density ()  const {return is_density_read;}
    [[nodiscard]] int ingested_scalar ()   const {return is_scalar_read;}
    [[nodiscard]] int ingested_q1 ()       const {return is_q1_read;}
    [[nodiscard]] int ingested_q2 ()       const {return is_q2_read;}
    [[nodiscard]] int ingested_KE ()       const {return is_KE_read;}
 
private:
 
    //! The times for which we currently have data
    double m_tn;
    double m_tnp1;
    double m_tnp2;
 
    //! Data at time m_tn
    amrex::Vector<std::unique_ptr<PlaneVector>> m_data_n;
 
    //! Data at time m_tnp1
    amrex::Vector<std::unique_ptr<PlaneVector>> m_data_np1;
 
    //! Data at time m_tnp2
    amrex::Vector<std::unique_ptr<PlaneVector>> m_data_np2;
 
    //! Data interpolated to the time requested
    amrex::Vector<std::unique_ptr<PlaneVector>> m_data_interp;
 
    //! Tendency between the n and np1 data
    amrex::Vector<std::unique_ptr<PlaneVector>> m_data_tendency;
 
    //! Time for plane at interpolation
    double m_tinterp{-1.0};
 
    //! Geometry at level 0
    amrex::Geometry m_geom;
 
    //! File name for IO
    std::string m_filename{""};
 
    //! File name for file holding timesteps and times
    std::string m_time_file{""};
 
    //! The timesteps / times that we read from time.dat
    amrex::Vector<double> m_in_times;
    amrex::Vector<int> m_in_timesteps;
 
    //! Variables to be read in
    amrex::Vector<std::string> m_var_names;
 
    //! Controls extents on native bndry output
    int m_in_rad        = 1;
    const int m_out_rad = 1;
    const int m_extent_rad = 0;
 
    //! Are real BCs being used?
    bool m_use_real_bcs = false;
 
    //! R_d/c_p is needed for reading boundary files
    const amrex::Real m_rdOcp;
 
    int is_velocity_read;
    int is_density_read;
    int is_temperature_read;
    int is_theta_read;
    int is_scalar_read;
    int is_q1_read;
    int is_q2_read;
    int is_KE_read;
 
    int last_file_read;
};
 
#endif /* ERF_BOUNDARYPLANE_H */