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