makeSurfaceWriterMethods.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 InClass
25  Foam::makeSurfaceWriterMethods
26 
27 Description
28  Convenience macros for instantiating writer methods for surfaceWriter
29  classes.
30 
31 \*---------------------------------------------------------------------------*/
32 
33 #ifndef makeSurfaceWriterMethods_H
34 #define makeSurfaceWriterMethods_H
35 
36 #include "surfaceWriter.H"
38 
39 namespace Foam
40 {
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 #define makeSurfaceWriterType(ThisClass) \
45  defineTypeNameAndDebug(ThisClass, 0); \
46  addToRunTimeSelectionTable(surfaceWriter, ThisClass, word)
47 
48 
49 #define defineSurfaceWriterWriteField(ThisClass, FieldType) \
50  void ThisClass::write \
51  ( \
52  const fileName& outputDir, \
53  const fileName& surfaceName, \
54  const pointField& points, \
55  const faceList& faces, \
56  const word& fieldName, \
57  const Field<FieldType>& values, \
58  const bool isNodeValues \
59  ) const \
60  { \
61  Write \
62  ( \
63  outputDir, \
64  surfaceName, \
65  points, \
66  faces, \
67  fieldName, \
68  values, \
69  isNodeValues \
70  ); \
71  }
72 
73 
74 #define defineSurfaceWriterWriteFields(ThisClass) \
75  defineSurfaceWriterWriteField(ThisClass, scalar); \
76  defineSurfaceWriterWriteField(ThisClass, vector); \
77  defineSurfaceWriterWriteField(ThisClass, sphericalTensor); \
78  defineSurfaceWriterWriteField(ThisClass, symmTensor); \
79  defineSurfaceWriterWriteField(ThisClass, tensor)
80 
81 
82 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
83 
84 } // End namespace Foam
85 
86 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
87 
88 #endif
89 
90 // ************************************************************************* //
Macros for easy insertion into run-time selection tables.
Namespace for OpenFOAM.