|
| class | abort |
| | Watches for presence of the named file in the $FOAM_CASE directory and aborts the calculation if it is present. More...
|
| |
| class | add |
| | Add a list of fields. More...
|
| |
| class | age |
| | Calculates and writes out the time taken for a particle to travel from an inlet to the location. Solves the following equation when incompressible:
![\[ \div (\phi t) = 1 \]](form_109.png)
where: More...
|
| |
| 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 | cloudInfo |
| | Outputs Lagrangian cloud information to a file. More...
|
| |
| class | components |
| | Calculates the components of a field. More...
|
| |
| class | CourantNo |
| | 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 | ddt |
| | Calculates the Eulerian time derivative of a field. 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 | dsmcFields |
| | Calculate intensive fields: More...
|
| |
| class | enstrophy |
| | Calculates the enstrophy of the velocity. More...
|
| |
| class | fieldAverage |
| | Calculates average quantities for a user-specified selection of volumetric and surface fields. More...
|
| |
| class | fieldAverageItem |
| | Helper class to describe what form of averaging to apply. A set will be applied to each base field in Foam::fieldAverage, of the form: More...
|
| |
| class | fieldCoordinateSystemTransform |
| | Transforms a user-specified selection of fields from global Cartesian co-ordinates to a local co-ordinate system. The fields are run-time modifiable. More...
|
| |
| class | fieldExpression |
| |
| 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 | flowType |
| | Calculates and writes the flowType of a velocity field. More...
|
| |
| class | forceCoeffs |
| | Extends the forces functionObject by providing lift, drag and moment coefficients. The data can optionally be output into bins, defined in a given direction. More...
|
| |
| class | forces |
| | Calculates the forces and moments by integrating the pressure and skin-friction forces over a given list of patches. More...
|
| |
| class | fvMeshFunctionObject |
| | Specialization of Foam::functionObject for an Foam::fvMesh, providing a reference to the Foam::fvMesh. More...
|
| |
| class | grad |
| | Calculates the gradient of a field. More...
|
| |
| class | histogram |
| | Write the volume-weighted histogram of a volScalarField. More...
|
| |
| class | icoUncoupledKinematicCloud |
| | This functionObject tracks a uncoupled kinematic particle cloud in the specified velocity field of an incompressible flow (laminar, RANS or LES). More...
|
| |
| class | interfaceHeight |
| | This function object reports the height of the interface above a set of locations. For each location, it writes the vertical distance of the interface above both the location and the lowest boundary. It also writes the point on the interface from which these heights are computed. It uses an integral approach, so if there are multiple interfaces above or below a location then this method will generate average values. 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 | log |
| | Calculates the natural logarithm of the specified scalar field. More...
|
| |
| class | logFiles |
| | functionObject base class for creating, maintaining and writing log files e.g. integrated of averaged field data vs time. 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 | nearWallFields |
| | Samples near-patch volume fields. More...
|
| |
| class | PecletNo |
| | Calculates and outputs the Peclet number as a surfaceScalarField. More...
|
| |
| class | phaseForces |
| | This function object calculates and outputs the blended interfacial forces acting on a given phase, i.e. drag, virtual mass, lift, wall-lubrication and turbulent dispersion. Note that it works only in run-time processing mode and in combination with the reactingEulerFoam solvers. More...
|
| |
| class | phaseScalarTransport |
| | Evolves a passive scalar transport equation within one phase of a multiphase simulation. The scalar is considered to be a phase-intensive property; i.e., its value represents an amount per-unit of the phase. In addition to the scalar, the function also writes out the product of the volume fraction and the scalar, as this provides a phase-extensive field which is often more convenient to post-process. 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 | Qdot |
| | Calculates and outputs the heat release rate for the current combustion model. More...
|
| |
| class | randomise |
| | Adds a random component to a field, with a specified perturbation magnitude. More...
|
| |
| class | readFields |
| | Reads fields from the time directories and adds them to the mesh database for further post-processing. More...
|
| |
| class | regionFunctionObject |
| | Specialization of Foam::functionObject for a region and providing a reference to the region Foam::objectRegistry. More...
|
| |
| class | regionSizeDistribution |
| | Creates a size distribution via interrogating a continuous phase fraction field. More...
|
| |
| class | removeRegisteredObject |
| | Removes registered objects if present in the database. More...
|
| |
| class | residuals |
| | Writes out the initial residual for specified fields. More...
|
| |
| class | rigidBodyState |
| | Writes the rigid body motion state. More...
|
| |
| class | scalarTransport |
| | Evolves a passive scalar transport equation. More...
|
| |
| class | scale |
| | Multiplies a field by a scaling factor. More...
|
| |
| class | setTimeStepFunctionObject |
| | Overrides the timeStep. Can only be used with solvers with adjustTimeStep control (e.g. pimpleFoam). Makes no attempt to cooperate with other timeStep 'controllers' (maxCo, other functionObjects). Supports 'enabled' flag but none of the other ones 'startTime', 'endTime', 'writeControl' etc. More...
|
| |
| class | sixDoFRigidBodyControl |
| | Convergence control based on the 6-DoF motion state. More...
|
| |
| class | sixDoFRigidBodyState |
| | Writes the 6-DoF motion state. More...
|
| |
| class | sizeDistribution |
| | This function object calculates and outputs information about the size distribution of the dispersed phase, such as the number density function or its moments. It is designed to be used exclusively with the population balance modeling functionality of the reactingEulerFoam solvers. It can be applied to a specific cellZone or the entire domain. More...
|
| |
| class | specieReactionRates |
| | Writes the domain averaged reaction rates for each specie for each reaction into the file <timeDir>/specieReactionRates.dat. 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 | systemCall |
| | Executes system calls, entered in the form of a string lists. More...
|
| |
| class | time |
| | Writes run time, CPU time and clock time and optionally the CPU and clock times per time step. More...
|
| |
| class | timeActivatedFileUpdate |
| | Performs a file copy/replacement once a specified time has been reached. More...
|
| |
| class | timeControl |
| |
| class | turbulenceFields |
| | Stores turbulence fields on the mesh database for further manipulation. More...
|
| |
| class | turbulenceIntensity |
| | Evaluates and writes the turbulence intensity field 'I'. More...
|
| |
| class | volRegion |
| | Volume (cell) region selection class. More...
|
| |
| class | vorticity |
| | Calculates the vorticity, the curl of the velocity. More...
|
| |
| class | wallHeatFlux |
| | Calculates and write the heat-flux at wall patches as the volScalarField field 'wallHeatFlux'. More...
|
| |
| class | wallHeatTransferCoeff |
| | Calculates and write the estimated incompressible flow heat transfer coefficient at wall patches as the volScalarField field 'wallHeatTransferCoeff'. More...
|
| |
| class | wallShearStress |
| | Calculates and write the shear-stress at wall patches as the volVectorField field 'wallShearStress'. 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 | writeDictionary |
| | Writes dictionaries on start-up and on change. More...
|
| |
| class | writeFile |
| | functionObject base class for writing single files More...
|
| |
| class | writeLocalObjects |
| | FunctionObject base class for managing a list of objects on behalf of the inheriting function object, on when those should be written to disk. More...
|
| |
| class | writeObjects |
| | Allows specification of different writing frequency of objects registered to the database. More...
|
| |
| class | writeObjectsBase |
| | FunctionObject base class for writing a list of objects registered to the database, on behalf of the inheriting function object, on when those should be written to disk. More...
|
| |
| class | writeVTK |
| | This functionObject writes objects registered to the database in VTK format using the foamToVTK library. 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 models. Values written to time directories as field 'yPlus'. More...
|
| |
|
| | defineTypeNameAndDebug (Qdot, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, Qdot, dictionary) |
| |
| | defineTypeNameAndDebug (fvMeshFunctionObject, 0) |
| |
| | defineTypeNameAndDebug (volRegion, 0) |
| |
| | defineTypeNameAndDebug (add, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, add, dictionary) |
| |
| | defineTypeNameAndDebug (age, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, age, dictionary) |
| |
| | defineTypeNameAndDebug (blendingFactor, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, blendingFactor, dictionary) |
| |
| | defineTypeNameAndDebug (components, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, components, dictionary) |
| |
| | defineTypeNameAndDebug (CourantNo, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, CourantNo, dictionary) |
| |
| | defineTypeNameAndDebug (ddt, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, ddt, dictionary) |
| |
| | defineTypeNameAndDebug (div, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, div, dictionary) |
| |
| | defineTypeNameAndDebug (enstrophy, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, enstrophy, dictionary) |
| |
| | defineTypeNameAndDebug (fieldAverage, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, fieldAverage, dictionary) |
| |
| Istream & | operator>> (Istream &, fieldAverageItem &) |
| |
| Ostream & | operator<< (Ostream &, const fieldAverageItem &) |
| |
| | defineTypeNameAndDebug (fieldCoordinateSystemTransform, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, fieldCoordinateSystemTransform, dictionary) |
| |
| | defineTypeNameAndDebug (fieldExpression, 0) |
| |
| | defineTypeNameAndDebug (fieldMinMax, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, fieldMinMax, dictionary) |
| |
| | defineTypeNameAndDebug (fieldsExpression, 0) |
| |
| | defineTypeNameAndDebug (fieldValue, 0) |
| |
| | defineRunTimeSelectionTable (fieldValue, dictionary) |
| |
| | defineTypeNameAndDebug (flowType, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, flowType, dictionary) |
| |
| | defineTypeNameAndDebug (grad, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, grad, dictionary) |
| |
| | defineTypeNameAndDebug (histogram, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, histogram, dictionary) |
| |
| | defineTypeNameAndDebug (interfaceHeight, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, interfaceHeight, dictionary) |
| |
| | defineTypeNameAndDebug (Lambda2, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, Lambda2, dictionary) |
| |
| | defineTypeNameAndDebug (log, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, log, dictionary) |
| |
| | defineTypeNameAndDebug (MachNo, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, MachNo, dictionary) |
| |
| | defineTypeNameAndDebug (mag, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, mag, dictionary) |
| |
| | defineTypeNameAndDebug (magSqr, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, magSqr, dictionary) |
| |
| | defineTypeNameAndDebug (nearWallFields, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, nearWallFields, dictionary) |
| |
| | defineTypeNameAndDebug (PecletNo, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, PecletNo, dictionary) |
| |
| | defineTypeNameAndDebug (pressure, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, pressure, dictionary) |
| |
| | defineTypeNameAndDebug (processorField, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, processorField, dictionary) |
| |
| | defineTypeNameAndDebug (Q, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, Q, dictionary) |
| |
| | defineTypeNameAndDebug (randomise, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, randomise, dictionary) |
| |
| | defineTypeNameAndDebug (readFields, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, readFields, dictionary) |
| |
| | defineTypeNameAndDebug (regionSizeDistribution, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, regionSizeDistribution, dictionary) |
| |
| | defineTypeNameAndDebug (scale, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, scale, dictionary) |
| |
| | defineTypeNameAndDebug (streamFunction, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, streamFunction, dictionary) |
| |
| | defineTypeNameAndDebug (streamLine, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, streamLine, dictionary) |
| |
| | defineTypeNameAndDebug (subtract, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, subtract, dictionary) |
| |
| | defineTypeNameAndDebug (surfaceInterpolate, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, surfaceInterpolate, dictionary) |
| |
| | defineTypeNameAndDebug (turbulenceFields, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, turbulenceFields, dictionary) |
| |
| | defineTypeNameAndDebug (turbulenceIntensity, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, turbulenceIntensity, dictionary) |
| |
| | defineTypeNameAndDebug (vorticity, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, vorticity, dictionary) |
| |
| | defineTypeNameAndDebug (wallHeatFlux, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, wallHeatFlux, dictionary) |
| |
| | defineTypeNameAndDebug (wallHeatTransferCoeff, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, wallHeatTransferCoeff, dictionary) |
| |
| | defineTypeNameAndDebug (wallShearStress, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, wallShearStress, dictionary) |
| |
| | defineTypeNameAndDebug (writeCellCentres, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, writeCellCentres, dictionary) |
| |
| | defineTypeNameAndDebug (writeCellVolumes, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, writeCellVolumes, dictionary) |
| |
| | defineTypeNameAndDebug (XiReactionRate, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, XiReactionRate, dictionary) |
| |
| | defineTypeNameAndDebug (yPlus, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, yPlus, dictionary) |
| |
| | defineTypeNameAndDebug (forceCoeffs, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, forceCoeffs, dictionary) |
| |
| | defineTypeNameAndDebug (forces, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, forces, dictionary) |
| |
| | defineTypeNameAndDebug (cloudInfo, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, cloudInfo, dictionary) |
| |
| | defineTypeNameAndDebug (dsmcFields, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, dsmcFields, dictionary) |
| |
| | defineTypeNameAndDebug (icoUncoupledKinematicCloud, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, icoUncoupledKinematicCloud, dictionary) |
| |
| | defineTypeNameAndDebug (phaseScalarTransport, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, phaseScalarTransport, dictionary) |
| |
| | defineTypeNameAndDebug (scalarTransport, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, scalarTransport, dictionary) |
| |
| | defineTypeNameAndDebug (abort, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, abort, dictionary) |
| |
| | defineTypeNameAndDebug (removeRegisteredObject, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, removeRegisteredObject, dictionary) |
| |
| | defineTypeNameAndDebug (residuals, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, residuals, dictionary) |
| |
| | defineTypeNameAndDebug (setTimeStepFunctionObject, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, setTimeStepFunctionObject, dictionary) |
| |
| | defineTypeNameAndDebug (systemCall, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, systemCall, dictionary) |
| |
| | defineTypeNameAndDebug (time, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, time, dictionary) |
| |
| | defineTypeNameAndDebug (timeActivatedFileUpdate, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, timeActivatedFileUpdate, dictionary) |
| |
| | defineTypeNameAndDebug (writeDictionary, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, writeDictionary, dictionary) |
| |
| | defineTypeNameAndDebug (writeObjects, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, writeObjects, dictionary) |
| |
| | defineTypeNameAndDebug (regionFunctionObject, 0) |
| |
| | defineTypeNameAndDebug (timeControl, 0) |
| |
| | defineTypeNameAndDebug (rigidBodyState, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, rigidBodyState, dictionary) |
| |
| | defineTypeNameAndDebug (sixDoFRigidBodyControl, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, sixDoFRigidBodyControl, dictionary) |
| |
| | defineTypeNameAndDebug (sixDoFRigidBodyState, 0) |
| |
| | addToRunTimeSelectionTable (functionObject, sixDoFRigidBodyState, dictionary) |
| |
Namespace for functionObjects.
OpenFOAM includes a collection of functionObjects selected by the user at run-time to manipulate the simulation and provide mechanisms to extract field and derived quantities. Alternatively, the same actions can be executed after the simulation using the -postProcess command-line option.
FunctionObjects are selected by additional entries in the $FOAM_CASE/system/controlDict dictionary. Each object is listed in the functions sub-dictionary, e.g. to select the functionObjectType functionObject the following entry would be specified:
functions
{
<functionObjectName>
{
type functionObjectType;
libs ("libMyFunctionObjectlib.so");
region defaultRegion;
enabled yes;
startTime 0;
endTime 10;
writeControl writeTime;
writeInterval 1;
...
}
}
Where:
| Property | Description | Required | Default value |
type | Type of function object | yes | |
libs | Libraries containing implementation | yes | |
region | Name of region for multi-region cases | no | |
enabled | On/off switch | no | yes |
log | Log information to standard output | no | yes |
startTime | Start time | no | |
endTime | End time | no | |
executeControl | See time controls below | no | timeStep |
executeInterval | Steps between each execute phase | no | |
writeControl | See time controls below | no | timeStep |
writeInterval | Steps between each write phase | no | |
Time controls:
| Option | Description |
timeStep | Execute/write every 'Interval' time-steps |
writeTime | Execute/write every 'Interval' output times |
adjustableRunTime | Execute/write every 'Interval' run time period |
runTime | Execute/write every 'Interval' run time period |
clockTime | Execute/write every 'Interval' clock time period |
cpuTime | Execute/write every 'Interval' CPU time period |
none | Execute/write every time-step |
The sub-dictionary name <functionObjectName> is chosen by the user, and is typically used as the name of the output directory for any data written by the functionObject. The type entry defines the type of function object properties that follow. FunctionObjects are packaged into separate libraries and the libs entry is used to specify which library should be loaded.
Each function object has two separate run phases:
- The
execute phase is meant to be used for updating calculations or for management tasks.
- The
write phase is meant for writing the calculated data to disk.
For each phase the respective time controls are provided, as listed above.
1.8.13 
