Overture  Version 25
Public Types | Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
Interpolate Class Reference

#include <Interpolate.h>

Public Types

enum  InterpolateOptionEnum {
  injection =0, fullWeighting100, fullWeighting010, fullWeighting001,
  fullWeighting110, fullWeighting101, fullWeighting011, fullWeighting111
}
 
enum  GeneralNamesEnum { useDefaultTransferWidth =-12345 }
 
enum  MaskOptionEnum { doNotUseMask =0, maskGreaterThanZero =1, maskEqualZero =2 }
 

Public Member Functions

 Interpolate ()
 
 Interpolate (const InterpolateParameters &interpParams_, const bool timing=LogicalFalse)
 
 ~Interpolate ()
 
int initialize (const InterpolateParameters &interpParams_, const bool timing=LogicalFalse)
 
int interpolateCoarseToFine (realArray &fineGridArray, const Index Iv[3], const realArray &coarseGridArray, const IntegerArray &amrRefinementRatio_=Overture::nullIntArray())
 
int interpolateFineToCoarse (realArray &coarseGridArray, const Index Iv[3], const realArray &fineGridArray, const IntegerArray &amrRefinementRatio_=Overture::nullIntArray())
 
int interpolateFineFromCoarse (realArray &fineGridArray, const Index Iv[3], const realArray &coarseGridArray, const IntegerArray &amrRefinementRatio_=Overture::nullIntArray(), const int update=0, const int transferWidth=useDefaultTransferWidth)
 Interpolate fine from coarse.
 
int interpolateFineFromCoarse (realArray &fineGridArray, const intSerialArray &mask, const Index Iv[3], const realArray &coarseGridArray, const IntegerArray &amrRefinementRatio_=Overture::nullIntArray(), const int update=0, const int transferWidth=useDefaultTransferWidth, const MaskOptionEnum maskOption=maskGreaterThanZero)
 Interpolate coarse to fine with a mask.
 
int interpolateCoarseFromFine (realArray &coarseGridArray, const Index Iv[3], const realArray &fineGridArray, const IntegerArray &amrRefinementRatio_=Overture::nullIntArray(), const InterpolateOptionEnum interpOption=injection, const int update=0, const int transferWidth=useDefaultTransferWidth)
 Interpolate coarse from fine.
 
int interpolateCoarseFromFine (realArray &coarseGridArray, const intSerialArray &mask, const Index Iv[3], const realArray &fineGridArray, const IntegerArray &amrRefinementRatio_=Overture::nullIntArray(), const InterpolateOptionEnum interpOption=injection, const int update=0, const int transferWidth=useDefaultTransferWidth, const MaskOptionEnum maskOption=maskGreaterThanZero)
 Interpolate coarse to fine with a mask.
 

Public Attributes

bool debug
 
bool timing
 

Protected Member Functions

int initializeCoefficients (const int maxRefinementRatio_, const int interpolateOrder_, const int numberOfDimensions_, const int *interpolateOffset_)
 
int computeIndexes (const realArray &uc, int *lm, Index *Jf, Index *Jc, const Index *If, const int *lmr, const int R, const int *A, const int *r, const int *stride, const int *extra, const int *offset, InterpolateParameters::InterpolateOffsetDirection *iod)
 
int displayEverything (const int *r, const int *extra, const int *offset, const int *lm, const int *lmr, const Index *Iv, const Index *If, const Index *Jf, const Index *Jc)
 

Protected Attributes

RealArray coeff
 
int interpolateOrder
 
int numberOfDimensions
 
bool preComputeAllCoefficients
 
bool useGeneralInterpolationFormula
 
IntegerArray amrRefinementRatio
 
GridFunctionParameters::GridFunctionType gridCentering
 
InterpolateParameters::InterpolateType interpolateType
 

Member Enumeration Documentation

enum Interpolate::GeneralNamesEnum
Enumerator
useDefaultTransferWidth 
enum Interpolate::InterpolateOptionEnum
Enumerator
injection 
fullWeighting100 
fullWeighting010 
fullWeighting001 
fullWeighting110 
fullWeighting101 
fullWeighting011 
fullWeighting111 
enum Interpolate::MaskOptionEnum
Enumerator
doNotUseMask 
maskGreaterThanZero 
maskEqualZero 

Constructor & Destructor Documentation

Interpolate::Interpolate ( )
Interpolate::Interpolate ( const InterpolateParameters &  interpParams_,
const bool  timing = LogicalFalse 
)

References initialize().

Interpolate::~Interpolate ( )

Member Function Documentation

int Interpolate::computeIndexes ( const realArray &  uc,
int *  lm,
Index *  Jf,
Index *  Jc,
const Index *  If,
const int *  lmr,
const int  R,
const int *  A,
const int *  r,
const int *  stride,
const int *  extra,
const int *  offset,
InterpolateParameters::InterpolateOffsetDirection *  iod 
)
protected

References Overture::abort(), interpolateOrder, M, max(), numberOfDimensions, and InterpolateParameters::offsetInterpolateToLeft.

Referenced by interpolateCoarseFromFine(), and interpolateCoarseToFine().

int Interpolate::displayEverything ( const int *  r,
const int *  extra,
const int *  offset,
const int *  lm,
const int *  lmr,
const Index *  Iv,
const Index *  If,
const Index *  Jf,
const Index *  Jc 
)
protected

References interpolateOrder, M, and max().

Referenced by interpolateCoarseToFine().

int Interpolate::initialize ( const InterpolateParameters &  interpParams_,
const bool  timing = LogicalFalse 
)

References InterpolateParameters::amrRefinementRatio(), amrRefinementRatio, debug, InterpolateParameters::debug, InterpolateParameters::defaultInterpolateOrder, getCPU(), InterpolateParameters::gridCentering(), gridCentering, InterpolateParameters::interpolateOrder(), interpolateOrder, InterpolateParameters::interpolateType(), interpolateType, InterpolateParameters::numberOfDimensions(), numberOfDimensions, timing, InterpolateParameters::useGeneralInterpolationFormula(), and useGeneralInterpolationFormula.

Referenced by Interpolate(), InterpolateRefinements::InterpolateRefinements(), and InterpolateRefinements::setOrderOfInterpolation().

int Interpolate::initializeCoefficients ( const int  maxRefinementRatio_,
const int  interpolateOrder_,
const int  numberOfDimensions_,
const int *  interpolateOffset_ 
)
protected

References A, coeff, debug, getCPU(), gridCentering, M, R, timing, and GridFunctionParameters::vertexCentered.

Referenced by interpolateCoarseToFine().

int Interpolate::interpolateCoarseFromFine ( realArray &  uc,
const Index  Iv[3],
const realArray &  uf,
const IntegerArray &  amrRefinementRatio_ = Overture::nullIntArray(),
const InterpolateOptionEnum  interpOption = injection,
const int  update = 0,
const int  transferWidth = useDefaultTransferWidth 
)

Interpolate coarse from fine.

Parameters
Iv[3]: coarse grid points to interpolate
update: 0= set uf=interpolant(uc) 1= set uf=uf+interpolant(uc)
transferWidth: by default use the current value of interpolateOrder+1, otherwise use this width. This value is only used with the fullWeighting options. The default full weighting width is 3. Author WDH.

References Overture::abort(), amrRefinementRatio, assert, CopyArray::copyArray(), doNotUseMask, getCPU(), getLocalArrayWithGhostBoundaries(), injection, interpCoarseFromFine, interpolateOrder, max(), min(), numberOfDimensions, printF(), R0, timing, and useDefaultTransferWidth.

Referenced by Ogmg::buildPredefinedVariableCoefficients(), Ogmg::fineToCoarse(), and interpolateFineFromCoarse().

int Interpolate::interpolateCoarseFromFine ( realArray &  uc,
const intSerialArray &  mask,
const Index  Iv[3],
const realArray &  uf,
const IntegerArray &  amrRefinementRatio_ = Overture::nullIntArray(),
const InterpolateOptionEnum  interpOption = injection,
const int  update = 0,
const int  transferWidth = useDefaultTransferWidth,
const MaskOptionEnum  maskOption = maskGreaterThanZero 
)

Interpolate coarse to fine with a mask.

Parameters
Iv[3]: coarse grid points to interpolate
update: 0= set uf=interpolant(uc) 1= set uf=uf+interpolant(uc)
transferWidth: by default use the current value of interpolateOrder+1, otherwise use this width. This value is only used with the fullWeighting options. The default full weighting width is 3.

References Overture::abort(), amrRefinementRatio, assert, c, computeIndexes(), CopyArray::copyArray(), getCPU(), ParallelUtility::getLocalArrayBounds(), getLocalArrayWithGhostBoundaries(), injection, interpCoarseFromFine, interpolateOrder, max(), min(), numberOfDimensions, printF(), R0, timing, and useDefaultTransferWidth.

int Interpolate::interpolateCoarseToFine ( realArray &  fineGridArray,
const Index  Iv[3],
const realArray &  coarseGridArray,
const IntegerArray &  amrRefinementRatio_ = Overture::nullIntArray() 
)

References A, Overture::abort(), abs(), amrRefinementRatio, axis1, axis2, axis3, C, coeff, InterpolateParameters::coeffEps, computeIndexes(), D, debug, displayEverything(), E, fabs(), getCPU(), initializeCoefficients(), interpolateOrder, interpolateType, log(), M, max(), min(), nr, nullRange, numberOfDimensions, InterpolateParameters::offsetInterpolateToLeft, InterpolateParameters::polynomial, r, R, timing, and useGeneralInterpolationFormula.

Referenced by InterpolateRefinements::interpolateRefinementBoundaries().

int Interpolate::interpolateFineFromCoarse ( realArray &  uf,
const Index  Iv[3],
const realArray &  uc,
const IntegerArray &  amrRefinementRatio_ = Overture::nullIntArray(),
const int  update = 0,
const int  transferWidth = useDefaultTransferWidth 
)

Interpolate fine from coarse.

Parameters
Iv[3]: fine grid points to interpolate
update: 0= set uf=interpolant(uc) 1= set uf=uf+interpolant(uc)
transferWidth: by default use the current value of interpolateOrder, otherwise use this width. The default is transferWidth==2 corresponding to linear interpolation. Author WDH.

References amrRefinementRatio, assert, IndexBox::base(), IndexBox::bound(), ParallelUtility::copy(), CopyArray::copyArray(), debug, debugFile, display(), doNotUseMask, getCPU(), CopyArray::getLocalArrayBoxWithGhost(), getLocalArrayWithGhostBoundaries(), interpFineFromCoarse, interpolateOrder, max(), min(), NULL, numberOfDimensions, IndexBox::setBounds(), timing, and useDefaultTransferWidth.

Referenced by Ogmg::coarseToFine(), InterpolateRefinements::interpolateRefinementBoundaries(), and InterpolateRefinements::interpolateRefinements().

int Interpolate::interpolateFineFromCoarse ( realArray &  uf,
const intSerialArray &  mask,
const Index  Iv[3],
const realArray &  uc,
const IntegerArray &  amrRefinementRatio_ = Overture::nullIntArray(),
const int  update = 0,
const int  transferWidth = useDefaultTransferWidth,
const MaskOptionEnum  maskOption = maskGreaterThanZero 
)

Interpolate coarse to fine with a mask.

Parameters
Iv[3]: fine grid points to interpolate
update: 0= set uf=interpolant(uc) 1= set uf=uf+interpolant(uc)
transferWidth: by default use the current value of interpolateOrder, otherwise use this width. The default is transferWidth==2 corresponding to linear interpolation.

References Overture::abort(), amrRefinementRatio, IndexBox::base(), IndexBox::bound(), ParallelUtility::copy(), CopyArray::copyArray(), debug, display(), getCPU(), CopyArray::getLocalArrayBoxWithGhost(), getLocalArrayWithGhostBoundaries(), interpFineFromCoarse, interpolateCoarseFromFine(), interpolateOrder, max(), min(), NULL, numberOfDimensions, IndexBox::setBounds(), timing, and useDefaultTransferWidth.

int Interpolate::interpolateFineToCoarse ( realArray &  coarseGridArray,
const Index  Iv[3],
const realArray &  fineGridArray,
const IntegerArray &  amrRefinementRatio_ = Overture::nullIntArray() 
)

References Overture::abort(), amrRefinementRatio, getCPU(), InterpolateParameters::injection, interpolateType, numberOfDimensions, InterpolateParameters::polynomial, r, and timing.

Member Data Documentation

IntegerArray Interpolate::amrRefinementRatio
protected

Referenced by initialize(), interpolateCoarseFromFine(), interpolateCoarseToFine(), interpolateFineFromCoarse(), and interpolateFineToCoarse().

RealArray Interpolate::coeff
protected

Referenced by initializeCoefficients(), and interpolateCoarseToFine().

bool Interpolate::debug

Referenced by initialize(), initializeCoefficients(), interpolateCoarseToFine(), and interpolateFineFromCoarse().

GridFunctionParameters::GridFunctionType Interpolate::gridCentering
protected

Referenced by initialize(), and initializeCoefficients().

int Interpolate::interpolateOrder
protected

Referenced by computeIndexes(), displayEverything(), initialize(), interpolateCoarseFromFine(), interpolateCoarseToFine(), and interpolateFineFromCoarse().

InterpolateParameters::InterpolateType Interpolate::interpolateType
protected

Referenced by initialize(), interpolateCoarseToFine(), and interpolateFineToCoarse().

int Interpolate::numberOfDimensions
protected

Referenced by computeIndexes(), initialize(), interpolateCoarseFromFine(), interpolateCoarseToFine(), interpolateFineFromCoarse(), and interpolateFineToCoarse().

bool Interpolate::preComputeAllCoefficients
protected
bool Interpolate::timing

Referenced by initialize(), initializeCoefficients(), interpolateCoarseFromFine(), interpolateCoarseToFine(), interpolateFineFromCoarse(), and interpolateFineToCoarse().

bool Interpolate::useGeneralInterpolationFormula
protected

Referenced by initialize(), and interpolateCoarseToFine().

The documentation for this class was generated from the following files:
Generated on Fri Jan 4 2013 10:18:09 for Overture by   doxygen 1.8.3