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