src/conversion/meshWriter/meshWriter.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend is free software: you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by the
  13     Free Software Foundation, either version 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Namespace
  25     Foam::meshWriters
  26
  27 Description
  28     A namespace for holding various types of mesh writers.
  29
  30
  31 Class
  32     Foam::meshWriter
  33
  34 Description
  35     write foam meshes and/or results to another CFD format
  36     - currently just STAR-CD
  37
  38 @par Files
  39
  40     "constant/boundaryRegion" is an IOMap<dictionary> that contains
  41     the boundary type and names. eg,
  42     @verbatim
  43         (
  44             0
  45             {
  46                 BoundaryType    wall;
  47                 Label           Default_Boundary_Region;
  48             }
  49
  50             1
  51             {
  52                 BoundaryType    inlet;
  53                 Label           inlet_1;
  54             }
  55
  56             ...
  57
  58             4
  59             {
  60                 BoundaryType    pressure;
  61                 Label           outlet;
  62             }
  63         )
  64     @endverbatim
  65
  66
  67 SourceFiles
  68     meshWriterI.H
  69     meshWriter.C
  70     meshWriterIO.C
  71
  72 \*---------------------------------------------------------------------------*/
  73
  74 #ifndef meshWriter_H
  75 #define meshWriter_H
  76
  77 #include "polyMesh.H"
  78 #include "boundaryRegion.H"
  79 #include "cellTable.H"
  80
  81 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  82
  83 namespace Foam
  84 {
  85
  86 /*---------------------------------------------------------------------------*\
  87                         Class meshWriter Declaration
  88 \*---------------------------------------------------------------------------*/
  89
  90 class meshWriter
  91 {
  92     // Private Member Functions
  93
  94         //- Disallow default bitwise copy construct
  95         meshWriter(const meshWriter&);
  96
  97         //- Disallow default bitwise assignment
  98         void operator=(const meshWriter&);
  99
 100
 101 protected:
 102
 103     // Protected data
 104
 105         //- Mesh reference
 106         const polyMesh& mesh_;
 107
 108         //- Scaling factor for points (eg, [m] -> [mm])
 109         scalar scaleFactor_;
 110
 111         //- Write bnd file
 112         bool writeBoundary_;
 113
 114         //- boundaryRegion persistent data saved as a dictionary
 115         boundaryRegion boundaryRegion_;
 116
 117         //- cellTable persistent data saved as a dictionary
 118         cellTable cellTable_;
 119
 120         //- cellTable IDs for each cell
 121         labelList cellTableId_;
 122
 123         //- Pointers to cell shape models
 124         static const cellModel* unknownModel;
 125         static const cellModel* tetModel;
 126         static const cellModel* pyrModel;
 127         static const cellModel* prismModel;
 128         static const cellModel* hexModel;
 129
 130
 131 public:
 132
 133     // Static data members
 134
 135         static string defaultMeshName;
 136         static string defaultSurfaceName;
 137
 138
 139     // Constructors
 140
 141         //- Ccreate a writer obejct
 142         meshWriter
 143         (
 144             const polyMesh&,
 145             const scalar scaleFactor = 1.0
 146         );
 147
 148
 149     //- Destructor
 150     virtual ~meshWriter();
 151
 152
 153     // Member Functions
 154
 155         // Edit
 156
 157             //- Set points scaling
 158             void scaleFactor(const scalar scaling)
 159             {
 160                 scaleFactor_ = scaling;
 161             }
 162
 163             //- Suppress writing bnd file
 164             void noBoundary()
 165             {
 166                 writeBoundary_ = false;
 167             }
 168
 169
 170         // Write
 171
 172             //- Write volume mesh
 173             //  subclass must to supply this method
 174             virtual bool write
 175             (
 176                 const fileName& timeName = fileName::null
 177             ) const = 0;
 178
 179             //- Write surface mesh with optional triangulation
 180             //  subclass could supply this information
 181             virtual bool writeSurface
 182             (
 183                 const fileName& timeName = fileName::null,
 184                 const bool& triangulate = false
 185             ) const
 186             {
 187                 return false;
 188             }
 189 };
 190
 191
 192 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 193
 194 } // End namespace Foam
 195
 196 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 197
 198 #endif
 199
 200 // ************************************************************************* //