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