ERF::ParticlePos Namespace Reference

Functions
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real	z_face_at_xy (amrex::Real x, amrex::Real y, int k_face, amrex::GpuArray< amrex::Real, AMREX_SPACEDIM > const &plo, amrex::GpuArray< amrex::Real, AMREX_SPACEDIM > const &dxi, amrex::Array4< amrex::Real const > const &height_arr) noexcept
	Bilinear interpolation of the height array at (x, y) for a given vertical node index k_face. More...
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real	z_from_zeta (amrex::Real x, amrex::Real y, amrex::Real zeta, amrex::GpuArray< amrex::Real, AMREX_SPACEDIM > const &plo, amrex::GpuArray< amrex::Real, AMREX_SPACEDIM > const &dxi, amrex::Array4< amrex::Real const > const &height_arr) noexcept
	Convert computational vertical coordinate zeta to physical z at column (x, y). More...
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real	zeta_from_z (amrex::Real x, amrex::Real y, amrex::Real z, amrex::GpuArray< amrex::Real, AMREX_SPACEDIM > const &plo, amrex::GpuArray< amrex::Real, AMREX_SPACEDIM > const &dxi, amrex::Array4< amrex::Real const > const &height_arr, int k_max) noexcept
	Convert physical z to computational vertical coordinate zeta at column (x, y). More...

Function Documentation

z_face_at_xy()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real ERF::ParticlePos::z_face_at_xy ( amrex::Real  x, amrex::Real  y, int  k_face, amrex::GpuArray< amrex::Real, AMREX_SPACEDIM > const &  plo, amrex::GpuArray< amrex::Real, AMREX_SPACEDIM > const &  dxi, amrex::Array4< amrex::Real const > const &  height_arr  )

noexcept

Bilinear interpolation of the height array at (x, y) for a given vertical node index k_face.

Parameters

[in]	x	Physical x-coordinate.
[in]	y	Physical y-coordinate.
[in]	k_face	Vertical node index.
[in]	plo	Lower bound of the box.
[in]	dxi	Inverse grid spacing.
[in]	height_arr	Array of node-centered heights.

Returns

Physical height z at the specified coordinates.

{
    const amrex::Real lx = (x - plo[0]) * dxi[0];
    const amrex::Real ly = (y - plo[1]) * dxi[1];
    // Keep the stencil (ix..ix+1, iy..iy+1) inside height_arr: a point on the upper
    //    boundary, or just past it, takes the boundary node's value instead of reading
    //    one node beyond the array
    const auto hlo = amrex::lbound(height_arr);
    const auto hhi = amrex::ubound(height_arr);
    const int  ix = amrex::Clamp(static_cast<int>(amrex::Math::floor(lx)), hlo.x, hhi.x - 1);
    const int  iy = amrex::Clamp(static_cast<int>(amrex::Math::floor(ly)), hlo.y, hhi.y - 1);
    const amrex::Real fx = amrex::Clamp(lx - static_cast<amrex::Real>(ix), amrex::Real(0), amrex::Real(1));
    const amrex::Real fy = amrex::Clamp(ly - static_cast<amrex::Real>(iy), amrex::Real(0), amrex::Real(1));
    return height_arr(ix  , iy  , k_face) * (amrex::Real(1) - fx) * (amrex::Real(1) - fy)
         + height_arr(ix+1, iy  , k_face) *                fx     * (amrex::Real(1) - fy)
         + height_arr(ix  , iy+1, k_face) * (amrex::Real(1) - fx) *                fy
         + height_arr(ix+1, iy+1, k_face) *                fx     *                fy;
}

Referenced by z_from_zeta(), and zeta_from_z().

Here is the caller graph for this function:

z_from_zeta()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real ERF::ParticlePos::z_from_zeta ( amrex::Real  x, amrex::Real  y, amrex::Real  zeta, amrex::GpuArray< amrex::Real, AMREX_SPACEDIM > const &  plo, amrex::GpuArray< amrex::Real, AMREX_SPACEDIM > const &  dxi, amrex::Array4< amrex::Real const > const &  height_arr  )

noexcept

Convert computational vertical coordinate zeta to physical z at column (x, y).

Parameters

[in]	x	Physical x-coordinate.
[in]	y	Physical y-coordinate.
[in]	zeta	Computational vertical coordinate.
[in]	plo	Lower bound of the box.
[in]	dxi	Inverse grid spacing.
[in]	height_arr	Array of node-centered heights.

Returns

Physical height z.

{
    if (!height_arr) {
        return zeta;  // no terrain: identity
    }
    const amrex::Real lz = (zeta - plo[AMREX_SPACEDIM-1]) * dxi[AMREX_SPACEDIM-1];
    const int  k  = static_cast<int>(amrex::Math::floor(lz));
    const amrex::Real fz = lz - static_cast<amrex::Real>(k);
    const amrex::Real z_lo = z_face_at_xy(x, y, k    , plo, dxi, height_arr);
    const amrex::Real z_hi = z_face_at_xy(x, y, k + 1, plo, dxi, height_arr);
    return (amrex::Real(1) - fz) * z_lo + fz * z_hi;
}

Here is the call graph for this function:

zeta_from_z()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real ERF::ParticlePos::zeta_from_z ( amrex::Real  x, amrex::Real  y, amrex::Real  z, amrex::GpuArray< amrex::Real, AMREX_SPACEDIM > const &  plo, amrex::GpuArray< amrex::Real, AMREX_SPACEDIM > const &  dxi, amrex::Array4< amrex::Real const > const &  height_arr, int  k_max  )

noexcept

Convert physical z to computational vertical coordinate zeta at column (x, y).

Parameters

[in]	x	Physical x-coordinate.
[in]	y	Physical y-coordinate.
[in]	z	Physical z-coordinate.
[in]	plo	Lower bound of the box.
[in]	dxi	Inverse grid spacing.
[in]	height_arr	Array of node-centered heights.
[in]	k_max	Largest valid cell index in the level.

Returns

Computational vertical coordinate zeta.

{
    if (!height_arr) {
        return z;  // no terrain: identity
    }
    const int k_lo = amrex::max(0,     height_arr.begin[2]);
    const int k_hi = amrex::min(k_max, height_arr.end[2] - 2);
    int k = k_lo;
    while (k < k_hi) {
        const amrex::Real z_hi = z_face_at_xy(x, y, k + 1, plo, dxi, height_arr);
        if (z < z_hi) { break; }
        ++k;
    }
    const amrex::Real z_lo = z_face_at_xy(x, y, k    , plo, dxi, height_arr);
    const amrex::Real z_hi = z_face_at_xy(x, y, k + 1, plo, dxi, height_arr);
    const amrex::Real fz = (z_hi > z_lo)
                         ? (z - z_lo) / (z_hi - z_lo)
                         : amrex::Real(0);
    return plo[AMREX_SPACEDIM-1]
         + (static_cast<amrex::Real>(k) + fz) / dxi[AMREX_SPACEDIM-1];
}

Here is the call graph for this function: