FourthOrderInterpStencil Class Reference

#include <FourthOrderInterpStencil.H>

List of all members.


Detailed Description

Time interpolator class using 4th-order Runge-Kutta.

Public Member Functions

 FourthOrderInterpStencil ()
 Default constructor.
 FourthOrderInterpStencil (const IntVect &a_bdryOffset, const int &a_refineCoarse, const int &a_degree=3)
 Full constructor.
 ~FourthOrderInterpStencil ()
 Destructor.
void define (const IntVect &a_bdryOffset, const int &a_refineCoarse, const int &a_degree=3)
 Actual constructor.
void fillFine (FArrayBox &a_fineFab, const FArrayBox &a_coarseFab, const IntVect &a_coarseDataCell, const IntVect &a_coarseToFineOffset=IntVect::Zero) const
 Interpolate to all the fine cells within one coarse cell.

Protected Attributes

int m_refineCoarse
 refinement ratio
int m_degree
 max degree of polynomials
IntVect m_bdryOffset
 displacement from domain boundary in each dimension, in range -(a_degree-1):(a_degree-1)
Box m_baseFineBox
 0:(m_refineCoarse-1) in every dimension
int m_stencilSize
 number of coarse cells in the stencil
Vector< int > m_coarseBaseIndices
 length m_stencilSize*SpaceDim, lists indices of coarse cell corresponding to each component of m_coarseToFineFab
FArrayBox m_coarseToFineFab
 m_stencilSize coefficients of coarse cells for each cell in m_baseFineBox
bool m_defined
 whether define() has been called

Private Member Functions

void operator= (const FourthOrderInterpStencil &a_input)
 FourthOrderInterpStencil (const FourthOrderInterpStencil &a_input)

Constructor & Destructor Documentation

FourthOrderInterpStencil::FourthOrderInterpStencil (  ) 

Default constructor.

Object requires define() to be called before all other functions.

FourthOrderInterpStencil::FourthOrderInterpStencil ( const IntVect a_bdryOffset,
const int &  a_refineCoarse,
const int &  a_degree = 3 
) [inline]

Full constructor.

Parameters:
a_bdryOffset  in range -(a_degree-1):(a_degree-1), specifies displacement to boundary in each dimension
a_refineCoarse  refinement ratio
a_degree  max degree of polynomials

References define().

FourthOrderInterpStencil::~FourthOrderInterpStencil (  ) 

Destructor.

Destroys all objects created by define(). Passed in data references of define() are left alone.

FourthOrderInterpStencil::FourthOrderInterpStencil ( const FourthOrderInterpStencil a_input  )  [inline, private]

References MayDay::Error().


Member Function Documentation

void FourthOrderInterpStencil::define ( const IntVect a_bdryOffset,
const int &  a_refineCoarse,
const int &  a_degree = 3 
)

Actual constructor.

Set up object.

Parameters:
a_bdryOffset  in range -(a_degree-1):(a_degree-1), specifies displacement to boundary in each dimension
a_refineCoarse  refinement ratio
a_degree  max degree of polynomials

Referenced by FourthOrderInterpStencil().

void FourthOrderInterpStencil::fillFine ( FArrayBox a_fineFab,
const FArrayBox a_coarseFab,
const IntVect a_coarseDataCell,
const IntVect a_coarseToFineOffset = IntVect::Zero 
) const

Interpolate to all the fine cells within one coarse cell.

Fill the fine cells inside a_coarseDataCell with interpolated data from a_coarseFab.

The fine cells to be filled in are at m_baseFineBox + m_refineCoarse * (a_coarseDataCell + a_coarseToFineOffset). The coarse cells from which we draw data are (a_coarseDataCell + m_coarseBaseIndices[i*D+[0:2]]: 0 <= i < m_stencilSize).

Parameters:
a_fineFab  to fill at m_baseFineBox + m_refineCoarse*(a_coarseBase + a_coarseToFineOffset)
a_coarseFab  coarse data
a_coarseDataCell  coarse cell with fine subcells to fill in
a_coarseToFineOffset  offset from base coarse cell to coarsened fine cells

void FourthOrderInterpStencil::operator= ( const FourthOrderInterpStencil a_input  )  [inline, private]

References MayDay::Error().


Member Data Documentation

refinement ratio

max degree of polynomials

displacement from domain boundary in each dimension, in range -(a_degree-1):(a_degree-1)

0:(m_refineCoarse-1) in every dimension

number of coarse cells in the stencil

length m_stencilSize*SpaceDim, lists indices of coarse cell corresponding to each component of m_coarseToFineFab

m_stencilSize coefficients of coarse cells for each cell in m_baseFineBox

whether define() has been called


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

Generated on Mon Mar 27 03:43:03 2017 for Chombo + EB by  doxygen 1.5.5