proxySurfaceWriter.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2020 OpenFOAM Foundation
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::proxySurfaceWriter
26 
27 Description
28  A surfaceWriter that writes the geometry via the MeshedSurfaceProxy, but
29  which does not support any fields.
30 
31 SourceFiles
32  proxySurfaceWriter.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef proxySurfaceWriter_H
37 #define proxySurfaceWriter_H
38 
39 #include "surfaceWriter.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class proxySurfaceWriter Declaration
48 \*---------------------------------------------------------------------------*/
49 
51 :
52  public surfaceWriter
53 {
54 
55  // Private Data
56 
57  //- The associated file extension
58  word ext_;
59 
60 public:
61 
62  //- Runtime type information
63  TypeName("proxy");
64 
65 
66  // Constructors
67 
68  //- Construct for a given extension
69  proxySurfaceWriter(const word& ext);
70 
71 
72  //- Destructor
73  virtual ~proxySurfaceWriter();
74 
75 
76  // Member Functions
77 
78 
79  //- True if the surface format supports geometry in a separate file.
80  // False if geometry and field must be in a single file
81  virtual bool separateGeometry()
82  {
83  return true;
84  }
85 
86 
87  //- Write single surface geometry to file.
88  virtual void write
89  (
90  const fileName& outputDir,
91  const fileName& surfaceName,
92  const pointField& points,
93  const faceList& faces
94  ) const;
95 
96  //- Write scalarField for a single surface to file.
97  // One value per face or vertex (isNodeValues = true)
98  virtual void write
99  (
100  const fileName& outputDir, // <case>/surface/TIME
101  const fileName& surfaceName, // name of surface
102  const pointField& points,
103  const faceList& faces,
104  const word& fieldName, // name of field
105  const Field<scalar>& values,
106  const bool isNodeValues
107  ) const
108  {}
109 
110  //- Write vectorField for a single surface to file.
111  // One value per face or vertex (isNodeValues = true)
112  virtual void write
113  (
114  const fileName& outputDir, // <case>/surface/TIME
115  const fileName& surfaceName, // name of surface
116  const pointField& points,
117  const faceList& faces,
118  const word& fieldName, // name of field
119  const Field<vector>& values,
120  const bool isNodeValues
121  ) const
122  {}
123 
124  //- Write sphericalTensorField for a single surface to file.
125  // One value per face or vertex (isNodeValues = true)
126  virtual void write
127  (
128  const fileName& outputDir, // <case>/surface/TIME
129  const fileName& surfaceName, // name of surface
130  const pointField& points,
131  const faceList& faces,
132  const word& fieldName, // name of field
133  const Field<sphericalTensor>& values,
134  const bool isNodeValues
135  ) const
136  {}
137 
138  //- Write symmTensorField for a single surface to file.
139  // One value per face or vertex (isNodeValues = true)
140  virtual void write
141  (
142  const fileName& outputDir, // <case>/surface/TIME
143  const fileName& surfaceName, // name of surface
144  const pointField& points,
145  const faceList& faces,
146  const word& fieldName, // name of field
147  const Field<symmTensor>& values,
148  const bool isNodeValues
149  ) const
150  {}
151 
152  //- Write tensorField for a single surface to file.
153  // One value per face or vertex (isNodeValues = true)
154  virtual void write
155  (
156  const fileName& outputDir, // <case>/surface/TIME
157  const fileName& surfaceName, // name of surface
158  const pointField& points,
159  const faceList& faces,
160  const word& fieldName, // name of field
161  const Field<tensor>& values,
162  const bool isNodeValues
163  ) const
164  {}
165 };
166 
167 
168 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
169 
170 } // End namespace Foam
171 
172 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
173 
174 #endif
175 
176 // ************************************************************************* //
virtual bool separateGeometry()
True if the surface format supports geometry in a separate file.
proxySurfaceWriter(const word &ext)
Construct for a given extension.
A class for handling file names.
Definition: fileName.H:79
virtual void write(const fileName &outputDir, const fileName &surfaceName, const pointField &points, const faceList &faces) const
Write single surface geometry to file.
TypeName("proxy")
Runtime type information.
A class for handling words, derived from string.
Definition: word.H:59
A surfaceWriter that writes the geometry via the MeshedSurfaceProxy, but which does not support any f...
virtual ~proxySurfaceWriter()
Destructor.
Base class for surface writers.
Definition: surfaceWriter.H:54
Namespace for OpenFOAM.