src/sampling/sampledSurface/writers/foamFile/foamFile.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2008 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::foamFile
  27
  28 Description
  29     A surfaceWriter for foamFiles
  30
  31 SourceFiles
  32     foamFile.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef foamFile_H
  37 #define foamFile_H
  38
  39 #include "surfaceWriter.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                            Class foamFile Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 template<class Type>
  51 class foamFile
  52 :
  53     public surfaceWriter<Type>
  54 {
  55
  56 public:
  57
  58     //- Runtime type information
  59     TypeName("foamFile");
  60
  61
  62     // Constructors
  63
  64         //- Construct null
  65         foamFile();
  66
  67
  68     // Destructor
  69
  70         virtual ~foamFile();
  71
  72
  73     // Member Functions
  74
  75         // Write
  76
  77         //- Writes single surface to file.
  78         virtual void write
  79         (
  80             const fileName& samplePath,
  81             const fileName& timeDir,
  82             const fileName& surfaceName,
  83             const pointField& points,
  84             const faceList& faces,
  85             const fileName& fieldName,
  86             const Field<Type>& values,
  87             const bool verbose = false
  88         ) const;
  89 };
  90
  91
  92 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  93
  94 } // End namespace Foam
  95
  96 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  97
  98 #ifdef NoRepository
  99 #   include "foamFile.C"
 100 #endif
 101
 102 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 103
 104 #endif
 105
 106 // ************************************************************************* //