Commit 2c827fdf authored by Andrew Heather's avatar Andrew Heather
Browse files

Merge branch 'doc-FOs-part-1' into 'develop'

DOC: Elaborate the usage of function objects

See merge request !348
parents b5491165 a5c6516e
......@@ -6,14 +6,16 @@
\\/ M anipulation |
-------------------------------------------------------------------------------
Description
Calculates and writes the second largest eigenvalue of the sum of the
square of the symmetrical and anti-symmetrical parts of the velocity
gradient tensor.
Computes the min/max/average arbitrary mesh interface (AMI) weights, and
optionally reports to a text file or writes VTK surfaces of the sum of
the weights and mask fields for arbitrarily coupled mesh interface (ACMI)
patches.
\*---------------------------------------------------------------------------*/
type AMIWeights;
libs ("libfieldFunctionObjects.so");
libs (fieldFunctionObjects);
writeFields yes;
writeControl writeTime;
......
......@@ -11,7 +11,7 @@ Description
\*---------------------------------------------------------------------------*/
type CourantNo;
libs ("libfieldFunctionObjects.so");
libs (fieldFunctionObjects);
field phi;
......
......@@ -6,14 +6,14 @@
\\/ M anipulation |
-------------------------------------------------------------------------------
Description
Calculates and writes the second largest eigenvalue of the sum of the
square of the symmetrical and anti-symmetrical parts of the velocity
gradient tensor.
Calculates Lamb vector, i.e. the cross product of vorticity and velocity.
Calculation of the divergence of the Lamb vector can be performed by using
\c div function object on this \c LambVector function object.
\*---------------------------------------------------------------------------*/
type lambVector;
libs ("libfieldFunctionObjects.so");
type LambVector;
libs (fieldFunctionObjects);
field U;
......
......@@ -13,7 +13,7 @@ Description
\*---------------------------------------------------------------------------*/
type Lambda2;
libs ("libfieldFunctionObjects.so");
libs (fieldFunctionObjects);
field U;
......
......@@ -11,7 +11,7 @@ Description
\*---------------------------------------------------------------------------*/
type MachNo;
libs ("libfieldFunctionObjects.so");
libs (fieldFunctionObjects);
field U;
......
......@@ -11,7 +11,7 @@ Description
\*---------------------------------------------------------------------------*/
type PecletNo;
libs ("libfieldFunctionObjects.so");
libs (fieldFunctionObjects);
field phi;
......
......@@ -11,7 +11,7 @@ Description
\*---------------------------------------------------------------------------*/
type Q;
libs ("libfieldFunctionObjects.so");
libs (fieldFunctionObjects);
field U;
......
......@@ -11,7 +11,7 @@ Description
\*---------------------------------------------------------------------------*/
type turbulenceFields;
libs ("libfieldFunctionObjects.so");
libs (fieldFunctionObjects);
field R;
......
......@@ -12,7 +12,7 @@ Description
\*---------------------------------------------------------------------------*/
type XiReactionRate;
libs ("libfieldFunctionObjects.so");
libs (fieldFunctionObjects);
fields (b Xi Su);
......
......@@ -11,7 +11,7 @@ Description
\*---------------------------------------------------------------------------*/
type add;
libs ("libfieldFunctionObjects.so");
libs (fieldFunctionObjects);
fields (<field names>);
......
......@@ -11,7 +11,7 @@ Description
\*---------------------------------------------------------------------------*/
type components;
libs ("libfieldFunctionObjects.so");
libs (fieldFunctionObjects);
field <fieldName>;
......
......@@ -11,7 +11,7 @@ Description
\*---------------------------------------------------------------------------*/
type ddt;
libs ("libfieldFunctionObjects.so");
libs (fieldFunctionObjects);
field <fieldName>;
......
......@@ -11,7 +11,7 @@ Description
\*---------------------------------------------------------------------------*/
type div;
libs ("libfieldFunctionObjects.so");
libs (fieldFunctionObjects);
field <fieldName>;
......
......@@ -11,7 +11,7 @@ Description
\*---------------------------------------------------------------------------*/
type energySpectrum;
libs ("librandomProcessesFunctionObjects.so");
libs (randomProcessesFunctionObjects);
executeControl writeTime;
writeControl writeTime;
......
......@@ -11,7 +11,7 @@ Description
\*---------------------------------------------------------------------------*/
type enstrophy;
libs ("libfieldFunctionObjects.so");
libs (fieldFunctionObjects);
field U;
......
......@@ -11,7 +11,7 @@ Description
\*---------------------------------------------------------------------------*/
type fieldMinMax;
libs ("libfieldFunctionObjects.so");
libs (fieldFunctionObjects);
fields (".*");
......
......@@ -14,7 +14,7 @@ Description
\*---------------------------------------------------------------------------*/
type flowType;
libs ("libfieldFunctionObjects.so");
libs (fieldFunctionObjects);
field U;
......
......@@ -11,7 +11,7 @@ Description
\*---------------------------------------------------------------------------*/
type grad;
libs ("libfieldFunctionObjects.so");
libs (fieldFunctionObjects);
field <fieldName>;
......
......@@ -11,7 +11,7 @@ Description
\*---------------------------------------------------------------------------*/
type mag;
libs ("libfieldFunctionObjects.so");
libs (fieldFunctionObjects);
field <fieldName>;
......
......@@ -11,7 +11,7 @@ Description
\*---------------------------------------------------------------------------*/
type magSqr;
libs ("libfieldFunctionObjects.so");
libs (fieldFunctionObjects);
field <fieldName>;
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment