The sets
function object samples field values at point locations and writes
the result to file using the chosen output file format.
Usage🔗
Basic operation of the sets
function object comprises:
sets1
{
type sets;
libs ("libsampling.so");
setFormat <format-type>;
fields (<fields>);
interpolationScheme <scheme-type>;
sets
{
mySet1
{
// set definition for 'mySet1'
type <set-type>;
axis <axis>;
...
}
mySet2
{
// set definition for 'mySet2'
type <set-type>;
axis <axis>;
...
}
...
mySetN
{
// set definition for 'mySetN'
type <set-type>;
axis <axis>;
...
}
}
}
Fields to be sampled are listed in the fields
entry, e.g.
fields (U p T);
Sets to be returned are listed in the sets
sub-dictionary, each in dictionary
format with a user-supplied name, e.g. mySet1
, mySet2
, and mySetN
above.
The <set-type>
value can be set to:
- cloud
-
array
: array of uniformly distributed points in a 3-D box -
cellCentre
: points defined at cell centres in a 3-D box -
circle
: uniformly distributed points on a circular path -
face
: face intersection points on line between start and end points -
midPoint
: mid points of face intersection points on line between start and end points -
midPointAndFace
: combination ofmidPoint
andface
methods -
patchCloud
: same ascloud
, but points constrained to nearest patch faces -
patchEdge
: points intersecting a patches and external surfaces -
patchSeed
: points on a patch -
polyLine
: points on the knots of a line defined as a list of points -
triSurfaceMeshPointSet
: all points from atriSurfaceMesh
-
uniform
: uniformly distributed points on line between start and end points
The <axis>
value describes how the point co-ordinates are written. Options
include:
-
x
,y
, orz
: single Cartesian co-ordinate only -
xyz
: Cartesian x, y, z -
distance
:- for lines: the distance from the start of the line
- for points: the distance from the first point
Sample output🔗
This information is also written in the user-specified output format to file in the directory:
$FOAM_CASE/postProcessing/<function object>/<time>
Stored properties🔗
Reduced data🔗
The following data are stored by the function object for the set of sample values, and can be used by other function objects:
-
average(<field-name>)
: average set value -
min(<field-name>)
: minimum set value -
max(<field-name>)
: maximum set value -
size(<field-name>)
: size of set
Further information🔗
Related:
Source code:
API:
Example usage:
- buoyantSimpleFoam
buoyantCavity
tutorial: $FOAM_TUTORIALS/heatTransfer/buoyantSimpleFoam/buoyantCavity