CG  Version 25
Public Types | Public Member Functions | Public Attributes | List of all members
GridFunction Class Reference

An enhanced grid-function (field-variable) used by DomainSolver's. More...

#include <GridFunction.h>

Collaboration diagram for GridFunction:
Collaboration graph
[legend]

Public Types

enum  Forms { primitiveVariables =0, conservativeVariables }
 

Public Member Functions

 GridFunction (Parameters *pParameters=NULL)
 Constructor to build an extended grid function.
 
 ~GridFunction ()
 destructor.
 
int updateToMatchGrid (CompositeGrid &cg)
 update to match a new grid.
 
void updateGridVelocityArrays ()
 Update the grid velocity arrays – use this function if the number of grids changes.
 
virtual int get (const GenericDataBase &dir, const aString &name)
 
virtual int put (GenericDataBase &dir, const aString &name) const
 
int primitiveToConservative (int gridToConvert=-1, int fixupUnsedPoints=false)
 Convert primitive variables to conservative.
 
int conservativeToPrimitive (int gridToConvert=-1, int fixupUnsedPoints=false)
 
realMappedGridFunction & createGridVelocity (int grid)
 Build a grid function to hold the grid velocities.
 
realMappedGridFunction & getGridVelocity (int grid)
 Return the gridVelocity (if it is there, otherwise return a null grid function).
 
int referenceGridVelocity (GridFunction &gf)
 Reference this gridVelocity to that of another grid function.
 
realCompositeGridFunction & getGridVelocity ()
 
void setParameters (Parameters &parameters)
 Provide parameters.
 
virtual real sizeOf (FILE *file=NULL) const
 return the size of this object in bytes.
 

Public Attributes

Forms form
 the grid function is either in primitive or conservative variables.
 
real t
 time for grid function.
 
real gridVelocityTime
 time at which the grid velocity has been computed.
 
realCompositeGridFunction u
 solution values.
 
int sizeOfGridVelocityArray
 number of entries in the gridVelocity array.
 
realMappedGridFunction ** gridVelocity
 grid velocity for moving grid problems.
 
CompositeGrid cg
 reference to the grid associated with u
 
MatrixTransform ** transform
 array of pointers to transformations for movement.
 
int numberOfTransformMappings
 number of entries in the above array.
 
ParameterspParams
 pointer to an associated Parameters object.
 
DataBase dbase
 

Detailed Description

An enhanced grid-function (field-variable) used by DomainSolver's.

This enhanced "grid-function" includes information such as whether the values are in conservative or primitive form, the time at which the GF lives, and the grid velocity.

Member Enumeration Documentation

Enumerator
primitiveVariables 
conservativeVariables 

Constructor & Destructor Documentation

GridFunction::GridFunction ( Parameters pParameters = NULL)

Constructor to build an extended grid function.

Parameters
pParameters(input) : pointer to a Parameters object.

References form, gridVelocity, gridVelocityTime, numberOfTransformMappings, pParams, primitiveVariables, sizeOfGridVelocityArray, t, and transform.

GridFunction::~GridFunction ( )

Member Function Documentation

int GridFunction::conservativeToPrimitive ( int  gridToConvert = -1,
int  fixupUnsedPoints = false 
)
realMappedGridFunction & GridFunction::createGridVelocity ( int  grid)

Build a grid function to hold the grid velocities.

Parameters
grid(input) : grid number.

References all, cg, grid, gridVelocity, and sizeOfGridVelocityArray.

Referenced by DomainSolver::setup().

int GridFunction::get ( const GenericDataBase &  dir,
const aString &  name 
)
virtual
realMappedGridFunction & GridFunction::getGridVelocity ( int  grid)
realCompositeGridFunction & GridFunction::getGridVelocity ( )

References printF(), and u.

int GridFunction::primitiveToConservative ( int  gridToConvert = -1,
int  fixupUnsedPoints = false 
)

Convert primitive variables to conservative.

primitive : rho, u,v,w, T, species
conservative rho, (rho*u), (rho*v), (rho*w), E, (rho*species)

Parameters
gridToConvert(input) : by default (grid==-1) convert all grids, otherwise convert this grid.
fixupUnsedPoints(input) : if true fixup unused points

References assert(), pParams, and Parameters::primitiveToConservative().

Referenced by DomainSolver::advanceAdamsPredictorCorrector(), DomainSolver::advanceSecondOrderSystem(), DomainSolver::advanceSteadyStateRungeKutta(), DomainSolver::advanceVariableTimeStepAdamsPredictorCorrector(), DomainSolver::applyBoundaryConditions(), Cgins::determineErrors(), DomainSolver::determineErrors(), DomainSolver::eulerStep(), DomainSolver::getUt(), DomainSolver::initializeSolution(), DomainSolver::interpolate(), DomainSolver::takeTimeStepFE(), and DomainSolver::takeTimeStepPC().

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

References cg, dir, grid, and u.

Referenced by DomainSolver::saveRestartFile().

int GridFunction::referenceGridVelocity ( GridFunction gf)

Reference this gridVelocity to that of another grid function.

Parameters
gf(input) :

References assert(), cg, getGridVelocity(), grid, gridVelocity, and sizeOfGridVelocityArray.

void GridFunction::setParameters ( Parameters parameters)

Provide parameters.

Parameters
parameters(input) :

References pParams.

Referenced by DomainSolver::setup(), and DomainSolver::setupGridFunctions().

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

return the size of this object in bytes.

Parameters
file(input) : output any summary info to this file.

References cg, grid, gridVelocity, sizeOfGridVelocityArray, and u.

void GridFunction::updateGridVelocityArrays ( )
int GridFunction::updateToMatchGrid ( CompositeGrid &  cg0)

Member Data Documentation

CompositeGrid GridFunction::cg

reference to the grid associated with u

Referenced by DomainSolver::adaptGrids(), DomainSolver::addGrids(), DomainSolver::advance(), Cgsm::advance(), DomainSolver::advanceAdamsPredictorCorrector(), Cgad::advanceADI(), DeformingBodyMotion::advanceElasticShell(), DomainSolver::advanceImplicitMultiStep(), Cgsm::advanceMethodOfLines(), DomainSolver::advanceNewton(), DomainSolver::advanceSecondOrderSystem(), DomainSolver::advanceSteadyStateRungeKutta(), DomainSolver::advanceTrapezoidal(), DomainSolver::advanceVariableTimeStepAdamsPredictorCorrector(), Cgasf::allSpeedImplicitTimeStep(), Cgsm::applyBoundaryConditions(), DomainSolver::applyBoundaryConditions(), DomainSolver::applyBoundaryConditionsForImplicitTimeStepping(), DomainSolver::assignInitialConditions(), Cgmp::assignInterfaceBoundaryConditions(), Cgmp::assignInterfaceRightHandSide(), Cgmp::assignInterfaceRightHandSideOld(), Cgins::assignPressureRHS(), Cgcns::assignTestProblem(), Cgasf::assignTestProblem(), DomainSolver::boundaryConditionPredictor(), DomainSolver::buildAmrGridsForInitialConditions(), DomainSolver::buildGrid(), Cgsm::checkDisplacementAndStress(), DomainSolver::computeBodyForcing(), Cgins::computeTurbulenceQuantities(), CnsParameters::conservativeToPrimitive(), createGridVelocity(), MovingGrids::detectCollisions(), DomainSolver::eulerStep(), DomainSolver::extrapolateInterpolationNeighbours(), Cgasf::formAllSpeedPressureEquation(), Cgad::formMatrixForImplicitSolve(), Cgcns::formMatrixForImplicitSolve(), Cgins::formMatrixForImplicitSolve(), get(), Cgcns::getAugmentedSolution(), Cgins::getAugmentedSolution(), DomainSolver::getAugmentedSolution(), MovingGrids::getGridVelocity(), DomainSolver::getInitialConditions(), Cgmp::getInterfaceResiduals(), Cgmp::getInterfaceResidualsOld(), DomainSolver::getMaterialProperties(), Cgins::getResidual(), DomainSolver::getTimeDerivativeOfBoundaryValues(), DomainSolver::getTimeStep(), InsParameters::getTurbulenceModelVariables(), InsParameters::getTwoPhaseFlowVariables(), MovingGrids::getUserDefinedGridVelocity(), DomainSolver::getUt(), InsParameters::getViscoPlasticVariables(), Cgasf::gridAccelerationBC(), Cgins::gridAccelerationBC(), Cgad::implicitSolve(), Cgcns::implicitSolve(), Cgins::implicitSolve(), Cgins::initializeFactorization(), Cgmp::initializeInterfaceBoundaryConditions(), Cgasf::initializeSolution(), DomainSolver::initializeTimeSteppingIM(), DomainSolver::initializeTimeSteppingPC(), DeformingBodyMotion::integrate(), Cgmp::interfaceProjection(), DomainSolver::interpolateAndApplyBoundaryConditions(), DomainSolver::jetInflow(), MovingGrids::moveDeformingBodies(), MovingGrids::moveGrids(), DomainSolver::moveGrids(), DomainSolver::output(), DomainSolver::outputProbes(), DomainSolver::parabolicInflow(), Cgmp::plot(), DomainSolver::plot(), CnsParameters::primitiveToConservative(), DomainSolver::printMemoryUsage(), DomainSolver::printStatistics(), Cgins::project(), DomainSolver::project(), DomainSolver::readRestartFile(), referenceGridVelocity(), rigidBodyBoundaryProjection(), MovingGrids::rigidBodyMotion(), DomainSolver::saveShow(), DomainSolver::setInterfaceBoundaryCondition(), DomainSolver::setInterfacesAtPastTimes(), Cgad::setOgesBoundaryConditions(), Cgins::setOgesBoundaryConditions(), DomainSolver::setOgesBoundaryConditions(), DomainSolver::setParametersInteractively(), Cgsm::setupGridFunctions(), DomainSolver::setVariableMaterialProperties(), sizeOf(), Cgasf::solveForAllSpeedPressure(), Cgasf::solveForTimeIndependentVariables(), Cgins::solveForTimeIndependentVariables(), CGINS_ApproximateFactorization::INS_Factor::solveLeftHandSide(), CGINS_ApproximateFactorization::INS_Factor::solveRightHandSide(), DomainSolver::takeTimeStepAF(), DomainSolver::takeTimeStepFE(), DomainSolver::takeTimeStepIM(), DomainSolver::takeTimeStepPC(), DomainSolver::timeIndependentBoundaryConditions(), DomainSolver::tracking(), DomainSolver::updateForAdaptiveGrids(), Cgins::updateForMovingGrids(), DomainSolver::updateForMovingGrids(), Cgins::updateForNewTimeStep(), Cgad::updateGeometryArrays(), Cgcns::updateGeometryArrays(), Cgasf::updateGeometryArrays(), Cgins::updateGeometryArrays(), Cgsm::updateGeometryArrays(), updateGridVelocityArrays(), Cgcns::updateStateVariables(), updateToMatchGrid(), DomainSolver::updateToMatchNewGrid(), DomainSolver::updateVariableTimeInterpolation(), DeformingBodyMotion::userDefinedDeformingSurface(), DomainSolver::userDefinedForcing(), DomainSolver::userDefinedGrid(), DomainSolver::userDefinedMaterialProperties(), DomainSolver::userDefinedOutput(), and DomainSolver::variableTimeStepBoundaryInterpolation().

DataBase GridFunction::dbase
mutable
Forms GridFunction::form
realMappedGridFunction** GridFunction::gridVelocity
real GridFunction::gridVelocityTime
int GridFunction::numberOfTransformMappings

number of entries in the above array.

Referenced by GridFunction(), MovingGrids::moveGrids(), and ~GridFunction().

Parameters* GridFunction::pParams
int GridFunction::sizeOfGridVelocityArray
real GridFunction::t

time for grid function.

Referenced by DomainSolver::adaptGrids(), DomainSolver::advance(), Cgsm::advance(), Cgmp::advance(), DomainSolver::advanceAdamsPredictorCorrector(), Cgad::advanceADI(), DomainSolver::advanceImplicitMultiStep(), Cgsm::advanceMethodOfLines(), DomainSolver::advanceNewton(), DomainSolver::advanceSecondOrderSystem(), DomainSolver::advanceSteadyStateRungeKutta(), DomainSolver::advanceTrapezoidal(), DomainSolver::advanceVariableTimeStepAdamsPredictorCorrector(), Cgasf::allSpeedImplicitTimeStep(), Cgsm::applyBoundaryConditions(), DomainSolver::applyBoundaryConditions(), DomainSolver::applyBoundaryConditionsForImplicitTimeStepping(), Cgsm::assignAnnulusEigenfunction(), Cgsm::assignGaussianPulseInitialConditions(), Cgsm::assignHempInitialConditions(), DomainSolver::assignInitialConditions(), Cgmp::assignInterfaceBoundaryConditions(), Cgsm::assignParabolicInitialConditions(), Cgins::assignPressureRHS(), Cgsm::assignSpecialInitialConditions(), Cgsm::assignTwilightZoneInitialConditions(), DomainSolver::boundaryConditionPredictor(), DomainSolver::buildAmrGridsForInitialConditions(), DomainSolver::computeBodyForcing(), Cgins::computeTurbulenceQuantities(), MovingGrids::detectCollisions(), Cgins::determineErrors(), DomainSolver::determineErrors(), DomainSolver::eulerStep(), DomainSolver::extrapolateInterpolationNeighbours(), Cgad::formMatrixForImplicitSolve(), Cgcns::formMatrixForImplicitSolve(), Cgins::formMatrixForImplicitSolve(), get(), Cgcns::getAugmentedSolution(), Cgins::getAugmentedSolution(), DomainSolver::getAugmentedSolution(), MovingGrids::getGridVelocity(), DomainSolver::getInitialConditions(), Cgins::getResidual(), Cgmp::getTimeStep(), Cgsm::getTimeStep(), DomainSolver::getTimeStep(), DomainSolver::getTimeStepAndNumberOfSubSteps(), InsParameters::getTurbulenceModelVariables(), InsParameters::getTwoPhaseFlowVariables(), InsParameters::getViscoPlasticVariables(), GridFunction(), Cgad::implicitSolve(), Cgcns::implicitSolve(), Cgins::implicitSolve(), Cgins::initializeSolution(), DomainSolver::initializeSolution(), DomainSolver::initializeTimeSteppingIM(), DomainSolver::initializeTimeSteppingPC(), Cgmp::interfaceProjection(), DomainSolver::interpolate(), DomainSolver::interpolateAndApplyBoundaryConditions(), MovingGrids::moveGrids(), DomainSolver::moveGrids(), Cgmp::multiDomainAdvance(), Cgmp::multiDomainAdvanceNew(), DomainSolver::output(), DomainSolver::outputProbes(), DomainSolver::printStatistics(), readRestartFile(), DomainSolver::readRestartFile(), rigidBodyBoundaryProjection(), MovingGrids::rigidBodyMotion(), DomainSolver::saveRestartFile(), Cgsm::saveShow(), DomainSolver::saveShow(), DomainSolver::setup(), DomainSolver::setupGridFunctions(), Cgmp::solve(), Cgins::solveForTimeIndependentVariables(), CGINS_ApproximateFactorization::INS_Factor::solveLeftHandSide(), DomainSolver::takeTimeStepAF(), DomainSolver::takeTimeStepFE(), DomainSolver::takeTimeStepIM(), DomainSolver::takeTimeStepPC(), DomainSolver::timeIndependentBoundaryConditions(), Cgsm::updateForNewTimeStep(), updateGridVelocityArrays(), Cgins::updatePressureEquation(), Cgcns::updateStateVariables(), Cgins::updateStateVariables(), DomainSolver::userDefinedForcing(), and DomainSolver::userDefinedOutput().

MatrixTransform** GridFunction::transform

array of pointers to transformations for movement.

Referenced by DomainSolver::adaptGrids(), GridFunction(), MovingGrids::moveGrids(), MovingGrids::userDefinedTransformMotion(), and ~GridFunction().

realCompositeGridFunction GridFunction::u

solution values.

Referenced by DomainSolver::adaptGrids(), CGINS_ApproximateFactorization::INS_Factor::addExplicitContribution(), Cgins::addForcing(), Cgins::addForcingToPressureEquation(), DomainSolver::advance(), Cgsm::advance(), DomainSolver::advanceAdamsPredictorCorrector(), Cgad::advanceADI(), DeformingBodyMotion::advanceElasticShell(), Cgsm::advanceFOS(), DomainSolver::advanceImplicitMultiStep(), Cgsm::advanceMethodOfLines(), DomainSolver::advanceNewton(), DomainSolver::advanceSecondOrderSystem(), Cgsm::advanceSOS(), DomainSolver::advanceSteadyStateRungeKutta(), DomainSolver::advanceTrapezoidal(), DomainSolver::advanceVariableTimeStepAdamsPredictorCorrector(), Cgasf::allSpeedImplicitTimeStep(), Cgsm::applyBoundaryConditions(), DomainSolver::applyBoundaryConditions(), DomainSolver::applyBoundaryConditionsForImplicitTimeStepping(), Cgsm::assignAnnulusEigenfunction(), Cgsm::assignBoundaryConditionsSOS(), Cgsm::assignGaussianPulseInitialConditions(), Cgsm::assignHempInitialConditions(), Cgsm::assignInitialConditions(), DomainSolver::assignInitialConditions(), Cgmp::assignInterfaceBoundaryConditions(), Cgmp::assignInterfaceRightHandSideOld(), Cgsm::assignParabolicInitialConditions(), Cgins::assignPressureRHS(), Cgsm::assignSpecialInitialConditions(), Cgcns::assignTestProblem(), Cgasf::assignTestProblem(), Cgsm::assignTwilightZoneInitialConditions(), DomainSolver::boundaryConditionPredictor(), DomainSolver::buildAmrGridsForInitialConditions(), DomainSolver::buildRunTimeDialog(), Cgsm::checkDisplacementAndStress(), DomainSolver::computeBodyForcing(), Cgsm::computeDissipation(), Cgins::computeTurbulenceQuantities(), CnsParameters::conservativeToPrimitive(), Cgins::determineErrors(), DomainSolver::determineErrors(), DomainSolver::eulerStep(), DomainSolver::extrapolateInterpolationNeighbours(), Cgasf::formAllSpeedPressureEquation(), Cgad::formMatrixForImplicitSolve(), Cgcns::formMatrixForImplicitSolve(), Cgins::formMatrixForImplicitSolve(), get(), Cgcns::getAugmentedSolution(), Cgsm::getAugmentedSolution(), Cgins::getAugmentedSolution(), DomainSolver::getAugmentedSolution(), Cgsm::getEnergy(), Cgsm::getErrors(), Cgsm::getForcing(), getGridVelocity(), Cgsm::getInitialConditions(), DomainSolver::getInitialConditions(), Cgmp::getInterfaceResidualsOld(), Cgsm::getMaxDivAndCurl(), Cgins::getResidual(), DomainSolver::getTimeStep(), InsParameters::getTurbulenceModelVariables(), InsParameters::getTwoPhaseFlowVariables(), DomainSolver::getUt(), Cgsm::getVelocityAndStress(), InsParameters::getViscoPlasticVariables(), Cgasf::gridAccelerationBC(), Cgins::gridAccelerationBC(), Cgad::implicitSolve(), Cgcns::implicitSolve(), Cgins::implicitSolve(), Cgmp::initializeInterfaceBoundaryConditions(), Cgasf::initializeSolution(), DomainSolver::initializeSolution(), DomainSolver::initializeTimeSteppingIM(), DomainSolver::initializeTimeSteppingPC(), Cgins::initializeTurbulenceModels(), DeformingBodyMotion::integrate(), Cgmp::interfaceProjection(), DomainSolver::interpolate(), DomainSolver::interpolateAndApplyBoundaryConditions(), DomainSolver::outputProbes(), Cgsm::outputResultsAfterEachTimeStep(), DomainSolver::plot(), CnsParameters::primitiveToConservative(), Cgcns::project(), Cgins::project(), DomainSolver::project(), DomainSolver::readRestartFile(), rigidBodyBoundaryProjection(), MovingGrids::rigidBodyMotion(), DomainSolver::saveShow(), DomainSolver::setParametersInteractively(), Cgsm::setup(), DomainSolver::setup(), Cgad::setupGridFunctions(), Cgcns::setupGridFunctions(), Cgasf::setupGridFunctions(), Cgins::setupGridFunctions(), Cgsm::setupGridFunctions(), DomainSolver::setupGridFunctions(), Cgad::setupPde(), Cgcns::setupPde(), Cgasf::setupPde(), Cgins::setupPde(), Cgsm::setupPde(), DomainSolver::setVariableBoundaryValues(), sizeOf(), DomainSolver::smoothVelocity(), Cgasf::solveForAllSpeedPressure(), Cgasf::solveForTimeIndependentVariables(), Cgins::solveForTimeIndependentVariables(), CGINS_ApproximateFactorization::INS_Factor::solveLeftHandSide(), CGINS_ApproximateFactorization::INS_Factor::solveRightHandSide(), DomainSolver::takeTimeStepAF(), DomainSolver::takeTimeStepFE(), DomainSolver::takeTimeStepIM(), DomainSolver::takeTimeStepPC(), DomainSolver::tracking(), DomainSolver::updateForAdaptiveGrids(), Cgins::updateForMovingGrids(), DomainSolver::updateForMovingGrids(), Cgins::updatePressureEquation(), Cgcns::updateStateVariables(), Cgins::updateStateVariables(), DomainSolver::updateToMatchNewGrid(), DomainSolver::updateVariableTimeInterpolation(), DomainSolver::updateWorkSpace(), Cgsm::userDefinedBoundaryValues(), DomainSolver::userDefinedBoundaryValues(), DeformingBodyMotion::userDefinedDeformingSurface(), DomainSolver::userDefinedForcing(), DomainSolver::userDefinedGrid(), DomainSolver::userDefinedOutput(), and DomainSolver::variableTimeStepBoundaryInterpolation().


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