flux

Description

The flux function object computes the flux of an input vector field.

Operands

Operand	Type	Location
input	{vol,surface}VectorField	$FOAM_CASE/<time>/<inpField>
output file	-	-
output field	surfaceScalarField	$FOAM_CASE/<time>/<outField>

Usage

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

flux1
{
    // Mandatory entries (unmodifiable)
    type            flux;
    libs            (fieldFunctionObjects);

    // Optional entries (runtime modifiable)
    rho             none;

    // Optional (inherited) entries
    field           <field>;
    result          <fieldResult>;
    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: flux	word	yes	-
libs	Library name: fieldFunctionObjects	word	yes	-
rho	Name of density field	word	no	none

The inherited entries are elaborated in:

• functionObject
• fieldExpression

Usage by the postProcess utility is not available.

Further information

Tutorial:

• cavity

Source code:

• flux

API:

• Foam::functionObjects::flux

History: Introduced in version v1612+