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

#include <DerivedFunctions.h>

Collaboration diagram for DerivedFunctions:
Collaboration graph
[legend]

Public Types

enum  DerivedItems {
  vorticity =0, xVorticity, yVorticity, zVorticity,
  enstrophy, divergence, machNumber, pressure,
  temperature, speed, entropy, schlieren,
  minimumScale, r1MinimumScale, r2MinimumScale, r3MinimumScale,
  r1Velocity, r2Velocity, r3Velocity, xDerivative,
  yDerivative, zDerivative, xxDerivative, yyDerivative,
  zzDerivative, laplaceDerivative, gradientNorm, cellVolume,
  minimumEdgeLength, logarithm, userDefined, energyDensity,
  eFieldNorm, hFieldNorm, displacementNorm, stressNorm,
  numberOfDerivedItems
}
 

Public Member Functions

 DerivedFunctions (ShowFileReader &showFileReader)
 
 DerivedFunctions ()
 
 ~DerivedFunctions ()
 
int add (int derivative, const aString &name_, int n1=0, int n2=0)
 
int getASolution (int &solutionNumber, MappedGrid &cg, realMappedGridFunction &u)
 
int getASolution (int &solutionNumber, CompositeGrid &cg, realCompositeGridFunction &u)
 
int getDisplacementComponents (int &u1c, int &u2c, int &u3c)
 Lookup the displacement components.
 
int getVelocityComponents (int &v1c, int &v2c, int &v3c)
 Lookup the velocity components.
 
int getStressComponents (int &s11c, int &s12c, int &s13c, int &s21c, int &s22c, int &s23c, int &s31c, int &s32c, int &s33c)
 Lookup the stress components.
 
int numberOfDerivedTypes () const
 
int remove (int i)
 
void set (ShowFileReader &showFileReader)
 Supply a ShowFileReader.
 
int setupUserDefinedDerivedFunction (GenericGraphicsInterface &gi, int numberOfComponents, aString *componentNames)
 
int getUserDefinedDerivedFunction (int index, int indexOut, const aString &name, const int numberOfComponents, realCompositeGridFunction &uIn, realCompositeGridFunction &uOut, bool &interpolationRequired)
 
int update (GenericGraphicsInterface &gi, int numberOfComponents, aString *componentNames, GraphicsParameters *pgp=NULL)
 

Protected Member Functions

int computeDerivedFunctions (realCompositeGridFunction &u)
 
int getComponent (int &c, const aString &cName)
 
void initialize ()
 

Protected Attributes

ShowFileReader * showFileReader
 
int numberOfDerivedFunctions
 
IntegerArray derived
 
aString * name
 
real exposure
 
real amplification
 
int velocityComponent [3]
 
int displacementComponent [3]
 
int stressComponent [9]
 

Member Enumeration Documentation

enum DerivedFunctions::DerivedItems
Enumerator
vorticity 
xVorticity 
yVorticity 
zVorticity 
enstrophy 
divergence 
machNumber 
pressure 
temperature 
speed 
entropy 
schlieren 
minimumScale 
r1MinimumScale 
r2MinimumScale 
r3MinimumScale 
r1Velocity 
r2Velocity 
r3Velocity 
xDerivative 
yDerivative 
zDerivative 
xxDerivative 
yyDerivative 
zzDerivative 
laplaceDerivative 
gradientNorm 
cellVolume 
minimumEdgeLength 
logarithm 
userDefined 
energyDensity 
eFieldNorm 
hFieldNorm 
displacementNorm 
stressNorm 
numberOfDerivedItems 

Constructor & Destructor Documentation

DerivedFunctions::DerivedFunctions ( ShowFileReader &  showFileReader)

References initialize(), and showFileReader.

DerivedFunctions::DerivedFunctions ( )

References initialize().

DerivedFunctions::~DerivedFunctions ( )

References name.

Member Function Documentation

int DerivedFunctions::add ( int  derivative,
const aString &  name_,
int  n1 = 0,
int  n2 = 0 
)

References aString, derived, name, and numberOfDerivedFunctions.

Referenced by setupUserDefinedDerivedFunction(), and update().

int DerivedFunctions::computeDerivedFunctions ( realCompositeGridFunction &  u)
protected

References Overture::abort(), amplification, assert, axis2, boundaryCondition, cellVolume, MappedGridOperators::derivative(), derived, dimension, displacementNorm, display(), divergence, dr, E, eFieldNorm, energyDensity, enstrophy, entropy, exposure, fabs(), FOR_3D, getBoundaryIndex(), getComponent(), doubleGridCollectionFunction::getComponentDimension(), doubleCompositeGridFunction::getCompositeGrid(), getDisplacementComponents(), ShowFileReader::getFrame(), ShowFileReader::getGeneralParameter(), getIndex(), ParallelUtility::getLocalArrayBounds(), getLocalArrayWithGhostBoundaries(), ParallelUtility::getMaxValue(), ParallelUtility::getMinValue(), doubleGridCollectionFunction::getName(), ReferenceCounting::getReferenceCount(), getStressComponents(), getUserDefinedDerivedFunction(), getVelocityComponents(), gradientNorm, gridIndexRange, hFieldNorm, i2, indexRange, GridCollectionData::interpolant, doubleCompositeGridFunction::interpolate(), Interpolant::iterateToInterpolate, laplaceDerivative, MappedGridOperators::laplacianOperator, log(), logarithm, machNumber, mask, MASK, max(), min(), minimumEdgeLength, minimumScale, name, NULL, numberOfDerivedFunctions, GridCollection::numberOfDimensions(), GenericGridCollection::numberOfGrids(), pow(), pressure, printF(), R, r1MinimumScale, r1Velocity, r2MinimumScale, r2Velocity, r3MinimumScale, r3Velocity, CompositeGrid::rcData, REAL_MAX, REAL_MIN, doubleCompositeGridFunction::reference(), rx, schlieren, Interpolant::setImplicitInterpolationMethod(), Interpolant::setMaximumNumberOfIterations(), doubleGridCollectionFunction::setName(), doubleCompositeGridFunction::setOperators(), showFileReader, speed, sPrintF(), SQR, stressNorm, temperature, MappedGrid::THEcellVolume, MappedGrid::THEvertex, MappedGrid::THEvertexDerivative, CompositeGrid::update(), userDefined, V, vorticity, X, x, xDerivative, MappedGridOperators::xDerivative, xr, xVorticity, xxDerivative, MappedGridOperators::xxDerivative, yDerivative, MappedGridOperators::yDerivative, yVorticity, yyDerivative, MappedGridOperators::yyDerivative, zDerivative, MappedGridOperators::zDerivative, zVorticity, zzDerivative, and MappedGridOperators::zzDerivative.

Referenced by getASolution().

int DerivedFunctions::getASolution ( int &  solutionNumber,
MappedGrid &  cg,
realMappedGridFunction &  u 
)

References printF().

Referenced by ShowFilePlotter::plot().

int DerivedFunctions::getASolution ( int &  solutionNumber,
CompositeGrid &  cg,
realCompositeGridFunction &  u 
)

References assert, computeDerivedFunctions(), ShowFileReader::getASolution(), NULL, and showFileReader.

int DerivedFunctions::getComponent ( int &  c,
const aString &  cName 
)
protected

References HDF_DataBase::get(), ShowFileReader::getFrame(), ShowFileReader::getGeneralParameter(), and showFileReader.

Referenced by computeDerivedFunctions(), getDisplacementComponents(), getStressComponents(), and getVelocityComponents().

int DerivedFunctions::getDisplacementComponents ( int &  u1c,
int &  u2c,
int &  u3c 
)

Lookup the displacement components.

References displacementComponent, and getComponent().

Referenced by computeDerivedFunctions().

int DerivedFunctions::getStressComponents ( int &  s11c,
int &  s12c,
int &  s13c,
int &  s21c,
int &  s22c,
int &  s23c,
int &  s31c,
int &  s32c,
int &  s33c 
)

Lookup the stress components.

References getComponent(), and stressComponent.

Referenced by computeDerivedFunctions(), and getUserDefinedDerivedFunction().

int DerivedFunctions::getUserDefinedDerivedFunction ( int  index,
int  indexOut,
const aString &  name,
const int  numberOfComponents,
realCompositeGridFunction &  uIn,
realCompositeGridFunction &  uOut,
bool &  interpolationRequired 
)

References amplification, assert, aString, MappedGrid::boundaryCondition(), MappedGridOperators::derivative(), derived, dimension, MappedGrid::dimension(), exposure, fabs(), FOR_3D, HDF_DataBase::get(), getBoundaryIndex(), doubleCompositeGridFunction::getCompositeGrid(), ShowFileReader::getFrame(), ShowFileReader::getGeneralParameter(), getIndex(), ParallelUtility::getLocalArrayBounds(), getLocalArrayWithGhostBoundaries(), getStressComponents(), getVelocityComponents(), MappedGrid::gridIndexRange(), i2, MappedGrid::indexRange(), mask, MappedGrid::mask(), max(), min(), normal, NULL, GridCollection::numberOfDimensions(), MappedGrid::numberOfDimensions(), GenericGridCollection::numberOfGrids(), OV_ABORT, printF(), REAL_MAX, REAL_MIN, rx, doubleCompositeGridFunction::setOperators(), showFileReader, SQR, SQRT, MappedGrid::THEcenter, MappedGrid::THEvertex, MappedGrid::THEvertexBoundaryNormal, MappedGrid::update(), MappedGrid::vertex(), MappedGrid::vertexBoundaryNormal(), MappedGrid::vertexBoundaryNormalArray(), x, MappedGridOperators::xDerivative, MappedGridOperators::yDerivative, and MappedGridOperators::zDerivative.

Referenced by computeDerivedFunctions().

int DerivedFunctions::getVelocityComponents ( int &  v1c,
int &  v2c,
int &  v3c 
)

Lookup the velocity components.

References getComponent(), printF(), and velocityComponent.

Referenced by computeDerivedFunctions(), and getUserDefinedDerivedFunction().

void DerivedFunctions::initialize ( )
protected

References amplification, displacementComponent, exposure, name, NULL, numberOfDerivedFunctions, showFileReader, stressComponent, and velocityComponent.

Referenced by DerivedFunctions().

int DerivedFunctions::numberOfDerivedTypes ( ) const
inline

References numberOfDerivedFunctions.

Referenced by ShowFilePlotter::plot().

int DerivedFunctions::remove ( int  i)

References derived, numberOfDerivedFunctions, and printF().

void DerivedFunctions::set ( ShowFileReader &  showFileReader)

Supply a ShowFileReader.

References showFileReader.

int DerivedFunctions::setupUserDefinedDerivedFunction ( GenericGraphicsInterface &  gi,
int  numberOfComponents,
aString *  componentNames 
)

References add(), assert, aString, ShowFileReader::getGeneralParameter(), GenericGraphicsInterface::getMenuItem(), GenericGraphicsInterface::inputString(), NULL, printF(), s, showFileReader, sScanF(), GenericGraphicsInterface::stopReadingCommandFile(), and userDefined.

Referenced by update().

int DerivedFunctions::update ( GenericGraphicsInterface &  gi,
int  numberOfComponents,
aString *  componentNames,
GraphicsParameters *  pgp = NULL 
)

References add(), amplification, aString, c, cellVolume, displacementComponent, displacementNorm, divergence, eFieldNorm, energyDensity, enstrophy, entropy, exposure, GenericGraphicsInterface::getMenuItem(), GI_DISPLACEMENT_U_COMPONENT, GI_DISPLACEMENT_V_COMPONENT, GI_DISPLACEMENT_W_COMPONENT, GI_U_COMPONENT_FOR_STREAM_LINES, gradientNorm, hFieldNorm, GenericGraphicsInterface::inputString(), laplaceDerivative, logarithm, machNumber, minimumEdgeLength, minimumScale, name, NULL, numberOfDerivedFunctions, pressure, printF(), r1MinimumScale, r1Velocity, r2MinimumScale, r2Velocity, r3MinimumScale, r3Velocity, schlieren, GraphicsParameters::set(), setupUserDefinedDerivedFunction(), speed, sPrintF(), sScanF(), GenericGraphicsInterface::stopReadingCommandFile(), stressComponent, stressNorm, temperature, velocityComponent, vorticity, xDerivative, xVorticity, xxDerivative, yDerivative, yVorticity, yyDerivative, zDerivative, zVorticity, and zzDerivative.

Referenced by ShowFilePlotter::plot().

Member Data Documentation

real DerivedFunctions::amplification
protected

Referenced by computeDerivedFunctions(), getUserDefinedDerivedFunction(), initialize(), and update().

IntegerArray DerivedFunctions::derived
protected

Referenced by add(), computeDerivedFunctions(), getUserDefinedDerivedFunction(), and remove().

int DerivedFunctions::displacementComponent[3]
protected

Referenced by getDisplacementComponents(), initialize(), and update().

real DerivedFunctions::exposure
protected

Referenced by computeDerivedFunctions(), getUserDefinedDerivedFunction(), initialize(), and update().

aString* DerivedFunctions::name
protected

Referenced by add(), computeDerivedFunctions(), initialize(), update(), and ~DerivedFunctions().

int DerivedFunctions::numberOfDerivedFunctions
protected

Referenced by add(), computeDerivedFunctions(), initialize(), numberOfDerivedTypes(), remove(), and update().

ShowFileReader* DerivedFunctions::showFileReader
protected

Referenced by computeDerivedFunctions(), DerivedFunctions(), getASolution(), getComponent(), getUserDefinedDerivedFunction(), initialize(), set(), and setupUserDefinedDerivedFunction().

int DerivedFunctions::stressComponent[9]
protected

Referenced by getStressComponents(), initialize(), and update().

int DerivedFunctions::velocityComponent[3]
protected

Referenced by getVelocityComponents(), initialize(), and update().

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