All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
noSurfaceWriter.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) 2019-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::noSurfaceWriter
26 
27 Description
28  A dummy surfaceWriter selected to disable surface writing.
29 
30 SourceFiles
31  noSurfaceWriter.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef noSurfaceWriter_H
36 #define noSurfaceWriter_H
37 
38 #include "surfaceWriter.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class noSurfaceWriter Declaration
47 \*---------------------------------------------------------------------------*/
48 
49 class noSurfaceWriter
50 :
51  public surfaceWriter
52 {
53 
54 public:
55 
56  //- Runtime type information
57  TypeName("none");
58 
59 
60  // Constructors
61 
62  //- Construct given write format
63  noSurfaceWriter(const IOstream::streamFormat writeFormat);
64 
65 
66  //- Destructor
67  virtual ~noSurfaceWriter();
68 
69 
70  // Member Functions
71 
72  //- Write single surface geometry to file.
73  virtual void write
74  (
75  const fileName& outputDir,
76  const fileName& surfaceName,
77  const pointField& points,
78  const faceList& faces
79  ) const
80  {}
81 
82  //- Write scalarField for a single surface to file.
83  // One value per face or vertex (isNodeValues = true)
84  virtual void write
85  (
86  const fileName& outputDir, // <case>/surface/TIME
87  const fileName& surfaceName, // name of surface
88  const pointField& points,
89  const faceList& faces,
90  const word& fieldName, // name of field
91  const Field<scalar>& values,
92  const bool isNodeValues
93  ) const
94  {}
95 
96  //- Write vectorField 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<vector>& values,
106  const bool isNodeValues
107  ) const
108  {}
109 
110  //- Write sphericalTensorField 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<sphericalTensor>& values,
120  const bool isNodeValues
121  ) const
122  {}
123 
124  //- Write symmTensorField 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<symmTensor>& values,
134  const bool isNodeValues
135  ) const
136  {}
137 
138  //- Write tensorField 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<tensor>& values,
148  const bool isNodeValues
149  ) const
150  {}
151 };
152 
153 
154 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
155 
156 } // End namespace Foam
157 
158 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
159 
160 #endif
161 
162 // ************************************************************************* //
virtual void write(const fileName &outputDir, const fileName &surfaceName, const pointField &points, const faceList &faces) const
Write single surface geometry to file.
A class for handling file names.
Definition: fileName.H:79
A dummy surfaceWriter selected to disable surface writing.
noSurfaceWriter(const IOstream::streamFormat writeFormat)
Construct given write format.
A class for handling words, derived from string.
Definition: word.H:59
streamFormat
Enumeration for the format of data in the stream.
Definition: IOstream.H:86
virtual ~noSurfaceWriter()
Destructor.
TypeName("none")
Runtime type information.
Base class for surface writers.
Definition: surfaceWriter.H:54
Namespace for OpenFOAM.