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

#include <floatGridCollectionFunction.h>

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

Classes

class  RCData
 

Public Types

enum  {
  undefinedValue =floatMappedGridFunction::undefinedValue, defaultValue =floatMappedGridFunction::defaultValue, forAll =floatMappedGridFunction::forAll, forAllGrids =forAll+1,
  maximumNumberOfIndicies =floatMappedGridFunction::maximumNumberOfIndicies, maximumNumberOfComponents =floatMappedGridFunction::maximumNumberOfComponents
}
 
enum  updateReturnValue { updateNoChange = floatMappedGridFunction::updateNoChange, updateReshaped = floatMappedGridFunction::updateReshaped, updateResized = floatMappedGridFunction::updateResized, updateComponentsChanged = floatMappedGridFunction::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
 
 floatGridCollectionFunction ()
 
 floatGridCollectionFunction (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)
 
 floatGridCollectionFunction (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)
 
 floatGridCollectionFunction (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)
 
 floatGridCollectionFunction (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)
 
 floatGridCollectionFunction (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)
 
 floatGridCollectionFunction (GridCollection &gridCollection)
 
 floatGridCollectionFunction (GridCollectionData &gridCollection)
 
 floatGridCollectionFunction (const floatGridCollectionFunction &cgf, const CopyType copyType=DEEP)
 
virtual ~floatGridCollectionFunction ()
 
virtual
floatGridCollectionFunction
operator= (const floatGridCollectionFunction &cgf)
 
virtual floatMappedGridFunctionoperator[] (const int grid) const
 
floatGridCollectionFunction 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 floatGridCollectionFunction &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 floatGridCollectionFunction &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 floatGridCollectionFunction &gcf, const int componentToLinkTo=0, const int numberOfComponents=1)
 
virtual void reference (const floatGridCollectionFunction &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 floatGridCollectionFunction &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 floatGridCollectionFunction &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 floatGenericGridCollectionFunction
 floatGenericGridCollectionFunction ()
 
 floatGenericGridCollectionFunction (const floatGenericGridCollectionFunction &, const CopyType=DEEP)
 
virtual ~floatGenericGridCollectionFunction ()
 
 floatGenericGridCollectionFunction (GenericGridCollection *gridList)
 
floatGenericGridCollectionFunctionoperator= (const floatGenericGridCollectionFunction &X)
 
floatGenericGridFunctionoperator[] (const int grid)
 
void reference (const floatGenericGridCollectionFunction &)
 
- 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

ListOfFloatMappedGridFunction mappedGridFunctionList
 
ListOfFloatGridCollectionFunction baseGrid
 
ListOfFloatGridCollectionFunction multigridLevel
 
ListOfFloatGridCollectionFunction refinementLevel
 
GridCollectionDatagridCollectionData
 
GridCollectiongridCollection
 
GenericCollectionOperatorsoperators
 
SparseRepForGCF * sparse
 
- Public Attributes inherited from floatGenericGridCollectionFunction
ListOfFloatGenericGridFunction 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

floatGridCollectionFunctionfabs (const floatGridCollectionFunction &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)
 
floatGridCollectionFunctionmultiply (const floatGridCollectionFunction &a, const floatGridCollectionFunction &coeff)
 
floatGridCollectionFunction evaluate (floatGridCollectionFunction &u)
 

Member Enumeration Documentation

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

Constructor & Destructor Documentation

floatGridCollectionFunction::floatGridCollectionFunction ( )

References initialize(), NULL, and rcData.

Referenced by operator()().

floatGridCollectionFunction::floatGridCollectionFunction ( 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 
)
floatGridCollectionFunction::floatGridCollectionFunction ( 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.

floatGridCollectionFunction::floatGridCollectionFunction ( 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 
)
floatGridCollectionFunction::floatGridCollectionFunction ( 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.

floatGridCollectionFunction::floatGridCollectionFunction ( 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 
)
floatGridCollectionFunction::floatGridCollectionFunction ( GridCollection gridCollection)
floatGridCollectionFunction::floatGridCollectionFunction ( GridCollectionData gridCollection)
floatGridCollectionFunction::floatGridCollectionFunction ( const floatGridCollectionFunction cgf,
const CopyType  copyType = DEEP 
)
floatGridCollectionFunction::~floatGridCollectionFunction ( )
virtual

Member Function Documentation

void floatGridCollectionFunction::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 floatGridCollectionFunction::applyBoundaryCondition ( const Index &  Components,
const BCTypes::BCNames boundaryConditionType,
const int &  boundaryCondition,
const RealArray forcing,
const real time = 0.,
const BoundaryConditionParameters bcParameters = Overture::defaultBoundaryConditionParameters() 
)
void floatGridCollectionFunction::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 floatGridCollectionFunction::applyBoundaryConditionCoefficients ( const Index &  Equation,
const Index &  Components,
const BCTypes::BCNames boundaryConditionType = BCTypes::dirichlet,
const int &  boundaryCondition = BCTypes::allBoundaries,
const BoundaryConditionParameters bcParameters = Overture::defaultBoundaryConditionParameters() 
)
void floatGridCollectionFunction::applyBoundaryConditions ( const real time = 0.,
const int &  grid = forAll 
)
void floatGridCollectionFunction::assignBoundaryConditionCoefficients ( const real time = 0.,
const int &  grid = forAll 
)
void floatGridCollectionFunction::breakReference ( void  )
virtual
void floatGridCollectionFunction::consistencyCheck ( void  ) const
virtual
void floatGridCollectionFunction::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 floatGridCollectionFunction::convectiveDerivative ( const COLLECTION_FUNCTION w,
const Index &  C1 = nullIndex,
const Index &  C2 = nullIndex,
const Index &  C3 = nullIndex 
) const
COLLECTION_FUNCTION floatGridCollectionFunction::convectiveDerivative ( const GridFunctionParameters gfType,
const COLLECTION_FUNCTION w,
const Index &  C1 = nullIndex,
const Index &  C2 = nullIndex,
const Index &  C3 = nullIndex 
) const
int floatGridCollectionFunction::dataCopy ( const floatGridCollectionFunction gcf)
virtual

References numberOfGrids(), and temporary.

COLLECTION_FUNCTION floatGridCollectionFunction::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 floatGridCollectionFunction::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 floatGridCollectionFunction::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 floatGridCollectionFunction::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 floatGridCollectionFunction::destroy ( )
virtual
void floatGridCollectionFunction::dimensionName ( )
protected
void floatGridCollectionFunction::display ( const aString label = nullString,
FILE *  file = NULL,
const aString format = nullString 
) const
virtual

References display(), NULL, nullString, and sPrintF().

void floatGridCollectionFunction::display ( const aString label,
const aString format 
) const
virtual

References display(), and NULL.

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

References display().

int floatGridCollectionFunction::faceCentering ( ) const
inline
COLLECTION_FUNCTION floatGridCollectionFunction::FCgrad ( const int  c0 = 0,
const int  c1 = 0,
const int  c2 = 0,
const int  c3 = 0,
const int  c4 = 0 
) const
COLLECTION_FUNCTION floatGridCollectionFunction::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 floatGridCollectionFunction::finishBoundaryConditions ( const BoundaryConditionParameters bcParameters = Overture::defaultBoundaryConditionParameters(),
const Range &  C0 = nullRange,
const IntegerArray gridsToUpdate = Overture::nullIntArray() 
)
int floatGridCollectionFunction::fixupUnusedPoints ( const RealArray value = Overture::nullRealArray(),
int  numberOfGhostlines = 1 
)
virtual

References numberOfGrids().

int floatGridCollectionFunction::get ( const GenericDataBase dir,
const aString name 
)
virtual
aString floatGridCollectionFunction::getClassName ( void  ) const
virtual
int floatGridCollectionFunction::getComponentBase ( int  component) const

References Overture::abort().

int floatGridCollectionFunction::getComponentBound ( int  component) const

References Overture::abort().

int floatGridCollectionFunction::getComponentDimension ( int  component) const

References Overture::abort().

int floatGridCollectionFunction::getCoordinateBase ( int  coordinate) const

References Overture::abort().

int floatGridCollectionFunction::getCoordinateBound ( int  coordinate) const

References Overture::abort().

int floatGridCollectionFunction::getCoordinateDimension ( int  coordinate) const

References Overture::abort().

GridFunctionParameters::faceCenteringType floatGridCollectionFunction::getFaceCentering ( ) const
GridCollection * floatGridCollectionFunction::getGridCollection ( const bool  abortIfNull = TRUE) const
virtual

References Overture::abort(), and NULL.

Referenced by multiply().

GridFunctionParameters::GridFunctionType floatGridCollectionFunction::getGridFunctionType ( const Index &  component0 = nullIndex,
const Index &  component1 = nullIndex,
const Index &  component2 = nullIndex,
const Index &  component3 = nullIndex,
const Index &  component4 = nullIndex 
) const
GridFunctionParameters::GridFunctionTypeWithComponents floatGridCollectionFunction::getGridFunctionTypeWithComponents ( const Index &  component0 = nullIndex,
const Index &  component1 = nullIndex,
const Index &  component2 = nullIndex,
const Index &  component3 = nullIndex,
const Index &  component4 = nullIndex 
) const
bool floatGridCollectionFunction::getIsACoefficientMatrix ( ) const
bool floatGridCollectionFunction::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 floatGridCollectionFunction::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 floatGridCollectionFunction::getName ( const int &  component0 = defaultValue,
const int &  component1 = defaultValue,
const int &  component2 = defaultValue,
const int &  component3 = defaultValue,
const int &  component4 = defaultValue 
) const

References assert, blankString, c, and R.

Referenced by link().

int floatGridCollectionFunction::getNumberOfComponents ( ) const
GridCollectionOperators * floatGridCollectionFunction::getOperators ( ) const

References NULL, and operators.

Referenced by setOperators().

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

Reimplemented in floatCompositeGridFunction.

References Interpolant::interpolate().

Referenced by interpolate().

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

References gridCollection, and NULL.

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

Reimplemented in floatCompositeGridFunction.

References link(), and R.

int floatGridCollectionFunction::numberOfComponentGrids ( ) const
int floatGridCollectionFunction::numberOfGrids ( ) const
int floatGridCollectionFunction::numberOfMultigridLevels ( ) const
int floatGridCollectionFunction::numberOfRefinementLevels ( ) const
INT_COLLECTION_FUNCTION floatGridCollectionFunction::operator!= ( const COLLECTION_FUNCTION cgf) const
floatGridCollectionFunction floatGridCollectionFunction::operator() ( const Range &  component0,
const Range &  component1 = nullRange,
const Range &  component2 = nullRange,
const Range &  component3 = nullRange,
const Range &  component4 = nullRange 
)
COLLECTION_FUNCTION& floatGridCollectionFunction::operator* ( const COLLECTION_FUNCTION cgf) const
COLLECTION_FUNCTION& floatGridCollectionFunction::operator* ( const INTEGRAL_TYPE  value) const
COLLECTION_FUNCTION& floatGridCollectionFunction::operator*= ( const COLLECTION_FUNCTION cgf)
COLLECTION_FUNCTION& floatGridCollectionFunction::operator*= ( const INTEGRAL_TYPE  value)
COLLECTION_FUNCTION& floatGridCollectionFunction::operator+ ( const COLLECTION_FUNCTION cgf) const
COLLECTION_FUNCTION& floatGridCollectionFunction::operator+ ( ) const
COLLECTION_FUNCTION& floatGridCollectionFunction::operator+ ( const INTEGRAL_TYPE  value) const
COLLECTION_FUNCTION& floatGridCollectionFunction::operator+= ( const COLLECTION_FUNCTION cgf)
COLLECTION_FUNCTION& floatGridCollectionFunction::operator+= ( const INTEGRAL_TYPE  value)
COLLECTION_FUNCTION& floatGridCollectionFunction::operator- ( const COLLECTION_FUNCTION cgf) const
COLLECTION_FUNCTION& floatGridCollectionFunction::operator- ( ) const
COLLECTION_FUNCTION& floatGridCollectionFunction::operator- ( const INTEGRAL_TYPE  value) const
COLLECTION_FUNCTION& floatGridCollectionFunction::operator-= ( const COLLECTION_FUNCTION cgf)
COLLECTION_FUNCTION& floatGridCollectionFunction::operator-= ( const INTEGRAL_TYPE  value)
COLLECTION_FUNCTION& floatGridCollectionFunction::operator/ ( const COLLECTION_FUNCTION cgf) const
COLLECTION_FUNCTION& floatGridCollectionFunction::operator/ ( const INTEGRAL_TYPE  value) const
COLLECTION_FUNCTION& floatGridCollectionFunction::operator/= ( const COLLECTION_FUNCTION cgf)
COLLECTION_FUNCTION& floatGridCollectionFunction::operator/= ( const INTEGRAL_TYPE  value)
INT_COLLECTION_FUNCTION floatGridCollectionFunction::operator< ( const COLLECTION_FUNCTION cgf) const
INT_COLLECTION_FUNCTION floatGridCollectionFunction::operator<= ( const COLLECTION_FUNCTION cgf) const
COLLECTION_FUNCTION& floatGridCollectionFunction::operator= ( const INTEGRAL_TYPE  value)
floatGridCollectionFunction & floatGridCollectionFunction::operator= ( const floatGridCollectionFunction cgf)
virtual
INT_COLLECTION_FUNCTION floatGridCollectionFunction::operator== ( const COLLECTION_FUNCTION cgf) const
INT_COLLECTION_FUNCTION floatGridCollectionFunction::operator> ( const COLLECTION_FUNCTION cgf) const
INT_COLLECTION_FUNCTION floatGridCollectionFunction::operator>= ( const COLLECTION_FUNCTION cgf) const
virtual floatMappedGridFunction& floatGridCollectionFunction::operator[] ( const int  grid) const
inlinevirtual
void floatGridCollectionFunction::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 floatGridCollectionFunction::positionOfComponent ( int  i) const
inline
int floatGridCollectionFunction::positionOfCoordinate ( int  i) const
inline
int floatGridCollectionFunction::positionOfFaceCentering ( ) const
inline
int floatGridCollectionFunction::put ( GenericDataBase dir,
const aString name 
) const
virtual
void floatGridCollectionFunction::reference ( const floatGridCollectionFunction cgf)
virtual
void floatGridCollectionFunction::setDataAllocationOption ( int  option)

Set the data allocation option.

References dataAllocationOption.

void floatGridCollectionFunction::setFaceCentering ( const int &  axis = defaultValue)
void floatGridCollectionFunction::setInterpolant ( Interpolant interpolant)
void floatGridCollectionFunction::setIsACoefficientMatrix ( const bool  trueOrFalse = TRUE,
const int  stencilSize = defaultValue,
const int  numberOfGhostLines = 1,
const int  numberOfComponentsForCoefficients = 1,
const int  offset = 0 
)
virtual
void floatGridCollectionFunction::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 floatGridCollectionFunction::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 floatGridCollectionFunction::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 floatGridCollectionFunction::setOperators ( GenericCollectionOperators operators)
virtual
void floatGridCollectionFunction::setPositionOfFaceCentering ( const int  number)
protected
real floatGridCollectionFunction::sizeOf ( FILE *  file = NULL) const
virtual
int floatGridCollectionFunction::updateCollections ( )
protectedvirtual
int floatGridCollectionFunction::updateFaceCentering ( )
floatGridCollectionFunction::updateReturnValue floatGridCollectionFunction::updateToMatchComponentGrids ( )
virtual
floatGridCollectionFunction::updateReturnValue floatGridCollectionFunction::updateToMatchGrid ( )
virtual
floatGridCollectionFunction::updateReturnValue floatGridCollectionFunction::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
floatGridCollectionFunction::updateReturnValue floatGridCollectionFunction::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
floatGridCollectionFunction::updateReturnValue floatGridCollectionFunction::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
floatGridCollectionFunction::updateReturnValue floatGridCollectionFunction::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
floatGridCollectionFunction::updateReturnValue floatGridCollectionFunction::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
floatGridCollectionFunction::updateReturnValue floatGridCollectionFunction::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
floatGridCollectionFunction::updateReturnValue floatGridCollectionFunction::updateToMatchGrid ( GridCollection grid,
const GridFunctionParameters::GridFunctionType type 
)
virtual
floatGridCollectionFunction::updateReturnValue floatGridCollectionFunction::updateToMatchGrid ( const GridFunctionParameters::GridFunctionType type)
virtual
floatGridCollectionFunction::updateReturnValue floatGridCollectionFunction::updateToMatchGrid ( GridCollection gridCollection)
virtual
floatGridCollectionFunction::updateReturnValue floatGridCollectionFunction::updateToMatchGrid ( GridCollectionData gridCollection)
virtual
floatGridCollectionFunction::updateReturnValue floatGridCollectionFunction::updateToMatchGridFunction ( const floatGridCollectionFunction 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
floatGridCollectionFunction::updateReturnValue floatGridCollectionFunction::updateToMatchGridFunction ( const floatGridCollectionFunction gcf)
virtual
floatGridCollectionFunction::updateReturnValue floatGridCollectionFunction::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
floatGridCollectionFunction& multiply ( const floatGridCollectionFunction a,
const floatGridCollectionFunction 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

ListOfFloatGridCollectionFunction floatGridCollectionFunction::baseGrid

Referenced by destroy().

aString floatGridCollectionFunction::className
protected
int floatGridCollectionFunction::dataAllocationOption
protected
GridCollection* floatGridCollectionFunction::gridCollection
GridCollectionData* floatGridCollectionFunction::gridCollectionData
ListOfFloatMappedGridFunction floatGridCollectionFunction::mappedGridFunctionList
ListOfFloatGridCollectionFunction floatGridCollectionFunction::multigridLevel
GenericCollectionOperators* floatGridCollectionFunction::operators
RCData* floatGridCollectionFunction::rcData
protected
ListOfFloatGridCollectionFunction floatGridCollectionFunction::refinementLevel
SparseRepForGCF* floatGridCollectionFunction::sparse
bool floatGridCollectionFunction::temporary
protected

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