src/sampling/sampledSurface/writers/proxy/proxySurfaceWriter.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 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
  50 class proxySurfaceWriter
  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 bool verbose = false
  95         ) const;
  96
  97 };
  98
  99
 100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 101
 102 } // End namespace Foam
 103
 104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 105
 106 #endif
 107
 108 // ************************************************************************* //