ERF_AdvectionSrcForScalars.H File Reference

#include <ERF_IndexDefines.H>
#include <ERF_Interpolation.H>

Include dependency graph for ERF_AdvectionSrcForScalars.H:

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

Go to the source code of this file.

Functions
template<typename InterpType_H , typename InterpType_V >
void	AdvectionSrcForScalarsWrapper (const amrex::Box &bx, const int &ncomp, const int &icomp, const amrex::GpuArray< const amrex::Array4< amrex::Real >, AMREX_SPACEDIM > flx_arr, const amrex::Array4< const amrex::Real > &cell_prim, const amrex::Array4< const amrex::Real > &avg_xmom, const amrex::Array4< const amrex::Real > &avg_ymom, const amrex::Array4< const amrex::Real > &avg_zmom, const amrex::Real horiz_upw_frac, const amrex::Real vert_upw_frac)
template<typename InterpType_H >
void	AdvectionSrcForScalarsVert (const amrex::Box &bx, const int &ncomp, const int &icomp, const amrex::GpuArray< const amrex::Array4< amrex::Real >, AMREX_SPACEDIM > flx_arr, const amrex::Array4< const amrex::Real > &cell_prim, const amrex::Array4< const amrex::Real > &avg_xmom, const amrex::Array4< const amrex::Real > &avg_ymom, const amrex::Array4< const amrex::Real > &avg_zmom, const amrex::Real horiz_upw_frac, const amrex::Real vert_upw_frac, const AdvType vert_adv_type)

Function Documentation

AdvectionSrcForScalarsVert()

template<typename InterpType_H >

void AdvectionSrcForScalarsVert	(	const amrex::Box &	bx,
		const int &	ncomp,
		const int &	icomp,
		const amrex::GpuArray< const amrex::Array4< amrex::Real >, AMREX_SPACEDIM >	flx_arr,
		const amrex::Array4< const amrex::Real > &	cell_prim,
		const amrex::Array4< const amrex::Real > &	avg_xmom,
		const amrex::Array4< const amrex::Real > &	avg_ymom,
		const amrex::Array4< const amrex::Real > &	avg_zmom,
		const amrex::Real	horiz_upw_frac,
		const amrex::Real	vert_upw_frac,
		const AdvType	vert_adv_type
	)

Wrapper function for templating the vertical advective tendency w/ spatial order > 2.

{
    switch(vert_adv_type) {
    case AdvType::Centered_2nd:
        AdvectionSrcForScalarsWrapper<InterpType_H,CENTERED2>(bx, ncomp, icomp,
                                                              flx_arr, cell_prim,
                                                              avg_xmom, avg_ymom, avg_zmom,
                                                              horiz_upw_frac, vert_upw_frac);
        break;
    case AdvType::Upwind_3rd:
        AdvectionSrcForScalarsWrapper<InterpType_H,UPWIND3>(bx, ncomp, icomp,
                                                            flx_arr, cell_prim,
                                                            avg_xmom, avg_ymom, avg_zmom,
                                                            horiz_upw_frac, vert_upw_frac);
        break;
    case AdvType::Centered_4th:
        AdvectionSrcForScalarsWrapper<InterpType_H,CENTERED4>(bx, ncomp, icomp,
                                                              flx_arr, cell_prim,
                                                              avg_xmom, avg_ymom, avg_zmom,
                                                              horiz_upw_frac, vert_upw_frac);
        break;
    case AdvType::Upwind_5th:
        AdvectionSrcForScalarsWrapper<InterpType_H,UPWIND5>(bx, ncomp, icomp,
                                                            flx_arr, cell_prim,
                                                            avg_xmom, avg_ymom, avg_zmom,
                                                            horiz_upw_frac, vert_upw_frac);
        break;
    case AdvType::Centered_6th:
        AdvectionSrcForScalarsWrapper<InterpType_H,CENTERED6>(bx, ncomp, icomp,
                                                              flx_arr, cell_prim,
                                                              avg_xmom, avg_ymom, avg_zmom,
                                                              horiz_upw_frac, vert_upw_frac);
        break;
    default:
        AMREX_ASSERT_WITH_MESSAGE(false, "Unknown vertical advection scheme!");
    }
}

AdvectionSrcForScalarsWrapper()

template<typename InterpType_H , typename InterpType_V >

void AdvectionSrcForScalarsWrapper	(	const amrex::Box &	bx,
		const int &	ncomp,
		const int &	icomp,
		const amrex::GpuArray< const amrex::Array4< amrex::Real >, AMREX_SPACEDIM >	flx_arr,
		const amrex::Array4< const amrex::Real > &	cell_prim,
		const amrex::Array4< const amrex::Real > &	avg_xmom,
		const amrex::Array4< const amrex::Real > &	avg_ymom,
		const amrex::Array4< const amrex::Real > &	avg_zmom,
		const amrex::Real	horiz_upw_frac,
		const amrex::Real	vert_upw_frac
	)

Wrapper function for computing the advective tendency w/ spatial order > 2.

{
    // Instantiate structs for vert/horiz interp
    InterpType_H interp_prim_h(cell_prim);
    InterpType_V interp_prim_v(cell_prim);
 
    const amrex::Box xbx = amrex::surroundingNodes(bx,0);
    const amrex::Box ybx = amrex::surroundingNodes(bx,1);
    const amrex::Box zbx = amrex::surroundingNodes(bx,2);
 
    amrex::ParallelFor(xbx, ncomp,[=] AMREX_GPU_DEVICE (int i, int j, int k, int n) noexcept
    {
        const int cons_index = icomp + n;
        const int prim_index = cons_index - 1;
 
        amrex::Real interpx(0.);
 
        interp_prim_h.InterpolateInX(i,j,k,prim_index,interpx,avg_xmom(i  ,j  ,k  ),horiz_upw_frac);
        (flx_arr[0])(i,j,k,cons_index) = avg_xmom(i,j,k) * interpx;
    });
    amrex::ParallelFor(ybx, ncomp,[=] AMREX_GPU_DEVICE (int i, int j, int k, int n) noexcept
    {
        const int cons_index = icomp + n;
        const int prim_index = cons_index - 1;
 
        amrex::Real interpy(0.);
        interp_prim_h.InterpolateInY(i,j,k,prim_index,interpy,avg_ymom(i  ,j  ,k  ),horiz_upw_frac);
 
        (flx_arr[1])(i,j,k,cons_index) = avg_ymom(i,j,k) * interpy;
    });
    amrex::ParallelFor(zbx, ncomp,[=] AMREX_GPU_DEVICE (int i, int j, int k, int n) noexcept
    {
        const int cons_index = icomp + n;
        const int prim_index = cons_index - 1;
 
        amrex::Real interpz(0.);
 
        interp_prim_v.InterpolateInZ(i,j,k,prim_index,interpz,avg_zmom(i  ,j  ,k  ),vert_upw_frac);
 
        (flx_arr[2])(i,j,k,cons_index) = avg_zmom(i,j,k) * interpz;
    });
}