ERF
Energy Research and Forecasting: An Atmospheric Modeling Code
Public Member Functions | Private Attributes | Static Private Attributes | List of all members
UPWIND3 Struct Reference

#include <ERF_Interpolation_UPW.H>

Collaboration diagram for UPWIND3:
Collaboration graph
[legend]

Public Member Functions

 UPWIND3 (const amrex::Array4< const amrex::Real > &phi)
 
AMREX_GPU_DEVICE AMREX_FORCE_INLINE void InterpolateInX (const int &i, const int &j, const int &k, const int &qty_index, amrex::Real &val_lo, amrex::Real upw_lo, const amrex::Real upw_frac) const
 
AMREX_GPU_DEVICE AMREX_FORCE_INLINE void InterpolateInY (const int &i, const int &j, const int &k, const int &qty_index, amrex::Real &val_lo, amrex::Real upw_lo, const amrex::Real upw_frac) const
 
AMREX_GPU_DEVICE AMREX_FORCE_INLINE void InterpolateInZ (const int &i, const int &j, const int &k, const int &qty_index, amrex::Real &val_lo, amrex::Real upw_lo, const amrex::Real upw_frac) const
 
AMREX_GPU_DEVICE AMREX_FORCE_INLINE amrex::Real Evaluate (const amrex::Real &sp1, const amrex::Real &s, const amrex::Real &sm1, const amrex::Real &sm2, const amrex::Real &upw) const
 
int GetUpwindCellNumber () const
 

Private Attributes

amrex::Array4< const amrex::Real > m_phi
 

Static Private Attributes

static constexpr amrex::Real g1 =(7.0/12.0)
 
static constexpr amrex::Real g2 =(1.0/12.0)
 

Detailed Description

Interpolation operators used for 3rd order upwind scheme

Constructor & Destructor Documentation

◆ UPWIND3()

UPWIND3::UPWIND3 ( const amrex::Array4< const amrex::Real > &  phi)
inline
97  : m_phi(phi) {}
UPWIND3::m_phi
amrex::Array4< const amrex::Real > m_phi
Definition: ERF_Interpolation_UPW.H:202

Member Function Documentation

◆ Evaluate()

AMREX_GPU_DEVICE AMREX_FORCE_INLINE amrex::Real UPWIND3::Evaluate ( const amrex::Real &  sp1,
const amrex::Real &  s,
const amrex::Real &  sm1,
const amrex::Real &  sm2,
const amrex::Real &  upw 
) const
inline
188  {
189  // Averages and diffs
190  amrex::Real a1 = (s + sm1);
191  amrex::Real d1 = (s - sm1);
192  amrex::Real a2 = (sp1 + sm2);
193  amrex::Real d2 = (sp1 - sm2);
194 
195  // Interpolated value
196  return ( g1*a1 - g2*a2 + upw * g2 * (d2 - 3.0*d1) );
197  }
UPWIND3::g2
static constexpr amrex::Real g2
Definition: ERF_Interpolation_UPW.H:204
UPWIND3::g1
static constexpr amrex::Real g1
Definition: ERF_Interpolation_UPW.H:203

Referenced by InterpolateInX(), InterpolateInY(), and InterpolateInZ().

Here is the caller graph for this function:

◆ GetUpwindCellNumber()

int UPWIND3::GetUpwindCellNumber ( ) const
inline
199 {return 2;}

◆ InterpolateInX()

AMREX_GPU_DEVICE AMREX_FORCE_INLINE void UPWIND3::InterpolateInX ( const int &  i,
const int &  j,
const int &  k,
const int &  qty_index,
amrex::Real &  val_lo,
amrex::Real  upw_lo,
const amrex::Real  upw_frac 
) const
inline
109  {
110  // Data to interpolate on
111  amrex::Real sp1 = m_phi(i+1, j , k , qty_index);
112  amrex::Real s = m_phi(i , j , k , qty_index);
113  amrex::Real sm1 = m_phi(i-1, j , k , qty_index);
114  amrex::Real sm2 = m_phi(i-2, j , k , qty_index);
115 
116  // Upwinding flags
117  if (upw_lo != 0.) upw_lo = (upw_lo > 0) ? 1. : -1.;
118 
119  // Add blending
120  upw_lo *= upw_frac;
121 
122  // Interpolate lo
123  val_lo = Evaluate(sp1,s,sm1,sm2,upw_lo);
124  }
UPWIND3::Evaluate
AMREX_GPU_DEVICE AMREX_FORCE_INLINE amrex::Real Evaluate(const amrex::Real &sp1, const amrex::Real &s, const amrex::Real &sm1, const amrex::Real &sm2, const amrex::Real &upw) const
Definition: ERF_Interpolation_UPW.H:183

Referenced by EBAdvectionSrcForScalarsWrapper().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ InterpolateInY()

AMREX_GPU_DEVICE AMREX_FORCE_INLINE void UPWIND3::InterpolateInY ( const int &  i,
const int &  j,
const int &  k,
const int &  qty_index,
amrex::Real &  val_lo,
amrex::Real  upw_lo,
const amrex::Real  upw_frac 
) const
inline
136  {
137  // Data to interpolate on
138  amrex::Real sp1 = m_phi(i , j+1, k , qty_index);
139  amrex::Real s = m_phi(i , j , k , qty_index);
140  amrex::Real sm1 = m_phi(i , j-1, k , qty_index);
141  amrex::Real sm2 = m_phi(i , j-2, k , qty_index);
142 
143  // Upwinding flags
144  if (upw_lo != 0.) upw_lo = (upw_lo > 0) ? 1. : -1.;
145 
146  // Add blending
147  upw_lo *= upw_frac;
148 
149  // Interpolate lo
150  val_lo = Evaluate(sp1,s,sm1,sm2,upw_lo);
151  }

Referenced by EBAdvectionSrcForScalarsWrapper().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ InterpolateInZ()

AMREX_GPU_DEVICE AMREX_FORCE_INLINE void UPWIND3::InterpolateInZ ( const int &  i,
const int &  j,
const int &  k,
const int &  qty_index,
amrex::Real &  val_lo,
amrex::Real  upw_lo,
const amrex::Real  upw_frac 
) const
inline
163  {
164  // Data to interpolate on
165  amrex::Real sp1 = m_phi(i , j , k+1, qty_index);
166  amrex::Real s = m_phi(i , j , k , qty_index);
167  amrex::Real sm1 = m_phi(i , j , k-1, qty_index);
168  amrex::Real sm2 = m_phi(i , j , k-2, qty_index);
169 
170  // Upwinding flags
171  if (upw_lo != 0.) upw_lo = (upw_lo > 0) ? 1. : -1.;
172 
173  // Add blending
174  upw_lo *= upw_frac;
175 
176  // Interpolate lo
177  val_lo = Evaluate(sp1,s,sm1,sm2,upw_lo);
178  }

Referenced by EBAdvectionSrcForScalarsWrapper().

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ g1

constexpr amrex::Real UPWIND3::g1 =(7.0/12.0)
staticconstexprprivate

Referenced by Evaluate().

◆ g2

constexpr amrex::Real UPWIND3::g2 =(1.0/12.0)
staticconstexprprivate

Referenced by Evaluate().

◆ m_phi

amrex::Array4<const amrex::Real> UPWIND3::m_phi
private

Referenced by InterpolateInX(), InterpolateInY(), and InterpolateInZ().

The documentation for this struct was generated from the following file: