XiReactionRate

Table of Contents

• Description
  • Operands
• Usage
• Further information

Description

The XiReactionRate function object writes the turbulent flame-speed and reaction-rate volScalarFields for the Xi-based combustion models.

Operands

Operand	Type	Location
input	-	-
output file	-	-
output field	volScalarField	$FOAM_CASE/<time>/{St,wdot}

Usage

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

XiReactionRate1
{
    // Mandatory entries (unmodifiable)
    type            XiReactionRate;
    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: XiReactionRate	word	yes	-
libs	Library name: fieldFunctionObjects	word	yes	-

The inherited entries are elaborated in:

• functionObject

Usage by the postProcess utility is not available.

Further information

Tutorial:

• $FOAM_TUTORIALS/combustion/XiDyMFoam/annularCombustorTurbine

Source code:

• Foam::functionObjects::XiReactionRate

History

• Introduced in version v1612+