processorField

Description

The processorField function object writes a scalar field whose value is the local processor ID. The output field name is processorID.

Operands

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

Usage

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

processorField1
{
    // Mandatory entries (unmodifiable)
    type            processorField;
    libs            (fieldFunctionObjects);

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

The inherited entries are elaborated in:

• functionObject

Example by using the postProcess utility:

postProcess -func processorField

Further information

Tutorial:

• cavity
• aeroFoil
• motorBike_leakDetection

Source code:

• processorField

API:

• Foam::functionObjects::processorField

History: Introduced in version v1606+