ERF_CanopyTurbulence.H File Reference

#include <cmath>
#include <limits>
#include <string>
#include <AMReX_GpuQualifiers.H>
#include <AMReX_Array4.H>
#include <AMReX_Box.H>
#include <AMReX_GpuLaunch.H>
#include <AMReX_REAL.H>
#include <ERF_CanopyTurbStruct.H>
#include <ERF_IndexDefines.H>

Include dependency graph for ERF_CanopyTurbulence.H:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces
	canopy_turbulence

Functions
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real	canopy_turbulence::limited_length (amrex::Real length, amrex::Real f_drag, amrex::Real alpha)
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real	canopy_turbulence::tke_source (amrex::Real rho, amrex::Real rhok_old, amrex::Real f_drag, amrex::Real wind, amrex::Real beta_p, amrex::Real beta_d, amrex::Real dt)
AMREX_INLINE void	AddCanopyTKESources (const amrex::Box &bx, const amrex::Array4< amrex::Real > &cell_src, const amrex::Array4< const amrex::Real > &cell_data, const amrex::Array4< const amrex::Real > &cell_old, const amrex::Array4< const amrex::Real > &u, const amrex::Array4< const amrex::Real > &v, const amrex::Array4< const amrex::Real > &w, const amrex::Array4< const amrex::Real > &f_arr, const amrex::Array4< const amrex::Real > &t_blank_arr, const CanopyTurbulence &canopy, amrex::Real dt)

Function Documentation

AddCanopyTKESources()

AMREX_INLINE void AddCanopyTKESources	(	const amrex::Box &	bx,
		const amrex::Array4< amrex::Real > &	cell_src,
		const amrex::Array4< const amrex::Real > &	cell_data,
		const amrex::Array4< const amrex::Real > &	cell_old,
		const amrex::Array4< const amrex::Real > &	u,
		const amrex::Array4< const amrex::Real > &	v,
		const amrex::Array4< const amrex::Real > &	w,
		const amrex::Array4< const amrex::Real > &	f_arr,
		const amrex::Array4< const amrex::Real > &	t_blank_arr,
		const CanopyTurbulence &	canopy,
		amrex::Real	dt
	)

Add the canopy TKE source to the RhoKE component of the staged cell source on one box. Called by make_sources inside its loop over the boxes, so it adds no pass over the level; cells outside the forest (f <= 0) return before the velocities are read. Fully immersed cells (terrain_blank = 1) get no source, where ERF_AdvanceDycore.cpp also zeroes the eddy diffusivities.

Parameters

[in]	bx	cell-centred box to fill
[in,out]	cell_src	staged source terms for the conserved state
[in]	cell_data	conserved state of the stage (Rho_comp is read)
[in]	cell_old	conserved state at the start of the step (RhoKE_comp is read)
[in]	u	x-face velocity
[in]	v	y-face velocity
[in]	w	z-face velocity
[in]	f_arr	cell-centred forest drag field f = C_d LAD
[in]	t_blank_arr	immersed-forcing blanking, or an empty Array4 without immersed forcing
[in]	canopy	canopy turbulence inputs
[in]	dt	time step of the stage the source enters

{
    const amrex::Real beta_p = canopy.beta_p;
    const amrex::Real beta_d = canopy.beta_d;
    const bool use_blank = static_cast<bool>(t_blank_arr);
 
    amrex::ParallelFor(bx, [=] AMREX_GPU_DEVICE (int i, int j, int k) noexcept
    {
        const amrex::Real f_drag = f_arr(i, j, k);
        if (f_drag <= amrex::Real(0.0)) {
            return;
        }
        if (use_blank && t_blank_arr(i, j, k) == amrex::Real(1.0)) {
            return;
        }
        const amrex::Real rho  = cell_data(i, j, k, Rho_comp);
        const amrex::Real rhok_old = amrex::max(cell_old(i, j, k, RhoKE_comp), amrex::Real(0.0));
        const amrex::Real u_cc = amrex::Real(0.5) * (u(i, j, k) + u(i+1, j, k));
        const amrex::Real v_cc = amrex::Real(0.5) * (v(i, j, k) + v(i, j+1, k));
        const amrex::Real w_cc = amrex::Real(0.5) * (w(i, j, k) + w(i, j, k+1));
        const amrex::Real wind = std::sqrt(u_cc*u_cc + v_cc*v_cc + w_cc*w_cc);
        cell_src(i, j, k, RhoKE_comp) +=
            canopy_turbulence::tke_source(rho, rhok_old, f_drag, wind, beta_p, beta_d, dt);
    });
}

Referenced by make_sources().

Here is the call graph for this function:

Here is the caller graph for this function: