applications/utilities/postProcessing/dataConversion/foamToEnsightParts/ensightOutputFunctions.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 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 Description
  26     Miscellaneous collection of functions and template related to Ensight data
  27
  28 SourceFiles
  29     ensightOutputFunctions.C
  30
  31 \*---------------------------------------------------------------------------*/
  32
  33 #ifndef ensightOutputFunctions_H
  34 #define ensightOutputFunctions_H
  35
  36 #include "ensightFile.H"
  37 #include "Cloud.H"
  38 #include "polyMesh.H"
  39 #include "IOobject.H"
  40
  41 namespace Foam
  42 {
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 void ensightCaseEntry
  47 (
  48     OFstream& caseFile,
  49     const string& ensightType,
  50     const word& fieldName,
  51     const fileName& dataMask,
  52     const fileName& local=fileName::null,
  53     const label cloudNo=-1,
  54     const label timeSet=1
  55 );
  56
  57
  58 void ensightParticlePositions
  59 (
  60     const polyMesh& mesh,
  61     const fileName& dataDir,
  62     const fileName& subDir,
  63     const word& cloudName,
  64     IOstream::streamFormat format
  65 );
  66
  67
  68 //- write lagrangian parcels
  69 template<class Type>
  70 void ensightLagrangianField
  71 (
  72     const IOobject& fieldObject,
  73     const fileName& dataDir,
  74     const fileName& subDir,
  75     const word& cloudName,
  76     IOstream::streamFormat format
  77 );
  78
  79 //- write generalized field components
  80 template<class Type>
  81 void ensightVolField
  82 (
  83     const ensightParts& partsList,
  84     const IOobject& fieldObject,
  85     const fvMesh& mesh,
  86     const fileName& dataDir,
  87     const fileName& subDir,
  88     IOstream::streamFormat format
  89 );
  90
  91 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  92
  93 } // namespace Foam
  94
  95 #ifdef NoRepository
  96 #   include "ensightOutputFunctions.C"
  97 #endif
  98
  99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 100
 101 #endif
 102
 103 // ************************************************************************* //