DampingChoice Struct Reference

#include <ERF_DampingStruct.H>

Collaboration diagram for DampingChoice:

Public Member Functions
void	init_params (std::string pp_prefix)
	Read damping options from the input parameter database. More...
void	display ()
	Print the configured damping options. More...

Public Attributes
bool	rayleigh_damp_U = false
	Whether Rayleigh damping is applied to x-momentum. More...
bool	rayleigh_damp_V = false
	Whether Rayleigh damping is applied to y-momentum. More...
bool	rayleigh_damp_W = false
	Whether Rayleigh damping is applied to vertical momentum. More...
bool	rayleigh_damp_T = false
	Whether Rayleigh damping is applied to potential temperature. More...
amrex::Real	rayleigh_dampcoef = amrex::Real(0.2)
	Rayleigh damping inverse time scale [1/s]. More...
amrex::Real	rayleigh_zdamp = amrex::Real(500.0)
	Rayleigh damping layer depth [m]. More...
amrex::Real	rayleigh_ztop
	Top of the Rayleigh damping layer [m]. More...
bool	w_damping = false
	Whether vertical-velocity damping is enabled. More...
amrex::Real	w_damping_cfl = one
	CFL threshold used by vertical-velocity damping. More...
amrex::Real	w_damping_const = -1
	Constant vertical damping coefficient. More...
amrex::Real	w_damping_coeff = -1
	Grid-dependent vertical damping coefficient multiplier. More...
RayleighDampingType	rayleigh_damping_type = RayleighDampingType::SlowExplicit
	Selected Rayleigh damping time-integration treatment. More...

Detailed Description

Container holding damping-related choices

Member Function Documentation

display()

void DampingChoice::display ( )

inline

Print the configured damping options.

    {
        amrex::Print() << "Rayleigh damping            :";
        if (rayleigh_damp_U || rayleigh_damp_V || rayleigh_damp_W || rayleigh_damp_T) {
            if (rayleigh_damp_U) amrex::Print() << " U";
            if (rayleigh_damp_V) amrex::Print() << " V";
            if (rayleigh_damp_W) amrex::Print() << " W";
            if (rayleigh_damp_T) amrex::Print() << " T";
            amrex::Print() << " (coef=" << rayleigh_dampcoef << " 1/s,"
                           << " depth=" << rayleigh_zdamp << " m)"
                           << std::endl;
        } else {
            amrex::Print() << " None" << std::endl;
        }
 
        amrex::Print() << "w damping                   : " << w_damping;
        if (w_damping_const > 0) {
            amrex::Print() << " (coeff = " << w_damping_const << ")" << std::endl;
        } else {
            amrex::Print() << " (coeff = " << w_damping_coeff << " * dz/dt**2)" << std::endl;
        }
    }

Referenced by SolverChoice::display().

Here is the caller graph for this function:

init_params()

void DampingChoice::init_params ( std::string  pp_prefix )

inline

Read damping options from the input parameter database.

Parameters

pp_prefix

ParmParse prefix for the ERF input namespace.

    {
        amrex::ParmParse pp(pp_prefix);
 
        static std::string rayleigh_type_string = "SlowExplicit";
        pp.query("rayleigh_damping_type",rayleigh_type_string);
 
        if (!rayleigh_type_string.compare("SlowExplicit")) {
            rayleigh_damping_type = RayleighDampingType::SlowExplicit;
        } else if (!rayleigh_type_string.compare("FastExplicit")) {
            rayleigh_damping_type = RayleighDampingType::FastExplicit;
        } else if (!rayleigh_type_string.compare("FastImplicit")) {
            rayleigh_damping_type = RayleighDampingType::FastImplicit;
        } else {
            amrex::Error("Don't know this rayleigh_damping_type");
        }
 
        // Include Rayleigh damping (separate flags for each variable)
        pp.query("rayleigh_damp_U", rayleigh_damp_U);
        pp.query("rayleigh_damp_V", rayleigh_damp_V);
        pp.query("rayleigh_damp_W", rayleigh_damp_W);
        pp.query("rayleigh_damp_T", rayleigh_damp_T);
        pp.query("rayleigh_dampcoef", rayleigh_dampcoef);
        pp.query("rayleigh_zdamp", rayleigh_zdamp);
 
        if (pp.countval("rayleigh_damp_substep") > 0) {
            amrex::Abort("The input rayleigh_damp_substep is deprecated.  Set rayleigh_damping_type instead.");
        }
 
        // Include vertical-velocity damping to improve robustness
        pp.query("w_damping", w_damping);
        pp.query("w_damping_cfl", w_damping_cfl);
        pp.query("w_damping_const", w_damping_const);
        pp.query("w_damping_coeff", w_damping_coeff);
 
        if (w_damping && (w_damping_const < 0 && w_damping_coeff < 0)) {
            amrex::Abort("Need to specify vertical damping coefficient w_damping_const (like WRF) or w_damping_coeff (~ dz/dt**2)");
        }
    }

Referenced by SolverChoice::init_params().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

rayleigh_damp_T

DampingChoice::rayleigh_damp_T = false

Whether Rayleigh damping is applied to potential temperature.

Referenced by display(), init_params(), and make_sources().

rayleigh_damp_U

DampingChoice::rayleigh_damp_U = false

Whether Rayleigh damping is applied to x-momentum.

Referenced by display(), init_params(), and make_mom_sources().

rayleigh_damp_V

DampingChoice::rayleigh_damp_V = false

Whether Rayleigh damping is applied to y-momentum.

Referenced by display(), init_params(), and make_mom_sources().

rayleigh_damp_W

DampingChoice::rayleigh_damp_W = false

Whether Rayleigh damping is applied to vertical momentum.

Referenced by display(), init_params(), and make_mom_sources().

rayleigh_dampcoef

DampingChoice::rayleigh_dampcoef = amrex::Real(0.2)

Rayleigh damping inverse time scale [1/s].

Referenced by display(), init_params(), make_mom_sources(), and make_sources().

rayleigh_damping_type

DampingChoice::rayleigh_damping_type = RayleighDampingType::SlowExplicit

Selected Rayleigh damping time-integration treatment.

Referenced by init_params(), make_mom_sources(), and make_sources().

rayleigh_zdamp

DampingChoice::rayleigh_zdamp = amrex::Real(500.0)

Rayleigh damping layer depth [m].

Referenced by display(), and init_params().

rayleigh_ztop

DampingChoice::rayleigh_ztop

Top of the Rayleigh damping layer [m].

w_damping

DampingChoice::w_damping = false

Whether vertical-velocity damping is enabled.

Referenced by display(), and init_params().

w_damping_cfl

DampingChoice::w_damping_cfl = one

CFL threshold used by vertical-velocity damping.

Referenced by init_params().

w_damping_coeff

DampingChoice::w_damping_coeff = -1

Grid-dependent vertical damping coefficient multiplier.

Referenced by display(), and init_params().

w_damping_const

DampingChoice::w_damping_const = -1

Constant vertical damping coefficient.

Referenced by display(), and init_params().

---

The documentation for this struct was generated from the following file:

• Source/DataStructs/ERF_DampingStruct.H