applications/utilities/postProcessing/dataConversion/foamToEnsight/ensightCloudField.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   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 InApplication
  26     foamToEnsight
  27
  28 Description
  29
  30 SourceFiles
  31     ensightCloudField.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef ensightCloudField_H
  36 #define ensightCloudField_H
  37
  38 #include "Cloud.H"
  39 #include "IOobject.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 template<class Type>
  44 void ensightCloudField
  45 (
  46     const Foam::IOobject& fieldObject,
  47     const Foam::fileName& postProcPath,
  48     const Foam::word& prepend,
  49     const Foam::label timeIndex,
  50     const Foam::word& timeFile,
  51     const Foam::word& cloudName,
  52     Foam::Ostream& ensightCaseFile,
  53     const bool dataExists
  54 );
  55
  56 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  57
  58 #ifdef NoRepository
  59 #   include "ensightCloudField.C"
  60 #endif
  61
  62 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  63
  64 #endif
  65
  66 // ************************************************************************* //