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

#include <ERF_Interpolation_UPW.H>

Collaboration diagram for UPWIND5:
Collaboration graph
[legend]

Public Member Functions

 UPWIND5 (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 &sp2, const amrex::Real &sp1, const amrex::Real &s, const amrex::Real &sm1, const amrex::Real &sm2, const amrex::Real &sm3, const amrex::Real &upw) const
 

Private Attributes

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

Static Private Attributes

static constexpr amrex::Real g1 =(37.0/60.0)
 
static constexpr amrex::Real g2 =(2.0/15.0)
 
static constexpr amrex::Real g3 =(1.0/60.0)
 

Detailed Description

Interpolation operators used for 5th order upwind scheme

Constructor & Destructor Documentation

◆ UPWIND5()

UPWIND5::UPWIND5 ( const amrex::Array4< const amrex::Real > &  phi)
inline
303  : m_phi(phi) {}
UPWIND5::m_phi
amrex::Array4< const amrex::Real > m_phi
Definition: ERF_Interpolation_UPW.H:416

Member Function Documentation

◆ Evaluate()

AMREX_GPU_DEVICE AMREX_FORCE_INLINE amrex::Real UPWIND5::Evaluate ( const amrex::Real &  sp2,
const amrex::Real &  sp1,
const amrex::Real &  s,
const amrex::Real &  sm1,
const amrex::Real &  sm2,
const amrex::Real &  sm3,
const amrex::Real &  upw 
) const
inline
402  {
403  // Averages and diffs
404  amrex::Real a1 = (s + sm1);
405  amrex::Real a2 = (sp1 + sm2);
406  amrex::Real a3 = (sp2 + sm3);
407  amrex::Real d1 = (s - sm1);
408  amrex::Real d2 = (sp1 - sm2);
409  amrex::Real d3 = (sp2 - sm3);
410 
411  // Interpolated value
412  return ( g1*a1 - g2*a2 + g3*a3 - upw * g3 * (d3 - 5.0*d2 + 10.0*d1) );
413  }
UPWIND5::g2
static constexpr amrex::Real g2
Definition: ERF_Interpolation_UPW.H:418
UPWIND5::g1
static constexpr amrex::Real g1
Definition: ERF_Interpolation_UPW.H:417
UPWIND5::g3
static constexpr amrex::Real g3
Definition: ERF_Interpolation_UPW.H:419

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

Here is the caller graph for this function:

◆ InterpolateInX()

AMREX_GPU_DEVICE AMREX_FORCE_INLINE void UPWIND5::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
315  {
316  // Data to interpolate on
317  amrex::Real sp2 = m_phi(i+2, j , k , qty_index);
318  amrex::Real sp1 = m_phi(i+1, j , k , qty_index);
319  amrex::Real s = m_phi(i , j , k , qty_index);
320  amrex::Real sm1 = m_phi(i-1, j , k , qty_index);
321  amrex::Real sm2 = m_phi(i-2, j , k , qty_index);
322  amrex::Real sm3 = m_phi(i-3, j , k , qty_index);
323 
324  // Upwinding flags
325  if (upw_lo != 0.) upw_lo = (upw_lo > 0) ? 1. : -1.;
326 
327  // Add blending
328  upw_lo *= upw_frac;
329 
330  // Interpolate lo
331  val_lo = Evaluate(sp2,sp1,s,sm1,sm2,sm3,upw_lo);
332  }
UPWIND5::Evaluate
AMREX_GPU_DEVICE AMREX_FORCE_INLINE amrex::Real Evaluate(const amrex::Real &sp2, const amrex::Real &sp1, const amrex::Real &s, const amrex::Real &sm1, const amrex::Real &sm2, const amrex::Real &sm3, const amrex::Real &upw) const
Definition: ERF_Interpolation_UPW.H:395
Here is the call graph for this function:

◆ InterpolateInY()

AMREX_GPU_DEVICE AMREX_FORCE_INLINE void UPWIND5::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
344  {
345  // Data to interpolate on
346  amrex::Real sp2 = m_phi(i , j+2, k , qty_index);
347  amrex::Real sp1 = m_phi(i , j+1, k , qty_index);
348  amrex::Real s = m_phi(i , j , k , qty_index);
349  amrex::Real sm1 = m_phi(i , j-1, k , qty_index);
350  amrex::Real sm2 = m_phi(i , j-2, k , qty_index);
351  amrex::Real sm3 = m_phi(i , j-3, k , qty_index);
352 
353  // Upwinding flags
354  if (upw_lo != 0.) upw_lo = (upw_lo > 0) ? 1. : -1.;
355 
356  // Add blending
357  upw_lo *= upw_frac;
358 
359  // Interpolate lo
360  val_lo = Evaluate(sp2,sp1,s,sm1,sm2,sm3,upw_lo);
361  }
Here is the call graph for this function:

◆ InterpolateInZ()

AMREX_GPU_DEVICE AMREX_FORCE_INLINE void UPWIND5::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
373  {
374  // Data to interpolate on
375  amrex::Real sp2 = m_phi(i , j , k+2, qty_index);
376  amrex::Real sp1 = m_phi(i , j , k+1, qty_index);
377  amrex::Real s = m_phi(i , j , k , qty_index);
378  amrex::Real sm1 = m_phi(i , j , k-1, qty_index);
379  amrex::Real sm2 = m_phi(i , j , k-2, qty_index);
380  amrex::Real sm3 = m_phi(i , j , k-3, qty_index);
381 
382  // Upwinding flags
383  if (upw_lo != 0.) upw_lo = (upw_lo > 0) ? 1. : -1.;
384 
385  // Add blending
386  upw_lo *= upw_frac;
387 
388  // Interpolate lo
389  val_lo = Evaluate(sp2,sp1,s,sm1,sm2,sm3,upw_lo);
390  }
Here is the call graph for this function:

Member Data Documentation

◆ g1

constexpr amrex::Real UPWIND5::g1 =(37.0/60.0)
staticconstexprprivate

Referenced by Evaluate().

◆ g2

constexpr amrex::Real UPWIND5::g2 =(2.0/15.0)
staticconstexprprivate

Referenced by Evaluate().

◆ g3

constexpr amrex::Real UPWIND5::g3 =(1.0/60.0)
staticconstexprprivate

Referenced by Evaluate().

◆ m_phi

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

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

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