streamFunction

Description

The streamFunction function object computes the stream function, i.e. https://w.wiki/Ncm.

Operands

Operand	Type	Location
input	surfaceScalarField	$FOAM_CASE/<time>/<inpField>
output file	-	-
output field	pointScalarField	$FOAM_CASE/<time>/<outField>

Usage

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

streamFunction1
{
    // Mandatory entries (unmodifiable)
    type            streamFunction;
    libs            (fieldFunctionObjects);

    // Optional (inherited) entries
    field           <inpField>;
    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: streamFunction	word	yes	-
libs	Library name: fieldFunctionObjects	word	yes	-

The inherited entries are elaborated in:

• functionObject
• fieldExpression

Example by using the postProcess utility:

postProcess -func streamFunction

Further information

Tutorial:

• cavity

Source code:

• streamFunction

API:

• Foam::functionObjects::streamFunction

History: Introduced in version v1606+