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

#include <floatMappedGridFunction.h>

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

Public Types

enum  {
  maximumNumberOfIndicies =floatMappedGridFunctionRCData::maximumNumberOfIndicies, numberOfIndicies =floatMappedGridFunctionRCData::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

 floatMappedGridFunction ()
 
 floatMappedGridFunction (MappedGrid &grid)
 
 floatMappedGridFunction (const floatMappedGridFunction &cgf, const CopyType copyType=DEEP)
 
 floatMappedGridFunction (MappedGridData &gridData)
 
 floatMappedGridFunction (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)
 
 floatMappedGridFunction (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)
 
 floatMappedGridFunction (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)
 
 floatMappedGridFunction (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)
 
 floatMappedGridFunction (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)
 
 floatMappedGridFunction (const GridFunctionParameters::GridFunctionType &type, const Range &component0=nullRange, const Range &component1=nullRange, const Range &component2=nullRange, const Range &component3=nullRange, const Range &component4=nullRange)
 
 ~floatMappedGridFunction ()
 
floatMappedGridFunctionoperator= (const floatMappedGridFunction &cgf)
 
floatMappedGridFunctionoperator= (const float x)
 
floatMappedGridFunctionoperator= (const floatDistributedArray &X)
 
float & operator() (const int &i0) const
 
float & operator() (const int &i0, const int &i1) const
 
float & operator() (const int &i0, const int &i1, const int i2) const
 
float & operator() (const int &i0, const int &i1, const int &i2, const int &i3) const
 
float & operator() (const int &i0, const int &i1, const int &i2, const int &i3, const int &i4) const
 
float & operator() (const int &i0, const int &i1, const int &i2, const int &i3, const int &i4, const int &i5) const
 
float & operator() (const int &i0, const int &i1, const int &i2, const int &i3, const int &i4, const int &i5, const int &i6) const
 
float & 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
 
floatDistributedArray operator() (const IndexArg &I0) const
 
floatDistributedArray operator() (const IndexArg &I0, const IndexArg &I1) const
 
floatDistributedArray operator() (const IndexArg &I0, const IndexArg &I1, const IndexArg &I2) const
 
floatDistributedArray operator() (const IndexArg &I0, const IndexArg &I1, const IndexArg &I2, const IndexArg &I3) const
 
floatDistributedArray operator() (const IndexArg &I0, const IndexArg &I1, const IndexArg &I2, const IndexArg &I3, const int &i4) const
 
floatDistributedArray operator() (const IndexArg &I0, const IndexArg &I1, const IndexArg &I2, const IndexArg &I3, const IndexArg &I4) const
 
floatDistributedArray operator() (const IndexArg &I0, const IndexArg &I1, const IndexArg &I2, const IndexArg &I3, const int &i4, const int &i5) const
 
floatDistributedArray operator() (const IndexArg &I0, const IndexArg &I1, const IndexArg &I2, const IndexArg &I3, const IndexArg &I4, const IndexArg &I5) const
 
floatDistributedArray operator() (const IndexArg &I0, const IndexArg &I1, const IndexArg &I2, const IndexArg &I3, const int &i4, const int &i5, const int &i6) const
 
floatDistributedArray operator() (const IndexArg &I0, const IndexArg &I1, const IndexArg &I2, const IndexArg &I3, const IndexArg &I4, const IndexArg &I5, const IndexArg &I6) const
 
floatDistributedArray 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
 
floatDistributedArray 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
 
float & 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
 
floatSerialArray & getSerialArray ()
 
const floatSerialArray & 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 floatMappedGridFunction &mgf)
 
void getRanges (Range &R0, Range &R1, Range &R2, Range &R3, Range &R4, Range &R5, Range &R6, Range &R7)
 
void link (const floatMappedGridFunction &mgf, const Range &R0, const Range &R1=nullRange, const Range &R2=nullRange, const Range &R3=nullRange, const Range &R4=nullRange)
 
void link (const floatMappedGridFunction &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 floatMappedGridFunction &cgf)
 
updateReturnValue updateToMatchGridFunction (const floatMappedGridFunction &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 floatMappedGridFunction &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 floatMappedGridFunction convectiveDerivative (const floatMappedGridFunction &w, const Index &I1=nullIndex, const Index &I2=nullIndex, const Index &I3=nullIndex) const
 
virtual floatMappedGridFunction convectiveDerivative (const GridFunctionParameters &gfType, const floatMappedGridFunction &w, const Index &I1=nullIndex, const Index &I2=nullIndex, const Index &I3=nullIndex) const
 
virtual floatMappedGridFunction derivativeScalarDerivative (const floatMappedGridFunction &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 floatMappedGridFunction derivativeScalarDerivative (const GridFunctionParameters &gfType, const floatMappedGridFunction &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 floatMappedGridFunction derivativeScalarDerivativeCoefficients (const floatMappedGridFunction &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 floatMappedGridFunction derivativeScalarDerivativeCoefficients (const GridFunctionParameters &gfType, const floatMappedGridFunction &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 floatMappedGridFunction 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 floatMappedGridFunction 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 floatMappedGridFunction &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 floatGenericGridFunction
 floatGenericGridFunction ()
 
 floatGenericGridFunction (const floatGenericGridFunction &, const CopyType=DEEP)
 
 ~floatGenericGridFunction ()
 
 floatGenericGridFunction (GenericGrid *grid0)
 
floatGenericGridFunctionoperator= (const floatGenericGridFunction &X)
 
void reference (const floatGenericGridFunction &)
 
- 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 floatGenericGridFunction
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 floatGridCollectionFunction
 

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

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

Member Function Documentation

void floatMappedGridFunction::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 floatMappedGridFunction::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 floatMappedGridFunction::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 floatMappedGridFunction::applyBoundaryCondition ( const Index &  Components,
const BCTypes::BCNames boundaryConditionType,
const int &  boundaryCondition,
const floatMappedGridFunction forcing,
const real time = 0.,
const BoundaryConditionParameters bcParameters = Overture::defaultBoundaryConditionParameters(),
const int &  grid = 0 
)
void floatMappedGridFunction::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 floatMappedGridFunction::applyBoundaryConditions ( const real time = 0.)
virtual
int floatMappedGridFunction::arg3 ( int  i3,
int  i4,
int  i5 = defaultValue,
int  i6 = defaultValue,
int  i7 = defaultValue 
) const

References defaultValue.

void floatMappedGridFunction::assignBoundaryConditionCoefficients ( const real time = 0.)
virtual
void floatMappedGridFunction::breakReference ( void  )
virtual
virtual floatMappedGridFunction floatMappedGridFunction::convectiveDerivative ( const floatMappedGridFunction w,
const Index &  I1 = nullIndex,
const Index &  I2 = nullIndex,
const Index &  I3 = nullIndex 
) const
virtual
virtual floatMappedGridFunction floatMappedGridFunction::convectiveDerivative ( const GridFunctionParameters gfType,
const floatMappedGridFunction w,
const Index &  I1 = nullIndex,
const Index &  I2 = nullIndex,
const Index &  I3 = nullIndex 
) const
virtual
int floatMappedGridFunction::dataCopy ( const floatMappedGridFunction mgf)
virtual floatMappedGridFunction floatMappedGridFunction::derivativeScalarDerivative ( const floatMappedGridFunction 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 floatMappedGridFunction floatMappedGridFunction::derivativeScalarDerivative ( const GridFunctionParameters gfType,
const floatMappedGridFunction 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 floatMappedGridFunction floatMappedGridFunction::derivativeScalarDerivativeCoefficients ( const floatMappedGridFunction 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 floatMappedGridFunction floatMappedGridFunction::derivativeScalarDerivativeCoefficients ( const GridFunctionParameters gfType,
const floatMappedGridFunction 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 floatMappedGridFunction::destroy ( )
int floatMappedGridFunction::faceCentering ( ) const
inlineprotected
virtual floatMappedGridFunction floatMappedGridFunction::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 floatMappedGridFunction floatMappedGridFunction::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 floatMappedGridFunction::finishBoundaryConditions ( const BoundaryConditionParameters bcParameters = Overture::defaultBoundaryConditionParameters(),
const Range &  C0 = nullRange 
)
int floatMappedGridFunction::fixupUnusedPoints ( const RealArray value = Overture::nullRealArray(),
int  numberOfGhostlines = 1 
)
virtual
int floatMappedGridFunction::get ( const GenericDataBase dir,
const aString name 
)
virtual
aString floatMappedGridFunction::getClassName ( void  ) const
virtual
int floatMappedGridFunction::getComponentBase ( int  component) const
int floatMappedGridFunction::getComponentBound ( int  component) const
int floatMappedGridFunction::getComponentDimension ( int  component) const
int floatMappedGridFunction::getCoordinateBase ( int  coordinate) const
int floatMappedGridFunction::getCoordinateBound ( int  coordinate) const
int floatMappedGridFunction::getCoordinateDimension ( int  coordinate) const
void floatMappedGridFunction::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 floatMappedGridFunction::getFaceCentering ( ) const

Referenced by setFaceCentering().

GridFunctionParameters::GridFunctionType floatMappedGridFunction::getGridFunctionType ( const Index &  component0 = nullIndex,
const Index &  component1 = nullIndex,
const Index &  component2 = nullIndex,
const Index &  component3 = nullIndex,
const Index &  component4 = nullIndex 
) const
GridFunctionParameters::GridFunctionTypeWithComponents floatMappedGridFunction::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, floatGridCollectionFunction::getGridFunctionType(), GridFunctionParameters::vertexCentered, GridFunctionParameters::vertexCenteredWith0Components, GridFunctionParameters::vertexCenteredWith1Component, GridFunctionParameters::vertexCenteredWith2Components, GridFunctionParameters::vertexCenteredWith3Components, GridFunctionParameters::vertexCenteredWith4Components, and GridFunctionParameters::vertexCenteredWith5Components.

bool floatMappedGridFunction::getIsACoefficientMatrix ( ) const
bool floatMappedGridFunction::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 floatMappedGridFunction::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 * floatMappedGridFunction::getMappedGrid ( const bool  abortIfNull = TRUE) const

References Overture::abort(), and NULL.

Referenced by multiply().

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

References NULL, and operators.

void floatMappedGridFunction::getRanges ( Range &  R0,
Range &  R1,
Range &  R2,
Range &  R3,
Range &  R4,
Range &  R5,
Range &  R6,
Range &  R7 
)
floatSerialArray & floatMappedGridFunction::getSerialArray ( )
const floatSerialArray & floatMappedGridFunction::getSerialArray ( ) const
floatMappedGridFunction::stencilTypes floatMappedGridFunction::getStencilType ( ) const
int floatMappedGridFunction::getStencilWidth ( ) const
int floatMappedGridFunction::isACoefficientMatrix ( ) const
inlineprotected
bool floatMappedGridFunction::isNull ( )

References mappedGrid, and NULL.

Referenced by operator=().

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

References link().

int floatMappedGridFunction::numberOfComponents ( ) const
inline

Referenced by updateToMatchGrid().

int floatMappedGridFunction::numberOfDimensions ( ) const
inline
float& floatMappedGridFunction::operator() ( const int &  i0) const
inline
float& floatMappedGridFunction::operator() ( const int &  i0,
const int &  i1 
) const
inline
float& floatMappedGridFunction::operator() ( const int &  i0,
const int &  i1,
const int  i2 
) const
inline
float& floatMappedGridFunction::operator() ( const int &  i0,
const int &  i1,
const int &  i2,
const int &  i3 
) const
inline
float& floatMappedGridFunction::operator() ( const int &  i0,
const int &  i1,
const int &  i2,
const int &  i3,
const int &  i4 
) const
inline
float& floatMappedGridFunction::operator() ( const int &  i0,
const int &  i1,
const int &  i2,
const int &  i3,
const int &  i4,
const int &  i5 
) const
inline
float& floatMappedGridFunction::operator() ( const int &  i0,
const int &  i1,
const int &  i2,
const int &  i3,
const int &  i4,
const int &  i5,
const int &  i6 
) const
inline
float& floatMappedGridFunction::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
floatDistributedArray floatMappedGridFunction::operator() ( const IndexArg I0) const
inline
floatDistributedArray floatMappedGridFunction::operator() ( const IndexArg I0,
const IndexArg I1 
) const
inline
floatDistributedArray floatMappedGridFunction::operator() ( const IndexArg I0,
const IndexArg I1,
const IndexArg I2 
) const
inline
floatDistributedArray floatMappedGridFunction::operator() ( const IndexArg I0,
const IndexArg I1,
const IndexArg I2,
const IndexArg I3 
) const
inline
floatDistributedArray floatMappedGridFunction::operator() ( const IndexArg I0,
const IndexArg I1,
const IndexArg I2,
const IndexArg I3,
const int &  i4 
) const
inline
floatDistributedArray floatMappedGridFunction::operator() ( const IndexArg I0,
const IndexArg I1,
const IndexArg I2,
const IndexArg I3,
const IndexArg I4 
) const

References Overture::abort().

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

References Overture::abort().

floatDistributedArray floatMappedGridFunction::operator() ( const IndexArg I0,
const IndexArg I1,
const IndexArg I2,
const IndexArg I3,
const int &  i4,
const int &  i5,
const int &  i6 
) const
inline
floatDistributedArray floatMappedGridFunction::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().

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

floatMappedGridFunction & floatMappedGridFunction::operator= ( const floatMappedGridFunction cgf)
floatMappedGridFunction & floatMappedGridFunction::operator= ( const float  x)
floatMappedGridFunction & floatMappedGridFunction::operator= ( const floatDistributedArray X)
void floatMappedGridFunction::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 floatMappedGridFunction::positionOfCoefficient ( const int  m1,
const int  m2,
const int  m3,
const int  component 
) const
int floatMappedGridFunction::positionOfComponent ( int  i) const
inline
int floatMappedGridFunction::positionOfCoordinate ( int  i) const
inline
int floatMappedGridFunction::positionOfFaceCentering ( ) const
inline
int floatMappedGridFunction::put ( GenericDataBase dir,
const aString name 
) const
virtual
void floatMappedGridFunction::reference ( const floatMappedGridFunction cgf)
float & floatMappedGridFunction::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 floatMappedGridFunction::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 floatMappedGridFunction::setFaceCentering ( const int &  axis = defaultValue)
void floatMappedGridFunction::setIsACoefficientMatrix ( const bool  trueOrFalse = TRUE,
const int  stencilSize = defaultValue,
const int  numberOfGhostLines = 1,
const int  numberOfComponentsForCoefficients = 1,
const int  offset = 0 
)
void floatMappedGridFunction::setIsACoefficientMatrix ( SparseRepForMGF sparseRep)
void floatMappedGridFunction::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 floatMappedGridFunction::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 floatMappedGridFunction::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 floatMappedGridFunction::setNumberOfComponents ( const int &  number)
protected
void floatMappedGridFunction::setNumberOfDimensions ( const int &  number)
protected
void floatMappedGridFunction::setOperators ( GenericMappedGridOperators operators)

References operators.

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

References assert, and NULL.

real floatMappedGridFunction::sizeOf ( FILE *  file = NULL) const
virtual
int floatMappedGridFunction::stencilType ( ) const
inlineprotected
int floatMappedGridFunction::stencilWidth ( ) const
inlineprotected
floatMappedGridFunction::updateReturnValue floatMappedGridFunction::updateToMatchGrid ( MappedGridData gridData)

References grid, and updateToMatchGrid().

floatMappedGridFunction::updateReturnValue floatMappedGridFunction::updateToMatchGrid ( MappedGrid grid)
floatMappedGridFunction::updateReturnValue floatMappedGridFunction::updateToMatchGrid ( )
floatMappedGridFunction::updateReturnValue floatMappedGridFunction::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().

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

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

Member Data Documentation

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

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