ERF
Energy Research and Forecasting: An Atmospheric Modeling Code
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Member Functions | Private Attributes | Static Private Attributes | List of all members
WENO5 Struct Reference

#include <ERF_Interpolation_WENO.H>

Collaboration diagram for WENO5:
Collaboration graph
[legend]

Public Member Functions

 WENO5 (const amrex::Array4< const amrex::Real > &phi, const amrex::Real)
 
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_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_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_GPU_DEVICE AMREX_FORCE_INLINE amrex::Real Evaluate (const amrex::Real &sm2, const amrex::Real &sm1, const amrex::Real &s, const amrex::Real &sp1, const amrex::Real &sp2) const
 

Private Attributes

amrex::Array4< const amrex::Real > m_phi
 
const amrex::Real eps =1.0e-6
 
const amrex::Real tol =1.0e-12
 

Static Private Attributes

static constexpr amrex::Real c1 =(13.0/12.0)
 
static constexpr amrex::Real g1 =(1.0/10.0)
 
static constexpr amrex::Real g2 =(3.0/5.0)
 
static constexpr amrex::Real g3 =(3.0/10.0)
 

Detailed Description

Interpolation operators used for WENO-5 scheme

Constructor & Destructor Documentation

◆ WENO5()

WENO5::WENO5 ( const amrex::Array4< const amrex::Real > &  phi,
const amrex::Real   
)
inline
131  : m_phi(phi) {}
WENO5::m_phi
amrex::Array4< const amrex::Real > m_phi
Definition: ERF_Interpolation_WENO.H:249

Member Function Documentation

◆ Evaluate()

AMREX_GPU_DEVICE AMREX_FORCE_INLINE amrex::Real WENO5::Evaluate ( const amrex::Real &  sm2,
const amrex::Real &  sm1,
const amrex::Real &  s,
const amrex::Real &  sp1,
const amrex::Real &  sp2 
) const
inline
222  {
223  // Smoothing factors
224  amrex::Real b1 = c1 * (sm2 - 2.0 * sm1 + s) * (sm2 - 2.0 * sm1 + s) +
225  0.25 * (sm2 - 4.0 * sm1 + 3.0 * s) * (sm2 - 4.0 * sm1 + 3.0 * s);
226  amrex::Real b2 = c1 * (sm1 - 2.0 * s + sp1) * (sm1 - 2.0 * s + sp1) +
227  0.25 * (sm1 - sp1) * (sm1 - sp1);
228  amrex::Real b3 = c1 * (s - 2.0 * sp1 + sp2) * (s - 2.0 * sp1 + sp2) +
229  0.25 * (3.0 * s - 4.0 * sp1 + sp2) * (3.0 * s - 4.0 * sp1 + sp2);
230 
231  // Weight factors
232  amrex::Real w1 = g1 / ( (eps + b1) * (eps + b1) );
233  amrex::Real w2 = g2 / ( (eps + b2) * (eps + b2) );
234  amrex::Real w3 = g3 / ( (eps + b3) * (eps + b3) );
235 
236  // Weight factor norm
237  amrex::Real wsum = w1 + w2 + w3;
238 
239  // Taylor expansions
240  amrex::Real v1 = 2.0 * sm2 - 7.0 * sm1 + 11.0 * s;
241  amrex::Real v2 = -sm1 + 5.0 * s + 2.0 * sp1;
242  amrex::Real v3 = 2.0 * s + 5.0 * sp1 - sp2;
243 
244  // Interpolated value
245  return ( (w1 * v1 + w2 * v2 + w3 * v3) / (6.0 * wsum) );
246  }
WENO5::eps
const amrex::Real eps
Definition: ERF_Interpolation_WENO.H:250
WENO5::c1
static constexpr amrex::Real c1
Definition: ERF_Interpolation_WENO.H:252
WENO5::g2
static constexpr amrex::Real g2
Definition: ERF_Interpolation_WENO.H:254
WENO5::g3
static constexpr amrex::Real g3
Definition: ERF_Interpolation_WENO.H:255
WENO5::g1
static constexpr amrex::Real g1
Definition: ERF_Interpolation_WENO.H:253

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

Here is the caller graph for this function:

◆ InterpolateInX()

AMREX_GPU_DEVICE AMREX_FORCE_INLINE void WENO5::InterpolateInX ( const int &  i,
const int &  j,
const int &  k,
const int &  qty_index,
amrex::Real &  val_lo,
amrex::Real  upw_lo 
) const
inline
142  {
143  // Data to interpolate on
144  amrex::Real sp2 = m_phi(i+2, j , k , qty_index);
145  amrex::Real sp1 = m_phi(i+1, j , k , qty_index);
146  amrex::Real s = m_phi(i , j , k , qty_index);
147  amrex::Real sm1 = m_phi(i-1, j , k , qty_index);
148  amrex::Real sm2 = m_phi(i-2, j , k , qty_index);
149  amrex::Real sm3 = m_phi(i-3, j , k , qty_index);
150 
151  if (upw_lo > tol) {
152  val_lo = Evaluate(sm3,sm2,sm1,s ,sp1);
153  } else if (upw_lo < -tol) {
154  val_lo = Evaluate(sp2,sp1,s ,sm1,sm2);
155  } else {
156  val_lo = 0.5 * (s + sm1);
157  }
158  }
WENO5::tol
const amrex::Real tol
Definition: ERF_Interpolation_WENO.H:251
WENO5::Evaluate
AMREX_GPU_DEVICE AMREX_FORCE_INLINE amrex::Real Evaluate(const amrex::Real &sm2, const amrex::Real &sm1, const amrex::Real &s, const amrex::Real &sp1, const amrex::Real &sp2) const
Definition: ERF_Interpolation_WENO.H:217
Here is the call graph for this function:

◆ InterpolateInY()

AMREX_GPU_DEVICE AMREX_FORCE_INLINE void WENO5::InterpolateInY ( const int &  i,
const int &  j,
const int &  k,
const int &  qty_index,
amrex::Real &  val_lo,
amrex::Real  upw_lo 
) const
inline
169  {
170  // Data to interpolate on
171  amrex::Real sp2 = m_phi(i , j+2, k , qty_index);
172  amrex::Real sp1 = m_phi(i , j+1, k , qty_index);
173  amrex::Real s = m_phi(i , j , k , qty_index);
174  amrex::Real sm1 = m_phi(i , j-1, k , qty_index);
175  amrex::Real sm2 = m_phi(i , j-2, k , qty_index);
176  amrex::Real sm3 = m_phi(i , j-3, k , qty_index);
177 
178  if (upw_lo > tol) {
179  val_lo = Evaluate(sm3,sm2,sm1,s ,sp1);
180  } else if (upw_lo < -tol) {
181  val_lo = Evaluate(sp2,sp1,s ,sm1,sm2);
182  } else {
183  val_lo = 0.5 * (s + sm1);
184  }
185  }
Here is the call graph for this function:

◆ InterpolateInZ()

AMREX_GPU_DEVICE AMREX_FORCE_INLINE void WENO5::InterpolateInZ ( const int &  i,
const int &  j,
const int &  k,
const int &  qty_index,
amrex::Real &  val_lo,
amrex::Real  upw_lo 
) const
inline
196  {
197  // Data to interpolate on
198  amrex::Real sp2 = m_phi(i , j , k+2, qty_index);
199  amrex::Real sp1 = m_phi(i , j , k+1, qty_index);
200  amrex::Real s = m_phi(i , j , k , qty_index);
201  amrex::Real sm1 = m_phi(i , j , k-1, qty_index);
202  amrex::Real sm2 = m_phi(i , j , k-2, qty_index);
203  amrex::Real sm3 = m_phi(i , j , k-3, qty_index);
204 
205  if (upw_lo > tol) {
206  val_lo = Evaluate(sm3,sm2,sm1,s ,sp1);
207  } else if (upw_lo < -tol) {
208  val_lo = Evaluate(sp2,sp1,s ,sm1,sm2);
209  } else {
210  val_lo = 0.5 * (s + sm1);
211  }
212  }
Here is the call graph for this function:

Member Data Documentation

◆ c1

constexpr amrex::Real WENO5::c1 =(13.0/12.0)
staticconstexprprivate

Referenced by Evaluate().

◆ eps

const amrex::Real WENO5::eps =1.0e-6
private

Referenced by Evaluate().

◆ g1

constexpr amrex::Real WENO5::g1 =(1.0/10.0)
staticconstexprprivate

Referenced by Evaluate().

◆ g2

constexpr amrex::Real WENO5::g2 =(3.0/5.0)
staticconstexprprivate

Referenced by Evaluate().

◆ g3

constexpr amrex::Real WENO5::g3 =(3.0/10.0)
staticconstexprprivate

Referenced by Evaluate().

◆ m_phi

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

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

◆ tol

const amrex::Real WENO5::tol =1.0e-12
private

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

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