Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • openfoam openfoam
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 418
    • Issues 418
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 7
    • Merge requests 7
  • Deployments
    • Deployments
    • Releases
  • Wiki
    • Wiki
  • Activity
  • Graph
  • Create a new issue
  • Commits
  • Issue Boards
Collapse sidebar
  • Development
  • openfoamopenfoam
  • Merge requests
  • !469

ENH: new multiFieldValue function object

  • Review changes

  • Download
  • Email patches
  • Plain diff
Merged Andrew Heather requested to merge feature-multifieldvalue into develop Jun 14, 2021
  • Overview 3
  • Commits 1
  • Changes 12

Computes a selected operation between multiple fieldValue function objects.

The operation is applied to all results of each 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 -

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.

Assignee
Assign to
Reviewers
Request review from
Time tracking
Source branch: feature-multifieldvalue