#include "AMReX_Box.H"
#include "AMReX_Gpu.H"

Include dependency graph for ERF_DirectionSelector.H:

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

Classes
struct	DirectionSelector< Index >

struct	DirectionSelector< 0 >

struct	DirectionSelector< 1 >

struct	DirectionSelector< 2 >

Typedefs
using	XDir = DirectionSelector< 0 >

using	YDir = DirectionSelector< 1 >

using	ZDir = DirectionSelector< 2 >

Functions
template<typename IndexSelector >
AMREX_GPU_HOST_DEVICE amrex::Box	PerpendicularBox (const amrex::Box &bx, const amrex::IntVect &iv)

template<typename IndexSelector >
AMREX_GPU_HOST_DEVICE amrex::Box	ParallelBox (const amrex::Box &bx, const amrex::IntVect &iv)

Typedef Documentation

◆ XDir

using XDir = DirectionSelector<0>

◆ YDir

using YDir = DirectionSelector<1>

◆ ZDir

using ZDir = DirectionSelector<2>

Function Documentation

◆ ParallelBox()

template<typename IndexSelector >

AMREX_GPU_HOST_DEVICE amrex::Box ParallelBox	(	const amrex::Box &	bx,
		const amrex::IntVect &	iv
	)

Given a box, return a 1D box parallel to the selected axis. For example, if we're using ZDir, return a box covering the z axis. The IntVect is used to set the constant indices in the perpendicular direction.

Parameters

[in]	bx	Initial box for computing of perpendicular box
[in]	iv	IntVect defining the perpendicular direction

 {
     amrex::IntVect line_lo, line_hi;
  
     if (std::is_same<IndexSelector, XDir>::value) {
         line_lo = {bx.smallEnd(0), iv[1], iv[2]};
         line_hi = {bx.bigEnd(0), iv[1], iv[2]};
     } else if (std::is_same<IndexSelector, YDir>::value) {
         line_lo = {iv[0], bx.smallEnd(1), iv[2]};
         line_hi = {iv[0], bx.bigEnd(1), iv[2]};
     } else {
         line_lo = {iv[0], iv[1], bx.smallEnd(2)};
         line_hi = {iv[0], iv[1], bx.bigEnd(2)};
     }
  
     amrex::Box lbx(line_lo, line_hi, bx.type());
  
     return lbx;
 }

◆ PerpendicularBox()

template<typename IndexSelector >

AMREX_GPU_HOST_DEVICE amrex::Box PerpendicularBox	(	const amrex::Box &	bx,
		const amrex::IntVect &	iv
	)

Given a box, return a 2D box perpendicular to the selected axis. For example, if we're using ZDir, return a box covering the x-y plane. The IntVect is used to set the constant index in the parallel direction.