fieldCalc

Syntax

Defined in couplingProperties dictionary.

postProcessingModels
(
    fieldCalc
);
fieldCalcProps
{
    operationMode word;
    startTime time;
    scalarFieldNames
    (
        scalarField
    );
    vectorFieldNames
    (
        vectorField
    );
    thresholds         tuple<scalar>;
    useVolumeFraction  switch;
    volumeFractionName word;
    verbose            switch;
    writeToFile        switch;
    stopFileName       word;
    stopFileBounds     tuple<scalar>;
};

  • operationMode = calculation type (volWeightedAverage | volWeightedSum, default: volWeightedAverage)

  • time = time to start the averaging. (default: 0.)

  • scalarField = names of the finite volume scalar fields the calculation is applied to (default: none)

  • vectorField = names of the finite volume vector fields the calculation is applied to (default: none)

  • thresholds = only cells with a field value (magnitude) greater/smaller than this lower/upper threshold are considered (default: -1e30/1e30)

  • useVolumeFraction = consider a volume fraction as a weight for the averaging. (default: false)

  • volumeFractionName = name of the volume fraction, only used if useVolumeFraction is true. (default: “voidfraction”)

  • verbose = give verbose output. (default: false)

  • writeToFile = switch for the output. (default: true)

  • stopFileName = definition of a stopFile written if the caluclation result is within the stopFileBounds. If not defined, no file will be written. If defined, also stopFileBounds must be defined and vice versa. (default: none)

  • stopFileBounds = definition of lower and upper bounds for writing a stopFile (default: 1e30,-1e30)

Examples

postProcessingModels
(
    fieldCalc
);
fieldCalcProps
{
    startTime 0.1;
    scalarFieldNames
    (
        voidfraction
    );
    thresholds (0 0.999);
}

Description

Calculation starts at startTime.

For the operationMode = volWeightedAverage the volume weighted averages (sum(vol*value)/totalVol) of those cells of the fields within the threshold are calculated. At writeTime a field named volWeightedAverage_field and a text file,is written. This field can then be probed using standard function object probes.

For the operationMode = volWeightedSum the volume weighted sum (sum(vol*value)) of those cells of the fields within the threshold are calculated. At writeTime a field named volWeightedSum_field and a text file,is written. This field can then be probed using standard function object probes.

Restrictions

Currently all fields have the same threshold value!