ENH: autoLayerDriver: better layering information message
[OpenFOAM-2.0.x.git] / src / conversion / meshWriter / starcd / STARCDMeshWriter.H
blob42df2d9f228303b65c20b35f43a7d85e29b41e11
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.
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.
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.
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/>.
24 Class
25     Foam::meshWriters::STARCD
27 Description
28     Writes polyMesh in pro-STAR (v4) bnd/cel/vrt format
30     The cellTableId and cellTable information are used (if available).
31     Otherwise the cellZones are used (if available).
33 SourceFiles
34     STARCDMeshWriter.C
36 \*---------------------------------------------------------------------------*/
38 #ifndef STARCDMeshWriter_H
39 #define STARCDMeshWriter_H
41 #include "meshWriter.H"
42 #include "IOstream.H"
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 namespace Foam
49 namespace meshWriters
52 /*---------------------------------------------------------------------------*\
53                     Class meshWriters::STARCD Declaration
54 \*---------------------------------------------------------------------------*/
56 class STARCD
58     public meshWriter
60     // Private Data
62         static const char* defaultBoundaryName;
65     // Private Member Functions
67         //- Disallow default bitwise copy construct
68         STARCD(const STARCD&);
70         //- Disallow default bitwise assignment
71         void operator=(const STARCD&);
73         //- Pro-STAR 4+ header format
74         static void writeHeader(Ostream&, const char* filetype);
76         //- Write points
77         void writePoints(const fileName& baseName) const;
79         //- Write cells
80         void writeCells(const fileName& baseName) const;
82         //- Write boundary
83         void writeBoundary(const fileName& baseName) const;
85         void getCellTable();
87         label findDefaultBoundary() const;
90 public:
92     // Static data members
94         //- Face addressing from OpenFOAM faces -> pro-STAR faces
95         static const label foamToStarFaceAddr[4][6];
98     // Constructors
100         //- Open a file for writing
101         STARCD
102         (
103             const polyMesh&,
104             const scalar scaleFactor = 1.0
105         );
108     //- Destructor
109     virtual ~STARCD();
112     // Member Functions
114         // Edit
116             //- Remove STAR-CD files for the baseName
117             void rmFiles(const fileName& baseName) const;
120         // Write
122             //- Write volume mesh
123             virtual bool write
124             (
125                 const fileName& meshName = fileName::null
126             ) const;
131 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
133 } // End namespace meshWriters
134 } // End namespace Foam
136 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
138 #endif
140 // ************************************************************************* //