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

#include <doubleMappedGridFunction.h>

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

Public Types

enum  {
  maximumNumberOfIndicies =doubleMappedGridFunctionRCData::maximumNumberOfIndicies, numberOfIndicies =doubleMappedGridFunctionRCData::numberOfIndicies, maximumNumberOfComponents =5, undefinedValue =-999,
  defaultValue =-998, forAll =-997
}
 
enum  edgeGridFunctionValues { startingGridIndex =-(INT_MAX/2), biggerNegativeNumber =startingGridIndex/2, endingGridIndex =biggerNegativeNumber/2, bigNegativeNumber =endingGridIndex/2 }
 
enum  stencilTypes { standardStencil, starStencil, generalStencil }
 
enum  updateReturnValue { updateNoChange = 0, updateReshaped = 1, updateResized = 2, updateComponentsChanged = 4 }
 
enum  UpdateToMatchGridOption { updateSize =1, updateCoefficientMatrix =2 }
 

Public Member Functions

 doubleMappedGridFunction ()
 
 doubleMappedGridFunction (MappedGrid &grid)
 
 doubleMappedGridFunction (const doubleMappedGridFunction &cgf, const CopyType copyType=DEEP)
 
 doubleMappedGridFunction (MappedGridData &gridData)
 
 doubleMappedGridFunction (MappedGrid &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)
 
 doubleMappedGridFunction (MappedGridData &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)
 
 doubleMappedGridFunction (MappedGrid &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)
 
 doubleMappedGridFunction (MappedGridData &gridData, 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)
 
 doubleMappedGridFunction (MappedGrid &mg, const GridFunctionParameters::GridFunctionType &type, const Range &component0=nullRange, const Range &component1=nullRange, const Range &component2=nullRange, const Range &component3=nullRange, const Range &component4=nullRange)
 
 doubleMappedGridFunction (const GridFunctionParameters::GridFunctionType &type, const Range &component0=nullRange, const Range &component1=nullRange, const Range &component2=nullRange, const Range &component3=nullRange, const Range &component4=nullRange)
 
 ~doubleMappedGridFunction ()
 
doubleMappedGridFunctionoperator= (const doubleMappedGridFunction &cgf)
 
doubleMappedGridFunctionoperator= (const double x)
 
doubleMappedGridFunctionoperator= (const doubleDistributedArray &X)
 
double & operator() (const int &i0) const
 
double & operator() (const int &i0, const int &i1) const
 
double & operator() (const int &i0, const int &i1, const int i2) const
 
double & operator() (const int &i0, const int &i1, const int &i2, const int &i3) const
 
double & operator() (const int &i0, const int &i1, const int &i2, const int &i3, const int &i4) const
 
double & operator() (const int &i0, const int &i1, const int &i2, const int &i3, const int &i4, const int &i5) const
 
double & operator() (const int &i0, const int &i1, const int &i2, const int &i3, const int &i4, const int &i5, const int &i6) const
 
double & operator() (const int &i0, const int &i1, const int &i2, const int &i3, const int &i4, const int &i5, const int &i6, const int &i7) const
 
doubleDistributedArray operator() (const IndexArg &I0) const
 
doubleDistributedArray operator() (const IndexArg &I0, const IndexArg &I1) const
 
doubleDistributedArray operator() (const IndexArg &I0, const IndexArg &I1, const IndexArg &I2) const
 
doubleDistributedArray operator() (const IndexArg &I0, const IndexArg &I1, const IndexArg &I2, const IndexArg &I3) const
 
doubleDistributedArray operator() (const IndexArg &I0, const IndexArg &I1, const IndexArg &I2, const IndexArg &I3, const int &i4) const
 
doubleDistributedArray operator() (const IndexArg &I0, const IndexArg &I1, const IndexArg &I2, const IndexArg &I3, const IndexArg &I4) const
 
doubleDistributedArray operator() (const IndexArg &I0, const IndexArg &I1, const IndexArg &I2, const IndexArg &I3, const int &i4, const int &i5) const
 
doubleDistributedArray operator() (const IndexArg &I0, const IndexArg &I1, const IndexArg &I2, const IndexArg &I3, const IndexArg &I4, const IndexArg &I5) const
 
doubleDistributedArray operator() (const IndexArg &I0, const IndexArg &I1, const IndexArg &I2, const IndexArg &I3, const int &i4, const int &i5, const int &i6) const
 
doubleDistributedArray operator() (const IndexArg &I0, const IndexArg &I1, const IndexArg &I2, const IndexArg &I3, const IndexArg &I4, const IndexArg &I5, const IndexArg &I6) const
 
doubleDistributedArray operator() (const IndexArg &I0, const IndexArg &I1, const IndexArg &I2, const IndexArg &I3, const int &i4, const int &i5, const int &i6, const int &i7) const
 
doubleDistributedArray operator() (const IndexArg &I0, const IndexArg &I1, const IndexArg &I2, const IndexArg &I3, const IndexArg &I4, const IndexArg &I5, const IndexArg &I6, const IndexArg &I7) const
 
int arg3 (int i3, int i4, int i5=defaultValue, int i6=defaultValue, int i7=defaultValue) const
 
double & sa (const int &i0, const int &i1, const int &i2, const int &c0=0, const int &c1=0, const int &c2=0, const int &c3=0, const int &c4=0) const
 
int positionOfComponent (int i) const
 
int positionOfCoordinate (int i) const
 
doubleSerialArray & getSerialArray ()
 
const doubleSerialArray & getSerialArray () 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
 
MappedGridgetMappedGrid (const bool abortIfNull=TRUE) 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 ()
 
void setIsACoefficientMatrix (const bool trueOrFalse=TRUE, const int stencilSize=defaultValue, const int numberOfGhostLines=1, const int numberOfComponentsForCoefficients=1, const int offset=0)
 
void setIsACoefficientMatrix (SparseRepForMGF *sparseRep)
 
bool getIsACoefficientMatrix () const
 
void setStencilType (const stencilTypes stencilType, const int stencilWidth=defaultValue)
 
stencilTypes getStencilType () const
 
int getStencilWidth () const
 
virtual int setCoefficientIndex (const int &m, const int &na, const Index &I1a, const Index &I2a, const Index &I3a, const int &nb, const Index &I1b, const Index &I2b, const Index &I3b)
 
int positionOfCoefficient (const int m1, const int m2, const int m3, const int component) const
 
int dataCopy (const doubleMappedGridFunction &mgf)
 
void getRanges (Range &R0, Range &R1, Range &R2, Range &R3, Range &R4, Range &R5, Range &R6, Range &R7)
 
void link (const doubleMappedGridFunction &mgf, const Range &R0, const Range &R1=nullRange, const Range &R2=nullRange, const Range &R3=nullRange, const Range &R4=nullRange)
 
void link (const doubleMappedGridFunction &mgf, const int componentToLinkTo=0, const int numberOfComponents=1)
 
int numberOfDimensions () const
 
int numberOfComponents () const
 
int positionOfFaceCentering () const
 
int destroy ()
 
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)
 
updateReturnValue updateToMatchGrid (MappedGridData &gridData)
 
updateReturnValue updateToMatchGrid (MappedGrid &grid)
 
updateReturnValue updateToMatchGrid ()
 
updateReturnValue updateToMatchGrid (MappedGridData &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)
 
updateReturnValue updateToMatchGrid (MappedGrid &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)
 
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)
 
updateReturnValue updateToMatchGrid (MappedGrid &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)
 
updateReturnValue updateToMatchGrid (MappedGrid &grid, const GridFunctionParameters::GridFunctionType &type, const Range &component0, const Range &component1=nullRange, const Range &component2=nullRange, const Range &component3=nullRange, const Range &component4=nullRange)
 
updateReturnValue updateToMatchGrid (MappedGridData &grid, const GridFunctionParameters::GridFunctionType &type, const Range &component0, const Range &component1=nullRange, const Range &component2=nullRange, const Range &component3=nullRange, const Range &component4=nullRange)
 
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)
 
updateReturnValue updateToMatchGrid (MappedGrid &grid, const GridFunctionParameters::GridFunctionType &type)
 
updateReturnValue updateToMatchGrid (const GridFunctionParameters::GridFunctionType &type)
 
updateReturnValue updateToMatchGridFunction (const doubleMappedGridFunction &cgf)
 
updateReturnValue updateToMatchGridFunction (const doubleMappedGridFunction &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)
 
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
 
void reference (const doubleMappedGridFunction &cgf)
 
void breakReference ()
 
virtual int get (const GenericDataBase &dir, const aString &name)
 
virtual int put (GenericDataBase &dir, const aString &name) const
 
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
 
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)
 
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
 
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)
 
GridFunctionParameters::faceCenteringType getFaceCentering () const
 
void setFaceCentering (const int &axis=defaultValue)
 
MappedGridOperatorsgetOperators () const
 
void setOperators (GenericMappedGridOperators &operators)
 
void setUpdateToMatchGridOption (const UpdateToMatchGridOption &updateToMatchGridOption)
 
virtual real sizeOf (FILE *file=NULL) const
 
virtual int fixupUnusedPoints (const RealArray &value=Overture::nullRealArray(), int numberOfGhostlines=1)
 
virtual doubleMappedGridFunction convectiveDerivative (const doubleMappedGridFunction &w, const Index &I1=nullIndex, const Index &I2=nullIndex, const Index &I3=nullIndex) const
 
virtual doubleMappedGridFunction convectiveDerivative (const GridFunctionParameters &gfType, const doubleMappedGridFunction &w, const Index &I1=nullIndex, const Index &I2=nullIndex, const Index &I3=nullIndex) const
 
virtual doubleMappedGridFunction derivativeScalarDerivative (const doubleMappedGridFunction &s, const int &direction1, const int &direction2, const Index &I1=nullIndex, const Index &I2=nullIndex, const Index &I3=nullIndex, const Index &I4=nullIndex, const Index &I5=nullIndex, const Index &I6=nullIndex, const Index &I7=nullIndex, const Index &I8=nullIndex) const
 
virtual doubleMappedGridFunction derivativeScalarDerivative (const GridFunctionParameters &gfType, const doubleMappedGridFunction &s, const int &direction1, const int &direction2, const Index &I1=nullIndex, const Index &I2=nullIndex, const Index &I3=nullIndex, const Index &I4=nullIndex, const Index &I5=nullIndex, const Index &I6=nullIndex, const Index &I7=nullIndex, const Index &I8=nullIndex) const
 
virtual doubleMappedGridFunction derivativeScalarDerivativeCoefficients (const doubleMappedGridFunction &s, const int &direction1, const int &direction2, const Index &I1=nullIndex, const Index &I2=nullIndex, const Index &I3=nullIndex, const Index &I4=nullIndex, const Index &I5=nullIndex, const Index &I6=nullIndex, const Index &I7=nullIndex, const Index &I8=nullIndex) const
 
virtual doubleMappedGridFunction derivativeScalarDerivativeCoefficients (const GridFunctionParameters &gfType, const doubleMappedGridFunction &s, const int &direction1, const int &direction2, const Index &I1=nullIndex, const Index &I2=nullIndex, const Index &I3=nullIndex, const Index &I4=nullIndex, const Index &I5=nullIndex, const Index &I6=nullIndex, const Index &I7=nullIndex, const Index &I8=nullIndex) const
 
virtual doubleMappedGridFunction FCgrad (const int c0=0, const int c1=0, const int c2=0, const int c3=0, const int c4=0, const Index &I1=nullIndex, const Index &I2=nullIndex, const Index &I3=nullIndex, const Index &I4=nullIndex, const Index &I5=nullIndex, const Index &I6=nullIndex, const Index &I7=nullIndex, const Index &I8=nullIndex) const
 
virtual doubleMappedGridFunction 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 Index &I1=nullIndex, const Index &I2=nullIndex, const Index &I3=nullIndex, const Index &I4=nullIndex, const Index &I5=nullIndex, const Index &I6=nullIndex, const Index &I7=nullIndex, const Index &I8=nullIndex) const
 
virtual void applyBoundaryConditions (const real &time=0.)
 
virtual void assignBoundaryConditionCoefficients (const real &time=0.)
 
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(), const int &grid=0)
 
void applyBoundaryCondition (const Index &Components, const BCTypes::BCNames &boundaryConditionType, const int &boundaryCondition, const RealArray &forcing, const real &time=0., const BoundaryConditionParameters &bcParameters=Overture::defaultBoundaryConditionParameters(), const int &grid=0)
 
void applyBoundaryCondition (const Index &Components, const BCTypes::BCNames &boundaryConditionType, const int &boundaryCondition, const RealArray &forcing, RealArray *forcinga[2][3], const real &time=0., const BoundaryConditionParameters &bcParameters=Overture::defaultBoundaryConditionParameters(), const int &grid=0)
 
void applyBoundaryCondition (const Index &Components, const BCTypes::BCNames &boundaryConditionType, const int &boundaryCondition, const doubleMappedGridFunction &forcing, const real &time=0., const BoundaryConditionParameters &bcParameters=Overture::defaultBoundaryConditionParameters(), const int &grid=0)
 
void finishBoundaryConditions (const BoundaryConditionParameters &bcParameters=Overture::defaultBoundaryConditionParameters(), const Range &C0=nullRange)
 
void applyBoundaryConditionCoefficients (const Index &Equation, const Index &Component, const BCTypes::BCNames &boundaryConditionType=BCTypes::dirichlet, const int &boundaryCondition=BCTypes::allBoundaries, const BoundaryConditionParameters &bcParameters=Overture::defaultBoundaryConditionParameters(), const int &grid=0)
 
void getDerivatives (const Index &I1=nullIndex, const Index &I2=nullIndex, const Index &I3=nullIndex, const Index &I4=nullIndex, const Index &I5=nullIndex, const Index &I6=nullIndex, const Index &I7=nullIndex, const Index &I8=nullIndex) const
 
- Public Member Functions inherited from doubleGenericGridFunction
 doubleGenericGridFunction ()
 
 doubleGenericGridFunction (const doubleGenericGridFunction &, const CopyType=DEEP)
 
 ~doubleGenericGridFunction ()
 
 doubleGenericGridFunction (GenericGrid *grid0)
 
doubleGenericGridFunctionoperator= (const doubleGenericGridFunction &X)
 
void reference (const doubleGenericGridFunction &)
 
- 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)
 
virtual void consistencyCheck () const
 

Public Attributes

MappedGridDatagrid
 
MappedGridmappedGrid
 
GenericMappedGridOperatorsoperators
 
SparseRepForMGFsparse
 
IntegerArray isCellCentered
 
- Public Attributes inherited from doubleGenericGridFunction
GenericGridgrid
 

Protected Member Functions

void setNumberOfDimensions (const int &number)
 
void setNumberOfComponents (const int &number)
 
int faceCentering () const
 
int isACoefficientMatrix () const
 
int stencilType () const
 
int stencilWidth () const
 
void setPositionOfFaceCentering (const int &position)
 

Friends

class doubleGridCollectionFunction
 

Member Enumeration Documentation

anonymous enum
Enumerator
maximumNumberOfIndicies 
numberOfIndicies 
maximumNumberOfComponents 
undefinedValue 
defaultValue 
forAll 
Enumerator
startingGridIndex 
biggerNegativeNumber 
endingGridIndex 
bigNegativeNumber 
Enumerator
standardStencil 
starStencil 
generalStencil 
Enumerator
updateNoChange 
updateReshaped 
updateResized 
updateComponentsChanged 
Enumerator
updateSize 
updateCoefficientMatrix 

Constructor & Destructor Documentation

doubleMappedGridFunction::doubleMappedGridFunction ( )
doubleMappedGridFunction::doubleMappedGridFunction ( MappedGrid grid)
doubleMappedGridFunction::doubleMappedGridFunction ( const doubleMappedGridFunction cgf,
const CopyType  copyType = DEEP 
)
doubleMappedGridFunction::doubleMappedGridFunction ( MappedGridData gridData)
doubleMappedGridFunction::doubleMappedGridFunction ( MappedGrid 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 
)
doubleMappedGridFunction::doubleMappedGridFunction ( MappedGridData 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 
)
doubleMappedGridFunction::doubleMappedGridFunction ( MappedGrid 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 
)
doubleMappedGridFunction::doubleMappedGridFunction ( MappedGridData gridData,
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 
)
doubleMappedGridFunction::doubleMappedGridFunction ( MappedGrid mg,
const GridFunctionParameters::GridFunctionType type,
const Range &  component0 = nullRange,
const Range &  component1 = nullRange,
const Range &  component2 = nullRange,
const Range &  component3 = nullRange,
const Range &  component4 = nullRange 
)
doubleMappedGridFunction::doubleMappedGridFunction ( const GridFunctionParameters::GridFunctionType type,
const Range &  component0 = nullRange,
const Range &  component1 = nullRange,
const Range &  component2 = nullRange,
const Range &  component3 = nullRange,
const Range &  component4 = nullRange 
)
doubleMappedGridFunction::~doubleMappedGridFunction ( )

Member Function Documentation

void doubleMappedGridFunction::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(),
const int &  grid = 0 
)
void doubleMappedGridFunction::applyBoundaryCondition ( const Index &  Components,
const BCTypes::BCNames boundaryConditionType,
const int &  boundaryCondition,
const RealArray forcing,
const real time = 0.,
const BoundaryConditionParameters bcParameters = Overture::defaultBoundaryConditionParameters(),
const int &  grid = 0 
)
void doubleMappedGridFunction::applyBoundaryCondition ( const Index &  Components,
const BCTypes::BCNames boundaryConditionType,
const int &  boundaryCondition,
const RealArray forcing,
RealArray forcinga[2][3],
const real time = 0.,
const BoundaryConditionParameters bcParameters = Overture::defaultBoundaryConditionParameters(),
const int &  grid = 0 
)
void doubleMappedGridFunction::applyBoundaryCondition ( const Index &  Components,
const BCTypes::BCNames boundaryConditionType,
const int &  boundaryCondition,
const doubleMappedGridFunction forcing,
const real time = 0.,
const BoundaryConditionParameters bcParameters = Overture::defaultBoundaryConditionParameters(),
const int &  grid = 0 
)
void doubleMappedGridFunction::applyBoundaryConditionCoefficients ( const Index &  Equation,
const Index &  Component,
const BCTypes::BCNames boundaryConditionType = BCTypes::dirichlet,
const int &  boundaryCondition = BCTypes::allBoundaries,
const BoundaryConditionParameters bcParameters = Overture::defaultBoundaryConditionParameters(),
const int &  grid = 0 
)
void doubleMappedGridFunction::applyBoundaryConditions ( const real time = 0.)
virtual
int doubleMappedGridFunction::arg3 ( int  i3,
int  i4,
int  i5 = defaultValue,
int  i6 = defaultValue,
int  i7 = defaultValue 
) const

References defaultValue.

void doubleMappedGridFunction::assignBoundaryConditionCoefficients ( const real time = 0.)
virtual
void doubleMappedGridFunction::breakReference ( void  )
virtual
virtual doubleMappedGridFunction doubleMappedGridFunction::convectiveDerivative ( const doubleMappedGridFunction w,
const Index &  I1 = nullIndex,
const Index &  I2 = nullIndex,
const Index &  I3 = nullIndex 
) const
virtual
virtual doubleMappedGridFunction doubleMappedGridFunction::convectiveDerivative ( const GridFunctionParameters gfType,
const doubleMappedGridFunction w,
const Index &  I1 = nullIndex,
const Index &  I2 = nullIndex,
const Index &  I3 = nullIndex 
) const
virtual
int doubleMappedGridFunction::dataCopy ( const doubleMappedGridFunction mgf)
virtual doubleMappedGridFunction doubleMappedGridFunction::derivativeScalarDerivative ( const doubleMappedGridFunction s,
const int &  direction1,
const int &  direction2,
const Index &  I1 = nullIndex,
const Index &  I2 = nullIndex,
const Index &  I3 = nullIndex,
const Index &  I4 = nullIndex,
const Index &  I5 = nullIndex,
const Index &  I6 = nullIndex,
const Index &  I7 = nullIndex,
const Index &  I8 = nullIndex 
) const
virtual
virtual doubleMappedGridFunction doubleMappedGridFunction::derivativeScalarDerivative ( const GridFunctionParameters gfType,
const doubleMappedGridFunction s,
const int &  direction1,
const int &  direction2,
const Index &  I1 = nullIndex,
const Index &  I2 = nullIndex,
const Index &  I3 = nullIndex,
const Index &  I4 = nullIndex,
const Index &  I5 = nullIndex,
const Index &  I6 = nullIndex,
const Index &  I7 = nullIndex,
const Index &  I8 = nullIndex 
) const
virtual
virtual doubleMappedGridFunction doubleMappedGridFunction::derivativeScalarDerivativeCoefficients ( const doubleMappedGridFunction s,
const int &  direction1,
const int &  direction2,
const Index &  I1 = nullIndex,
const Index &  I2 = nullIndex,
const Index &  I3 = nullIndex,
const Index &  I4 = nullIndex,
const Index &  I5 = nullIndex,
const Index &  I6 = nullIndex,
const Index &  I7 = nullIndex,
const Index &  I8 = nullIndex 
) const
virtual
virtual doubleMappedGridFunction doubleMappedGridFunction::derivativeScalarDerivativeCoefficients ( const GridFunctionParameters gfType,
const doubleMappedGridFunction s,
const int &  direction1,
const int &  direction2,
const Index &  I1 = nullIndex,
const Index &  I2 = nullIndex,
const Index &  I3 = nullIndex,
const Index &  I4 = nullIndex,
const Index &  I5 = nullIndex,
const Index &  I6 = nullIndex,
const Index &  I7 = nullIndex,
const Index &  I8 = nullIndex 
) const
virtual
int doubleMappedGridFunction::destroy ( )
int doubleMappedGridFunction::faceCentering ( ) const
inlineprotected
virtual doubleMappedGridFunction doubleMappedGridFunction::FCgrad ( const int  c0 = 0,
const int  c1 = 0,
const int  c2 = 0,
const int  c3 = 0,
const int  c4 = 0,
const Index &  I1 = nullIndex,
const Index &  I2 = nullIndex,
const Index &  I3 = nullIndex,
const Index &  I4 = nullIndex,
const Index &  I5 = nullIndex,
const Index &  I6 = nullIndex,
const Index &  I7 = nullIndex,
const Index &  I8 = nullIndex 
) const
virtual
virtual doubleMappedGridFunction doubleMappedGridFunction::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 Index &  I1 = nullIndex,
const Index &  I2 = nullIndex,
const Index &  I3 = nullIndex,
const Index &  I4 = nullIndex,
const Index &  I5 = nullIndex,
const Index &  I6 = nullIndex,
const Index &  I7 = nullIndex,
const Index &  I8 = nullIndex 
) const
virtual
void doubleMappedGridFunction::finishBoundaryConditions ( const BoundaryConditionParameters bcParameters = Overture::defaultBoundaryConditionParameters(),
const Range &  C0 = nullRange 
)
int doubleMappedGridFunction::fixupUnusedPoints ( const RealArray value = Overture::nullRealArray(),
int  numberOfGhostlines = 1 
)
virtual
int doubleMappedGridFunction::get ( const GenericDataBase dir,
const aString name 
)
virtual
aString doubleMappedGridFunction::getClassName ( void  ) const
virtual
int doubleMappedGridFunction::getComponentBase ( int  component) const
int doubleMappedGridFunction::getComponentBound ( int  component) const
int doubleMappedGridFunction::getComponentDimension ( int  component) const
int doubleMappedGridFunction::getCoordinateBase ( int  coordinate) const
int doubleMappedGridFunction::getCoordinateBound ( int  coordinate) const
int doubleMappedGridFunction::getCoordinateDimension ( int  coordinate) const
void doubleMappedGridFunction::getDerivatives ( const Index &  I1 = nullIndex,
const Index &  I2 = nullIndex,
const Index &  I3 = nullIndex,
const Index &  I4 = nullIndex,
const Index &  I5 = nullIndex,
const Index &  I6 = nullIndex,
const Index &  I7 = nullIndex,
const Index &  I8 = nullIndex 
) const
GridFunctionParameters::faceCenteringType doubleMappedGridFunction::getFaceCentering ( ) const

Referenced by setFaceCentering().

GridFunctionParameters::GridFunctionType doubleMappedGridFunction::getGridFunctionType ( const Index &  component0 = nullIndex,
const Index &  component1 = nullIndex,
const Index &  component2 = nullIndex,
const Index &  component3 = nullIndex,
const Index &  component4 = nullIndex 
) const
GridFunctionParameters::GridFunctionTypeWithComponents doubleMappedGridFunction::getGridFunctionTypeWithComponents ( const Index &  component0 = nullIndex,
const Index &  component1 = nullIndex,
const Index &  component2 = nullIndex,
const Index &  component3 = nullIndex,
const Index &  component4 = nullIndex 
) const

References assert, GridFunctionParameters::cellCentered, GridFunctionParameters::cellCenteredWith0Components, GridFunctionParameters::cellCenteredWith1Component, GridFunctionParameters::cellCenteredWith2Components, GridFunctionParameters::cellCenteredWith3Components, GridFunctionParameters::cellCenteredWith4Components, GridFunctionParameters::cellCenteredWith5Components, GridFunctionParameters::faceCenteredAll, GridFunctionParameters::faceCenteredAllWith0Components, GridFunctionParameters::faceCenteredAllWith1Component, GridFunctionParameters::faceCenteredAllWith2Components, GridFunctionParameters::faceCenteredAllWith3Components, GridFunctionParameters::faceCenteredAllWith4Components, GridFunctionParameters::faceCenteredAllWith5Components, GridFunctionParameters::faceCenteredAxis1, GridFunctionParameters::faceCenteredAxis1With0Components, GridFunctionParameters::faceCenteredAxis1With1Component, GridFunctionParameters::faceCenteredAxis1With2Components, GridFunctionParameters::faceCenteredAxis1With3Components, GridFunctionParameters::faceCenteredAxis1With4Components, GridFunctionParameters::faceCenteredAxis1With5Components, GridFunctionParameters::faceCenteredAxis2, GridFunctionParameters::faceCenteredAxis2With0Components, GridFunctionParameters::faceCenteredAxis2With1Component, GridFunctionParameters::faceCenteredAxis2With2Components, GridFunctionParameters::faceCenteredAxis2With3Components, GridFunctionParameters::faceCenteredAxis2With4Components, GridFunctionParameters::faceCenteredAxis2With5Components, GridFunctionParameters::faceCenteredAxis3, GridFunctionParameters::faceCenteredAxis3With0Components, GridFunctionParameters::faceCenteredAxis3With1Component, GridFunctionParameters::faceCenteredAxis3With2Components, GridFunctionParameters::faceCenteredAxis3With3Components, GridFunctionParameters::faceCenteredAxis3With4Components, GridFunctionParameters::faceCenteredAxis3With5Components, GridFunctionParameters::general, GridFunctionParameters::generalWith0Components, GridFunctionParameters::generalWith1Component, GridFunctionParameters::generalWith2Components, GridFunctionParameters::generalWith3Components, GridFunctionParameters::generalWith4Components, GridFunctionParameters::generalWith5Components, doubleGridCollectionFunction::getGridFunctionType(), GridFunctionParameters::vertexCentered, GridFunctionParameters::vertexCenteredWith0Components, GridFunctionParameters::vertexCenteredWith1Component, GridFunctionParameters::vertexCenteredWith2Components, GridFunctionParameters::vertexCenteredWith3Components, GridFunctionParameters::vertexCenteredWith4Components, and GridFunctionParameters::vertexCenteredWith5Components.

bool doubleMappedGridFunction::getIsACoefficientMatrix ( ) const
bool doubleMappedGridFunction::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
bool doubleMappedGridFunction::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
MappedGrid * doubleMappedGridFunction::getMappedGrid ( const bool  abortIfNull = TRUE) const
aString doubleMappedGridFunction::getName ( const int &  component0 = defaultValue,
const int &  component1 = defaultValue,
const int &  component2 = defaultValue,
const int &  component3 = defaultValue,
const int &  component4 = defaultValue 
) const
int doubleMappedGridFunction::getNumberOfComponents ( ) const
MappedGridOperators * doubleMappedGridFunction::getOperators ( ) const
void doubleMappedGridFunction::getRanges ( Range &  R0,
Range &  R1,
Range &  R2,
Range &  R3,
Range &  R4,
Range &  R5,
Range &  R6,
Range &  R7 
)
doubleSerialArray & doubleMappedGridFunction::getSerialArray ( )
const doubleSerialArray & doubleMappedGridFunction::getSerialArray ( ) const
doubleMappedGridFunction::stencilTypes doubleMappedGridFunction::getStencilType ( ) const
int doubleMappedGridFunction::getStencilWidth ( ) const
int doubleMappedGridFunction::isACoefficientMatrix ( ) const
inlineprotected
bool doubleMappedGridFunction::isNull ( )

References mappedGrid, and NULL.

Referenced by operator=().

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

References link().

int doubleMappedGridFunction::numberOfComponents ( ) const
inline
int doubleMappedGridFunction::numberOfDimensions ( ) const
inline
double& doubleMappedGridFunction::operator() ( const int &  i0) const
inline
double& doubleMappedGridFunction::operator() ( const int &  i0,
const int &  i1 
) const
inline
double& doubleMappedGridFunction::operator() ( const int &  i0,
const int &  i1,
const int  i2 
) const
inline
double& doubleMappedGridFunction::operator() ( const int &  i0,
const int &  i1,
const int &  i2,
const int &  i3 
) const
inline
double& doubleMappedGridFunction::operator() ( const int &  i0,
const int &  i1,
const int &  i2,
const int &  i3,
const int &  i4 
) const
inline
double& doubleMappedGridFunction::operator() ( const int &  i0,
const int &  i1,
const int &  i2,
const int &  i3,
const int &  i4,
const int &  i5 
) const
inline
double& doubleMappedGridFunction::operator() ( const int &  i0,
const int &  i1,
const int &  i2,
const int &  i3,
const int &  i4,
const int &  i5,
const int &  i6 
) const
inline
double& doubleMappedGridFunction::operator() ( const int &  i0,
const int &  i1,
const int &  i2,
const int &  i3,
const int &  i4,
const int &  i5,
const int &  i6,
const int &  i7 
) const
inline
doubleDistributedArray doubleMappedGridFunction::operator() ( const IndexArg I0) const
inline
doubleDistributedArray doubleMappedGridFunction::operator() ( const IndexArg I0,
const IndexArg I1 
) const
inline
doubleDistributedArray doubleMappedGridFunction::operator() ( const IndexArg I0,
const IndexArg I1,
const IndexArg I2 
) const
inline
doubleDistributedArray doubleMappedGridFunction::operator() ( const IndexArg I0,
const IndexArg I1,
const IndexArg I2,
const IndexArg I3 
) const
inline
doubleDistributedArray doubleMappedGridFunction::operator() ( const IndexArg I0,
const IndexArg I1,
const IndexArg I2,
const IndexArg I3,
const int &  i4 
) const
inline
doubleDistributedArray doubleMappedGridFunction::operator() ( const IndexArg I0,
const IndexArg I1,
const IndexArg I2,
const IndexArg I3,
const IndexArg I4 
) const

References Overture::abort().

doubleDistributedArray doubleMappedGridFunction::operator() ( const IndexArg I0,
const IndexArg I1,
const IndexArg I2,
const IndexArg I3,
const int &  i4,
const int &  i5 
) const
inline
doubleDistributedArray doubleMappedGridFunction::operator() ( const IndexArg I0,
const IndexArg I1,
const IndexArg I2,
const IndexArg I3,
const IndexArg I4,
const IndexArg I5 
) const

References Overture::abort().

doubleDistributedArray doubleMappedGridFunction::operator() ( const IndexArg I0,
const IndexArg I1,
const IndexArg I2,
const IndexArg I3,
const int &  i4,
const int &  i5,
const int &  i6 
) const
inline
doubleDistributedArray doubleMappedGridFunction::operator() ( const IndexArg I0,
const IndexArg I1,
const IndexArg I2,
const IndexArg I3,
const IndexArg I4,
const IndexArg I5,
const IndexArg I6 
) const

References Overture::abort().

doubleDistributedArray doubleMappedGridFunction::operator() ( const IndexArg I0,
const IndexArg I1,
const IndexArg I2,
const IndexArg I3,
const int &  i4,
const int &  i5,
const int &  i6,
const int &  i7 
) const
inline
doubleDistributedArray doubleMappedGridFunction::operator() ( const IndexArg I0,
const IndexArg I1,
const IndexArg I2,
const IndexArg I3,
const IndexArg I4,
const IndexArg I5,
const IndexArg I6,
const IndexArg I7 
) const

References Overture::abort().

doubleMappedGridFunction & doubleMappedGridFunction::operator= ( const doubleMappedGridFunction cgf)
doubleMappedGridFunction & doubleMappedGridFunction::operator= ( const double  x)
doubleMappedGridFunction & doubleMappedGridFunction::operator= ( const doubleDistributedArray X)
void doubleMappedGridFunction::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 
)
int doubleMappedGridFunction::positionOfCoefficient ( const int  m1,
const int  m2,
const int  m3,
const int  component 
) const
int doubleMappedGridFunction::positionOfComponent ( int  i) const
inline
int doubleMappedGridFunction::positionOfCoordinate ( int  i) const
inline
int doubleMappedGridFunction::positionOfFaceCentering ( ) const
inline
int doubleMappedGridFunction::put ( GenericDataBase dir,
const aString name 
) const
virtual
void doubleMappedGridFunction::reference ( const doubleMappedGridFunction cgf)
double & doubleMappedGridFunction::sa ( const int &  i0,
const int &  i1,
const int &  i2,
const int &  c0 = 0,
const int &  c1 = 0,
const int &  c2 = 0,
const int &  c3 = 0,
const int &  c4 = 0 
) const
int doubleMappedGridFunction::setCoefficientIndex ( const int &  m,
const int &  na,
const Index &  I1a,
const Index &  I2a,
const Index &  I3a,
const int &  nb,
const Index &  I1b,
const Index &  I2b,
const Index &  I3b 
)
virtual
void doubleMappedGridFunction::setFaceCentering ( const int &  axis = defaultValue)
void doubleMappedGridFunction::setIsACoefficientMatrix ( const bool  trueOrFalse = TRUE,
const int  stencilSize = defaultValue,
const int  numberOfGhostLines = 1,
const int  numberOfComponentsForCoefficients = 1,
const int  offset = 0 
)
void doubleMappedGridFunction::setIsACoefficientMatrix ( SparseRepForMGF sparseRep)
void doubleMappedGridFunction::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 
)
void doubleMappedGridFunction::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 
)
void doubleMappedGridFunction::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 doubleMappedGridFunction::setNumberOfComponents ( const int &  number)
protected
void doubleMappedGridFunction::setNumberOfDimensions ( const int &  number)
protected
void doubleMappedGridFunction::setOperators ( GenericMappedGridOperators operators)

References operators.

Referenced by main(), and EllipticGridGenerator::setup().

void doubleMappedGridFunction::setPositionOfFaceCentering ( const int &  position)
protected
void doubleMappedGridFunction::setStencilType ( const stencilTypes  stencilType,
const int  stencilWidth = defaultValue 
)
void doubleMappedGridFunction::setUpdateToMatchGridOption ( const UpdateToMatchGridOption updateToMatchGridOption)

References assert, and NULL.

real doubleMappedGridFunction::sizeOf ( FILE *  file = NULL) const
virtual
int doubleMappedGridFunction::stencilType ( ) const
inlineprotected
int doubleMappedGridFunction::stencilWidth ( ) const
inlineprotected
doubleMappedGridFunction::updateReturnValue doubleMappedGridFunction::updateToMatchGrid ( MappedGridData gridData)
doubleMappedGridFunction::updateReturnValue doubleMappedGridFunction::updateToMatchGrid ( MappedGrid grid)
doubleMappedGridFunction::updateReturnValue doubleMappedGridFunction::updateToMatchGrid ( )
doubleMappedGridFunction::updateReturnValue doubleMappedGridFunction::updateToMatchGrid ( MappedGridData 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 
)

References grid, and updateToMatchGrid().

doubleMappedGridFunction::updateReturnValue doubleMappedGridFunction::updateToMatchGrid ( MappedGrid 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 
)
doubleMappedGridFunction::updateReturnValue doubleMappedGridFunction::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 
)
doubleMappedGridFunction::updateReturnValue doubleMappedGridFunction::updateToMatchGrid ( MappedGrid 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 
)
doubleMappedGridFunction::updateReturnValue doubleMappedGridFunction::updateToMatchGrid ( MappedGrid grid,
const GridFunctionParameters::GridFunctionType type,
const Range &  component0,
const Range &  component1 = nullRange,
const Range &  component2 = nullRange,
const Range &  component3 = nullRange,
const Range &  component4 = nullRange 
)
doubleMappedGridFunction::updateReturnValue doubleMappedGridFunction::updateToMatchGrid ( MappedGridData grid,
const GridFunctionParameters::GridFunctionType type,
const Range &  component0,
const Range &  component1 = nullRange,
const Range &  component2 = nullRange,
const Range &  component3 = nullRange,
const Range &  component4 = nullRange 
)

References grid, and updateToMatchGrid().

doubleMappedGridFunction::updateReturnValue doubleMappedGridFunction::updateToMatchGrid ( const GridFunctionParameters::GridFunctionType type,
const Range &  component0,
const Range &  component1 = nullRange,
const Range &  component2 = nullRange,
const Range &  component3 = nullRange,
const Range &  component4 = nullRange 
)
doubleMappedGridFunction::updateReturnValue doubleMappedGridFunction::updateToMatchGrid ( MappedGrid grid,
const GridFunctionParameters::GridFunctionType type 
)
doubleMappedGridFunction::updateReturnValue doubleMappedGridFunction::updateToMatchGrid ( const GridFunctionParameters::GridFunctionType type)
doubleMappedGridFunction::updateReturnValue doubleMappedGridFunction::updateToMatchGridFunction ( const doubleMappedGridFunction cgf)
doubleMappedGridFunction::updateReturnValue doubleMappedGridFunction::updateToMatchGridFunction ( const doubleMappedGridFunction 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 
)

Friends And Related Function Documentation

friend class doubleGridCollectionFunction
friend

Member Data Documentation

MappedGridData* doubleMappedGridFunction::grid
IntegerArray doubleMappedGridFunction::isCellCentered
MappedGrid* doubleMappedGridFunction::mappedGrid
GenericMappedGridOperators* doubleMappedGridFunction::operators
SparseRepForMGF* doubleMappedGridFunction::sparse

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