Description

The fieldMinMax function object 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.

Multiple fields can be processed, where for rank > 0 primitives, e.g. vectors and tensors, the extrema can be calculated per component, or by magnitude. In addition, spatial location and local processor index are included in the output.

Operands

Operand	Type	Location
input	-	-
output file	dat	`$FOAM_CASE/postProcessing/<FO>/<time>/<file>`
output field	-	-

Usage

Example of the fieldExtents function object by using functions sub-dictionary in system/controlDict file:

fieldMinMax1
{
    // Mandatory entries (unmodifiable)
    type        fieldMinMax;
    libs        (fieldFunctionObjects);

    // Mandatory entries (runtime modifiable)
    mode        magnitude;
    fields      (<field1> <field2> ... <fieldN>);

    // Optional entries (runtime modifiable)
    location    true;

    // Optional (inherited) entries
    writePrecision  8;
    writeToFile     true;
    useUserTime     true;
    region          region0;
    enabled         true;
    log             true;
    timeStart       0;
    timeEnd         1000;
    executeControl  timeStep;
    executeInterval 1;
    writeControl    timeStep;
    writeInterval   1;
}

where the entries mean:

Property	Description	Type	Required	Default
type	Type name: fieldExtents	word	yes	-
libs	Library name: fieldFunctionObjects	word	yes	-
fields	List of operand fields	wordList	yes	-
location	Write location of the min/max value	bool	no	true
mode	Calculation mode: magnitude or component	word	no	magnitude

The inherited entries are elaborated in:

Usage by the postProcess utility is not available.

Stored properties

Integral values are stored for further post-processing:

Minimum field value: min(<fieldName>)
Minimum field value position: min(<field>)_position
Minimum field value processor: min(<field>)_processor
Maximum field value: max(<field>)
Maximum field value position: max(<field>)_position
Maximum field value processor: max(<field>)_processor

Further information

Tutorial:

Source code:

Foam::functionObjects::fieldMinMax

History

Introduced in version v1606+

Table of Contents

Description

Operands

Usage

Stored properties

Further information