Classes | |
| class | ObukhovLength |
| Computes the Obukhov length field and associated friction velocity field. More... | |
| class | volRegion |
| Volume (cell) region selection class. More... | |
| class | add |
| Sums a given list of (at least two or more) fields and outputs the result into a new field, where the fields possess the same sizes and dimensions: More... | |
| class | AMIWeights |
| Computes the min/max/average weights of arbitrary mesh interface (AMI) patches, and optionally reports to a text file or writes VTK surfaces of the sum of the weights and mask fields for arbitrarily coupled mesh interface (ACMI) patches. More... | |
| class | binField |
| Calculates binned data, where specified patches are divided into segments according to various input bin characteristics, so that spatially-localised information can be output for each segment. More... | |
| class | blendingFactor |
| Computes blending factor as an indicator about which of the schemes is active across the domain. More... | |
| class | columnAverage |
Computes the arithmetic average of given quantities along columns of cells in a given direction for structured-like layered meshes. It is, for example, useful for channel-like cases where spanwise average of a field is desired. However, the columnAverage function object does not operate on arbitrary unstructured meshes. More... | |
| class | components |
| Extracts the components of elements of a field and outputs the result into new fields, where the fields possess the same sizes and dimensions. More... | |
| class | continuityError |
| Computes local, global and cumulative continuity errors for a flux field. More... | |
| class | CourantNo |
| Computes the Courant number field for time-variant simulations. More... | |
| class | Curle |
| Computes the acoustic pressure based on Curle's analogy. More... | |
| class | ddt |
| Computes the Eulerian time derivative of an input volume field for time-variant simulations (not appropriate to steady-state simulations). More... | |
| class | ddt2 |
| Computes the magnitude or magnitude squared of the Eulerian time derivative of an input volume field for time-variant simulations (not appropriate to steady-state simulations). More... | |
| class | derivedFields |
Computes two predefined derived fields, i.e. rhoU, and pTotal, where the defined fields are hard-coded as follows: More... | |
| class | DESModelRegions |
| Computes an indicator field for detached eddy simulation (DES) turbulence calculations, where the values of the indicator mean: More... | |
| class | div |
| Computes the divergence of an input field. More... | |
| class | DMD |
| Computes a dynamic mode decomposition model on a specified field. More... | |
| class | enstrophy |
Computes the enstrophy of an input volVectorField. More... | |
| class | fvExpressionField |
| Function object that generates or modifies a field based on expressions. More... | |
| class | externalCoupled |
| Provides a simple file-based communication interface for explicit coupling with an external application, so that data is transferred to- and from OpenFOAM. The data exchange employs specialised boundary conditions to provide either one-way or two-way coupling models. More... | |
| class | extractEulerianParticles |
Generates particle size information from Eulerian calculations, e.g. VoF. More... | |
| class | fieldAverage |
| Computes ensemble- and/or time-based field averages, with optional windowing, for a user-specified selection of volumetric and/or surface fields. More... | |
| class | fieldExpression |
Intermediate class for handling field expression function objects (e.g. blendingFactor etc.) whereinto a single field is input. More... | |
| class | fieldExtents |
| Computes the spatial minimum and maximum extents of an input field. More... | |
| class | fieldMinMax |
| Computes the values and locations of field minima and maxima. These are good indicators of calculation performance, e.g. to confirm that predicted results are within expected bounds, or how well a case is converging. More... | |
| class | fieldsExpression |
Intermediate class for handling field expression function objects (e.g. add, subtract etc.) whereinto more than one fields are input. More... | |
| class | fieldValue |
| Intermediate class for handling field value-based function objects. More... | |
| class | surfaceFieldValue |
A face regionType variant of the fieldValues function object. More... | |
| class | volFieldValue |
Provides a 'volRegion' specialization of the fieldValue function object. More... | |
| class | flowType |
| Computes the flow type indicator of an input velocity field. More... | |
| class | flux |
| Computes the flux of an input vector field. More... | |
| class | fluxSummary |
| Computes the volumetric- or mass-flux information across selections of face zones. More... | |
| class | grad |
| Computes the gradient of an input field. More... | |
| class | heatTransferCoeff |
Computes the heat transfer coefficient [W/(m2 K)] as a volScalarField for a given set of patches. More... | |
| class | histogram |
Computes the volume-weighted histogram of an input volScalarField. More... | |
| class | Lambda2 |
| Computes 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 |
Computes 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 function object on this LambVector function object. More... | |
| class | limitFields |
| Limits input fields to user-specified min and max bounds. More... | |
| class | log |
Computes the natural logarithm of an input volScalarField. More... | |
| class | MachNo |
Computes the Mach number as a volScalarField. More... | |
| class | mag |
| Computes the magnitude of an input field. More... | |
| class | magSqr |
| Computes the magnitude of the square of an input field. More... | |
| class | mapFields |
| Maps input fields from local mesh to secondary mesh at runtime. More... | |
| class | momentum |
| Computes linear/angular momentum, reporting integral values and optionally writing the fields. More... | |
| class | multiFieldValue |
| Computes a selected operation between multiple function objects. More... | |
| class | multiply |
| Multiplies a given list of (at least two or more) fields and outputs the result into a new field. More... | |
| class | nearWallFields |
| Samples near-patch volume fields within an input distance range. More... | |
| class | norm |
| Normalises an input field with a chosen norm, and outputs a new normalised field. More... | |
| class | particleDistribution |
| Generates a particle distribution for lagrangian data at a given time. More... | |
| class | PecletNo |
Computes the Peclet number as a surfaceScalarField. More... | |
| class | pow |
Computes the power of an input volScalarField. More... | |
| class | pressure |
| Provides several methods to convert an input pressure field into derived forms, including: More... | |
| class | processorField |
Writes a scalar field whose value is the local processor ID. The output field name is processorID. More... | |
| class | proudmanAcousticPower |
| Computes the acoustic power due to the volume of isotropic turbulence using Proudman's formula. More... | |
| class | Q |
| Computes the second invariant of the velocity gradient tensor \([s^{-2}]\). More... | |
| class | randomise |
| Adds a random component to an input field, with a specified perturbation magnitude. More... | |
| class | reactionsSensitivityAnalysis< chemistryType > |
| Computes indicators for reaction rates of creation or destruction of species in each reaction. More... | |
| class | readFields |
| Reads fields from the time directories and adds them to the mesh database for further post-processing. More... | |
| class | reference |
| Computes a field whose values are offset to a reference value obtained by from a Function1. More... | |
| class | regionSizeDistribution |
| Creates a droplet 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 |
Computes the stabilityBlendingFactor to be used by the local blended convection scheme. The output is a surface field weight between 0-1. More... | |
| class | streamFunction |
| Computes the stream function (i.e. https://w.wiki/Ncm). 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 |
| Subtracts a given list of (at least one or more) fields from a field and produces a new field, where the fields possess the same sizes and dimensions. More... | |
| class | surfaceDistance |
| Computes the distance to the nearest surface from a given geometry. More... | |
| class | surfaceInterpolate |
| Linearly interpolates volume fields to generate surface fields. More... | |
| class | turbulenceFields |
| Computes various turbulence-related quantities that are not typically output during calculations, and stores/writes them on the mesh database for further manipulation. More... | |
| class | valueAverage |
Computes the ensemble- or time-based singular-value average values, with optional windowing, from the output of function objects that generate non-field type values (e.g. Cd of forceCoeffs or momentum_x in momentum function objects). More... | |
| class | vorticity |
| Computes 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 |
| Computes the near wall \(y_1^+\) for turbulence models. More... | |
| class | zeroGradient |
| 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 | filmFlux |
| Calculates the mass flux for surface film models. More... | |
| class | specieReactionRates< ChemistryModelType > |
| Writes the domain averaged reaction rates for each specie for each reaction into the file <timeDir>/specieReactionRates.dat. More... | |
This group contains field-based function objects
Function objects in this group are packaged into the libfieldFunctionObjects.so library.
1.9.5 