#include <prob_common.H>

Collaboration diagram for ProblemBase:

Public Member Functions
virtual	~ProblemBase ()=default

virtual void	erf_init_dens_hse (amrex::MultiFab &, std::unique_ptr< amrex::MultiFab > &, std::unique_ptr< amrex::MultiFab > &, amrex::Geometry const &)

virtual void	erf_init_dens_hse_moist (amrex::MultiFab &, std::unique_ptr< amrex::MultiFab > &, amrex::Geometry const &)

virtual void	init_custom_pert (const amrex::Box &, const amrex::Box &, const amrex::Box &, const amrex::Box &, amrex::Array4< amrex::Real const > const &, amrex::Array4< amrex::Real > const &, amrex::Array4< amrex::Real > const &, amrex::Array4< amrex::Real > const &, amrex::Array4< amrex::Real > const &, amrex::Array4< amrex::Real > const &, amrex::Array4< amrex::Real > const &, amrex::Array4< amrex::Real const > const &, amrex::Array4< amrex::Real const > const &, amrex::GeometryData const &, amrex::Array4< amrex::Real const > const &, amrex::Array4< amrex::Real const > const &, amrex::Array4< amrex::Real const > const &, const SolverChoice &)

virtual void	update_rhotheta_sources (const amrex::Real &, amrex::Vector< amrex::Real > &src, amrex::Gpu::DeviceVector< amrex::Real > &d_src, const amrex::Geometry &geom, std::unique_ptr< amrex::MultiFab > &z_phys_cc)

virtual void	update_rhoqt_sources (const amrex::Real &, amrex::Vector< amrex::Real > &qsrc, amrex::Gpu::DeviceVector< amrex::Real > &d_qsrc, const amrex::Geometry &geom, std::unique_ptr< amrex::MultiFab > &z_phys_cc)

virtual void	update_w_subsidence (const amrex::Real &, amrex::Vector< amrex::Real > &wbar, amrex::Gpu::DeviceVector< amrex::Real > &d_wbar, const amrex::Geometry &geom, std::unique_ptr< amrex::MultiFab > &z_phys_cc)

virtual void	update_geostrophic_profile (const amrex::Real &, amrex::Vector< amrex::Real > &u_geos, amrex::Gpu::DeviceVector< amrex::Real > &d_u_geos, amrex::Vector< amrex::Real > &v_geos, amrex::Gpu::DeviceVector< amrex::Real > &d_v_geos, const amrex::Geometry &geom, std::unique_ptr< amrex::MultiFab > &z_phys_cc)

virtual void	init_custom_terrain (const amrex::Geometry &, amrex::MultiFab &z_phys_nd, const amrex::Real &)

virtual void	init_custom_terrain (const amrex::Geometry &, amrex::FArrayBox &z_phys_nd, const amrex::Real &)

virtual void	erf_init_rayleigh (amrex::Vector< amrex::Vector< amrex::Real > > &, amrex::Geometry const &, std::unique_ptr< amrex::MultiFab > &)

void	init_uniform (const amrex::Box &bx, amrex::Array4< amrex::Real > const &state)

Protected Member Functions
void	init_base_parms (amrex::Real rho_0, amrex::Real T_0)

virtual std::string	name ()=0

Protected Attributes
ProbParmDefaults	base_parms

Detailed Description

Class to hold problem-specific routines

Constructor & Destructor Documentation

◆ ~ProblemBase()

virtual ProblemBase::~ProblemBase ( )

virtualdefault

Virtual destructor to avoid data leakage with derived class

Member Function Documentation

◆ erf_init_dens_hse()

virtual void ProblemBase::erf_init_dens_hse	(	amrex::MultiFab &	,
		std::unique_ptr< amrex::MultiFab > &	,
		std::unique_ptr< amrex::MultiFab > &	,
		amrex::Geometry const &
	)

inlinevirtual

Function to initialize the hydrostatic reference density

Parameters

[out]	rho_hse	hydrostatic reference density
[in]	z_phys_nd	height coordinate at nodes
[in]	z_phys_cc	height coordinate at cell centers
[in]	geom	container for geometric information

     {
         amrex::Print() << "Hydrostatically balanced density was NOT set"
             << " -- an appropriate init_type should probably have been specified"
             << " (e.g., input_sounding, ideal, real, or metgrid)"
             << std::endl;
         amrex::Error("Should never call erf_init_dens_hse for "+name()+" problem");
     }

Here is the call graph for this function:

◆ erf_init_dens_hse_moist()

virtual void ProblemBase::erf_init_dens_hse_moist	(	amrex::MultiFab &	,
		std::unique_ptr< amrex::MultiFab > &	,
		amrex::Geometry const &
	)

inlinevirtual

     {
  
     }

◆ erf_init_rayleigh()

virtual void ProblemBase::erf_init_rayleigh	(	amrex::Vector< amrex::Vector< amrex::Real > > &	,
		amrex::Geometry const &	,
		std::unique_ptr< amrex::MultiFab > &
	)

inlinevirtual

Function to define the quantities needed to impose Rayleigh damping

Parameters

[out]	rayleigh_ptrs	= {strength of Rayleigh damping, reference values for xvel/yvel/zvel/theta used to define Rayleigh damping}
[in]	geom	container for geometric information
[in]	z_phys_cc	height coordinate at cell centers

     {
         amrex::Error("Should never call erf_init_rayleigh for "+name()+" problem");
     }

Here is the call graph for this function:

◆ init_base_parms()

void ProblemBase::init_base_parms	(	amrex::Real	rho_0,
		amrex::Real	T_0
	)

inlineprotected

Function to update default base parameters, currently only used for init_type=='uniform'

                                                           {
         base_parms.rho_0 = rho_0;
         base_parms.T_0 = T_0;
     }

◆ init_custom_pert()

virtual void ProblemBase::init_custom_pert	(	const amrex::Box &	,
		const amrex::Box &	,
		const amrex::Box &	,
		const amrex::Box &	,
		amrex::Array4< amrex::Real const > const &	,
		amrex::Array4< amrex::Real > const &	,
		amrex::Array4< amrex::Real > const &	,
		amrex::Array4< amrex::Real > const &	,
		amrex::Array4< amrex::Real > const &	,
		amrex::Array4< amrex::Real > const &	,
		amrex::Array4< amrex::Real > const &	,
		amrex::Array4< amrex::Real const > const &	,
		amrex::Array4< amrex::Real const > const &	,
		amrex::GeometryData const &	,
		amrex::Array4< amrex::Real const > const &	,
		amrex::Array4< amrex::Real const > const &	,
		amrex::Array4< amrex::Real const > const &	,
		const SolverChoice &
	)

inlinevirtual

Function to perform custom initialization of a test problem

Parameters

[in]	bx	cell-centered box on which to initialize scalars
[in]	xbx	box on which to initialize x-component of velocity
[in]	ybx	box on which to initialize y-component of velocity
[in]	zbx	box on which to initialize z-component of velocity
[out]	state	cell-centered variables to be filled in this routine
[out]	x_velocity	x-component of velocity to be filled in this routine
[out]	y_velocity	y-component of velocity to be filled in this routine
[out]	z_velocity	z-component of velocity to be filled in this routine
[out]	r_hse	hydrostatic reference density
[out]	p_hse	hydrostatic reference pressure
[in]	z_nd	height coordinate at nodes
[in]	z_cc	height coordinate at cell centers
[in]	qv	water vapor
[in]	qc	cloud water
[in]	qi	cloud ice
[in]	mf_m	map factor on cell centers
[in]	mf_u	map factor on x-faces
[in]	mf_v	map factor on y-faces
[in]	sc	SolverChoice structure that carries parameters

     {
         amrex::Print() << "No perturbation to background fields supplied for "
             << name() << " problem" << std::endl;;
     }

Here is the call graph for this function:

◆ init_custom_terrain() [1/2]

virtual void ProblemBase::init_custom_terrain	(	const amrex::Geometry &	,
		amrex::FArrayBox &	z_phys_nd,
		const amrex::Real &
	)

inlinevirtual

Function to perform custom initialization of terrain

This version takes a single FArrayBox instead of a MultiFab

     {
         // Note that this only sets the terrain value at the ground IF k=0 is in the box
         amrex::Print() << "Initializing flat terrain at z=0" << std::endl;
  
         // Bottom of domain
         int k0 = 0;
  
         // Grown box with no z range
         amrex::Box bx = z_phys_nd.box();
         amrex::Array4<amrex::Real> const& z_arr = z_phys_nd.array();
  
         ParallelFor(bx, [=] AMREX_GPU_DEVICE (int i, int j, int) {
             z_arr(i,j,k0) = 0.0;
         });
     }

◆ init_custom_terrain() [2/2]

virtual void ProblemBase::init_custom_terrain	(	const amrex::Geometry &	,
		amrex::MultiFab &	z_phys_nd,
		const amrex::Real &
	)

inlinevirtual

Function to perform custom initialization of terrain

Note: Terrain functionality can also be used to provide grid stretching.

Parameters

[in]	geom	container for geometric information
[out]	z_phys_nd	height coordinate at nodes
[in]	time	current time

     {
         // Note that this only sets the terrain value at the ground IF k=0 is in the box
         amrex::Print() << "Initializing flat terrain at z=0" << std::endl;
  
         // Number of ghost cells
         int ngrow = z_phys_nd.nGrow();
  
         // Bottom of domain
         int k0 = 0;
  
         for ( amrex::MFIter mfi(z_phys_nd, amrex::TilingIfNotGPU()); mfi.isValid(); ++mfi )
         {
             // Grown box with no z range
             amrex::Box  zbx = mfi.nodaltilebox(2);
             if (zbx.smallEnd(2) <= 0) {
                 amrex::Box xybx = mfi.growntilebox(ngrow);
                 xybx.setRange(2,0);
  
                 amrex::Array4<amrex::Real> const& z_arr = z_phys_nd.array(mfi);
  
                 ParallelFor(xybx, [=] AMREX_GPU_DEVICE (int i, int j, int) {
                     z_arr(i,j,k0) = 0.0;
                 });
             }
         }
     }

◆ init_uniform()

void ProblemBase::init_uniform	(	const amrex::Box &	bx,
		amrex::Array4< amrex::Real > const &	state
	)

inline

Function to set uniform background density and pressure fields

     {
         amrex::Real rho_0 = base_parms.rho_0;
         amrex::Real T_0 = base_parms.T_0;
         amrex::Print() << "Initializing uniform fields"
             << " rho=" << rho_0 << " theta=" << T_0
             << " -- this probably only makes sense with gravity turned off"
             << std::endl;
  
         ParallelFor(bx, [=] AMREX_GPU_DEVICE (int i, int j, int k) noexcept
         {
             state(i, j, k, Rho_comp) = rho_0;
             state(i, j, k, RhoTheta_comp) = rho_0 * T_0;
         });
     }

◆ name()

virtual std::string ProblemBase::name ( )

protectedpure virtual

Referenced by erf_init_dens_hse(), erf_init_rayleigh(), init_custom_pert(), update_geostrophic_profile(), update_rhoqt_sources(), update_rhotheta_sources(), and update_w_subsidence().

Here is the caller graph for this function:

◆ update_geostrophic_profile()

virtual void ProblemBase::update_geostrophic_profile	(	const amrex::Real &	,
		amrex::Vector< amrex::Real > &	u_geos,
		amrex::Gpu::DeviceVector< amrex::Real > &	d_u_geos,
		amrex::Vector< amrex::Real > &	v_geos,
		amrex::Gpu::DeviceVector< amrex::Real > &	d_v_geos,
		const amrex::Geometry &	geom,
		std::unique_ptr< amrex::MultiFab > &	z_phys_cc
	)

inlinevirtual

Function to update user-specified temperature source terms that can vary with time and height.

Parameters

[in]	time	current time
[out]	u_geos	geostrophic wind profile
[out]	v_geos	geostrophic wind profile
[in]	geom	container for geometric information
[in]	z_phys_cc	height coordinate at cell centers

     {
         if (u_geos.empty()) return;
  
         if (z_phys_cc) {
             // use_terrain=1
             amrex::Error("Geostrophic wind profile not defined for "+name()+" problem with terrain");
         } else {
             const int khi              = geom.Domain().bigEnd()[2];
             // const amrex::Real* prob_lo = geom.ProbLo();
             // const auto dx              = geom.CellSize();
             for (int k = 0; k <= khi; k++)
             {
                 // const amrex::Real z_cc = prob_lo[2] + (k+0.5)* dx[2];
                 // set RHS term of RhoTheta equation based on time, z_cc here
                 u_geos[k] = 0.0;
                 v_geos[k] = 0.0;
             }
         }
  
         // Copy from host version to device version
         amrex::Gpu::copy(amrex::Gpu::hostToDevice, u_geos.begin(), u_geos.end(), d_u_geos.begin());
         amrex::Gpu::copy(amrex::Gpu::hostToDevice, v_geos.begin(), v_geos.end(), d_v_geos.begin());
     }

Here is the call graph for this function:

◆ update_rhoqt_sources()

virtual void ProblemBase::update_rhoqt_sources	(	const amrex::Real &	,
		amrex::Vector< amrex::Real > &	qsrc,
		amrex::Gpu::DeviceVector< amrex::Real > &	d_qsrc,
		const amrex::Geometry &	geom,
		std::unique_ptr< amrex::MultiFab > &	z_phys_cc
	)

inlinevirtual

Function to update user-specified temperature source terms that can vary with time and height.

Parameters

[in]	time	current time
[out]	rhoqt_source	moisture forcing profile
[in]	geom	container for geometric information
[in]	z_phys_cc	height coordinate at cell centers

     {
         if (qsrc.empty()) return;
  
         if (z_phys_cc) {
             // use_terrain=1
             amrex::Error("Moisture forcing not defined for "+name()+" problem with terrain");
         } else {
             const int khi              = geom.Domain().bigEnd()[2];
             // const amrex::Real* prob_lo = geom.ProbLo();
             // const auto dx              = geom.CellSize();
             for (int k = 0; k <= khi; k++)
             {
                 // const amrex::Real z_cc = prob_lo[2] + (k+0.5)* dx[2];
                 // set RHS term of RhoTheta equation based on time, z_cc here
                 qsrc[k] = 0.0;
             }
         }
  
         // Copy from host version to device version
         amrex::Gpu::copy(amrex::Gpu::hostToDevice, qsrc.begin(), qsrc.end(), d_qsrc.begin());
     }

Here is the call graph for this function:

◆ update_rhotheta_sources()

virtual void ProblemBase::update_rhotheta_sources	(	const amrex::Real &	,
		amrex::Vector< amrex::Real > &	src,
		amrex::Gpu::DeviceVector< amrex::Real > &	d_src,
		const amrex::Geometry &	geom,
		std::unique_ptr< amrex::MultiFab > &	z_phys_cc
	)

inlinevirtual

Function to update user-specified temperature source terms that can vary with time and height.

Parameters

[in]	time	current time
[out]	rhotheta_source	forcing profile
[in]	geom	container for geometric information
[in]	z_phys_cc	height coordinate at cell centers

     {
         if (src.empty()) return;
  
         if (z_phys_cc) {
             // use_terrain=1
             amrex::Error("Temperature forcing not defined for "+name()+" problem with terrain");
         } else {
             const int khi              = geom.Domain().bigEnd()[2];
             // const amrex::Real* prob_lo = geom.ProbLo();
             // const auto dx              = geom.CellSize();
             for (int k = 0; k <= khi; k++)
             {
                 // const amrex::Real z_cc = prob_lo[2] + (k+0.5)* dx[2];
                 // set RHS term of RhoTheta equation based on time, z_cc here
                 src[k] = 0.0;
             }
         }
  
         // Copy from host version to device version
         amrex::Gpu::copy(amrex::Gpu::hostToDevice, src.begin(), src.end(), d_src.begin());
     }

Here is the call graph for this function:

◆ update_w_subsidence()

virtual void ProblemBase::update_w_subsidence	(	const amrex::Real &	,
		amrex::Vector< amrex::Real > &	wbar,
		amrex::Gpu::DeviceVector< amrex::Real > &	d_wbar,
		const amrex::Geometry &	geom,
		std::unique_ptr< amrex::MultiFab > &	z_phys_cc
	)

inlinevirtual

Function to update user-specified temperature source terms that can vary with time and height.

Parameters

[in]	time	current time
[out]	wbar	w vel forcing profile
[in]	geom	container for geometric information
[in]	z_phys_cc	height coordinate at cell centers

     {
         if (wbar.empty()) return;
  
         if (z_phys_cc) {
             // use_terrain=1
             amrex::Error("Moisture forcing not defined for "+name()+" problem with terrain");
         } else {
             const int khi              = geom.Domain().bigEnd()[2];
             // const amrex::Real* prob_lo = geom.ProbLo();
             // const auto dx              = geom.CellSize();
             for (int k = 0; k <= khi; k++)
             {
                 // const amrex::Real z_cc = prob_lo[2] + (k+0.5)* dx[2];
                 // set RHS term of RhoTheta equation based on time, z_cc here
                 wbar[k] = 0.0;
             }
         }
  
         // Copy from host version to device version
         amrex::Gpu::copy(amrex::Gpu::hostToDevice, wbar.begin(), wbar.end(), d_wbar.begin());
     }

Here is the call graph for this function:

Member Data Documentation

◆ base_parms

ProbParmDefaults ProblemBase::base_parms

protected

Referenced by init_base_parms(), and init_uniform().

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

Source/prob_common.H

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~ProblemBase()

Member Function Documentation

◆ erf_init_dens_hse()

◆ erf_init_dens_hse_moist()

◆ erf_init_rayleigh()

◆ init_base_parms()

◆ init_custom_pert()

◆ init_custom_terrain() [1/2]

◆ init_custom_terrain() [2/2]

◆ init_uniform()

◆ name()

◆ update_geostrophic_profile()

◆ update_rhoqt_sources()

◆ update_rhotheta_sources()

◆ update_w_subsidence()

Member Data Documentation

◆ base_parms