src/sampling/sampledSurface/writers/raw/rawSurfaceWriter.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 Class
  26     Foam::rawSurfaceWriter
  27
  28 Description
  29
  30 SourceFiles
  31     rawSurfaceWriter.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef rawSurfaceWriter_H
  36 #define rawSurfaceWriter_H
  37
  38 #include "surfaceWriter.H"
  39
  40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  41
  42 namespace Foam
  43 {
  44
  45 /*---------------------------------------------------------------------------*\
  46                            Class raw Declaration
  47 \*---------------------------------------------------------------------------*/
  48
  49 template<class Type>
  50 class rawSurfaceWriter
  51 :
  52     public surfaceWriter<Type>
  53 {
  54     // Private Member Functions
  55
  56         static void writeGeometry
  57         (
  58             const pointField& points,
  59             const label pointI,
  60             Ostream& os
  61         );
  62
  63         static void writeGeometry
  64         (
  65             const pointField& points,
  66             const faceList& faces,
  67             const label faceI,
  68             Ostream& os
  69         );
  70
  71         static void writeData
  72         (
  73             const fileName& fieldName,
  74             const pointField& points,
  75             const faceList& faces,
  76             const scalarField& values,
  77             Ostream& os
  78         );
  79
  80         static void writeData
  81         (
  82             const fileName& fieldName,
  83             const pointField& points,
  84             const faceList& faces,
  85             const vectorField& values,
  86             Ostream& os
  87         );
  88
  89         static void writeData
  90         (
  91             const fileName& fieldName,
  92             const pointField& points,
  93             const faceList& faces,
  94             const sphericalTensorField& values,
  95             Ostream& os
  96         );
  97
  98         static void writeData
  99         (
 100             const fileName& fieldName,
 101             const pointField& points,
 102             const faceList& faces,
 103             const symmTensorField& values,
 104             Ostream& os
 105         );
 106
 107         static void writeData
 108         (
 109             const fileName& fieldName,
 110             const pointField& points,
 111             const faceList& faces,
 112             const tensorField& values,
 113             Ostream& os
 114         );
 115
 116
 117 public:
 118
 119     //- Runtime type information
 120     TypeName("raw");
 121
 122
 123     // Constructors
 124
 125         //- Construct null
 126         rawSurfaceWriter();
 127
 128
 129     // Destructor
 130
 131         virtual ~rawSurfaceWriter();
 132
 133
 134     // Member Functions
 135
 136         // Write
 137
 138         //- Write geometry to file.
 139         virtual void write
 140         (
 141             const fileName& outputDir,
 142             const fileName& surfaceName,
 143             const pointField& points,
 144             const faceList& faces,
 145             const bool verbose = false
 146         ) const;
 147
 148         //- Writes single surface to file.
 149         virtual void write
 150         (
 151             const fileName& outputDir,
 152             const fileName& surfaceName,
 153             const pointField& points,
 154             const faceList& faces,
 155             const fileName& fieldName,
 156             const Field<Type>& values,
 157             const bool verbose = false
 158         ) const;
 159 };
 160
 161
 162 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 163
 164 } // End namespace Foam
 165
 166 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 167
 168 #ifdef NoRepository
 169 #   include "rawSurfaceWriter.C"
 170 #endif
 171
 172 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 173
 174 #endif
 175
 176 // ************************************************************************* //