fieldTimeRelaxed

Syntax

Defined in couplingProperties dictionary.

forceModels
(
    fieldTimeRelaxed
);
fieldTimeRelaxedProps
{
    startTime    scalar;
    scalarFieldNames wordList;
    vectorFieldNames wordList;
    relaxation   scalar;
};

startTime = time to start temporal averaging
scalarField = list containing the names of the finite volume scalar fields to be temporally averaged
vectorField = list containing the names of the finite volume vector fields to be temporally averaged
relaxation = relaxation factor (default: 0.01)

Examples

forceModels
(
    fieldTimeRelaxed
);
fieldTimeRelaxedProps
{
    startTime 1.0;
    scalarFieldNames ( "voidfraction" );
    vectorFieldNames ( "U" "Us" );
}

Description

Starting at start time the specified fields (e.g. $\phi$ ) are temporally relaxed with the relaxation factor $r$ , i.e. $\phi_\mathrm{relax} = (1 - r) \phi_\mathrm{relax} + r \phi$ and written at writeTime as specified by controlDict. They can then be probed using standard functionobject probes. The output name is FavreAverage_scalarField, where scalarField is the name of the original field.

Restrictions

None.