ERF
Energy Research and Forecasting: An Atmospheric Modeling Code
SpongeChoice Struct Reference

#include <ERF_SpongeStruct.H>

Collaboration diagram for SpongeChoice:

Public Member Functions

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

Public Attributes

bool use_xlo_sponge_damping = false
 
bool use_xhi_sponge_damping = false
 
bool use_ylo_sponge_damping = false
 
bool use_yhi_sponge_damping = false
 
bool use_zlo_sponge_damping = false
 
bool use_zhi_sponge_damping = false
 
amrex::Real sponge_strength = 0.0
 
amrex::Real xlo_sponge_end
 
amrex::Real xhi_sponge_start
 
amrex::Real ylo_sponge_end
 
amrex::Real yhi_sponge_start
 
amrex::Real zlo_sponge_end
 
amrex::Real zhi_sponge_start
 
amrex::Real sponge_density = -one
 
amrex::Real sponge_rhotheta = -one
 
amrex::Real sponge_rhomoist = -one
 
amrex::Real sponge_x_velocity
 
amrex::Real sponge_y_velocity
 
amrex::Real sponge_z_velocity
 

Static Public Attributes

static SpongeType sponge_type = SpongeType::None
 

Detailed Description

Container holding the sponge-related choices

Member Function Documentation

◆ display()

void SpongeChoice::display ( )
inline
67  {
68  amrex::Print() << "Sponge choices: " << std::endl;
69  }

Referenced by SolverChoice::display().

Here is the caller graph for this function:

◆ init_params()

void SpongeChoice::init_params ( std::string  pp_prefix)
inline
22  {
23  amrex::ParmParse pp(pp_prefix);
24 
25  pp.query_enum_case_insensitive("sponge_type",sponge_type);
26 
27  // Include sponge damping
28  if (sponge_type != SpongeType::None) {
29  pp.query("use_xlo_sponge_damping", use_xlo_sponge_damping);
30  pp.query("use_xhi_sponge_damping", use_xhi_sponge_damping);
31  pp.query("use_ylo_sponge_damping", use_ylo_sponge_damping);
32  pp.query("use_yhi_sponge_damping", use_yhi_sponge_damping);
33  pp.query("use_zlo_sponge_damping", use_zlo_sponge_damping);
34  pp.query("use_zhi_sponge_damping", use_zhi_sponge_damping);
35 
36  pp.get("sponge_strength" , sponge_strength);
37 
39  pp.get("xlo_sponge_end" , xlo_sponge_end);
40  }
42  pp.get("xhi_sponge_start" , xhi_sponge_start);
43  }
45  pp.get("ylo_sponge_end" , ylo_sponge_end);
46  }
48  pp.get("yhi_sponge_start" , yhi_sponge_start);
49  }
51  pp.get("zlo_sponge_end" , zlo_sponge_end);
52  }
54  pp.get("zhi_sponge_start" , zhi_sponge_start);
55  }
56 
57  pp.query("sponge_density" , sponge_density);
58  pp.query("sponge_rhotheta" , sponge_rhotheta);
59  pp.query("sponge_rhomoist" , sponge_rhomoist);
60  pp.query("sponge_x_velocity" , sponge_x_velocity);
61  pp.query("sponge_y_velocity" , sponge_y_velocity);
62  pp.query("sponge_z_velocity" , sponge_z_velocity);
63  }
64  }
ParmParse pp("prob")
bool use_xlo_sponge_damping
Definition: ERF_SpongeStruct.H:71
amrex::Real sponge_y_velocity
Definition: ERF_SpongeStruct.H:89
amrex::Real xlo_sponge_end
Definition: ERF_SpongeStruct.H:83
amrex::Real zlo_sponge_end
Definition: ERF_SpongeStruct.H:85
bool use_zlo_sponge_damping
Definition: ERF_SpongeStruct.H:75
amrex::Real sponge_strength
Definition: ERF_SpongeStruct.H:78
bool use_ylo_sponge_damping
Definition: ERF_SpongeStruct.H:73
amrex::Real zhi_sponge_start
Definition: ERF_SpongeStruct.H:85
amrex::Real sponge_z_velocity
Definition: ERF_SpongeStruct.H:89
static SpongeType sponge_type
Definition: ERF_SpongeStruct.H:81
bool use_xhi_sponge_damping
Definition: ERF_SpongeStruct.H:72
amrex::Real sponge_x_velocity
Definition: ERF_SpongeStruct.H:89
bool use_zhi_sponge_damping
Definition: ERF_SpongeStruct.H:76
amrex::Real yhi_sponge_start
Definition: ERF_SpongeStruct.H:84
amrex::Real sponge_density
Definition: ERF_SpongeStruct.H:86
bool use_yhi_sponge_damping
Definition: ERF_SpongeStruct.H:74
amrex::Real xhi_sponge_start
Definition: ERF_SpongeStruct.H:83
amrex::Real sponge_rhomoist
Definition: ERF_SpongeStruct.H:88
amrex::Real ylo_sponge_end
Definition: ERF_SpongeStruct.H:84
amrex::Real sponge_rhotheta
Definition: ERF_SpongeStruct.H:87

Referenced by SolverChoice::init_params().

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ sponge_density

amrex::Real SpongeChoice::sponge_density = -one

◆ sponge_rhomoist

amrex::Real SpongeChoice::sponge_rhomoist = -one

◆ sponge_rhotheta

amrex::Real SpongeChoice::sponge_rhotheta = -one

◆ sponge_strength

◆ sponge_type

SpongeType SpongeChoice::sponge_type = SpongeType::None
inlinestatic

◆ sponge_x_velocity

amrex::Real SpongeChoice::sponge_x_velocity

◆ sponge_y_velocity

amrex::Real SpongeChoice::sponge_y_velocity

◆ sponge_z_velocity

amrex::Real SpongeChoice::sponge_z_velocity

◆ use_xhi_sponge_damping

bool SpongeChoice::use_xhi_sponge_damping = false

◆ use_xlo_sponge_damping

bool SpongeChoice::use_xlo_sponge_damping = false

◆ use_yhi_sponge_damping

bool SpongeChoice::use_yhi_sponge_damping = false

◆ use_ylo_sponge_damping

bool SpongeChoice::use_ylo_sponge_damping = false

◆ use_zhi_sponge_damping

bool SpongeChoice::use_zhi_sponge_damping = false

◆ use_zlo_sponge_damping

bool SpongeChoice::use_zlo_sponge_damping = false

◆ xhi_sponge_start

◆ xlo_sponge_end

◆ yhi_sponge_start

◆ ylo_sponge_end

◆ zhi_sponge_start

◆ zlo_sponge_end


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