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

#include <GenericGridCollectionOperators.h>

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

Public Types

enum  { forAll =realMappedGridFunction::forAll, undefinedValue =realMappedGridFunction::undefinedValue }
 

Public Member Functions

 GenericGridCollectionOperators ()
 
 GenericGridCollectionOperators (GridCollection &mg)
 
 GenericGridCollectionOperators (const GenericGridCollectionOperators &mgo)
 
 GenericGridCollectionOperators (GenericMappedGridOperators &mgo)
 
 GenericGridCollectionOperators (GridCollection &mg, GenericMappedGridOperators &mgo)
 
virtual
GenericGridCollectionOperators * 		virtualConstructor ()
 
virtual ~GenericGridCollectionOperators ()
 
virtual
GenericGridCollectionOperators & 		operator= (const GenericGridCollectionOperators &mgo)
 
GenericMappedGridOperators & operator[] (const int grid) const
 
virtual real sizeOf (FILE *file=NULL) const
 
virtual void updateToMatchGrid (GridCollection &g)
 
virtual void updateToMatchOperators (GenericMappedGridOperators &op)
 
virtual int get (const GenericDataBase &dir, const aString &name)
 
virtual int put (GenericDataBase &dir, const aString &name) const
 
virtual void setOrderOfAccuracy (const int &orderOfAccuracy)
 
int getOrderOfAccuracy () const
 
virtual void setStencilSize (const int stencilSize)
 
virtual void setNumberOfComponentsForCoefficients (const int number)
 
void setTwilightZoneFlow (const int &twilightZoneFlow)
 
void setTwilightZoneFlowFunction (OGFunction &twilightZoneFlowFunction)
 
virtual void useConservativeApproximations (bool trueOrFalse=TRUE)
 
void setAveragingType (const GenericMappedGridOperators::AveragingType &type)
 
virtual realGridCollectionFunction convectiveDerivative (const realGridCollectionFunction &u, const realGridCollectionFunction &w, const Index &C1=nullIndex, const Index &C2=nullIndex, const Index &C3=nullIndex)
 
virtual realGridCollectionFunction convectiveDerivative (const realGridCollectionFunction &u, const GridFunctionParameters &gfType, const realGridCollectionFunction &w, const Index &C1=nullIndex, const Index &C2=nullIndex, const Index &C3=nullIndex)
 
virtual realGridCollectionFunction derivativeScalarDerivative (const realGridCollectionFunction &u, const realGridCollectionFunction &s, const int &direction1, const int &direction2, const Index &C1=nullIndex, const Index &C2=nullIndex, const Index &C3=nullIndex, const Index &C4=nullIndex)
 
virtual realGridCollectionFunction derivativeScalarDerivative (const realGridCollectionFunction &u, const GridFunctionParameters &gfType, const realGridCollectionFunction &s, const int &direction1, const int &direction2, const Index &C1=nullIndex, const Index &C2=nullIndex, const Index &C3=nullIndex, const Index &C4=nullIndex)
 
virtual realGridCollectionFunction derivativeScalarDerivativeCoefficients (const realGridCollectionFunction &s, const int &direction1, const int &direction2, const Index &C0=nullIndex, const Index &C1=nullIndex, const Index &C2=nullIndex, const Index &C3=nullIndex)
 
virtual realGridCollectionFunction derivativeScalarDerivativeCoefficients (const GridFunctionParameters &gfType, const realGridCollectionFunction &s, const int &direction1, const int &direction2, const Index &C0=nullIndex, const Index &C1=nullIndex, const Index &C2=nullIndex, const Index &C3=nullIndex)
 
virtual realGridCollectionFunction FCgrad (const realGridCollectionFunction &phi, const int c0=0, const int c1=0, const int c2=0, const int c3=0, const int c4=0)
 
virtual realGridCollectionFunction FCgrad (const realGridCollectionFunction &phi, const GridFunctionParameters &gfType, const int c0=0, const int c1=0, const int c2=0, const int c3=0, const int c4=0)
 
virtual void applyBoundaryConditions (realGridCollectionFunction &u, const real &time=0., const int &grid=forAll)
 
virtual void assignBoundaryConditionCoefficients (realGridCollectionFunction &coeff, const real &time=0., const int &grid=forAll)
 
virtual void applyBoundaryCondition (realGridCollectionFunction &u, 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())
 
virtual void applyBoundaryCondition (realGridCollectionFunction &u, const Index &Components, const BCTypes::BCNames &boundaryConditionType, const int &boundaryCondition, const RealArray &forcing, const real &time=0., const BoundaryConditionParameters &bcParameters=Overture::defaultBoundaryConditionParameters())
 
virtual void applyBoundaryCondition (realGridCollectionFunction &u, const Index &Components, const BCTypes::BCNames &boundaryConditionType, const int &boundaryCondition, const realGridCollectionFunction &forcing, const real &time=0., const BoundaryConditionParameters &bcParameters=Overture::defaultBoundaryConditionParameters())
 
virtual void finishBoundaryConditions (realGridCollectionFunction &u, const BoundaryConditionParameters &bcParameters=Overture::defaultBoundaryConditionParameters(), const Range &C0=nullRange, const IntegerArray &gridsToUpdate=Overture::nullIntArray())
 
virtual void applyBoundaryConditionCoefficients (realGridCollectionFunction &coeff, const Index &Equations, const Index &Components, const BCTypes::BCNames &boundaryConditionType=BCTypes::dirichlet, const int &boundaryCondition=BCTypes::allBoundaries, const BoundaryConditionParameters &bcParameters=Overture::defaultBoundaryConditionParameters())
 

Public Attributes

GridCollection gridCollection
 

Protected Member Functions

void setup ()
 

Protected Attributes

int stencilSize
 
Index I1
 
Index I2
 
Index I3
 
ListOfGenericMappedGridOperators mappedGridOperators
 
GenericMappedGridOperators * mappedGridOperatorsPointer
 
bool twilightZoneFlow
 
OGFunction * twilightZoneFlowFunction
 

Member Enumeration Documentation

anonymous enum
Enumerator
forAll 
undefinedValue 

Constructor & Destructor Documentation

GenericGridCollectionOperators::GenericGridCollectionOperators ( )

References setup().

Referenced by virtualConstructor().

GenericGridCollectionOperators::GenericGridCollectionOperators ( GridCollection &  mg)

References setup(), and updateToMatchGrid().

GenericGridCollectionOperators::GenericGridCollectionOperators ( const GenericGridCollectionOperators &  mgo)
GenericGridCollectionOperators::GenericGridCollectionOperators ( GenericMappedGridOperators &  mgo)

References mappedGridOperatorsPointer, and setup().

GenericGridCollectionOperators::GenericGridCollectionOperators ( GridCollection &  mg,
GenericMappedGridOperators &  mgo 
)

References mappedGridOperatorsPointer, setup(), and updateToMatchGrid().

GenericGridCollectionOperators::~GenericGridCollectionOperators ( )
virtual

References ListOfGenericMappedGridOperators::deepClean(), and mappedGridOperators.

Member Function Documentation

void GenericGridCollectionOperators::applyBoundaryCondition ( realGridCollectionFunction &  u,
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() 
)
virtual

References gridCollection, mappedGridOperators, and GenericGridCollection::numberOfGrids().

Referenced by applyBoundaryCondition().

void GenericGridCollectionOperators::applyBoundaryCondition ( realGridCollectionFunction &  u,
const Index &  Components,
const BCTypes::BCNames &  boundaryConditionType,
const int &  boundaryCondition,
const RealArray &  forcing,
const real &  time = 0.,
const BoundaryConditionParameters &  bcParameters = Overture::defaultBoundaryConditionParameters() 
)
virtual

References applyBoundaryCondition(), gridCollection, mappedGridOperators, and GenericGridCollection::numberOfGrids().

void GenericGridCollectionOperators::applyBoundaryCondition ( realGridCollectionFunction &  u,
const Index &  Components,
const BCTypes::BCNames &  boundaryConditionType,
const int &  boundaryCondition,
const realGridCollectionFunction &  forcing,
const real &  time = 0.,
const BoundaryConditionParameters &  bcParameters = Overture::defaultBoundaryConditionParameters() 
)
virtual

References applyBoundaryCondition(), gridCollection, mappedGridOperators, and GenericGridCollection::numberOfGrids().

void GenericGridCollectionOperators::applyBoundaryConditionCoefficients ( realGridCollectionFunction &  coeff,
const Index &  Equations,
const Index &  Components,
const BCTypes::BCNames &  boundaryConditionType = BCTypes::dirichlet,
const int &  boundaryCondition = BCTypes::allBoundaries,
const BoundaryConditionParameters &  bcParameters = Overture::defaultBoundaryConditionParameters() 
)
virtual

References gridCollection, mappedGridOperators, and GenericGridCollection::numberOfGrids().

void GenericGridCollectionOperators::applyBoundaryConditions ( realGridCollectionFunction &  u,
const real &  time = 0.,
const int &  grid = forAll 
)
virtual

References Overture::abort(), aString, GenericMappedGridOperators::errorInFindInterpolationNeighbours, forAll, GridCollectionData::getClassName(), doubleGridCollectionFunction::getGridCollection(), gridCollection, mappedGridOperators, GenericGridCollection::numberOfGrids(), and CompositeGrid::saveGridToAFile().

void GenericGridCollectionOperators::assignBoundaryConditionCoefficients ( realGridCollectionFunction &  coeff,
const real &  time = 0.,
const int &  grid = forAll 
)
virtual

References forAll, gridCollection, mappedGridOperators, and GenericGridCollection::numberOfGrids().

virtual realGridCollectionFunction GenericGridCollectionOperators::convectiveDerivative ( const realGridCollectionFunction &  u,
const realGridCollectionFunction &  w,
const Index &  C1 = nullIndex,
const Index &  C2 = nullIndex,
const Index &  C3 = nullIndex 
)
virtual
virtual realGridCollectionFunction GenericGridCollectionOperators::convectiveDerivative ( const realGridCollectionFunction &  u,
const GridFunctionParameters &  gfType,
const realGridCollectionFunction &  w,
const Index &  C1 = nullIndex,
const Index &  C2 = nullIndex,
const Index &  C3 = nullIndex 
)
virtual
virtual realGridCollectionFunction GenericGridCollectionOperators::derivativeScalarDerivative ( const realGridCollectionFunction &  u,
const realGridCollectionFunction &  s,
const int &  direction1,
const int &  direction2,
const Index &  C1 = nullIndex,
const Index &  C2 = nullIndex,
const Index &  C3 = nullIndex,
const Index &  C4 = nullIndex 
)
virtual
virtual realGridCollectionFunction GenericGridCollectionOperators::derivativeScalarDerivative ( const realGridCollectionFunction &  u,
const GridFunctionParameters &  gfType,
const realGridCollectionFunction &  s,
const int &  direction1,
const int &  direction2,
const Index &  C1 = nullIndex,
const Index &  C2 = nullIndex,
const Index &  C3 = nullIndex,
const Index &  C4 = nullIndex 
)
virtual
virtual realGridCollectionFunction GenericGridCollectionOperators::derivativeScalarDerivativeCoefficients ( const realGridCollectionFunction &  s,
const int &  direction1,
const int &  direction2,
const Index &  C0 = nullIndex,
const Index &  C1 = nullIndex,
const Index &  C2 = nullIndex,
const Index &  C3 = nullIndex 
)
virtual
virtual realGridCollectionFunction GenericGridCollectionOperators::derivativeScalarDerivativeCoefficients ( const GridFunctionParameters &  gfType,
const realGridCollectionFunction &  s,
const int &  direction1,
const int &  direction2,
const Index &  C0 = nullIndex,
const Index &  C1 = nullIndex,
const Index &  C2 = nullIndex,
const Index &  C3 = nullIndex 
)
virtual
virtual realGridCollectionFunction GenericGridCollectionOperators::FCgrad ( const realGridCollectionFunction &  phi,
const int  c0 = 0,
const int  c1 = 0,
const int  c2 = 0,
const int  c3 = 0,
const int  c4 = 0 
)
virtual
virtual realGridCollectionFunction GenericGridCollectionOperators::FCgrad ( const realGridCollectionFunction &  phi,
const GridFunctionParameters &  gfType,
const int  c0 = 0,
const int  c1 = 0,
const int  c2 = 0,
const int  c3 = 0,
const int  c4 = 0 
)
virtual
void GenericGridCollectionOperators::finishBoundaryConditions ( realGridCollectionFunction &  u,
const BoundaryConditionParameters &  bcParameters = Overture::defaultBoundaryConditionParameters(),
const Range &  C0 = nullRange,
const IntegerArray &  gridsToUpdate = Overture::nullIntArray() 
)
virtual

References doubleGridCollectionFunction::getIsACoefficientMatrix(), gridCollection, interpolateRefinements(), mappedGridOperators, and GenericGridCollection::numberOfGrids().

int GenericGridCollectionOperators::get ( const GenericDataBase &  dir,
const aString &  name 
)
virtual

Reimplemented in GridCollectionOperators.

int GenericGridCollectionOperators::getOrderOfAccuracy ( ) const

References gridCollection, mappedGridOperators, and GenericGridCollection::numberOfGrids().

GenericGridCollectionOperators & GenericGridCollectionOperators::operator= ( const GenericGridCollectionOperators &  mgo)
virtual

Reimplemented in GridCollectionOperators.

References mappedGridOperators, mappedGridOperatorsPointer, twilightZoneFlow, and twilightZoneFlowFunction.

GenericMappedGridOperators & GenericGridCollectionOperators::operator[] ( const int  grid) const

References Overture::abort(), ListOfGenericMappedGridOperators::getLength(), and mappedGridOperators.

int GenericGridCollectionOperators::put ( GenericDataBase &  dir,
const aString &  name 
) const
virtual

Reimplemented in GridCollectionOperators.

void GenericGridCollectionOperators::setAveragingType ( const GenericMappedGridOperators::AveragingType &  type)

References gridCollection, mappedGridOperators, and GenericGridCollection::numberOfGrids().

void GenericGridCollectionOperators::setNumberOfComponentsForCoefficients ( const int  number)
virtual

References gridCollection, mappedGridOperators, and GenericGridCollection::numberOfGrids().

void GenericGridCollectionOperators::setOrderOfAccuracy ( const int &  orderOfAccuracy)
virtual

References gridCollection, mappedGridOperators, and GenericGridCollection::numberOfGrids().

Referenced by PlotIt::plotGridQuality().

void GenericGridCollectionOperators::setStencilSize ( const int  stencilSize)
virtual

References gridCollection, mappedGridOperators, GenericGridCollection::numberOfGrids(), and stencilSize.

Referenced by setup().

void GenericGridCollectionOperators::setTwilightZoneFlow ( const int &  twilightZoneFlow)

References gridCollection, mappedGridOperators, GenericGridCollection::numberOfComponentGrids(), and twilightZoneFlow.

Referenced by updateToMatchGrid().

void GenericGridCollectionOperators::setTwilightZoneFlowFunction ( OGFunction &  twilightZoneFlowFunction)

References gridCollection, mappedGridOperators, GenericGridCollection::numberOfGrids(), and twilightZoneFlowFunction.

Referenced by updateToMatchGrid().

void GenericGridCollectionOperators::setup ( )
protected

References gridCollection, NULL, GridCollection::numberOfDimensions(), pow(), setStencilSize(), twilightZoneFlow, and twilightZoneFlowFunction.

Referenced by GenericGridCollectionOperators(), and GridCollectionOperators::GridCollectionOperators().

real GenericGridCollectionOperators::sizeOf ( FILE *  file = NULL) const
virtual

Reimplemented in GridCollectionOperators.

Referenced by GridCollectionOperators::sizeOf().

void GenericGridCollectionOperators::updateToMatchGrid ( GridCollection &  g)
virtual

Reimplemented in GridCollectionOperators.

References ListOfGenericMappedGridOperators::addElement(), ListOfGenericMappedGridOperators::deleteElement(), ListOfGenericMappedGridOperators::getLength(), gridCollection, mappedGridOperators, mappedGridOperatorsPointer, NULL, GenericGridCollection::numberOfGrids(), GridCollection::reference(), setTwilightZoneFlow(), setTwilightZoneFlowFunction(), twilightZoneFlow, twilightZoneFlowFunction, and GenericMappedGridOperators::virtualConstructor().

Referenced by GenericGridCollectionOperators(), and GridCollectionOperators::updateToMatchGrid().

void GenericGridCollectionOperators::updateToMatchOperators ( GenericMappedGridOperators &  op)
virtual

References mappedGridOperatorsPointer.

void GenericGridCollectionOperators::useConservativeApproximations ( bool  trueOrFalse = TRUE)
virtual

References gridCollection, mappedGridOperators, and GenericGridCollection::numberOfGrids().

GenericGridCollectionOperators * GenericGridCollectionOperators::virtualConstructor ( )
virtual

Reimplemented in GridCollectionOperators.

References GenericGridCollectionOperators().

Member Data Documentation

GridCollection GenericGridCollectionOperators::gridCollection

Referenced by applyBoundaryCondition(), applyBoundaryConditionCoefficients(), applyBoundaryConditions(), assignBoundaryConditionCoefficients(), finishBoundaryConditions(), getOrderOfAccuracy(), setAveragingType(), setNumberOfComponentsForCoefficients(), setOrderOfAccuracy(), setStencilSize(), setTwilightZoneFlow(), setTwilightZoneFlowFunction(), setup(), updateToMatchGrid(), and useConservativeApproximations().

Index GenericGridCollectionOperators::I1
protected
Index GenericGridCollectionOperators::I2
protected
Index GenericGridCollectionOperators::I3
protected
ListOfGenericMappedGridOperators GenericGridCollectionOperators::mappedGridOperators
protected

Referenced by applyBoundaryCondition(), applyBoundaryConditionCoefficients(), applyBoundaryConditions(), assignBoundaryConditionCoefficients(), finishBoundaryConditions(), getOrderOfAccuracy(), GridCollectionOperators::operator=(), operator=(), GridCollectionOperators::operator[](), operator[](), setAveragingType(), setNumberOfComponentsForCoefficients(), setOrderOfAccuracy(), setStencilSize(), setTwilightZoneFlow(), setTwilightZoneFlowFunction(), updateToMatchGrid(), useConservativeApproximations(), and ~GenericGridCollectionOperators().

GenericMappedGridOperators* GenericGridCollectionOperators::mappedGridOperatorsPointer
protected

Referenced by GenericGridCollectionOperators(), GridCollectionOperators::GridCollectionOperators(), GridCollectionOperators::operator=(), operator=(), updateToMatchGrid(), updateToMatchOperators(), and GridCollectionOperators::~GridCollectionOperators().

int GenericGridCollectionOperators::stencilSize
protected

Referenced by setStencilSize().

bool GenericGridCollectionOperators::twilightZoneFlow
protected

Referenced by operator=(), setTwilightZoneFlow(), setup(), and updateToMatchGrid().

OGFunction* GenericGridCollectionOperators::twilightZoneFlowFunction
protected

Referenced by operator=(), setTwilightZoneFlowFunction(), setup(), and updateToMatchGrid().

The documentation for this class was generated from the following files:
Generated on Fri Jan 4 2013 10:18:08 for Overture by   doxygen 1.8.3