SpongeChoice Struct Reference

#include <ERF_SpongeStruct.H>

Collaboration diagram for SpongeChoice:

Public Member Functions
void	init_params ()
void	display ()

Public Attributes
std::string	pp_prefix {"erf"}
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
std::string	sponge_type
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
amrex::Real	sponge_x_velocity
amrex::Real	sponge_y_velocity
amrex::Real	sponge_z_velocity

Detailed Description

Container holding the sponge-related choices

Member Function Documentation

display()

void SpongeChoice::display ( )

inline

    {
        amrex::Print() << "Sponge choices: " << std::endl;
    }

Referenced by SolverChoice::display().

Here is the caller graph for this function:

init_params()

void SpongeChoice::init_params ( )

inline

    {
        amrex::ParmParse pp(pp_prefix);
 
        pp.query("sponge_type", sponge_type);
 
        // Include sponge damping
        pp.query("use_xlo_sponge_damping", use_xlo_sponge_damping);
        pp.query("use_xhi_sponge_damping", use_xhi_sponge_damping);
        pp.query("use_ylo_sponge_damping", use_ylo_sponge_damping);
        pp.query("use_yhi_sponge_damping", use_yhi_sponge_damping);
        pp.query("use_zlo_sponge_damping", use_zlo_sponge_damping);
        pp.query("use_zhi_sponge_damping", use_zhi_sponge_damping);
 
        pp.query("sponge_strength" , sponge_strength);
        pp.query("xlo_sponge_end"  , xlo_sponge_end);
        pp.query("xhi_sponge_start", xhi_sponge_start);
        pp.query("ylo_sponge_end"  , ylo_sponge_end);
        pp.query("yhi_sponge_start", yhi_sponge_start);
        pp.query("zlo_sponge_end"  , zlo_sponge_end);
        pp.query("zhi_sponge_start", zhi_sponge_start);
 
        pp.query("sponge_density" , sponge_density);
        pp.query("sponge_x_velocity" , sponge_x_velocity);
        pp.query("sponge_y_velocity" , sponge_y_velocity);
        pp.query("sponge_z_velocity" , sponge_z_velocity);
    }

Referenced by SolverChoice::init_params().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

pp_prefix

std::string SpongeChoice::pp_prefix {"erf"}

Referenced by init_params().

sponge_density

amrex::Real SpongeChoice::sponge_density

Referenced by ApplySpongeZoneBCsForCC(), ApplySpongeZoneBCsForMom(), and init_params().

sponge_strength

amrex::Real SpongeChoice::sponge_strength

Referenced by ApplySpongeZoneBCsForCC(), ApplySpongeZoneBCsForMom(), ApplySpongeZoneBCsForMom_ReadFromFile(), and init_params().

sponge_type

std::string SpongeChoice::sponge_type

Referenced by ERF::advance_dycore(), init_params(), make_mom_sources(), and make_sources().

sponge_x_velocity

amrex::Real SpongeChoice::sponge_x_velocity

Referenced by ApplySpongeZoneBCsForMom(), and init_params().

sponge_y_velocity

amrex::Real SpongeChoice::sponge_y_velocity

Referenced by ApplySpongeZoneBCsForMom(), and init_params().

sponge_z_velocity

amrex::Real SpongeChoice::sponge_z_velocity

Referenced by ApplySpongeZoneBCsForMom(), and init_params().

use_xhi_sponge_damping

bool SpongeChoice::use_xhi_sponge_damping = false

Referenced by ApplySpongeZoneBCsForCC(), ApplySpongeZoneBCsForMom(), ApplySpongeZoneBCsForMom_ReadFromFile(), and init_params().

use_xlo_sponge_damping

bool SpongeChoice::use_xlo_sponge_damping = false

Referenced by ApplySpongeZoneBCsForCC(), ApplySpongeZoneBCsForMom(), ApplySpongeZoneBCsForMom_ReadFromFile(), and init_params().

use_yhi_sponge_damping

bool SpongeChoice::use_yhi_sponge_damping = false

Referenced by ApplySpongeZoneBCsForCC(), ApplySpongeZoneBCsForMom(), ApplySpongeZoneBCsForMom_ReadFromFile(), and init_params().

use_ylo_sponge_damping

bool SpongeChoice::use_ylo_sponge_damping = false

Referenced by ApplySpongeZoneBCsForCC(), ApplySpongeZoneBCsForMom(), ApplySpongeZoneBCsForMom_ReadFromFile(), and init_params().

use_zhi_sponge_damping

bool SpongeChoice::use_zhi_sponge_damping = false

Referenced by ApplySpongeZoneBCsForCC(), ApplySpongeZoneBCsForMom(), ApplySpongeZoneBCsForMom_ReadFromFile(), and init_params().

use_zlo_sponge_damping

bool SpongeChoice::use_zlo_sponge_damping = false

Referenced by ApplySpongeZoneBCsForCC(), ApplySpongeZoneBCsForMom(), ApplySpongeZoneBCsForMom_ReadFromFile(), and init_params().

xhi_sponge_start

amrex::Real SpongeChoice::xhi_sponge_start

Referenced by ApplySpongeZoneBCsForCC(), ApplySpongeZoneBCsForMom(), ApplySpongeZoneBCsForMom_ReadFromFile(), and init_params().

xlo_sponge_end

amrex::Real SpongeChoice::xlo_sponge_end

Referenced by ApplySpongeZoneBCsForCC(), ApplySpongeZoneBCsForMom(), ApplySpongeZoneBCsForMom_ReadFromFile(), and init_params().

yhi_sponge_start

amrex::Real SpongeChoice::yhi_sponge_start

Referenced by ApplySpongeZoneBCsForCC(), ApplySpongeZoneBCsForMom(), ApplySpongeZoneBCsForMom_ReadFromFile(), and init_params().

ylo_sponge_end

amrex::Real SpongeChoice::ylo_sponge_end

Referenced by ApplySpongeZoneBCsForCC(), ApplySpongeZoneBCsForMom(), ApplySpongeZoneBCsForMom_ReadFromFile(), and init_params().

zhi_sponge_start

amrex::Real SpongeChoice::zhi_sponge_start

Referenced by ApplySpongeZoneBCsForCC(), ApplySpongeZoneBCsForMom(), ApplySpongeZoneBCsForMom_ReadFromFile(), and init_params().

zlo_sponge_end

amrex::Real SpongeChoice::zlo_sponge_end

Referenced by ApplySpongeZoneBCsForCC(), ApplySpongeZoneBCsForMom(), ApplySpongeZoneBCsForMom_ReadFromFile(), and init_params().

---

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

• Source/DataStructs/ERF_SpongeStruct.H