ERF_IndexDefines.H

Go to the documentation of this file.

#ifndef ERF_INDEX_DEFINES_H_
#define ERF_INDEX_DEFINES_H_
 
#include <AMReX_REAL.H>
#include <AMReX_Arena.H>
#include <AMReX_Extension.H>
#include <AMReX_GpuQualifiers.H>
 
/**
 * Definition of indexing parameters
*/
 
// This defines the ACTUAL number of non-moisture vars =
//      rho, rhotheta, rhoKE
#define NDRY       3
 
// Smoke: a passive tracer the fire coupling emits from the fire's heat [kg/m^3],
// present in builds with the fire coupling (ERF_USE_FIRE)
#ifdef ERF_USE_FIRE
#define NSCALARS_SMOKE 1
#else
#define NSCALARS_SMOKE 0
#endif
 
// This defines the ACTUAL number of non-moisture scalar vars
#define NSCALARS   (1 + NSCALARS_SMOKE)
 
// This defines the MAXIMUM number of moisture vars (six q's plus five n's)
#define NMOIST_max 11
 
// This is the number of components if using moisture
// We use this to allocate the 1d arrays of boundary condition types,
//    but not to allocate actual solution data
// Full moist state with no additional non-moist species
#define NVAR_MOIST_max (NDRY + NSCALARS + NMOIST_max)
 
#define NVAR_max ((NDRY + NSCALARS + NMOIST_max) + 2*5) // allow up to 5 non-moist species
 
// This is the number of components if we assume there is only one passive scalar
// We can use this when we assume all passive scalars have the same bc's
// We also assume (the final "+1" that the base state components have the same bcs)
#define NBCVAR_max ((NDRY + 1 + NMOIST_max + 1) + 2*5) // allow up to 5 non-moist species
 
// Number of primitive components: one per conserved component after Rho_comp,
// counting every passive scalar (the base scalar and, with the fire coupling, smoke)
// and the moist quantities.
// The trailing 2*5 mirrors NVAR_max: a microphysics model may append up to 5 non-moist
// species (two components each) after the water species, and the diffusion coefficient
// tables are indexed by primitive component over that full range as well.
#define NPRIMVAR_max ((NDRY + NSCALARS + NMOIST_max) + 2*5)
 
// Cell-centered state variables
#define Rho_comp       0
#define RhoTheta_comp  (Rho_comp+1)
#define RhoKE_comp     (Rho_comp+2) // for Deardorff LES Model, k-equation RANS, or MYNN PBL Model
 
#define RhoScalar_comp (RhoKE_comp+1)
 
// Scalar slots (consecutive, starting at RhoScalar_comp = NDRY):
//   [RhoScalar_comp]     always present (base passive scalar)
//   [RhoSmoke_comp]      smoke, only with ERF_USE_FIRE
//   [RhoQ1_comp ...]     moisture variables
#ifdef ERF_USE_FIRE
#define RhoSmoke_comp  (RhoScalar_comp+1)
#endif
#define RhoQ1_comp     (RhoScalar_comp+NSCALARS)
#define RhoQ2_comp     (RhoQ1_comp+1)
#define RhoQ3_comp     (RhoQ1_comp+2)
#define RhoQ4_comp     (RhoQ1_comp+3)
#define RhoQ5_comp     (RhoQ1_comp+4)
#define RhoQ6_comp     (RhoQ1_comp+5)
#define RhoQ7_comp     (RhoQ1_comp+6)
#define RhoQ8_comp     (RhoQ1_comp+7)
#define RhoQ9_comp     (RhoQ1_comp+8)
#define RhoQ10_comp    (RhoQ1_comp+9)
#define RhoQ11_comp    (RhoQ1_comp+10)
 
// Cell-centered primitive variables
#define PrimTheta_comp   (RhoTheta_comp -1)
#define PrimKE_comp      (RhoKE_comp    -1)
#define PrimScalar_comp  (RhoScalar_comp-1)
#define PrimQ1_comp      (RhoQ1_comp-1)
#define PrimQ2_comp      (RhoQ2_comp-1)
#define PrimQ3_comp      (RhoQ3_comp-1)
#define PrimQ4_comp      (RhoQ4_comp-1)
#define PrimQ5_comp      (RhoQ5_comp-1)
#define PrimQ6_comp      (RhoQ6_comp-1)
#define PrimQ7_comp      (RhoQ7_comp-1)
#define PrimQ8_comp      (RhoQ8_comp-1)
#define PrimQ9_comp      (RhoQ9_comp-1)
#define PrimQ10_comp     (RhoQ10_comp-1)
#define PrimQ11_comp     (RhoQ11_comp-1)
 
// Base state variables
namespace BaseState {
    enum {
        r0_comp = 0,
        p0_comp,
        pi0_comp,
        th0_comp,
        qv0_comp,
        num_comps
    };
}
 
// NOTE: we still use this indexing even if no moisture
// NOTE: We assume a single boundary condition for all passive scalars
namespace BCVars {
    enum {
        cons_bc = 0,
        Rho_bc_comp = 0,
        RhoTheta_bc_comp,
        RhoKE_bc_comp,
        RhoScalar_bc_comp,
        RhoQ1_bc_comp,
        RhoQ2_bc_comp,
        RhoQ3_bc_comp,
        RhoQ4_bc_comp,
        RhoQ5_bc_comp,
        RhoQ6_bc_comp,
        RhoQ7_bc_comp,
        RhoQ8_bc_comp,
        RhoQ9_bc_comp,
        RhoQ10_bc_comp,
        RhoQ11_bc_comp,
        xvel_bc = NBCVAR_max,
        yvel_bc = NBCVAR_max+1,
        zvel_bc = NBCVAR_max+2,
        NumTypes
    };
}
 
/**
 * The boundary-condition slot (BCVars) of conserved component n: every passive
 * scalar shares BCVars::RhoScalar_bc_comp, and each component above the scalars
 * has its own slot, NSCALARS - 1 below its component index. Boundary planes are
 * stored by these slots too (ReadBndryPlanes::plane_slot).
 */
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE
int cons_bc_comp (int n) noexcept
{
    if (n >= RhoScalar_comp && n < RhoScalar_comp + NSCALARS) { return BCVars::RhoScalar_bc_comp; }
    return (n >= RhoScalar_comp + NSCALARS) ? n - (NSCALARS - 1) : n;
}
 
AMREX_FORCE_INLINE
bool cons_bc_run_contiguous (int prev, int next) noexcept
{
    return next == prev + 1 && cons_bc_comp(next) == cons_bc_comp(prev) + 1;
}
 
// Note that we don't use these, but we need this vector to be long enough
//  not to segfault when we do the FillPatch operation.
namespace BaseBCVars {
    enum {
        rho0_bc_comp = 0,
          p0_bc_comp,
         pi0_bc_comp,
         th0_bc_comp,
         qv0_bc_comp
    };
}
 
namespace RealBdyVars {
    enum {
        U  = 0,
        V  = 1,
        T  = 2,
        QV = 3,
        R  = 4,
        QC = 5,
        QI = 6,
        NumTypes
    };
}
 
// Additional runtime boundary slots used when all precipitating
// hydrometeors are represented as separate ERF state components.  Keep the
// compact QC/QI indices above unchanged for aggregate-boundary compatibility.
namespace RealBdyHydrometeorVars {
    enum {
        QR = RealBdyVars::NumTypes,
        QS,
        QG,
        NumTypes
    };
}
 
namespace WRFBdyVars {
    enum {
        U  = 0,
        V  = 1,
        T  = 2,
        QV = 3, // water vapor
        R  = 4, // density
        PH    , // Perturbational geopotential
        MU    , // bdy perturbation dry air mass in column (we will get mub from the initial data)
        PC    , // p_s - p_top = dry hydrostatic pressure difference between the surface and the model top
        QC    , // cloud water
        QI    , // cloud ice
        NumTypes
    };
 
    constexpr int LegacyNumTypes = PC + 1;
}
 
// Additional serialized/cache slots used when all precipitating hydrometeors
// are retained separately.  The legacy and aggregate layouts remain unchanged.
namespace WRFBdyHydrometeorVars {
    enum {
        QR = WRFBdyVars::NumTypes,
        QS,
        QG,
        NumTypes
    };
}
 
static_assert(WRFBdyVars::U  == 0 && WRFBdyVars::V  == 1 &&
              WRFBdyVars::T  == 2 && WRFBdyVars::QV == 3 &&
              WRFBdyVars::R  == 4 && WRFBdyVars::PH == 5 &&
              WRFBdyVars::MU == 6 && WRFBdyVars::PC == 7,
              "The serialized legacy WRF boundary layout must not change");
 
namespace MetGridBdyVars {
    enum {
        U  = 0,
        V  = 1,
        T  = 2,
        QV = 3,
        NumTypes
    };
}
 
namespace MetGridTmpSrcVars {
    enum {
        Theta = 0,
        QV    = 1,
        NumTypes
    };
}
 
namespace MetGridTmpDstVars {
    enum {
        P = 0,
        T = 1,
        Theta = 2,
        QV = 3,
        NumTypes
    };
}
 
namespace Vars {
    enum {
        cons = 0,
        xvel,
        yvel,
        zvel,
        NumTypes
    };
}
 
namespace GpVars {
    enum {
        gpx = 0,
        gpy,
        gpz,
    };
}
 
namespace IntVars {
    enum {
        cons = 0,
        xmom,
        ymom,
        zmom,
        NumTypes
    };
}
 
// We separate out horizontal and vertical turbulent diffusivities
// These are the same for LES, but different for PBL models
namespace EddyDiff {
    enum {
        Mom_h = 0,
        Theta_h,
        KE_h,
        Scalar_h,
        Q_h,
        Mom_v,
        Theta_v,
        KE_v,
        Scalar_v,
        Q_v,
        Turb_lengthscale,
        // Nonlocal (countergradient) terms.  All four are stored *normalized by the
        // PBL height*, i.e. as a gradient of the transported quantity, so that the
        // implicit vertical diffusion solvers form the countergradient flux as
        //     F_cg = +rho*alpha*gamma
        // with no further metric or grid-spacing factors.
        HGAMT_v,  // MRF/YSU countergradient for heat (HGAMT/h, units K/m), zero outside PBL
        HGAMQ_v,  // MRF/YSU countergradient for moisture (HGAMQ/h, units kg/kg/m), zero outside PBL
        HGAMU_v,  // YSU countergradient for x-momentum (HGAMU/h, units 1/s), zero outside PBL
        HGAMV_v,  // YSU countergradient for y-momentum (HGAMV/h, units 1/s), zero outside PBL
        // k-eqn RANS diagnostics: smoothed turbulent Richardson number and the
        // two stability functions (Axell & Liungman 2001, Eqs. 29-32)
        RANS_Rt,
        RANS_cmu,
        RANS_cmu_prime,
        // k-eqn RANS: nu_t over its realizability cap C_r k / S (erf.rans_realizability);
        // above 1 the cap is active, 0 when the cap is off
        RANS_cap_ratio,
        NumDiffs
    };
}
 
enum struct ERF_BC {
    symmetry,
    inflow,
    outflow,
    inflow_outflow,
    ho_outflow,
    open,
    no_slip_wall,
    slip_wall,
    periodic,
    surface_layer,
    undefined
};
 
// NOTE: the first of these must match up with the BCType enum
//     in amrex/Src/Base/AMReX_BC_TYPES.H.  We had extras at
//     the end to use locally
namespace ERFBCType {
enum mathematicalBndryTypes : int {
    bogus            = -666,
    reflect_odd      = -1,
    int_dir          =  0,
    reflect_even     =  1,
    foextrap         =  2,
    ext_dir          =  3,
    hoextrap         =  4,
    surface_layer    =  101,
    ext_dir_prim     =  102,
    ext_dir_ingested =  103,
    neumann          =  104,
    neumann_int      =  105,
    open             =  106,
    ext_dir_upwind   =  107
};
}
 
enum struct AdvType : int {
    Centered_2nd  = 101,
    Upwind_3rd    = 102,
    Upwind_3rd_SL = 103,
    Centered_4th  = 104,
    Upwind_5th    = 105,
    Centered_6th  = 106,
    Weno_3        = 107,
    Weno_3Z       = 108,
    Weno_5        = 109,
    Weno_5Z       = 110,
    Weno_3MZQ     = 111,
    Weno_7        = 112,
    Weno_7Z       = 113,
    Unknown       = 114
};
#endif