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