Field function objects
Collaboration diagram for Field function objects:

Classes

class  volRegion
 Volume (cell) region selection class. More...
 
class  add
 Add a list of fields. More...
 
class  AMIWeights
 
class  blendingFactor
 Calculates and outputs the blendingFactor as used by the bended convection schemes. The output is a volume field (cells) whose value is calculated via the maximum blending factor for any cell face. More...
 
class  columnAverage
 Averages columns of cells for layered meshes. More...
 
class  components
 Calculates the components of a field. More...
 
class  continuityError
 Calculates the continuity error for a flux field. More...
 
class  CourantNo
 This function object calculates and outputs the Courant number as a volScalarField. The field is stored on the mesh database so that it can be retrieved and used for other applications. More...
 
class  Curle
 Calculates the acoustic pressure based on Curle's analogy. More...
 
class  ddt
 Calculates the Eulerian time derivative of a field. More...
 
class  ddt2
 This function object calculates the magnitude squared of d(scalarField)/dt. More...
 
class  derivedFields
 A limited set of predefined derived fields ("rhoU", "pTotal"). More...
 
class  DESModelRegions
 This function object writes out an indicator field for DES turbulence calculations, that is: More...
 
class  div
 Calculates the divergence of a field. The operation is limited to surfaceScalarFields and volVectorFields, and the output is a volScalarField. More...
 
class  enstrophy
 Calculates the enstrophy of the velocity. More...
 
class  externalCoupled
 This functionObject provides a simple interface for explicit coupling with an external application. More...
 
class  extractEulerianParticles
 Generates particle size information from Eulerian calculations, e.g. VoF. More...
 
class  fieldAverage
 Calculates average quantities for a user-specified selection of volumetric and surface fields. With the subRegion option, also supports fields on functionObject surface output (eg, sampledSurfaces). More...
 
class  fieldCoordinateSystemTransform
 Transforms a user-specified selection of fields from global Cartesian coordinates to a local coordinate system. The fields are run-time modifiable. More...
 
class  fieldExpression
 Base class for field expression function objects. More...
 
class  fieldExtents
 Calculates the spatial minimum and maximum extents of a field. More...
 
class  fieldMinMax
 Calculates the value and location of scalar minimum and maximum for a list of user-specified fields. More...
 
class  fieldsExpression
 
class  fieldValue
 Base class for field value-based function objects. More...
 
class  fieldValueDelta
 Provides an operation between two 'field value' function objects. More...
 
class  surfaceFieldValue
 Provides a 'face regionType' variant of the fieldValues function object. More...
 
class  volFieldValue
 Provides a 'volRegion' specialization of the fieldValue function object. More...
 
class  flowType
 Calculates and writes the flowType of a velocity field. More...
 
class  flux
 Calculates the flux of a field. The operation is limited to surfaceVectorFields and volVectorFields, and the output is a surfaceScalarField. More...
 
class  fluxSummary
 This function object calculates the flux across selections of faces. More...
 
class  grad
 Calculates the gradient of a field. More...
 
class  heatTransferCoeff
 This function object calculates and writes the heat transfer coefficient as a volScalarField for a set of patches. More...
 
class  histogram
 Write the volume-weighted histogram of a volScalarField. More...
 
class  Lambda2
 Calculates and outputs the second largest eigenvalue of the sum of the square of the symmetrical and anti-symmetrical parts of the velocity gradient tensor. More...
 
class  lambVector
 Calculates Lamb vector, i.e. the cross product of vorticity and velocity. Calculation of the divergence of the Lamb vector can be performed by using 'div' functionObject on this 'lambVector' functionObject. More...
 
class  MachNo
 Calculates and writes the Mach number as a volScalarField. More...
 
class  mag
 Calculates the magnitude of a field. More...
 
class  magSqr
 Calculates the magnitude of the sqr of a field. More...
 
class  mapFields
 Map fields from local mesh to secondary mesh at run-time. More...
 
class  momentum
 Calculates linear/angular momentum, reporting integral values and optionally writing the fields. More...
 
class  nearWallFields
 Samples near-patch volume fields. More...
 
class  particleDistribution
 Generates a particle distribution for lagrangian data at a given time. More...
 
class  PecletNo
 Calculates and outputs the Peclet number as a surfaceScalarField. More...
 
class  pressure
 Includes tools to manipulate the pressure into different forms. More...
 
class  processorField
 Writes a scalar field whose value is the local processor ID. The output field name is 'processorID'. More...
 
class  Q
 Calculates and outputs the second invariant of the velocity gradient tensor [1/s^2]. More...
 
class  randomise
 Adds a random component to a field, with a specified perturbation magnitude. More...
 
class  reactionsSensitivityAnalysis< chemistryType >
 This function object creates four data files named: More...
 
class  readFields
 Reads fields from the time directories and adds them to the mesh database for further post-processing. More...
 
class  reference
 Calculates and outputs a field whose values are offset to a reference value obtained by sampling the field at a user-specified location. More...
 
class  regionSizeDistribution
 Creates a size distribution via interrogating a continuous phase fraction field. More...
 
class  setFlow
 Provides options to set the velocity and flux fields as a function of time. More...
 
class  stabilityBlendingFactor
 Calculates and outputs the stabilityBlendingFactor to be used by the local blended convection scheme. The output is a surface field weight between 0-1. More...
 
class  streamFunction
 This function object calculates and outputs the stream-function as a pointScalarField. More...
 
class  streamLine
 Generates streamline data by sampling a set of user-specified fields along a particle track, transported by a user-specified velocity field. More...
 
class  subtract
 From the first field subtract the remaining fields in the list. More...
 
class  surfaceInterpolate
 Linearly interpolates volume fields to generate surface fields. More...
 
class  turbulenceFields
 Stores turbulence fields on the mesh database for further manipulation. More...
 
class  valueAverage
 This function object calculates the average value from the output of function objects that generate singular values. More...
 
class  vorticity
 Calculates the vorticity, the curl of the velocity. More...
 
class  wallBoundedStreamLine
 Generates streamline data by sampling a set of user-specified fields along a particle track, transported by a user-specified velocity field, constrained to a patch. More...
 
class  writeCellCentres
 Writes the cell-centres volVectorField and the three component fields as volScalarFields. More...
 
class  writeCellVolumes
 Writes the cell-volumes volScalarField. More...
 
class  XiReactionRate
 Writes the turbulent flame-speed and reaction-rate volScalarFields for the Xi-based combustion models. More...
 
class  yPlus
 Evaluates and outputs turbulence y+ for turbulence models. More...
 
class  zeroGradient
 This function object creates a volume field with zero-gradient boundary conditions from another volume field. More...
 
class  energySpectrum
 Calculates the energy spectrum for a structured IJK mesh. More...
 
class  specieReactionRates< ChemistryModelType >
 Writes the domain averaged reaction rates for each specie for each reaction into the file <timeDir>/specieReactionRates.dat. More...
 

Detailed Description

This group contains field-based function objects

Function objects in this group are packaged into the libfieldFunctionObjects.so library.