Merge remote-tracking branch 'origin/master' into develop

This commit is contained in:
Andrew Heather
2018-09-21 16:01:16 +01:00
30 changed files with 72 additions and 71 deletions

View File

@ -49,7 +49,7 @@ Usage
type | Type name: CourantNo | yes |
rho | Name of density field | no | rho
field | Name of flux field | no | phi
result | Name of Courant number field | no | <function name>
result | Name of Courant number field | no | \<function name\>
log | Log to standard output | no | yes
\endtable

View File

@ -51,7 +51,7 @@ Usage
\table
Property | Description | Required | Default value
type | type name: DESModelRegions| yes |
resultName | Name of DES indicator field | no | <function name>
resultName | Name of DES indicator field | no | \<function name\>
log | log to standard output | no | yes
\endtable

View File

@ -47,7 +47,7 @@ Usage
type | type name: Peclet | yes |
phi | Name of flux field | no | phi
rho | Name of density field | no | rho
result | Name of Peclet field | no | <function name>
result | Name of Peclet field | no | \<function name\>
log | Log to standard output | no | yes
\endtable

View File

@ -56,7 +56,7 @@ Usage
Property | Description | Required | Default value
type | type name: Q | yes |
U | Name of velocity field | no | U
result | Name of Q field | no | <function name>
result | Name of Q field | no | \<function name\>
log | Log to standard output | no | yes
\endtable

View File

@ -42,7 +42,7 @@ Description
The factor is a face-based quantity, which is converted to a cell-based
quantity by assigning the minimum blending factor for any cell face.
An indicator (volume) field, named <functionObjectName>:<fieldName>, is
An indicator (volume) field, named \<functionObjectName\>:\<fieldName\>, is
generated that is set to (1 - f), i.e. values of:
- 0 represent scheme1 as active, and
- 1 represent scheme2 as active.

View File

@ -71,7 +71,7 @@ Usage
- surface
- surfaceAndDirection
Output data is written to files of the form \<timeDir\>/<faceZoneName>.dat
Output data is written to files of the form \<timeDir\>/\<faceZoneName\>.dat
See also
Foam::functionObjects::fvMeshFunctionObject

View File

@ -53,7 +53,7 @@ Usage
type | Type name: mapFields | yes |
mapRegion | Name of region to map to | yes |
mapMethod | Mapping method | yes |
patchMapMethod | Patch mapping method | no | <auto>
patchMapMethod | Patch mapping method | no | \<auto\>
consistent | Mapping meshes have consistent boundaries | yes |
fields | List of field names to map | yes |
log | Log to standard output | no | yes

View File

@ -67,8 +67,8 @@ Usage
Property | Description | Required | Default value
type | Type name: reference | yes |
field | Name of field | yes |
result | Name of result field | no | reference(<field>)
position | Position to sample | no | <not used>
result | Name of result field | no | reference(\<field\>)
position | Position to sample | no | \<not used\>
scale | Scale value | no | 1
offset | Offset value | no | zero
log | Log to standard output | no | yes

View File

@ -63,7 +63,7 @@ Description
),
1.0
)
\f[
\f]
For option 2, the following relation is used:
\f[
@ -78,7 +78,7 @@ Description
),
1.0
)
\f[
\f]
Note that magGradCC is equal to 3 for ortoghonal meshes
For option 3 a PID control is used in order to control residual
@ -89,14 +89,14 @@ Description
P*residual
+ I*residualIntegral
+ D*residualDifferential
\f[
\f]
where P, I and D are user inputs
The following relation is used:
\f[
fRes = (factor - meanRes)/(maxRes*meanRes);
\f[
\f]
where:
meanRes = average(residual)
@ -120,7 +120,7 @@ Description
),
1.0
)
\f[
\f]
Note that faceWeights for a orthogonal mesh is 0.5.
@ -138,7 +138,7 @@ Description
),
1.0
)
\f[
\f]
For option 6 , the following relation is used:
@ -275,8 +275,7 @@ Usage
tolerance | Tolerance for number of blended cells | no | 0.001
field | Name of field to evaluate | yes |
result | Name of surface field to be used in the localBlended scheme
| yes
| yes |
\endtable
The 'log' flag true write the number of cells on each scheme, plus it

View File

@ -48,6 +48,7 @@ Description
Usage
Example of function object specification to solve a scalar transport
equation:
\verbatim
functions
{
scalar1