Upgrade case file headers
[foam-extend-3.2.git] / applications / utilities / postProcessing / sampling / sample / sampleDict
blobec4f7bc168ce5b3ffdea7888ae1dcff83ff44724
1 /*--------------------------------*- C++ -*----------------------------------*\
2 | =========                 |                                                 |
3 | \\      /  F ield         | foam-extend: Open Source CFD                    |
4 |  \\    /   O peration     | Version:     3.2                                |
5 |   \\  /    A nd           | Web:         http://www.foam-extend.org         |
6 |    \\/     M anipulation  |                                                 |
7 \*---------------------------------------------------------------------------*/
8 FoamFile
10     version     2.0;
11     format      ascii;
12     class       dictionary;
13     location    system;
14     object      sampleDict;
16 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
18 // Set output format : choice of
19 //      xmgr
20 //      jplot
21 //      gnuplot
22 //      raw
23 setFormat raw;
25 // Surface output format. Choice of
26 //      null        : suppress output
27 //      foamFile    : separate points, faces and values file
28 //      dx          : DX scalar or vector format
29 //      vtk         : VTK ascii format
30 //      raw         : x y z value format for use with e.g. gnuplot 'splot'.
32 // Note:
33 // other formats such as obj, stl, etc can also be written (by proxy)
34 // but without any values!
35 surfaceFormat vtk;
37 // interpolationScheme. choice of
38 //      cell          : use cell-centre value only; constant over cells (default)
39 //      cellPoint     : use cell-centre and vertex values
40 //      cellPointFace : use cell-centre, vertex and face values.
41 // 1] vertex values determined from neighbouring cell-centre values
42 // 2] face values determined using the current face interpolation scheme
43 //    for the field (linear, gamma, etc.)
44 interpolationScheme cellPoint;
46 // Fields to sample.
47 fields
49     p
50     U
53 // Set sampling definition: choice of
54 //      uniform             evenly distributed points on line
55 //      face                one point per face intersection
56 //      midPoint            one point per cell, inbetween two face intersections
57 //      midPointAndFace     combination of face and midPoint
59 //      curve               specified points, not nessecary on line, uses
60 //                          tracking
61 //      cloud               specified points, uses findCell
63 // axis: how to write point coordinate. Choice of
64 // - x/y/z: x/y/z coordinate only
65 // - xyz: three columns
66 //  (probably does not make sense for anything but raw)
67 // - distance: distance from start of sampling line (if uses line) or
68 //             distance from first specified sampling point
70 // type specific:
71 //      uniform, face, midPoint, midPointAndFace : start and end coordinate
72 //      uniform: extra number of sampling points
73 //      curve, cloud: list of coordinates
74 sets
76     lineX1
77     {
78         type        uniform;
79         axis        distance;
81         //- cavity. Slightly perturbed so not to align with face or edge.
82         start       (0.0201 0.05101 0.00501);
83         end         (0.0601 0.05101 0.00501);
84         nPoints     10;
85     }
87     lineX2
88     {
89         type        face;
90         axis        x;
92         //- flangeHex
93         //start       (0 20  -20);
94         //end         (0 20   10);
96         //- nablaCavity
97         //start       (-1 0.05 0.005);
98         //end         ( 1 0.05 0.005);
100         //- cavity
101         start       (0.001 0.5101  0.00501);
102         end         (2.01 0.5101  0.00501);
103         nPoints     10;
104     }
106     somePoints
107     {
108         type    cloud;
109         axis    xyz;
110         points  ((0.049 0.049 0.00501)(0.051 0.049 0.00501));
111     }
115 // Surface sampling definition: choice of
116 //      plane : values on plane defined by point, normal.
117 //      patch : values on patch.
119 // 1] patches are not triangulated by default
120 // 2] planes are always triangulated
121 // 3] iso-surfaces are always triangulated
122 surfaces
124     constantPlane
125     {
126         type            plane;    // always triangulated
127         basePoint       (0.0501 0.0501 0.005);
128         normalVector    (0.1 0.1 1);
130         //- Optional: restrict to a particular zone
131         // zoneName        zone1;
132     }
134     interpolatedPlane
135     {
136         type            plane;    // always triangulated
137         // make plane relative to the coordinateSystem (Cartesian)
138         coordinateSystem
139         {
140             origin      (0.0501 0.0501 0.005);
141         }
142         basePoint       (0 0 0);
143         normalVector    (0.1 0.1 1);
144         interpolate     true;
145     }
147     movingWall_constant
148     {
149         type            patch;
150         patchName       movingWall;
151         // Optional: whether to leave as faces (=default) or triangulate
152         // triangulate     false;
153     }
155     movingWall_interpolated
156     {
157         type            patch;
158         patchName       movingWall;
159         interpolate     true;
160         // Optional: whether to leave as faces (=default) or triangulate
161         // triangulate     false;
162     }
164     interpolatedIso
165     {
166         // Iso surface for interpolated values only
167         type            isoSurface;    // always triangulated
168         isoField        rho;
169         isoValue        0.5;
170         interpolate     true;
172         //zone            ABC;          // Optional: zone only
173         //exposedPatchName fixedWalls;  // Optional: zone only
175         // regularise      false;    // Optional: do not simplify
176     }
177     constantIso
178     {
179         // Iso surface for constant values.
180         // Triangles guaranteed not to cross cells.
181         type            isoSurfaceCell;    // always triangulated
182         isoField        rho;
183         isoValue        0.5;
184         interpolate     false;
185         regularise      false;              // do not simplify
186     }
188     triangleCut
189     {
190         // Cutingplane using iso surface
191         type            cuttingPlane;
192         planeType       pointAndNormal;
193         pointAndNormalDict
194         {
195             basePoint       (0.4 0 0.4);
196             normalVector    (1 0.2 0.2);
197         }
198         interpolate     true;
200         //zone            ABC;          // Optional: zone only
201         //exposedPatchName fixedWalls;  // Optional: zone only
203         // regularise      false;    // Optional: do not simplify
204     }
208 // *********************************************************************** //