ERF_NumericalDiffusion.H File Reference

#include <AMReX.H>
#include <ERF_DataStruct.H>
#include <AMReX_MultiFab.H>

Include dependency graph for ERF_NumericalDiffusion.H:

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

Go to the source code of this file.

Functions
AMREX_GPU_DEVICE AMREX_FORCE_INLINE amrex::Real	calc_fifth_order_deriv (const amrex::Real &dnp2, const amrex::Real &dnp1, const amrex::Real &dn, const amrex::Real &dnm1, const amrex::Real &dnm2, const amrex::Real &dnm3)
void	NumericalDiffusion_Scal (const amrex::Box &bx, const int start_comp, const int num_comp, const double dt, const amrex::Real num_diff_coeff, const amrex::Array4< const amrex::Real > &prim_data, const amrex::Array4< const amrex::Real > &cell_data, const amrex::Array4< amrex::Real > &rhs, const amrex::Array4< const amrex::Real > &mfx, const amrex::Array4< const amrex::Real > &mfy)
void	NumericalDiffusion_Xmom (const amrex::Box &bx, const double dt, const amrex::Real num_diff_coeff, const amrex::Array4< const amrex::Real > &prim_data, const amrex::Array4< const amrex::Real > &cell_data, const amrex::Array4< amrex::Real > &rhs, const amrex::Array4< const amrex::Real > &mfx, const amrex::Array4< const amrex::Real > &mfy)
void	NumericalDiffusion_Ymom (const amrex::Box &bx, const double dt, const amrex::Real num_diff_coeff, const amrex::Array4< const amrex::Real > &prim_data, const amrex::Array4< const amrex::Real > &cell_data, const amrex::Array4< amrex::Real > &rhs, const amrex::Array4< const amrex::Real > &mfx, const amrex::Array4< const amrex::Real > &mfy)

Function Documentation

calc_fifth_order_deriv()

AMREX_GPU_DEVICE AMREX_FORCE_INLINE amrex::Real calc_fifth_order_deriv	(	const amrex::Real &	dnp2,
		const amrex::Real &	dnp1,
		const amrex::Real &	dn,
		const amrex::Real &	dnm1,
		const amrex::Real &	dnm2,
		const amrex::Real &	dnm3
	)

Compute a fifth-order derivative approximation.

Parameters

[in]	dnp2	Value at index n+2
[in]	dnp1	Value at index n+1
[in]	dn	Value at index n
[in]	dnm1	Value at index n-1
[in]	dnm2	Value at index n-2
[in]	dnm3	Value at index n-3

Returns

The calculated derivative

{
    amrex::Real interp = amrex::Real(10.) * (dn   - dnm1)
                        - amrex::Real(5.) * (dnp1 - dnm2)
                             + (dnp2 - dnm3);
    return interp;
}

Referenced by NumericalDiffusion_Scal(), NumericalDiffusion_Xmom(), and NumericalDiffusion_Ymom().

Here is the caller graph for this function:

NumericalDiffusion_Scal()

void NumericalDiffusion_Scal	(	const amrex::Box &	bx,
		const int	start_comp,
		const int	num_comp,
		const double	dt,
		const amrex::Real	num_diff_coeff,
		const amrex::Array4< const amrex::Real > &	prim_data,
		const amrex::Array4< const amrex::Real > &	cell_data,
		const amrex::Array4< amrex::Real > &	rhs,
		const amrex::Array4< const amrex::Real > &	mfx,
		const amrex::Array4< const amrex::Real > &	mfy
	)

Apply numerical diffusion to scalar variables.

Parameters

[in]	bx	Box of cells to process
[in]	start_comp	Starting component index
[in]	num_comp	Number of components to process
[in]	dt	Time step
[in]	num_diff_coeff	Numerical diffusion coefficient
[in]	prim_data	Primitive variable data
[in]	cell_data	Cell-centered data
[out]	rhs	Right-hand side array for updates
[in]	mfx	Map factors in x
[in]	mfy	Map factors in y

NumericalDiffusion_Xmom()

void NumericalDiffusion_Xmom	(	const amrex::Box &	bx,
		const double	dt,
		const amrex::Real	num_diff_coeff,
		const amrex::Array4< const amrex::Real > &	prim_data,
		const amrex::Array4< const amrex::Real > &	cell_data,
		const amrex::Array4< amrex::Real > &	rhs,
		const amrex::Array4< const amrex::Real > &	mfx,
		const amrex::Array4< const amrex::Real > &	mfy
	)

Apply numerical diffusion to the x-momentum equation.

Parameters

[in]	bx	Box of cells to process
[in]	dt	Time step
[in]	num_diff_coeff	Numerical diffusion coefficient
[in]	prim_data	Primitive variable data
[in]	cell_data	Cell-centered data
[out]	rhs	Right-hand side array for updates
[in]	mfx	Map factors in x
[in]	mfy	Map factors in y

NumericalDiffusion_Ymom()

void NumericalDiffusion_Ymom	(	const amrex::Box &	bx,
		const double	dt,
		const amrex::Real	num_diff_coeff,
		const amrex::Array4< const amrex::Real > &	prim_data,
		const amrex::Array4< const amrex::Real > &	cell_data,
		const amrex::Array4< amrex::Real > &	rhs,
		const amrex::Array4< const amrex::Real > &	mfx,
		const amrex::Array4< const amrex::Real > &	mfy
	)

Apply numerical diffusion to the y-momentum equation.

Parameters

[in]	bx	Box of cells to process
[in]	dt	Time step
[in]	num_diff_coeff	Numerical diffusion coefficient
[in]	prim_data	Primitive variable data
[in]	cell_data	Cell-centered data
[out]	rhs	Right-hand side array for updates
[in]	mfx	Map factors in x
[in]	mfy	Map factors in y