applications/utilities/postProcessing/sampling/sample/sample.C

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2004-2011 OpenCFD Ltd.
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of OpenFOAM.
  10
  11     OpenFOAM is free software: you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your option) any later version.
  15
  16     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
  17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19     for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Description
  25     Sample field data with a choice of interpolation schemes, sampling options
  26     and write formats.
  27
  28     Keywords:
  29
  30     \param setFormat : set output format, choice of \n
  31       - xmgr
  32       - jplot
  33       - gnuplot
  34       - raw
  35
  36     \param surfaceFormat : surface output format, choice of \n
  37       - null        : suppress output
  38       - foamFile    : separate points, faces and values file
  39       - dx          : DX scalar or vector format
  40       - vtk         : VTK ascii format
  41       - raw         : x y z value format for use with e.g. gnuplot 'splot'.
  42       - obj         : Wavefron stl. Does not contain values!
  43       - stl         : ascii stl. Does not contain values!
  44
  45     \param interpolationScheme : interpolation scheme, choice of \n
  46       - cell          : use cell-centre value; constant over cells (default)
  47       - cellPoint     : use cell-centre and vertex values
  48       - cellPointFace : use cell-centre, vertex and face values. \n
  49         -# vertex values determined from neighbouring cell-centre values
  50         -# face values determined using the current face interpolation scheme
  51            for the field (linear, limitedLinear, etc.)
  52
  53     \param fields : list of fields to sample
  54
  55     \param sets : list of sets to sample, choice of \n
  56       - uniform             evenly distributed points on line
  57       - face                one point per face intersection
  58       - midPoint            one point per cell, inbetween two face intersections
  59       - midPointAndFace     combination of face and midPoint
  60
  61       - curve               specified points, not nessecary on line, uses
  62                             tracking
  63       - cloud               specified points, uses findCell
  64
  65         Option axis: how to write point coordinate. Choice of
  66           - x/y/z: x/y/z coordinate only
  67           - xyz: three columns
  68             (probably does not make sense for anything but raw)
  69           - distance: distance from start of sampling line (if uses line)
  70             or distance from first specified sampling point
  71
  72         Type specific options:
  73             uniform, face, midPoint, midPointAndFace : start and end coordinate
  74             uniform: extra number of sampling points
  75             curve, cloud: list of coordinates
  76
  77     \param surfaces : list of surfaces to sample, choice of \n
  78       - plane : values on plane defined by point, normal.
  79       - patch : values on patch.
  80
  81 Notes
  82     Runs in parallel
  83
  84 \*---------------------------------------------------------------------------*/
  85
  86 #include "argList.H"
  87 #include "timeSelector.H"
  88 #include "IOsampledSets.H"
  89 #include "IOsampledSurfaces.H"
  90
  91 using namespace Foam;
  92
  93 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  94 // Main program:
  95
  96 int main(int argc, char *argv[])
  97 {
  98     timeSelector::addOptions();
  99     #include "addRegionOption.H"
 100     argList::addOption
 101     (
 102         "dict",
 103         "word",
 104         "name of dictionary to provide sample information"
 105     );
 106
 107     #include "setRootCase.H"
 108     #include "createTime.H"
 109     instantList timeDirs = timeSelector::select0(runTime, args);
 110     #include "createNamedMesh.H"
 111
 112     word sampleDict(args.optionLookupOrDefault<word>("dict", "sampleDict"));
 113
 114     IOsampledSets sSets
 115     (
 116         sampledSets::typeName,
 117         mesh,
 118         sampleDict,
 119         IOobject::MUST_READ_IF_MODIFIED,
 120         true
 121     );
 122
 123     IOsampledSurfaces sSurfs
 124     (
 125         sampledSurfaces::typeName,
 126         mesh,
 127         sampleDict,
 128         IOobject::MUST_READ_IF_MODIFIED,
 129         true
 130     );
 131
 132     forAll(timeDirs, timeI)
 133     {
 134         runTime.setTime(timeDirs[timeI], timeI);
 135         Info<< "Time = " << runTime.timeName() << endl;
 136
 137         // Handle geometry/topology changes
 138         polyMesh::readUpdateState state = mesh.readUpdate();
 139
 140         sSets.readUpdate(state);
 141         sSurfs.readUpdate(state);
 142
 143         sSets.write();
 144         sSurfs.write();
 145
 146         Info<< endl;
 147     }
 148
 149     Info<< "End\n" << endl;
 150
 151     return 0;
 152 }
 153
 154
 155 // ************************************************************************* //