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

#include <doubleGridCollectionFunction.h>

Inheritance diagram for doubleGridCollectionFunction:
Inheritance graph
[legend]
Collaboration diagram for doubleGridCollectionFunction:
Collaboration graph
[legend]

Classes

class  RCData
 

Public Types

enum  {
  undefinedValue =doubleMappedGridFunction::undefinedValue, defaultValue =doubleMappedGridFunction::defaultValue, forAll =doubleMappedGridFunction::forAll, forAllGrids =forAll+1,
  maximumNumberOfIndicies =doubleMappedGridFunction::maximumNumberOfIndicies, maximumNumberOfComponents =doubleMappedGridFunction::maximumNumberOfComponents
}
 
enum  updateReturnValue { updateNoChange = doubleMappedGridFunction::updateNoChange, updateReshaped = doubleMappedGridFunction::updateReshaped, updateResized = doubleMappedGridFunction::updateResized, updateComponentsChanged = doubleMappedGridFunction::updateComponentsChanged }
 

Public Member Functions

int positionOfComponent (int i) const
 
int positionOfCoordinate (int i) const
 
int numberOfComponentGrids () const
 
int numberOfGrids () const
 
int numberOfRefinementLevels () const
 
int numberOfMultigridLevels () const
 
int positionOfFaceCentering () const
 
int faceCentering () const
 
 doubleGridCollectionFunction ()
 
 doubleGridCollectionFunction (GridCollection &grid, const Range &R0, const Range &R1=nullRange, const Range &R2=nullRange, const Range &R3=nullRange, const Range &R4=nullRange, const Range &R5=nullRange, const Range &R6=nullRange, const Range &R7=nullRange)
 
 doubleGridCollectionFunction (GridCollectionData &gcData, const Range &R0, const Range &R1=nullRange, const Range &R2=nullRange, const Range &R3=nullRange, const Range &R4=nullRange, const Range &R5=nullRange, const Range &R6=nullRange, const Range &R7=nullRange)
 
 doubleGridCollectionFunction (GridCollection &grid, const int &i0, const Range &R1=nullRange, const Range &R2=nullRange, const Range &R3=nullRange, const Range &R4=nullRange, const Range &R5=nullRange, const Range &R6=nullRange, const Range &R7=nullRange)
 
 doubleGridCollectionFunction (GridCollectionData &gcData, const int &i0, const Range &R1=nullRange, const Range &R2=nullRange, const Range &R3=nullRange, const Range &R4=nullRange, const Range &R5=nullRange, const Range &R6=nullRange, const Range &R7=nullRange)
 
 doubleGridCollectionFunction (GridCollection &gc, const GridFunctionParameters::GridFunctionType &type, const Range &component0=nullRange, const Range &component1=nullRange, const Range &component2=nullRange, const Range &component3=nullRange, const Range &component4=nullRange)
 
 doubleGridCollectionFunction (GridCollection &gridCollection)
 
 doubleGridCollectionFunction (GridCollectionData &gridCollection)
 
 doubleGridCollectionFunction (const doubleGridCollectionFunction &cgf, const CopyType copyType=DEEP)
 
virtual ~doubleGridCollectionFunction ()
 
virtual
doubleGridCollectionFunction
operator= (const doubleGridCollectionFunction &cgf)
 
virtual doubleMappedGridFunctionoperator[] (const int grid) const
 
doubleGridCollectionFunction operator() (const Range &component0, const Range &component1=nullRange, const Range &component2=nullRange, const Range &component3=nullRange, const Range &component4=nullRange)
 
virtual void consistencyCheck () const
 
virtual aString getClassName () const
 
int getComponentBound (int component) const
 
int getComponentBase (int component) const
 
int getComponentDimension (int component) const
 
int getCoordinateBound (int coordinate) const
 
int getCoordinateBase (int coordinate) const
 
int getCoordinateDimension (int coordinate) const
 
GridFunctionParameters::GridFunctionType getGridFunctionType (const Index &component0=nullIndex, const Index &component1=nullIndex, const Index &component2=nullIndex, const Index &component3=nullIndex, const Index &component4=nullIndex) const
 
GridFunctionParameters::GridFunctionTypeWithComponents getGridFunctionTypeWithComponents (const Index &component0=nullIndex, const Index &component1=nullIndex, const Index &component2=nullIndex, const Index &component3=nullIndex, const Index &component4=nullIndex) const
 
int getNumberOfComponents () const
 
bool isNull ()
 
virtual void setIsACoefficientMatrix (const bool trueOrFalse=TRUE, const int stencilSize=defaultValue, const int numberOfGhostLines=1, const int numberOfComponentsForCoefficients=1, const int offset=0)
 
bool getIsACoefficientMatrix () const
 
virtual int dataCopy (const doubleGridCollectionFunction &gcf)
 
virtual void display (const aString &label=nullString, FILE *file=NULL, const aString &format=nullString) const
 
virtual void display (const aString &label, const aString &format) const
 
virtual void display (const aString &label, const DisplayParameters &displayParameters) const
 
virtual int interpolate (Interpolant &interpolant, const Range &C0=nullRange, const Range &C1=nullRange, const Range &C2=nullRange)
 
virtual int interpolate (const Range &C0=nullRange, const Range &C1=nullRange, const Range &C2=nullRange)
 
virtual int destroy ()
 
virtual void link (const doubleGridCollectionFunction &gcf, const Range &R0, const Range &R1=nullRange, const Range &R2=nullRange, const Range &R3=nullRange, const Range &R4=nullRange)
 
void getRanges (Range &R0, Range &R1, Range &R2, Range &R3, Range &R4, Range &R5, Range &R6, Range &R7) const
 
virtual void link (const doubleGridCollectionFunction &gcf, const int componentToLinkTo=0, const int numberOfComponents=1)
 
virtual void reference (const doubleGridCollectionFunction &cgf)
 
virtual void breakReference ()
 
void setName (const aString &name, const int &component0=defaultValue, const int &component1=defaultValue, const int &component2=defaultValue, const int &component3=defaultValue, const int &component4=defaultValue)
 
aString getName (const int &component0=defaultValue, const int &component1=defaultValue, const int &component2=defaultValue, const int &component3=defaultValue, const int &component4=defaultValue) const
 
virtual GridCollectiongetGridCollection (const bool abortIfNull=TRUE) const
 
virtual int get (const GenericDataBase &dir, const aString &name)
 
virtual int put (GenericDataBase &dir, const aString &name) const
 
virtual void periodicUpdate (const Range &C0=nullRange, const Range &C1=nullRange, const Range &C2=nullRange, const Range &C3=nullRange, const Range &C4=nullRange, const bool &derivativePeriodic=FALSE)
 
virtual updateReturnValue updateToMatchGrid ()
 
virtual updateReturnValue updateToMatchGrid (GridCollectionData &gridData, const Range &R0, const Range &R1=nullRange, const Range &R2=nullRange, const Range &R3=nullRange, const Range &R4=nullRange, const Range &R5=nullRange, const Range &R6=nullRange, const Range &R7=nullRange)
 
virtual updateReturnValue updateToMatchGrid (GridCollection &grid, const Range &R0, const Range &R1=nullRange, const Range &R2=nullRange, const Range &R3=nullRange, const Range &R4=nullRange, const Range &R5=nullRange, const Range &R6=nullRange, const Range &R7=nullRange)
 
virtual updateReturnValue updateToMatchGrid (GridCollection &grid, const int &i0, const Range &R1=nullRange, const Range &R2=nullRange, const Range &R3=nullRange, const Range &R4=nullRange, const Range &R5=nullRange, const Range &R6=nullRange, const Range &R7=nullRange)
 
virtual updateReturnValue updateToMatchGrid (const Range &R0, const Range &R1=nullRange, const Range &R2=nullRange, const Range &R3=nullRange, const Range &R4=nullRange, const Range &R5=nullRange, const Range &R6=nullRange, const Range &R7=nullRange)
 
virtual updateReturnValue updateToMatchGrid (GridCollection &grid, const GridFunctionParameters::GridFunctionType &type, const Range &component0, const Range &component1=nullRange, const Range &component2=nullRange, const Range &component3=nullRange, const Range &component4=nullRange)
 
virtual updateReturnValue updateToMatchGrid (const GridFunctionParameters::GridFunctionType &type, const Range &component0, const Range &component1=nullRange, const Range &component2=nullRange, const Range &component3=nullRange, const Range &component4=nullRange)
 
virtual updateReturnValue updateToMatchGrid (GridCollection &grid, const GridFunctionParameters::GridFunctionType &type)
 
virtual updateReturnValue updateToMatchGrid (const GridFunctionParameters::GridFunctionType &type)
 
virtual updateReturnValue updateToMatchGrid (GridCollection &gridCollection)
 
virtual updateReturnValue updateToMatchGrid (GridCollectionData &gridCollection)
 
virtual updateReturnValue updateToMatchGridFunction (const doubleGridCollectionFunction &cgf, const Range &R0, const Range &R1=nullRange, const Range &R2=nullRange, const Range &R3=nullRange, const Range &R4=nullRange, const Range &R5=nullRange, const Range &R6=nullRange, const Range &R7=nullRange)
 
virtual updateReturnValue updateToMatchGridFunction (const doubleGridCollectionFunction &gcf)
 
virtual updateReturnValue updateToMatchNumberOfGrids (GridCollection &gc)
 
virtual updateReturnValue updateToMatchComponentGrids ()
 
void setInterpolant (Interpolant *interpolant)
 
bool getIsCellCentered (const Index &axis=nullIndex, const Index &component0=nullIndex, const Index &component1=nullIndex, const Index &component2=nullIndex, const Index &component3=nullIndex, const Index &component4=nullIndex, const Index &grid=nullIndex) const
 
void setIsCellCentered (const bool trueOrFalse, const Index &axis=nullIndex, const Index &component0=nullIndex, const Index &component1=nullIndex, const Index &component2=nullIndex, const Index &component3=nullIndex, const Index &component4=nullIndex, const Index &grid=nullIndex)
 
void setIsFaceCentered (const int &axis=forAll, const Index &component0=nullIndex, const Index &component1=nullIndex, const Index &component2=nullIndex, const Index &component3=nullIndex, const Index &component4=nullIndex, const Index &grid=nullIndex)
 
bool getIsFaceCentered (const int &axis=forAll, const Index &component0=nullIndex, const Index &component1=nullIndex, const Index &component2=nullIndex, const Index &component3=nullIndex, const Index &component4=nullIndex, const Index &grid=nullIndex) const
 
GridFunctionParameters::faceCenteringType getFaceCentering () const
 
void setFaceCentering (const int &axis=defaultValue)
 
int updateFaceCentering ()
 
void setDataAllocationOption (int option)
 Set the data allocation option.
 
virtual real sizeOf (FILE *file=NULL) const
 
virtual int fixupUnusedPoints (const RealArray &value=Overture::nullRealArray(), int numberOfGhostlines=1)
 
GridCollectionOperatorsgetOperators () const
 
virtual void setOperators (GenericCollectionOperators &operators)
 
COLLECTION_FUNCTIONoperator+ (const COLLECTION_FUNCTION &cgf) const
 
COLLECTION_FUNCTIONoperator- (const COLLECTION_FUNCTION &cgf) const
 
COLLECTION_FUNCTIONoperator* (const COLLECTION_FUNCTION &cgf) const
 
COLLECTION_FUNCTIONoperator/ (const COLLECTION_FUNCTION &cgf) const
 
COLLECTION_FUNCTIONoperator+= (const COLLECTION_FUNCTION &cgf)
 
COLLECTION_FUNCTIONoperator-= (const COLLECTION_FUNCTION &cgf)
 
COLLECTION_FUNCTIONoperator*= (const COLLECTION_FUNCTION &cgf)
 
COLLECTION_FUNCTIONoperator/= (const COLLECTION_FUNCTION &cgf)
 
COLLECTION_FUNCTIONoperator+ () const
 
COLLECTION_FUNCTIONoperator- () const
 
COLLECTION_FUNCTIONoperator= (const INTEGRAL_TYPE value)
 
COLLECTION_FUNCTIONoperator+ (const INTEGRAL_TYPE value) const
 
COLLECTION_FUNCTIONoperator- (const INTEGRAL_TYPE value) const
 
COLLECTION_FUNCTIONoperator* (const INTEGRAL_TYPE value) const
 
COLLECTION_FUNCTIONoperator/ (const INTEGRAL_TYPE value) const
 
COLLECTION_FUNCTIONoperator+= (const INTEGRAL_TYPE value)
 
COLLECTION_FUNCTIONoperator-= (const INTEGRAL_TYPE value)
 
COLLECTION_FUNCTIONoperator*= (const INTEGRAL_TYPE value)
 
COLLECTION_FUNCTIONoperator/= (const INTEGRAL_TYPE value)
 
INT_COLLECTION_FUNCTION operator< (const COLLECTION_FUNCTION &cgf) const
 
INT_COLLECTION_FUNCTION operator<= (const COLLECTION_FUNCTION &cgf) const
 
INT_COLLECTION_FUNCTION operator> (const COLLECTION_FUNCTION &cgf) const
 
INT_COLLECTION_FUNCTION operator>= (const COLLECTION_FUNCTION &cgf) const
 
INT_COLLECTION_FUNCTION operator== (const COLLECTION_FUNCTION &cgf) const
 
INT_COLLECTION_FUNCTION operator!= (const COLLECTION_FUNCTION &cgf) const
 
COLLECTION_FUNCTION convectiveDerivative (const COLLECTION_FUNCTION &w, const Index &C1=nullIndex, const Index &C2=nullIndex, const Index &C3=nullIndex) const
 
COLLECTION_FUNCTION convectiveDerivative (const GridFunctionParameters &gfType, const COLLECTION_FUNCTION &w, const Index &C1=nullIndex, const Index &C2=nullIndex, const Index &C3=nullIndex) const
 
COLLECTION_FUNCTION derivativeScalarDerivative (const COLLECTION_FUNCTION &s, const int &direction1, const int &direction2, const Index &C1=nullIndex, const Index &C2=nullIndex, const Index &C3=nullIndex, const Index &C4=nullIndex) const
 
COLLECTION_FUNCTION derivativeScalarDerivative (const GridFunctionParameters &gfType, const COLLECTION_FUNCTION &s, const int &direction1, const int &direction2, const Index &C1=nullIndex, const Index &C2=nullIndex, const Index &C3=nullIndex, const Index &C4=nullIndex) const
 
COLLECTION_FUNCTION derivativeScalarDerivativeCoefficients (const COLLECTION_FUNCTION &s, const int &direction1, const int &direction2, const Index &C0=nullIndex, const Index &C1=nullIndex, const Index &C2=nullIndex, const Index &C3=nullIndex) const
 
COLLECTION_FUNCTION derivativeScalarDerivativeCoefficients (const GridFunctionParameters &gfType, const COLLECTION_FUNCTION &s, const int &direction1, const int &direction2, const Index &C0=nullIndex, const Index &C1=nullIndex, const Index &C2=nullIndex, const Index &C3=nullIndex) const
 
COLLECTION_FUNCTION FCgrad (const int c0=0, const int c1=0, const int c2=0, const int c3=0, const int c4=0) const
 
COLLECTION_FUNCTION FCgrad (const GridFunctionParameters &gfType, const int c0=0, const int c1=0, const int c2=0, const int c3=0, const int c4=0) const
 
void applyBoundaryConditions (const real &time=0., const int &grid=forAll)
 
void assignBoundaryConditionCoefficients (const real &time=0., const int &grid=forAll)
 
void applyBoundaryCondition (const Index &Components, const BCTypes::BCNames &boundaryConditionType=BCTypes::dirichlet, const int &boundaryCondition=BCTypes::allBoundaries, const real &forcing=0., const real &time=0., const BoundaryConditionParameters &bcParameters=Overture::defaultBoundaryConditionParameters())
 
void applyBoundaryCondition (const Index &Components, const BCTypes::BCNames &boundaryConditionType, const int &boundaryCondition, const RealArray &forcing, const real &time=0., const BoundaryConditionParameters &bcParameters=Overture::defaultBoundaryConditionParameters())
 
void applyBoundaryCondition (const Index &Components, const BCTypes::BCNames &boundaryConditionType, const int &boundaryCondition, const COLLECTION_FUNCTION &forcing, const real &time=0., const BoundaryConditionParameters &bcParameters=Overture::defaultBoundaryConditionParameters())
 
void finishBoundaryConditions (const BoundaryConditionParameters &bcParameters=Overture::defaultBoundaryConditionParameters(), const Range &C0=nullRange, const IntegerArray &gridsToUpdate=Overture::nullIntArray())
 
void applyBoundaryConditionCoefficients (const Index &Equation, const Index &Components, const BCTypes::BCNames &boundaryConditionType=BCTypes::dirichlet, const int &boundaryCondition=BCTypes::allBoundaries, const BoundaryConditionParameters &bcParameters=Overture::defaultBoundaryConditionParameters())
 
- Public Member Functions inherited from doubleGenericGridCollectionFunction
 doubleGenericGridCollectionFunction ()
 
 doubleGenericGridCollectionFunction (const doubleGenericGridCollectionFunction &, const CopyType=DEEP)
 
virtual ~doubleGenericGridCollectionFunction ()
 
 doubleGenericGridCollectionFunction (GenericGridCollection *gridList)
 
doubleGenericGridCollectionFunctionoperator= (const doubleGenericGridCollectionFunction &X)
 
doubleGenericGridFunctionoperator[] (const int grid)
 
void reference (const doubleGenericGridCollectionFunction &)
 
- Public Member Functions inherited from ReferenceCounting
 ReferenceCounting ()
 
 ReferenceCounting (const ReferenceCounting &x, const CopyType ct=DEEP)
 
virtual ~ReferenceCounting ()
 
Integer incrementReferenceCount ()
 
Integer decrementReferenceCount ()
 
Integer getReferenceCount () const
 
Logical uncountedReferencesMayExist ()
 
Integer getGlobalID () const
 
void setGlobalID (int id)
 

Public Attributes

ListOfDoubleMappedGridFunction mappedGridFunctionList
 
ListOfDoubleGridCollectionFunction baseGrid
 
ListOfDoubleGridCollectionFunction multigridLevel
 
ListOfDoubleGridCollectionFunction refinementLevel
 
GridCollectionDatagridCollectionData
 
GridCollectiongridCollection
 
GenericCollectionOperatorsoperators
 
SparseRepForGCF * sparse
 
- Public Attributes inherited from doubleGenericGridCollectionFunction
ListOfDoubleGenericGridFunction genericGridFunctionList
 
GenericGridCollectiongridList
 

Protected Member Functions

void constructor (GridCollection *gridCollection0, GridCollectionData *gridCollectionData0, const Range &R0, const Range &R1, const Range &R2, const Range &R3, const Range &R4, const Range &R5, const Range &R6, const Range &R7, const bool createMappedGridFunctionList=TRUE)
 
void initialize ()
 
void dimensionName ()
 
virtual int updateCollections ()
 
void setPositionOfFaceCentering (const int number)
 

Protected Attributes

aString className
 
bool temporary
 
int dataAllocationOption
 
RCDatarcData
 

Friends

doubleGridCollectionFunctionfabs (const doubleGridCollectionFunction &cgf)
 
COLLECTION_FUNCTIONoperator+ (const INTEGRAL_TYPE value, const COLLECTION_FUNCTION &cgf)
 
COLLECTION_FUNCTIONoperator- (const INTEGRAL_TYPE value, const COLLECTION_FUNCTION &cgf)
 
COLLECTION_FUNCTIONoperator* (const INTEGRAL_TYPE value, const COLLECTION_FUNCTION &cgf)
 
COLLECTION_FUNCTIONoperator/ (const INTEGRAL_TYPE value, const COLLECTION_FUNCTION &cgf)
 
INTEGRAL_TYPE max (const COLLECTION_FUNCTION &cgf)
 
INTEGRAL_TYPE min (const COLLECTION_FUNCTION &cgf)
 
doubleGridCollectionFunctionmultiply (const doubleGridCollectionFunction &a, const doubleGridCollectionFunction &coeff)
 
doubleGridCollectionFunction evaluate (doubleGridCollectionFunction &u)
 

Member Enumeration Documentation

anonymous enum
Enumerator
undefinedValue 
defaultValue 
forAll 
forAllGrids 
maximumNumberOfIndicies 
maximumNumberOfComponents 
Enumerator
updateNoChange 
updateReshaped 
updateResized 
updateComponentsChanged 

Constructor & Destructor Documentation

doubleGridCollectionFunction::doubleGridCollectionFunction ( )

References initialize(), NULL, and rcData.

Referenced by operator()().

doubleGridCollectionFunction::doubleGridCollectionFunction ( GridCollection grid,
const Range &  R0,
const Range &  R1 = nullRange,
const Range &  R2 = nullRange,
const Range &  R3 = nullRange,
const Range &  R4 = nullRange,
const Range &  R5 = nullRange,
const Range &  R6 = nullRange,
const Range &  R7 = nullRange 
)
doubleGridCollectionFunction::doubleGridCollectionFunction ( GridCollectionData gcData,
const Range &  R0,
const Range &  R1 = nullRange,
const Range &  R2 = nullRange,
const Range &  R3 = nullRange,
const Range &  R4 = nullRange,
const Range &  R5 = nullRange,
const Range &  R6 = nullRange,
const Range &  R7 = nullRange 
)

References constructor(), initialize(), NULL, and rcData.

doubleGridCollectionFunction::doubleGridCollectionFunction ( GridCollection grid,
const int &  i0,
const Range &  R1 = nullRange,
const Range &  R2 = nullRange,
const Range &  R3 = nullRange,
const Range &  R4 = nullRange,
const Range &  R5 = nullRange,
const Range &  R6 = nullRange,
const Range &  R7 = nullRange 
)
doubleGridCollectionFunction::doubleGridCollectionFunction ( GridCollectionData gcData,
const int &  i0,
const Range &  R1 = nullRange,
const Range &  R2 = nullRange,
const Range &  R3 = nullRange,
const Range &  R4 = nullRange,
const Range &  R5 = nullRange,
const Range &  R6 = nullRange,
const Range &  R7 = nullRange 
)

References constructor(), initialize(), NULL, and rcData.

doubleGridCollectionFunction::doubleGridCollectionFunction ( GridCollection gc,
const GridFunctionParameters::GridFunctionType type,
const Range &  component0 = nullRange,
const Range &  component1 = nullRange,
const Range &  component2 = nullRange,
const Range &  component3 = nullRange,
const Range &  component4 = nullRange 
)
doubleGridCollectionFunction::doubleGridCollectionFunction ( GridCollection gridCollection)
doubleGridCollectionFunction::doubleGridCollectionFunction ( GridCollectionData gridCollection)
doubleGridCollectionFunction::doubleGridCollectionFunction ( const doubleGridCollectionFunction cgf,
const CopyType  copyType = DEEP 
)
doubleGridCollectionFunction::~doubleGridCollectionFunction ( )
virtual

Member Function Documentation

void doubleGridCollectionFunction::applyBoundaryCondition ( const Index &  Components,
const BCTypes::BCNames boundaryConditionType = BCTypes::dirichlet,
const int &  boundaryCondition = BCTypes::allBoundaries,
const real forcing = 0.,
const real time = 0.,
const BoundaryConditionParameters bcParameters = Overture::defaultBoundaryConditionParameters() 
)
void doubleGridCollectionFunction::applyBoundaryCondition ( const Index &  Components,
const BCTypes::BCNames boundaryConditionType,
const int &  boundaryCondition,
const RealArray forcing,
const real time = 0.,
const BoundaryConditionParameters bcParameters = Overture::defaultBoundaryConditionParameters() 
)
void doubleGridCollectionFunction::applyBoundaryCondition ( const Index &  Components,
const BCTypes::BCNames boundaryConditionType,
const int &  boundaryCondition,
const COLLECTION_FUNCTION forcing,
const real time = 0.,
const BoundaryConditionParameters bcParameters = Overture::defaultBoundaryConditionParameters() 
)
void doubleGridCollectionFunction::applyBoundaryConditionCoefficients ( const Index &  Equation,
const Index &  Components,
const BCTypes::BCNames boundaryConditionType = BCTypes::dirichlet,
const int &  boundaryCondition = BCTypes::allBoundaries,
const BoundaryConditionParameters bcParameters = Overture::defaultBoundaryConditionParameters() 
)
void doubleGridCollectionFunction::applyBoundaryConditions ( const real time = 0.,
const int &  grid = forAll 
)
void doubleGridCollectionFunction::assignBoundaryConditionCoefficients ( const real time = 0.,
const int &  grid = forAll 
)
void doubleGridCollectionFunction::breakReference ( void  )
virtual
void doubleGridCollectionFunction::consistencyCheck ( void  ) const
virtual
void doubleGridCollectionFunction::constructor ( GridCollection gridCollection0,
GridCollectionData gridCollectionData0,
const Range &  R0,
const Range &  R1,
const Range &  R2,
const Range &  R3,
const Range &  R4,
const Range &  R5,
const Range &  R6,
const Range &  R7,
const bool  createMappedGridFunctionList = TRUE 
)
protected
COLLECTION_FUNCTION doubleGridCollectionFunction::convectiveDerivative ( const COLLECTION_FUNCTION w,
const Index &  C1 = nullIndex,
const Index &  C2 = nullIndex,
const Index &  C3 = nullIndex 
) const
COLLECTION_FUNCTION doubleGridCollectionFunction::convectiveDerivative ( const GridFunctionParameters gfType,
const COLLECTION_FUNCTION w,
const Index &  C1 = nullIndex,
const Index &  C2 = nullIndex,
const Index &  C3 = nullIndex 
) const
int doubleGridCollectionFunction::dataCopy ( const doubleGridCollectionFunction gcf)
virtual

References numberOfGrids(), and temporary.

COLLECTION_FUNCTION doubleGridCollectionFunction::derivativeScalarDerivative ( const COLLECTION_FUNCTION s,
const int &  direction1,
const int &  direction2,
const Index &  C1 = nullIndex,
const Index &  C2 = nullIndex,
const Index &  C3 = nullIndex,
const Index &  C4 = nullIndex 
) const
COLLECTION_FUNCTION doubleGridCollectionFunction::derivativeScalarDerivative ( const GridFunctionParameters gfType,
const COLLECTION_FUNCTION s,
const int &  direction1,
const int &  direction2,
const Index &  C1 = nullIndex,
const Index &  C2 = nullIndex,
const Index &  C3 = nullIndex,
const Index &  C4 = nullIndex 
) const
COLLECTION_FUNCTION doubleGridCollectionFunction::derivativeScalarDerivativeCoefficients ( const COLLECTION_FUNCTION s,
const int &  direction1,
const int &  direction2,
const Index &  C0 = nullIndex,
const Index &  C1 = nullIndex,
const Index &  C2 = nullIndex,
const Index &  C3 = nullIndex 
) const
COLLECTION_FUNCTION doubleGridCollectionFunction::derivativeScalarDerivativeCoefficients ( const GridFunctionParameters gfType,
const COLLECTION_FUNCTION s,
const int &  direction1,
const int &  direction2,
const Index &  C0 = nullIndex,
const Index &  C1 = nullIndex,
const Index &  C2 = nullIndex,
const Index &  C3 = nullIndex 
) const
int doubleGridCollectionFunction::destroy ( )
virtual
void doubleGridCollectionFunction::dimensionName ( )
protected
void doubleGridCollectionFunction::display ( const aString label = nullString,
FILE *  file = NULL,
const aString format = nullString 
) const
virtual
void doubleGridCollectionFunction::display ( const aString label,
const aString format 
) const
virtual

References display(), and NULL.

void doubleGridCollectionFunction::display ( const aString label,
const DisplayParameters displayParameters 
) const
virtual

References display().

int doubleGridCollectionFunction::faceCentering ( ) const
inline
COLLECTION_FUNCTION doubleGridCollectionFunction::FCgrad ( const int  c0 = 0,
const int  c1 = 0,
const int  c2 = 0,
const int  c3 = 0,
const int  c4 = 0 
) const
COLLECTION_FUNCTION doubleGridCollectionFunction::FCgrad ( const GridFunctionParameters gfType,
const int  c0 = 0,
const int  c1 = 0,
const int  c2 = 0,
const int  c3 = 0,
const int  c4 = 0 
) const
void doubleGridCollectionFunction::finishBoundaryConditions ( const BoundaryConditionParameters bcParameters = Overture::defaultBoundaryConditionParameters(),
const Range &  C0 = nullRange,
const IntegerArray gridsToUpdate = Overture::nullIntArray() 
)
int doubleGridCollectionFunction::fixupUnusedPoints ( const RealArray value = Overture::nullRealArray(),
int  numberOfGhostlines = 1 
)
virtual

References numberOfGrids().

int doubleGridCollectionFunction::get ( const GenericDataBase dir,
const aString name 
)
virtual
aString doubleGridCollectionFunction::getClassName ( void  ) const
virtual
int doubleGridCollectionFunction::getComponentBase ( int  component) const
int doubleGridCollectionFunction::getComponentBound ( int  component) const
int doubleGridCollectionFunction::getComponentDimension ( int  component) const
int doubleGridCollectionFunction::getCoordinateBase ( int  coordinate) const

References Overture::abort().

int doubleGridCollectionFunction::getCoordinateBound ( int  coordinate) const

References Overture::abort().

int doubleGridCollectionFunction::getCoordinateDimension ( int  coordinate) const

References Overture::abort().

GridFunctionParameters::faceCenteringType doubleGridCollectionFunction::getFaceCentering ( ) const
GridCollection * doubleGridCollectionFunction::getGridCollection ( const bool  abortIfNull = TRUE) const
virtual
GridFunctionParameters::GridFunctionType doubleGridCollectionFunction::getGridFunctionType ( const Index &  component0 = nullIndex,
const Index &  component1 = nullIndex,
const Index &  component2 = nullIndex,
const Index &  component3 = nullIndex,
const Index &  component4 = nullIndex 
) const
GridFunctionParameters::GridFunctionTypeWithComponents doubleGridCollectionFunction::getGridFunctionTypeWithComponents ( const Index &  component0 = nullIndex,
const Index &  component1 = nullIndex,
const Index &  component2 = nullIndex,
const Index &  component3 = nullIndex,
const Index &  component4 = nullIndex 
) const
bool doubleGridCollectionFunction::getIsACoefficientMatrix ( ) const
bool doubleGridCollectionFunction::getIsCellCentered ( const Index &  axis = nullIndex,
const Index &  component0 = nullIndex,
const Index &  component1 = nullIndex,
const Index &  component2 = nullIndex,
const Index &  component3 = nullIndex,
const Index &  component4 = nullIndex,
const Index &  grid = nullIndex 
) const
bool doubleGridCollectionFunction::getIsFaceCentered ( const int &  axis = forAll,
const Index &  component0 = nullIndex,
const Index &  component1 = nullIndex,
const Index &  component2 = nullIndex,
const Index &  component3 = nullIndex,
const Index &  component4 = nullIndex,
const Index &  grid = nullIndex 
) const

References TRUE.

aString doubleGridCollectionFunction::getName ( const int &  component0 = defaultValue,
const int &  component1 = defaultValue,
const int &  component2 = defaultValue,
const int &  component3 = defaultValue,
const int &  component4 = defaultValue 
) const
int doubleGridCollectionFunction::getNumberOfComponents ( ) const
GridCollectionOperators * doubleGridCollectionFunction::getOperators ( ) const

References NULL, and operators.

Referenced by setOperators().

void doubleGridCollectionFunction::getRanges ( Range &  R0,
Range &  R1,
Range &  R2,
Range &  R3,
Range &  R4,
Range &  R5,
Range &  R6,
Range &  R7 
) const
void doubleGridCollectionFunction::initialize ( )
protected
int doubleGridCollectionFunction::interpolate ( Interpolant interpolant,
const Range &  C0 = nullRange,
const Range &  C1 = nullRange,
const Range &  C2 = nullRange 
)
virtual

Reimplemented in doubleCompositeGridFunction.

Referenced by interpolate().

int doubleGridCollectionFunction::interpolate ( const Range &  C0 = nullRange,
const Range &  C1 = nullRange,
const Range &  C2 = nullRange 
)
virtual
bool doubleGridCollectionFunction::isNull ( )

References gridCollection, and NULL.

Referenced by CompositeGridData::operator=().

void doubleGridCollectionFunction::link ( const doubleGridCollectionFunction gcf,
const Range &  R0,
const Range &  R1 = nullRange,
const Range &  R2 = nullRange,
const Range &  R3 = nullRange,
const Range &  R4 = nullRange 
)
virtual
void doubleGridCollectionFunction::link ( const doubleGridCollectionFunction gcf,
const int  componentToLinkTo = 0,
const int  numberOfComponents = 1 
)
virtual

Reimplemented in doubleCompositeGridFunction.

References link(), and R.

int doubleGridCollectionFunction::numberOfComponentGrids ( ) const
int doubleGridCollectionFunction::numberOfGrids ( ) const
int doubleGridCollectionFunction::numberOfMultigridLevels ( ) const
int doubleGridCollectionFunction::numberOfRefinementLevels ( ) const
INT_COLLECTION_FUNCTION doubleGridCollectionFunction::operator!= ( const COLLECTION_FUNCTION cgf) const
doubleGridCollectionFunction doubleGridCollectionFunction::operator() ( const Range &  component0,
const Range &  component1 = nullRange,
const Range &  component2 = nullRange,
const Range &  component3 = nullRange,
const Range &  component4 = nullRange 
)
COLLECTION_FUNCTION& doubleGridCollectionFunction::operator* ( const COLLECTION_FUNCTION cgf) const
COLLECTION_FUNCTION& doubleGridCollectionFunction::operator* ( const INTEGRAL_TYPE  value) const
COLLECTION_FUNCTION& doubleGridCollectionFunction::operator*= ( const COLLECTION_FUNCTION cgf)
COLLECTION_FUNCTION& doubleGridCollectionFunction::operator*= ( const INTEGRAL_TYPE  value)
COLLECTION_FUNCTION& doubleGridCollectionFunction::operator+ ( const COLLECTION_FUNCTION cgf) const
COLLECTION_FUNCTION& doubleGridCollectionFunction::operator+ ( ) const
COLLECTION_FUNCTION& doubleGridCollectionFunction::operator+ ( const INTEGRAL_TYPE  value) const
COLLECTION_FUNCTION& doubleGridCollectionFunction::operator+= ( const COLLECTION_FUNCTION cgf)
COLLECTION_FUNCTION& doubleGridCollectionFunction::operator+= ( const INTEGRAL_TYPE  value)
COLLECTION_FUNCTION& doubleGridCollectionFunction::operator- ( const COLLECTION_FUNCTION cgf) const
COLLECTION_FUNCTION& doubleGridCollectionFunction::operator- ( ) const
COLLECTION_FUNCTION& doubleGridCollectionFunction::operator- ( const INTEGRAL_TYPE  value) const
COLLECTION_FUNCTION& doubleGridCollectionFunction::operator-= ( const COLLECTION_FUNCTION cgf)
COLLECTION_FUNCTION& doubleGridCollectionFunction::operator-= ( const INTEGRAL_TYPE  value)
COLLECTION_FUNCTION& doubleGridCollectionFunction::operator/ ( const COLLECTION_FUNCTION cgf) const
COLLECTION_FUNCTION& doubleGridCollectionFunction::operator/ ( const INTEGRAL_TYPE  value) const
COLLECTION_FUNCTION& doubleGridCollectionFunction::operator/= ( const COLLECTION_FUNCTION cgf)
COLLECTION_FUNCTION& doubleGridCollectionFunction::operator/= ( const INTEGRAL_TYPE  value)
INT_COLLECTION_FUNCTION doubleGridCollectionFunction::operator< ( const COLLECTION_FUNCTION cgf) const
INT_COLLECTION_FUNCTION doubleGridCollectionFunction::operator<= ( const COLLECTION_FUNCTION cgf) const
COLLECTION_FUNCTION& doubleGridCollectionFunction::operator= ( const INTEGRAL_TYPE  value)
doubleGridCollectionFunction & doubleGridCollectionFunction::operator= ( const doubleGridCollectionFunction cgf)
virtual
INT_COLLECTION_FUNCTION doubleGridCollectionFunction::operator== ( const COLLECTION_FUNCTION cgf) const
INT_COLLECTION_FUNCTION doubleGridCollectionFunction::operator> ( const COLLECTION_FUNCTION cgf) const
INT_COLLECTION_FUNCTION doubleGridCollectionFunction::operator>= ( const COLLECTION_FUNCTION cgf) const
virtual doubleMappedGridFunction& doubleGridCollectionFunction::operator[] ( const int  grid) const
inlinevirtual
void doubleGridCollectionFunction::periodicUpdate ( const Range &  C0 = nullRange,
const Range &  C1 = nullRange,
const Range &  C2 = nullRange,
const Range &  C3 = nullRange,
const Range &  C4 = nullRange,
const bool &  derivativePeriodic = FALSE 
)
virtual
int doubleGridCollectionFunction::positionOfComponent ( int  i) const
inline
int doubleGridCollectionFunction::positionOfCoordinate ( int  i) const
inline
int doubleGridCollectionFunction::positionOfFaceCentering ( ) const
inline
int doubleGridCollectionFunction::put ( GenericDataBase dir,
const aString name 
) const
virtual
void doubleGridCollectionFunction::reference ( const doubleGridCollectionFunction cgf)
virtual
void doubleGridCollectionFunction::setDataAllocationOption ( int  option)

Set the data allocation option.

References dataAllocationOption.

Referenced by Ogmg::buildPredefinedEquations().

void doubleGridCollectionFunction::setFaceCentering ( const int &  axis = defaultValue)
void doubleGridCollectionFunction::setInterpolant ( Interpolant interpolant)
void doubleGridCollectionFunction::setIsACoefficientMatrix ( const bool  trueOrFalse = TRUE,
const int  stencilSize = defaultValue,
const int  numberOfGhostLines = 1,
const int  numberOfComponentsForCoefficients = 1,
const int  offset = 0 
)
virtual
void doubleGridCollectionFunction::setIsCellCentered ( const bool  trueOrFalse,
const Index &  axis = nullIndex,
const Index &  component0 = nullIndex,
const Index &  component1 = nullIndex,
const Index &  component2 = nullIndex,
const Index &  component3 = nullIndex,
const Index &  component4 = nullIndex,
const Index &  grid = nullIndex 
)
void doubleGridCollectionFunction::setIsFaceCentered ( const int &  axis = forAll,
const Index &  component0 = nullIndex,
const Index &  component1 = nullIndex,
const Index &  component2 = nullIndex,
const Index &  component3 = nullIndex,
const Index &  component4 = nullIndex,
const Index &  grid = nullIndex 
)
void doubleGridCollectionFunction::setName ( const aString name,
const int &  component0 = defaultValue,
const int &  component1 = defaultValue,
const int &  component2 = defaultValue,
const int &  component3 = defaultValue,
const int &  component4 = defaultValue 
)
void doubleGridCollectionFunction::setOperators ( GenericCollectionOperators operators)
virtual
void doubleGridCollectionFunction::setPositionOfFaceCentering ( const int  number)
protected
real doubleGridCollectionFunction::sizeOf ( FILE *  file = NULL) const
virtual
int doubleGridCollectionFunction::updateCollections ( )
protectedvirtual
int doubleGridCollectionFunction::updateFaceCentering ( )
doubleGridCollectionFunction::updateReturnValue doubleGridCollectionFunction::updateToMatchComponentGrids ( )
virtual
doubleGridCollectionFunction::updateReturnValue doubleGridCollectionFunction::updateToMatchGrid ( )
virtual
doubleGridCollectionFunction::updateReturnValue doubleGridCollectionFunction::updateToMatchGrid ( GridCollectionData gridData,
const Range &  R0,
const Range &  R1 = nullRange,
const Range &  R2 = nullRange,
const Range &  R3 = nullRange,
const Range &  R4 = nullRange,
const Range &  R5 = nullRange,
const Range &  R6 = nullRange,
const Range &  R7 = nullRange 
)
virtual
doubleGridCollectionFunction::updateReturnValue doubleGridCollectionFunction::updateToMatchGrid ( GridCollection grid,
const Range &  R0,
const Range &  R1 = nullRange,
const Range &  R2 = nullRange,
const Range &  R3 = nullRange,
const Range &  R4 = nullRange,
const Range &  R5 = nullRange,
const Range &  R6 = nullRange,
const Range &  R7 = nullRange 
)
virtual
doubleGridCollectionFunction::updateReturnValue doubleGridCollectionFunction::updateToMatchGrid ( GridCollection grid,
const int &  i0,
const Range &  R1 = nullRange,
const Range &  R2 = nullRange,
const Range &  R3 = nullRange,
const Range &  R4 = nullRange,
const Range &  R5 = nullRange,
const Range &  R6 = nullRange,
const Range &  R7 = nullRange 
)
virtual
doubleGridCollectionFunction::updateReturnValue doubleGridCollectionFunction::updateToMatchGrid ( const Range &  R0,
const Range &  R1 = nullRange,
const Range &  R2 = nullRange,
const Range &  R3 = nullRange,
const Range &  R4 = nullRange,
const Range &  R5 = nullRange,
const Range &  R6 = nullRange,
const Range &  R7 = nullRange 
)
virtual
doubleGridCollectionFunction::updateReturnValue doubleGridCollectionFunction::updateToMatchGrid ( GridCollection grid,
const GridFunctionParameters::GridFunctionType type,
const Range &  component0,
const Range &  component1 = nullRange,
const Range &  component2 = nullRange,
const Range &  component3 = nullRange,
const Range &  component4 = nullRange 
)
virtual
doubleGridCollectionFunction::updateReturnValue doubleGridCollectionFunction::updateToMatchGrid ( const GridFunctionParameters::GridFunctionType type,
const Range &  component0,
const Range &  component1 = nullRange,
const Range &  component2 = nullRange,
const Range &  component3 = nullRange,
const Range &  component4 = nullRange 
)
virtual
doubleGridCollectionFunction::updateReturnValue doubleGridCollectionFunction::updateToMatchGrid ( GridCollection grid,
const GridFunctionParameters::GridFunctionType type 
)
virtual
doubleGridCollectionFunction::updateReturnValue doubleGridCollectionFunction::updateToMatchGrid ( const GridFunctionParameters::GridFunctionType type)
virtual
doubleGridCollectionFunction::updateReturnValue doubleGridCollectionFunction::updateToMatchGrid ( GridCollection gridCollection)
virtual
doubleGridCollectionFunction::updateReturnValue doubleGridCollectionFunction::updateToMatchGrid ( GridCollectionData gridCollection)
virtual
doubleGridCollectionFunction::updateReturnValue doubleGridCollectionFunction::updateToMatchGridFunction ( const doubleGridCollectionFunction cgf,
const Range &  R0,
const Range &  R1 = nullRange,
const Range &  R2 = nullRange,
const Range &  R3 = nullRange,
const Range &  R4 = nullRange,
const Range &  R5 = nullRange,
const Range &  R6 = nullRange,
const Range &  R7 = nullRange 
)
virtual
doubleGridCollectionFunction::updateReturnValue doubleGridCollectionFunction::updateToMatchGridFunction ( const doubleGridCollectionFunction gcf)
virtual
doubleGridCollectionFunction::updateReturnValue doubleGridCollectionFunction::updateToMatchNumberOfGrids ( GridCollection gc)
virtual

Friends And Related Function Documentation

INTEGRAL_TYPE max ( const COLLECTION_FUNCTION cgf)
friend

Referenced by updateCollections().

INTEGRAL_TYPE min ( const COLLECTION_FUNCTION cgf)
friend
doubleGridCollectionFunction& multiply ( const doubleGridCollectionFunction a,
const doubleGridCollectionFunction coeff 
)
friend
COLLECTION_FUNCTION& operator* ( const INTEGRAL_TYPE  value,
const COLLECTION_FUNCTION cgf 
)
friend
COLLECTION_FUNCTION& operator+ ( const INTEGRAL_TYPE  value,
const COLLECTION_FUNCTION cgf 
)
friend
COLLECTION_FUNCTION& operator- ( const INTEGRAL_TYPE  value,
const COLLECTION_FUNCTION cgf 
)
friend
COLLECTION_FUNCTION& operator/ ( const INTEGRAL_TYPE  value,
const COLLECTION_FUNCTION cgf 
)
friend

Member Data Documentation

ListOfDoubleGridCollectionFunction doubleGridCollectionFunction::baseGrid

Referenced by destroy().

aString doubleGridCollectionFunction::className
protected
int doubleGridCollectionFunction::dataAllocationOption
protected
GridCollection* doubleGridCollectionFunction::gridCollection
GridCollectionData* doubleGridCollectionFunction::gridCollectionData
ListOfDoubleMappedGridFunction doubleGridCollectionFunction::mappedGridFunctionList
ListOfDoubleGridCollectionFunction doubleGridCollectionFunction::multigridLevel
GenericCollectionOperators* doubleGridCollectionFunction::operators
RCData* doubleGridCollectionFunction::rcData
protected
ListOfDoubleGridCollectionFunction doubleGridCollectionFunction::refinementLevel
SparseRepForGCF* doubleGridCollectionFunction::sparse
bool doubleGridCollectionFunction::temporary
protected

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