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-2021 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  // Private Data
55 
56  //- The associated file extension
57  word ext_;
58 
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  //- Write fields for a single surface to file.
79  virtual void write
80  (
81  const fileName& outputDir, // <case>/surface/TIME
82  const fileName& surfaceName, // name of surface
83  const pointField& points,
84  const faceList& faces,
85  const wordList& fieldNames, // names of fields
86  const bool writePointValues
87  #define FieldTypeValuesConstArg(Type, nullArg) \
88  , const UPtrList<const Field<Type>>& field##Type##Values
91  ) const;
92 };
93 
94 
95 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
96 
97 } // End namespace Foam
98 
99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
100 
101 #endif
102 
103 // ************************************************************************* //
A templated 1D list of pointers to objects of type <T>, where the size of the array is known and used...
Definition: UPtrList.H:66
A class for handling file names.
Definition: fileName.H:82
A surfaceWriter that writes the geometry via the MeshedSurfaceProxy, but which does not support any f...
virtual ~proxySurfaceWriter()
Destructor.
proxySurfaceWriter(const word &ext)
Construct for a given extension.
virtual void write(const fileName &outputDir, const fileName &surfaceName, const pointField &points, const faceList &faces, const wordList &fieldNames, const bool writePointValues #define FieldTypeValuesConstArg(Type, nullArg)) const
Write fields for a single surface to file.
TypeName("proxy")
Runtime type information.
Base class for surface writers.
Definition: surfaceWriter.H:55
A class for handling words, derived from string.
Definition: word.H:62
static List< word > fieldNames
Definition: globalFoam.H:46
const pointField & points
Namespace for OpenFOAM.
FOR_ALL_FIELD_TYPES(DefineContiguousFvWallLocationDataType)
#define FieldTypeValuesConstArg(Type, nullArg)