Description🔗
The PecletNo
function object
computes the Peclet number as a surfaceScalarField.
Operands🔗
Operand | Type | Location |
---|---|---|
input | surfaceScalarField |
$FOAM_CASE/<time>/<inpField> |
output file | - | - |
output field | surfaceScalarField |
$FOAM_CASE/<time>/<outField> |
Usage🔗
Example of the PecletNo
function object
by using functions
sub-dictionary in system/controlDict
file:
PecletNo1
{
// Mandatory entries (unmodifiable)
type PecletNo;
libs (fieldFunctionObjects);
// Optional entries (runtime modifiable)
rho rho;
// 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: PecletNo | word | yes | - |
libs | Library name: fieldFunctionObjects | word | yes | - |
rho | Name of density field | word | no | rho |
The inherited entries are elaborated in:
Example by using the postProcess
utility:
postProcess -func PecletNo
Further information🔗
Tutorial:
Source code:
API:
History:
- Introduced in version v1606+