applications/utilities/postProcessing/dataConversion/foamToVTK/readFields.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2008 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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 InClass
  26     Foam::readFields
  27
  28 Description
  29
  30 SourceFiles
  31     readFields.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef readFields_H
  36 #define readFields_H
  37
  38 #include "fvMesh.H"
  39 #include "PtrList.H"
  40 #include "IOobjectList.H"
  41 #include "HashSet.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 // Read the fields and optionally subset and put on the pointer list
  49 template<class GeoField>
  50 void readFields
  51 (
  52     const vtkMesh& vMesh,
  53     const typename GeoField::Mesh& mesh,
  54     const IOobjectList& objects,
  55     const HashSet<word>& selectedFields,
  56     PtrList<GeoField>& fields
  57 );
  58
  59 } // End namespace Foam
  60
  61 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  62
  63 #ifdef NoRepository
  64 #   include "readFields.C"
  65 #endif
  66
  67 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  68
  69 #endif
  70
  71 // ************************************************************************* //