src/sampling/sampledSurface/writers/makeSurfaceWriterMethods.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 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"
  37 #include "addToRunTimeSelectionTable.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 bool verbose                                                    \
  60     ) const                                                                   \
  61     {                                                                         \
  62         writeTemplate                                                         \
  63         (                                                                     \
  64             outputDir,                                                        \
  65             surfaceName,                                                      \
  66             points,                                                           \
  67             faces,                                                            \
  68             fieldName,                                                        \
  69             values,                                                           \
  70             isNodeValues,                                                     \
  71             verbose                                                           \
  72         );                                                                    \
  73     }
  74
  75
  76 #define defineSurfaceWriterWriteFields(ThisClass)                             \
  77     defineSurfaceWriterWriteField(ThisClass, scalar);                         \
  78     defineSurfaceWriterWriteField(ThisClass, vector);                         \
  79     defineSurfaceWriterWriteField(ThisClass, sphericalTensor);                \
  80     defineSurfaceWriterWriteField(ThisClass, symmTensor);                     \
  81     defineSurfaceWriterWriteField(ThisClass, tensor)
  82
  83
  84 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  85
  86 } // End namespace Foam
  87
  88 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  89
  90 #endif
  91
  92 // ************************************************************************* //