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

#include <GenericCompositeGridOperators.h>

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

Public Types

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

Public Member Functions

 GenericCompositeGridOperators ()
 
 GenericCompositeGridOperators (CompositeGrid &mg)
 
 GenericCompositeGridOperators (const GenericCompositeGridOperators &mgo)
 
 GenericCompositeGridOperators (GenericMappedGridOperators &mgo)
 
 GenericCompositeGridOperators (CompositeGrid &mg, GenericMappedGridOperators &mgo)
 
virtual
GenericCompositeGridOperators * 		virtualConstructor ()
 
virtual ~GenericCompositeGridOperators ()
 
virtual
GenericCompositeGridOperators & 		operator= (const GenericCompositeGridOperators &mgo)
 
GenericMappedGridOperators & operator[] (const int grid) const
 
virtual real sizeOf (FILE *file=NULL) const
 
virtual void updateToMatchGrid (CompositeGrid &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 realCompositeGridFunction convectiveDerivative (const realCompositeGridFunction &u, const realCompositeGridFunction &w, const Index &C1=nullIndex, const Index &C2=nullIndex, const Index &C3=nullIndex)
 
virtual realCompositeGridFunction convectiveDerivative (const realCompositeGridFunction &u, const GridFunctionParameters &gfType, const realCompositeGridFunction &w, const Index &C1=nullIndex, const Index &C2=nullIndex, const Index &C3=nullIndex)
 
virtual realCompositeGridFunction derivativeScalarDerivative (const realCompositeGridFunction &u, const realCompositeGridFunction &s, const int &direction1, const int &direction2, const Index &C1=nullIndex, const Index &C2=nullIndex, const Index &C3=nullIndex, const Index &C4=nullIndex)
 
virtual realCompositeGridFunction derivativeScalarDerivative (const realCompositeGridFunction &u, const GridFunctionParameters &gfType, const realCompositeGridFunction &s, const int &direction1, const int &direction2, const Index &C1=nullIndex, const Index &C2=nullIndex, const Index &C3=nullIndex, const Index &C4=nullIndex)
 
virtual realCompositeGridFunction derivativeScalarDerivativeCoefficients (const realCompositeGridFunction &s, const int &direction1, const int &direction2, const Index &C0=nullIndex, const Index &C1=nullIndex, const Index &C2=nullIndex, const Index &C3=nullIndex)
 
virtual realCompositeGridFunction derivativeScalarDerivativeCoefficients (const GridFunctionParameters &gfType, const realCompositeGridFunction &s, const int &direction1, const int &direction2, const Index &C0=nullIndex, const Index &C1=nullIndex, const Index &C2=nullIndex, const Index &C3=nullIndex)
 
virtual realCompositeGridFunction FCgrad (const realCompositeGridFunction &phi, const int c0=0, const int c1=0, const int c2=0, const int c3=0, const int c4=0)
 
virtual realCompositeGridFunction FCgrad (const realCompositeGridFunction &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 (realCompositeGridFunction &u, const real &time=0., const int &grid=forAll)
 
virtual void assignBoundaryConditionCoefficients (realCompositeGridFunction &coeff, const real &time=0., const int &grid=forAll)
 
virtual void applyBoundaryCondition (realCompositeGridFunction &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 (realCompositeGridFunction &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 (realCompositeGridFunction &u, const Index &Components, const BCTypes::BCNames &boundaryConditionType, const int &boundaryCondition, const realCompositeGridFunction &forcing, const real &time=0., const BoundaryConditionParameters &bcParameters=Overture::defaultBoundaryConditionParameters())
 
virtual void finishBoundaryConditions (realCompositeGridFunction &u, const BoundaryConditionParameters &bcParameters=Overture::defaultBoundaryConditionParameters(), const Range &C0=nullRange, const IntegerArray &gridsToUpdate=Overture::nullIntArray())
 
virtual void applyBoundaryConditionCoefficients (realCompositeGridFunction &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

CompositeGrid gridCollection
 

Protected Member Functions

void getInterpolationCoefficients (realCompositeGridFunction &coeff, const IntegerArray &gridsToUpdate=Overture::nullIntArray())
 
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

GenericCompositeGridOperators::GenericCompositeGridOperators ( )

References setup().

Referenced by virtualConstructor().

GenericCompositeGridOperators::GenericCompositeGridOperators ( CompositeGrid &  mg)

References setup(), and updateToMatchGrid().

GenericCompositeGridOperators::GenericCompositeGridOperators ( const GenericCompositeGridOperators &  mgo)
GenericCompositeGridOperators::GenericCompositeGridOperators ( GenericMappedGridOperators &  mgo)

References mappedGridOperatorsPointer, and setup().

GenericCompositeGridOperators::GenericCompositeGridOperators ( CompositeGrid &  mg,
GenericMappedGridOperators &  mgo 
)

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

GenericCompositeGridOperators::~GenericCompositeGridOperators ( )
virtual

References ListOfGenericMappedGridOperators::deepClean(), and mappedGridOperators.

Member Function Documentation

void GenericCompositeGridOperators::applyBoundaryCondition ( realCompositeGridFunction &  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(), ErrorEstimator::interpolateAndApplyBoundaryConditions(), and main().

void GenericCompositeGridOperators::applyBoundaryCondition ( realCompositeGridFunction &  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 GenericCompositeGridOperators::applyBoundaryCondition ( realCompositeGridFunction &  u,
const Index &  Components,
const BCTypes::BCNames &  boundaryConditionType,
const int &  boundaryCondition,
const realCompositeGridFunction &  forcing,
const real &  time = 0.,
const BoundaryConditionParameters &  bcParameters = Overture::defaultBoundaryConditionParameters() 
)
virtual

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

void GenericCompositeGridOperators::applyBoundaryConditionCoefficients ( realCompositeGridFunction &  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 GenericCompositeGridOperators::applyBoundaryConditions ( realCompositeGridFunction &  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 GenericCompositeGridOperators::assignBoundaryConditionCoefficients ( realCompositeGridFunction &  coeff,
const real &  time = 0.,
const int &  grid = forAll 
)
virtual

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

virtual realCompositeGridFunction GenericCompositeGridOperators::convectiveDerivative ( const realCompositeGridFunction &  u,
const realCompositeGridFunction &  w,
const Index &  C1 = nullIndex,
const Index &  C2 = nullIndex,
const Index &  C3 = nullIndex 
)
virtual
virtual realCompositeGridFunction GenericCompositeGridOperators::convectiveDerivative ( const realCompositeGridFunction &  u,
const GridFunctionParameters &  gfType,
const realCompositeGridFunction &  w,
const Index &  C1 = nullIndex,
const Index &  C2 = nullIndex,
const Index &  C3 = nullIndex 
)
virtual
virtual realCompositeGridFunction GenericCompositeGridOperators::derivativeScalarDerivative ( const realCompositeGridFunction &  u,
const realCompositeGridFunction &  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 realCompositeGridFunction GenericCompositeGridOperators::derivativeScalarDerivative ( const realCompositeGridFunction &  u,
const GridFunctionParameters &  gfType,
const realCompositeGridFunction &  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 realCompositeGridFunction GenericCompositeGridOperators::derivativeScalarDerivativeCoefficients ( const realCompositeGridFunction &  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 realCompositeGridFunction GenericCompositeGridOperators::derivativeScalarDerivativeCoefficients ( const GridFunctionParameters &  gfType,
const realCompositeGridFunction &  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 realCompositeGridFunction GenericCompositeGridOperators::FCgrad ( const realCompositeGridFunction &  phi,
const int  c0 = 0,
const int  c1 = 0,
const int  c2 = 0,
const int  c3 = 0,
const int  c4 = 0 
)
virtual
virtual realCompositeGridFunction GenericCompositeGridOperators::FCgrad ( const realCompositeGridFunction &  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 GenericCompositeGridOperators::finishBoundaryConditions ( realCompositeGridFunction &  u,
const BoundaryConditionParameters &  bcParameters = Overture::defaultBoundaryConditionParameters(),
const Range &  C0 = nullRange,
const IntegerArray &  gridsToUpdate = Overture::nullIntArray() 
)
virtual

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

Referenced by Ogmg::applyOgesSmoother(), and ErrorEstimator::interpolateAndApplyBoundaryConditions().

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

Reimplemented in CompositeGridOperators.

void GenericCompositeGridOperators::getInterpolationCoefficients ( realCompositeGridFunction &  coeff,
const IntegerArray &  gridsToUpdate = Overture::nullIntArray() 
)
protected

References Overture::abort(), axis1, axis2, axis3, delta, MappedGrid::dimension(), End, CompositeGrid::epsilon(), fabs(), doubleCompositeGridFunction::getCompositeGrid(), MappedGrid::gridSpacing(), i2, MappedGrid::indexRange(), SparseRepForMGF::indexToEquation(), CompositeGrid::interpolationCoordinates, CompositeGrid::interpolationPoint, CompositeGrid::interpolationWidth, CompositeGrid::interpoleeGrid, CompositeGrid::interpoleeLocation, MappedGrid::isCellCentered(), M123CE, Mapping::mappingName, mask, MappedGrid::mask(), max(), min(), doubleCompositeGridFunction::multigridLevel, GenericGridCollection::numberOfBaseGrids(), SparseRepForMGF::numberOfComponents, GridCollection::numberOfDimensions(), GenericGridCollection::numberOfGrids(), CompositeGrid::numberOfInterpolationPoints, GenericGridCollection::numberOfMultigridLevels(), px, q, Q11, Q12, Q21, Q22, Q32, REAL_EPSILON, SparseRepForMGF::setCoefficientIndex(), doubleMappedGridFunction::sparse, Start, SparseRepForMGF::stencilSize, CompositeGrid::variableInterpolationWidth, and variableInterpolationWidth.

Referenced by finishBoundaryConditions().

int GenericCompositeGridOperators::getOrderOfAccuracy ( ) const

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

Referenced by ErrorEstimator::interpolateAndApplyBoundaryConditions(), and Oges::setEquationAndBoundaryConditions().

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

Reimplemented in CompositeGridOperators.

References mappedGridOperators, mappedGridOperatorsPointer, twilightZoneFlow, and twilightZoneFlowFunction.

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

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

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

Reimplemented in CompositeGridOperators.

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

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

void GenericCompositeGridOperators::setNumberOfComponentsForCoefficients ( const int  number)
virtual

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

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

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

Referenced by Ogmg::buildCoefficientArrays(), Ogmg::buildPredefinedEquations(), Integrate::computeLeftNullVector(), Integrate::computeWeights(), and main().

void GenericCompositeGridOperators::setStencilSize ( const int  stencilSize)
virtual

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

Referenced by Ogmg::buildCoefficientArrays(), Ogmg::buildPredefinedEquations(), checkGrid(), Integrate::computeLeftNullVector(), Integrate::computeWeights(), main(), Oges::setEquationAndBoundaryConditions(), and setup().

void GenericCompositeGridOperators::setTwilightZoneFlow ( const int &  twilightZoneFlow)

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

Referenced by main(), and updateToMatchGrid().

void GenericCompositeGridOperators::setTwilightZoneFlowFunction ( OGFunction &  twilightZoneFlowFunction)

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

Referenced by main(), and updateToMatchGrid().

void GenericCompositeGridOperators::setup ( )
protected

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

Referenced by CompositeGridOperators::CompositeGridOperators(), and GenericCompositeGridOperators().

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

Reimplemented in CompositeGridOperators.

Referenced by CompositeGridOperators::sizeOf().

void GenericCompositeGridOperators::updateToMatchGrid ( CompositeGrid &  g)
virtual

Reimplemented in CompositeGridOperators.

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

Referenced by GenericCompositeGridOperators(), and CompositeGridOperators::updateToMatchGrid().

void GenericCompositeGridOperators::updateToMatchOperators ( GenericMappedGridOperators &  op)
virtual

References mappedGridOperatorsPointer.

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

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

Referenced by main().

GenericCompositeGridOperators * GenericCompositeGridOperators::virtualConstructor ( )
virtual

Reimplemented in CompositeGridOperators.

References GenericCompositeGridOperators().

Member Data Documentation

CompositeGrid GenericCompositeGridOperators::gridCollection

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

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

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

GenericMappedGridOperators* GenericCompositeGridOperators::mappedGridOperatorsPointer
protected

Referenced by CompositeGridOperators::CompositeGridOperators(), GenericCompositeGridOperators(), CompositeGridOperators::operator=(), operator=(), updateToMatchGrid(), updateToMatchOperators(), and CompositeGridOperators::~CompositeGridOperators().

int GenericCompositeGridOperators::stencilSize
protected

Referenced by setStencilSize().

bool GenericCompositeGridOperators::twilightZoneFlow
protected

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

OGFunction* GenericCompositeGridOperators::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