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