openfoam/tutorials/lagrangian
Andrew Heather ea12bfdb0f ENH: new multiFieldValue function object
Computes a selected operation between multiple \c fieldValue function
    objects.

    The operation is applied to all results of each \c fieldValue object.

Note
    Each object must generate the same number and type of results.

Usage
    Minimal example by using \c system/controlDict.functions:

    multiFieldValue1
    {
        // Mandatory entries (unmodifiable)
        type            multiFieldValue;
        libs            (fieldFunctionObjects);

        // Mandatory entries (runtime modifiable)
        operation       subtract;

        // List of fieldValue function objects as dictionaries
        functions
        {
            region1
            {
                ...
            }
            region2
            {
                ...
            }

            ...

            regionN
            {
                ...
            }
        }

        // Optional (inherited) entries
        ...
    }

    where the entries mean:

      Property     | Description                         | Type | Req'd | Dflt
      type         | Type name: multiFieldValue          | word |  yes  | -
      libs         | Library name: fieldFunctionObjects  | word |  yes  | -
      operation    | Operation type to apply to values   | word |  yes  | -
      functions    | List of fieldValue function objects | dict |  yes  | -
    \endtable

    Options for the \c operation entry:

       add           | add
       subtract      | subtract
       min           | minimum
       max           | maximum
       average       | average

Deprecated fieldValueDelta

- The fieldValueDelta function object was originally written to compute the
difference between two fieldValue-type function objects. The multiFieldValue
object name better describes its purpose whilst being able to operate on an
arbitrary number of fieldValue-type objects.
2021-06-16 11:19:44 +02:00
..
coalChemistryFoam/simplifiedSiwek TUT: lagrangian: clean up tutorials 2021-03-12 11:40:02 +00:00
DPMFoam/Goldschmidt TUT: lagrangian: clean up tutorials 2021-03-12 11:40:02 +00:00
icoUncoupledKinematicParcelDyMFoam/mixerVesselAMI2D TUT: lagrangian: clean up tutorials 2021-03-12 11:40:02 +00:00
icoUncoupledKinematicParcelFoam/hopper TUT: lagrangian: clean up tutorials 2021-03-12 11:40:02 +00:00
MPPICDyMFoam TUT: lagrangian: clean up tutorials 2021-03-12 11:40:02 +00:00
MPPICFoam TUT: lagrangian: clean up tutorials 2021-03-12 11:40:02 +00:00
reactingHeterogenousParcelFoam/rectangularDuct TUT: lagrangian: clean up tutorials 2021-03-12 11:40:02 +00:00
reactingParcelFoam ENH: new multiFieldValue function object 2021-06-16 11:19:44 +02:00
simpleReactingParcelFoam/verticalChannel TUT: lagrangian: clean up tutorials 2021-03-12 11:40:02 +00:00
sprayFoam/aachenBomb TUT: sprayFoam: add examples for the new cloud function objects 2021-06-08 20:34:28 +00:00
uncoupledKinematicParcelDyMFoam/rotor2DAMI TUT: lagrangian: clean up tutorials 2021-03-12 11:40:02 +00:00