constants.hpp

Go to the documentation of this file.

#ifndef CONSTANTS_HPP
#define CONSTANTS_HPP 1

#include <map>
#include <string>

#ifndef DEBUG
    #define DEBUG 1
#endif

namespace constants
{

    const double R_earth = 6371e3;

    const bool USE_HIGH_PRECISION_DISTANCE = false;

    const double rho0 = 1025;

    const double g = 9.81;

    const int DiffOrd = 4;

    const double fill_value = -1e8;

    const signed short fill_value_s = -32767;

    const bool DEFORM_AROUND_LAND = false;

    const bool FILTER_OVER_LAND = true;

    const bool ZONAL_KERNEL_ONLY = false;

    const bool EXTEND_DOMAIN_TO_POLES = true;

    const bool CARTESIAN = false;

    const bool PERIODIC_X = true;

    const bool PERIODIC_Y = false;

    const bool UNIFORM_LON_GRID = true;

    const bool UNIFORM_LAT_GRID = true;

    const bool FULL_LON_SPAN = true;

    const bool COMP_VORT = true;

    const bool COMP_TRANSFERS = true;
    const bool COMP_PI_HELMHOLTZ = false;

    const bool COMP_BC_TRANSFERS = false;

    const bool COMP_WIND_FORCE = false;

    const bool DO_OKUBOWEISS_ANALYSIS = false;

    const bool MINIMAL_OUTPUT = true;

    const bool NO_FULL_OUTPUTS = true;

    const bool CAST_TO_SINGLE = false;

    const bool CAST_TO_INT = false;

    const bool DO_TIMING = false;

    const bool APPLY_POSTPROCESS = true;

    const bool POSTPROCESS_DO_ZONAL_MEANS = true;

    const bool POSTPROCESS_DO_TIME_MEANS = false;

    const int KERNEL_OPT = 4;

    const double KernPad = 2.5;
    /*
    switch (KERNEL_OPT) {
        case 0: const double KernPad =  1.1;
        case 1: const double KernPad =  2.5;  // exp(-2.5^4) ~1e-17
        case 2: const double KernPad =  5.;   // exp(-5^2)   ~1e-11
        case 3: const double KernPad = -1.;
        case 4: const double KernPad =  2.5;
    }
    */

    enum ParticleRecycleType : int { FixedInterval, Stochastic };
    const int PARTICLE_RECYCLE_TYPE = ParticleRecycleType::FixedInterval;


    const std::map< std::string, std::string > variable_descriptions = {
        { "coarse_u_r",         "Coarse-grained vertical/radial velocity." },
        { "coarse_u_lon",       "Coarse-grained zonal velocity." },
        { "coarse_u_lat",       "Coarse-grained meridional velocity." },
        { "coarse_KE",          "Kinetic energy of coarse-grained velocity" },
        { "fine_KE",            "Small-scale kinetic energy ( filter(KE(u)) - KE(filter(u)) )" },
        { "enstrophy",          "Enstrophy of coarse-grained velocity" },
        { "Pi",                 "Non-linear energy transfer from large-scales to small-scales" },
        { "Z",                  "Non-linear enstrophy transfer from large-scales to small-scales" },
        { "OkuboWeiss",         "Okubo-Weiss parameter ( positive -> strain dominated, negative -> vortex dominated )" },
        { "div_Jtransport",     "divergence of energy transport term" },
        { "coarse_vort_r",      "Radial (z) vorticity of coarse-grained velocity." },
        { "coarse_vel_div",     "Divergence of the coarse-grained velocity" }
    };

    const std::map< std::string, std::string > variable_units = {
        { "coarse_u_r",         "m / s" },
        { "coarse_u_lon",       "m / s" },
        { "coarse_u_lat",       "m / s" },
        { "coarse_KE",          "J / (m^3)" },
        { "fine_KE",            "J / (m^3)" },
        { "enstrophy",          "J / (m^5)" },
        { "Pi",                 "Watt / (m^3)" },
        { "Z",                  "Watt / (m^5)" },
        { "OkuboWeiss",         "1 / (s^2)" },
        { "div_Jtransport",     "Watt / (m^3)" },
        { "coarse_vort_r",      "1 / s" },
        { "coarse_vel_div",     "1 / s" }
    };


    const std::string spatial_average_description       = "The lat/lon average computed over each defined region (see region dimension).";

    const std::string zonal_average_description         = "The zonal (longitudinal) average computed at each latitude.";

    const std::string time_average_description          = "Time average over the entire provided dataset.";

    const std::string OkuboWeiss_average_description    = "Variable binned by Okubo-Weiss parameter (i.e. histogram). "
                                                          "Values in OkuboWeiss dimension indicate the lower bound of each bin.";

}
#endif