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::Standard
 

Detailed Description

Container holding the sponge-related choices

Member Function Documentation

◆ display()

void SpongeChoice::display ( )
inline
76  {
77  amrex::Print() << "Sponge choices: " << std::endl;
78  }

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  // The default type is SpongeType::Standard
26  // Here we can overwrite the default with None or Input_Sponge
27  pp.query_enum_case_insensitive("sponge_type",sponge_type);
28 
29  if (sponge_type == SpongeType::None) return;
30 
31  pp.query("sponge_strength" , sponge_strength);
32 
33  // If sponge_strength == 0 then we set sponge_type to None
34  if (std::abs(sponge_strength) == zero)
35  {
36  sponge_type = SpongeType::None;
37  }
38  else
39  {
40  pp.query("use_xlo_sponge_damping", use_xlo_sponge_damping);
41  pp.query("use_xhi_sponge_damping", use_xhi_sponge_damping);
42  pp.query("use_ylo_sponge_damping", use_ylo_sponge_damping);
43  pp.query("use_yhi_sponge_damping", use_yhi_sponge_damping);
44  pp.query("use_zlo_sponge_damping", use_zlo_sponge_damping);
45  pp.query("use_zhi_sponge_damping", use_zhi_sponge_damping);
46 
48  pp.get("xlo_sponge_end" , xlo_sponge_end);
49  }
51  pp.get("xhi_sponge_start" , xhi_sponge_start);
52  }
54  pp.get("ylo_sponge_end" , ylo_sponge_end);
55  }
57  pp.get("yhi_sponge_start" , yhi_sponge_start);
58  }
60  pp.get("zlo_sponge_end" , zlo_sponge_end);
61  }
63  pp.get("zhi_sponge_start" , zhi_sponge_start);
64  }
65 
66  pp.query("sponge_density" , sponge_density);
67  pp.query("sponge_rhotheta" , sponge_rhotheta);
68  pp.query("sponge_rhomoist" , sponge_rhomoist);
69  pp.query("sponge_x_velocity" , sponge_x_velocity);
70  pp.query("sponge_y_velocity" , sponge_y_velocity);
71  pp.query("sponge_z_velocity" , sponge_z_velocity);
72  }
73  }
constexpr amrex::Real zero
Definition: ERF_Constants.H:8
ParmParse pp("prob")
bool use_xlo_sponge_damping
Definition: ERF_SpongeStruct.H:80
amrex::Real sponge_y_velocity
Definition: ERF_SpongeStruct.H:98
amrex::Real xlo_sponge_end
Definition: ERF_SpongeStruct.H:92
amrex::Real zlo_sponge_end
Definition: ERF_SpongeStruct.H:94
bool use_zlo_sponge_damping
Definition: ERF_SpongeStruct.H:84
amrex::Real sponge_strength
Definition: ERF_SpongeStruct.H:87
bool use_ylo_sponge_damping
Definition: ERF_SpongeStruct.H:82
amrex::Real zhi_sponge_start
Definition: ERF_SpongeStruct.H:94
amrex::Real sponge_z_velocity
Definition: ERF_SpongeStruct.H:98
static SpongeType sponge_type
Definition: ERF_SpongeStruct.H:90
bool use_xhi_sponge_damping
Definition: ERF_SpongeStruct.H:81
amrex::Real sponge_x_velocity
Definition: ERF_SpongeStruct.H:98
bool use_zhi_sponge_damping
Definition: ERF_SpongeStruct.H:85
amrex::Real yhi_sponge_start
Definition: ERF_SpongeStruct.H:93
amrex::Real sponge_density
Definition: ERF_SpongeStruct.H:95
bool use_yhi_sponge_damping
Definition: ERF_SpongeStruct.H:83
amrex::Real xhi_sponge_start
Definition: ERF_SpongeStruct.H:92
amrex::Real sponge_rhomoist
Definition: ERF_SpongeStruct.H:97
amrex::Real ylo_sponge_end
Definition: ERF_SpongeStruct.H:93
amrex::Real sponge_rhotheta
Definition: ERF_SpongeStruct.H:96

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::Standard
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: