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