applications/utilities/postProcessing/dataConversion/foamToVTK/writeFuns.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 Class
  26     Foam::writeFunctions
  27
  28 Description
  29     Various functions for collecting and writing binary data.
  30
  31 SourceFiles
  32     writeFunctions.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef writeFunctions_H
  37 #define writeFunctions_H
  38
  39 #include "floatScalar.H"
  40 #include "DynamicList.H"
  41 #include "volFieldsFwd.H"
  42 #include "pointFieldsFwd.H"
  43 #include "vtkMesh.H"
  44 #include "volPointInterpolation.H"
  45
  46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  47
  48 namespace Foam
  49 {
  50
  51 /*---------------------------------------------------------------------------*\
  52                            Class writeFuns Declaration
  53 \*---------------------------------------------------------------------------*/
  54
  55 class writeFuns
  56 {
  57     // Private member functions
  58
  59         // Swap halves of word.
  60
  61             static void swapWord(label& word32);
  62             static void swapWords(const label nWords, label* words32);
  63
  64
  65 public:
  66
  67     // Write ascii or binary. If binary optionally in-place swaps argument
  68
  69         static void write(std::ostream&, const bool, List<floatScalar>&);
  70         static void write(std::ostream&, const bool, DynamicList<floatScalar>&);
  71         static void write(std::ostream&, const bool, labelList&);
  72         static void write(std::ostream&, const bool, DynamicList<label>&);
  73
  74
  75     // Write header
  76
  77         static void writeHeader
  78         (
  79             std::ostream&,
  80             const bool,
  81             const string&
  82         );
  83
  84         static void writeCellDataHeader
  85         (
  86             std::ostream&,
  87             const label,
  88             const label
  89         );
  90
  91         static void writePointDataHeader
  92         (
  93             std::ostream&,
  94             const label,
  95             const label
  96         );
  97
  98
  99     // Convert to VTK and store
 100
 101         static void insert(const scalar&, DynamicList<floatScalar>&);
 102         static void insert(const point&, DynamicList<floatScalar>&);
 103         static void insert(const sphericalTensor&, DynamicList<floatScalar>&);
 104         static void insert(const symmTensor&, DynamicList<floatScalar>&);
 105         static void insert(const tensor&, DynamicList<floatScalar>&);
 106
 107
 108     //- Append elements to DynamicList
 109     static void insert(const labelList&, DynamicList<label>&);
 110     template<class Type>
 111     static void insert(const List<Type>&, DynamicList<floatScalar>&);
 112
 113     //- Write volField with cell values (including decomposed cells)
 114     template<class Type>
 115     static void write
 116     (
 117         std::ostream&,
 118         const bool binary,
 119         const GeometricField<Type, fvPatchField, volMesh>&,
 120         const vtkMesh&
 121     );
 122
 123     //- Write pointField on all mesh points. Interpolate to cell centre
 124     //  for decomposed cell centres.
 125     template<class Type>
 126     static void write
 127     (
 128         std::ostream&,
 129         const bool binary,
 130         const GeometricField<Type, pointPatchField, pointMesh>&,
 131         const vtkMesh&
 132     );
 133
 134     //- Write interpolated field on points and original cell values on
 135     //  decomposed cell centres.
 136     template<class Type>
 137     static void write
 138     (
 139         std::ostream&,
 140         const bool binary,
 141         const GeometricField<Type, fvPatchField, volMesh>&,
 142         const GeometricField<Type, pointPatchField, pointMesh>&,
 143         const vtkMesh&
 144     );
 145
 146     //- Write generic GeometricFields
 147     template<class Type, template<class> class PatchField, class GeoMesh>
 148     static void write
 149     (
 150         std::ostream&,
 151         const bool binary,
 152         const PtrList<GeometricField<Type, PatchField, GeoMesh> >&,
 153         const vtkMesh&
 154     );
 155
 156     //- Interpolate and write volFields
 157     template<class Type>
 158     static void write
 159     (
 160         std::ostream&,
 161         const bool binary,
 162         const volPointInterpolation&,
 163         const PtrList<GeometricField<Type, fvPatchField, volMesh> >&,
 164         const vtkMesh&
 165     );
 166 };
 167
 168
 169 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 170
 171 } // End namespace Foam
 172
 173 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 174
 175 #ifdef NoRepository
 176 #   include "writeFunsTemplates.C"
 177 #endif
 178
 179 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 180
 181 #endif
 182
 183 // ************************************************************************* //