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

#include <intGridCollectionFunction.h>

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

Classes

class  RCData
 

Public Types

enum  {
  undefinedValue =intMappedGridFunction::undefinedValue, defaultValue =intMappedGridFunction::defaultValue, forAll =intMappedGridFunction::forAll, forAllGrids =forAll+1,
  maximumNumberOfIndicies =intMappedGridFunction::maximumNumberOfIndicies, maximumNumberOfComponents =intMappedGridFunction::maximumNumberOfComponents
}
 
enum  updateReturnValue { updateNoChange = intMappedGridFunction::updateNoChange, updateReshaped = intMappedGridFunction::updateReshaped, updateResized = intMappedGridFunction::updateResized, updateComponentsChanged = intMappedGridFunction::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
 
 intGridCollectionFunction ()
 
 intGridCollectionFunction (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)
 
 intGridCollectionFunction (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)
 
 intGridCollectionFunction (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)
 
 intGridCollectionFunction (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)
 
 intGridCollectionFunction (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)
 
 intGridCollectionFunction (GridCollection &gridCollection)
 
 intGridCollectionFunction (GridCollectionData &gridCollection)
 
 intGridCollectionFunction (const intGridCollectionFunction &cgf, const CopyType copyType=DEEP)
 
virtual ~intGridCollectionFunction ()
 
virtual intGridCollectionFunction & operator= (const intGridCollectionFunction &cgf)
 
virtual intMappedGridFunction & operator[] (const int grid) const
 
intGridCollectionFunction 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 intGridCollectionFunction &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 intGridCollectionFunction &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 intGridCollectionFunction &gcf, const int componentToLinkTo=0, const int numberOfComponents=1)
 
virtual void reference (const intGridCollectionFunction &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 GridCollection * getGridCollection (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 intGridCollectionFunction &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 intGridCollectionFunction &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)
 
GridCollectionOperators * getOperators () const
 
virtual void setOperators (GenericCollectionOperators &operators)
 
COLLECTION_FUNCTION & operator+ (const COLLECTION_FUNCTION &cgf) const
 
COLLECTION_FUNCTION & operator- (const COLLECTION_FUNCTION &cgf) const
 
COLLECTION_FUNCTION & operator* (const COLLECTION_FUNCTION &cgf) const
 
COLLECTION_FUNCTION & operator/ (const COLLECTION_FUNCTION &cgf) const
 
COLLECTION_FUNCTION & operator+= (const COLLECTION_FUNCTION &cgf)
 
COLLECTION_FUNCTION & operator-= (const COLLECTION_FUNCTION &cgf)
 
COLLECTION_FUNCTION & operator*= (const COLLECTION_FUNCTION &cgf)
 
COLLECTION_FUNCTION & operator/= (const COLLECTION_FUNCTION &cgf)
 
COLLECTION_FUNCTION & operator+ () const
 
COLLECTION_FUNCTION & operator- () const
 
COLLECTION_FUNCTION & operator= (const INTEGRAL_TYPE value)
 
COLLECTION_FUNCTION & operator+ (const INTEGRAL_TYPE value) const
 
COLLECTION_FUNCTION & operator- (const INTEGRAL_TYPE value) const
 
COLLECTION_FUNCTION & operator* (const INTEGRAL_TYPE value) const
 
COLLECTION_FUNCTION & operator/ (const INTEGRAL_TYPE value) const
 
COLLECTION_FUNCTION & operator+= (const INTEGRAL_TYPE value)
 
COLLECTION_FUNCTION & operator-= (const INTEGRAL_TYPE value)
 
COLLECTION_FUNCTION & operator*= (const INTEGRAL_TYPE value)
 
COLLECTION_FUNCTION & operator/= (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 intGenericGridCollectionFunction
 intGenericGridCollectionFunction ()
 
 intGenericGridCollectionFunction (const intGenericGridCollectionFunction &, const CopyType=DEEP)
 
virtual ~intGenericGridCollectionFunction ()
 
 intGenericGridCollectionFunction (GenericGridCollection *gridList)
 
intGenericGridCollectionFunction & operator= (const intGenericGridCollectionFunction &X)
 
intGenericGridFunction & operator[] (const int grid)
 
void reference (const intGenericGridCollectionFunction &)
 
- 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

ListOfIntMappedGridFunction mappedGridFunctionList
 
ListOfIntGridCollectionFunction baseGrid
 
ListOfIntGridCollectionFunction multigridLevel
 
ListOfIntGridCollectionFunction refinementLevel
 
GridCollectionData * gridCollectionData
 
GridCollection * gridCollection
 
GenericCollectionOperators * operators
 
SparseRepForGCF * sparse
 
- Public Attributes inherited from intGenericGridCollectionFunction
ListOfIntGenericGridFunction genericGridFunctionList
 
GenericGridCollection * gridList
 

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
 
RCData * rcData
 

Friends

intGridCollectionFunction & abs (const intGridCollectionFunction &cgf)
 
COLLECTION_FUNCTION & operator+ (const INTEGRAL_TYPE value, const COLLECTION_FUNCTION &cgf)
 
COLLECTION_FUNCTION & operator- (const INTEGRAL_TYPE value, const COLLECTION_FUNCTION &cgf)
 
COLLECTION_FUNCTION & operator* (const INTEGRAL_TYPE value, const COLLECTION_FUNCTION &cgf)
 
COLLECTION_FUNCTION & operator/ (const INTEGRAL_TYPE value, const COLLECTION_FUNCTION &cgf)
 
INTEGRAL_TYPE max (const COLLECTION_FUNCTION &cgf)
 
INTEGRAL_TYPE min (const COLLECTION_FUNCTION &cgf)
 
intGridCollectionFunction & multiply (const intGridCollectionFunction &a, const intGridCollectionFunction &coeff)
 
intGridCollectionFunction evaluate (intGridCollectionFunction &u)
 

Member Enumeration Documentation

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

Constructor & Destructor Documentation

intGridCollectionFunction::intGridCollectionFunction ( )

References initialize(), NULL, and rcData.

Referenced by operator()().

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

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

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

Member Function Documentation

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

References numberOfGrids(), and temporary.

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

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

Referenced by checkGrid(), and main().

void intGridCollectionFunction::display ( const aString &  label,
const aString &  format 
) const
virtual

References display(), and NULL.

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

References display().

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

References numberOfGrids().

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

References Overture::abort().

int intGridCollectionFunction::getComponentBound ( int  component) const

References Overture::abort().

int intGridCollectionFunction::getComponentDimension ( int  component) const

References Overture::abort().

int intGridCollectionFunction::getCoordinateBase ( int  coordinate) const

References Overture::abort().

int intGridCollectionFunction::getCoordinateBound ( int  coordinate) const

References Overture::abort().

int intGridCollectionFunction::getCoordinateDimension ( int  coordinate) const

References Overture::abort().

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

References Overture::abort(), and NULL.

Referenced by assign(), and multiply().

GridFunctionParameters::GridFunctionType intGridCollectionFunction::getGridFunctionType ( const Index &  component0 = nullIndex,
const Index &  component1 = nullIndex,
const Index &  component2 = nullIndex,
const Index &  component3 = nullIndex,
const Index &  component4 = nullIndex 
) const
GridFunctionParameters::GridFunctionTypeWithComponents intGridCollectionFunction::getGridFunctionTypeWithComponents ( const Index &  component0 = nullIndex,
const Index &  component1 = nullIndex,
const Index &  component2 = nullIndex,
const Index &  component3 = nullIndex,
const Index &  component4 = nullIndex 
) const
bool intGridCollectionFunction::getIsACoefficientMatrix ( ) const
bool intGridCollectionFunction::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 intGridCollectionFunction::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 intGridCollectionFunction::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 intGridCollectionFunction::getNumberOfComponents ( ) const
GridCollectionOperators * intGridCollectionFunction::getOperators ( ) const

References NULL, and operators.

Referenced by setOperators().

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

Reimplemented in intCompositeGridFunction.

Referenced by interpolate().

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

References gridCollection, and NULL.

Referenced by CompositeGridData::operator=().

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

Reimplemented in intCompositeGridFunction.

References link(), and R.

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

Set the data allocation option.

References dataAllocationOption.

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

Reimplemented in intCompositeGridFunction.

References gridCollection, and updateToMatchGrid().

intGridCollectionFunction::updateReturnValue intGridCollectionFunction::updateToMatchGrid ( GridCollection &  grid,
const GridFunctionParameters::GridFunctionType &  type 
)
virtual
intGridCollectionFunction::updateReturnValue intGridCollectionFunction::updateToMatchGrid ( const GridFunctionParameters::GridFunctionType &  type)
virtual
intGridCollectionFunction::updateReturnValue intGridCollectionFunction::updateToMatchGrid ( GridCollection &  gridCollection)
virtual
intGridCollectionFunction::updateReturnValue intGridCollectionFunction::updateToMatchGrid ( GridCollectionData &  gridCollection)
virtual
intGridCollectionFunction::updateReturnValue intGridCollectionFunction::updateToMatchGridFunction ( const intGridCollectionFunction &  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
intGridCollectionFunction::updateReturnValue intGridCollectionFunction::updateToMatchGridFunction ( const intGridCollectionFunction &  gcf)
virtual
intGridCollectionFunction::updateReturnValue intGridCollectionFunction::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
intGridCollectionFunction& multiply ( const intGridCollectionFunction &  a,
const intGridCollectionFunction &  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

ListOfIntGridCollectionFunction intGridCollectionFunction::baseGrid

Referenced by destroy().

aString intGridCollectionFunction::className
protected
int intGridCollectionFunction::dataAllocationOption
protected
GridCollection* intGridCollectionFunction::gridCollection
GridCollectionData* intGridCollectionFunction::gridCollectionData
ListOfIntMappedGridFunction intGridCollectionFunction::mappedGridFunctionList
ListOfIntGridCollectionFunction intGridCollectionFunction::multigridLevel
GenericCollectionOperators* intGridCollectionFunction::operators
RCData* intGridCollectionFunction::rcData
protected
ListOfIntGridCollectionFunction intGridCollectionFunction::refinementLevel
SparseRepForGCF* intGridCollectionFunction::sparse
bool intGridCollectionFunction::temporary
protected

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