SMESHsurfaceFormat.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2011-2016 OpenFOAM Foundation
9  Copyright (C) 2016-2020 OpenCFD Ltd.
10 -------------------------------------------------------------------------------
11 License
12  This file is part of OpenFOAM.
13 
14  OpenFOAM is free software: you can redistribute it and/or modify it
15  under the terms of the GNU General Public License as published by
16  the Free Software Foundation, either version 3 of the License, or
17  (at your option) any later version.
18 
19  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22  for more details.
23 
24  You should have received a copy of the GNU General Public License
25  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26 
27 Class
28  Foam::fileFormats::SMESHsurfaceFormat
29 
30 Description
31  Write tetgen SMESH format (Tetgen http://tetgen.berlios.de)
32 
33  Output stream options:
34  - ASCII only
35  - compression on/off
36 
37  Output dictionary options: ignored
38 
39 See also
40  File format information:
41  http://tetgen.berlios.de/fformats.smesh.html
42 
43 SourceFiles
44  SMESHsurfaceFormat.C
45 
46 \*---------------------------------------------------------------------------*/
47 
48 #ifndef SMESHsurfaceFormat_H
49 #define SMESHsurfaceFormat_H
50 
51 #include "MeshedSurface.H"
52 #include "MeshedSurfaceProxy.H"
53 #include "UnsortedMeshedSurface.H"
54 
55 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
56 
57 namespace Foam
58 {
59 namespace fileFormats
60 {
61 
62 /*---------------------------------------------------------------------------*\
63  Class fileFormats::SMESHsurfaceFormat Declaration
64 \*---------------------------------------------------------------------------*/
65 
66 template<class Face>
68 :
69  public MeshedSurface<Face>
70 {
71 public:
72 
73  // Constructors
74 
75  //- Default construct
76  SMESHsurfaceFormat() = default;
77 
78 
79  //- Destructor
80  virtual ~SMESHsurfaceFormat() = default;
81 
82 
83  // Static Functions
84 
85  //- Write surface mesh components by proxy
86  static void write
87  (
88  const fileName& filename,
89  const MeshedSurfaceProxy<Face>& surf,
90  IOstreamOption streamOpt = IOstreamOption(),
91  const dictionary& /*unused*/ = dictionary::null
92  );
93 
94 
95  // Member Functions
96 
97  //- Write surface mesh to file
98  virtual void write
99  (
100  const fileName& name,
101  IOstreamOption streamOpt = IOstreamOption(),
102  const dictionary& options = dictionary::null
103  ) const
104  {
105  write(name, MeshedSurfaceProxy<Face>(*this), streamOpt, options);
106  }
107 };
108 
109 
110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
111 
112 } // End namespace fileFormats
113 } // End namespace Foam
114 
115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
116 
117 #ifdef NoRepository
118  #include "SMESHsurfaceFormat.C"
119 #endif
120 
121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
122 
123 #endif
124 
125 // ************************************************************************* //
MeshedSurfaceProxy.H
Foam::fileName
A class for handling file names.
Definition: fileName.H:69
Foam::fileFormats::SMESHsurfaceFormat::~SMESHsurfaceFormat
virtual ~SMESHsurfaceFormat()=default
Destructor.
SMESHsurfaceFormat.C
Foam::MeshedSurfaceProxy
A proxy for writing MeshedSurface, UnsortedMeshedSurface and surfMesh to various file formats.
Definition: MeshedSurface.H:82
Foam::fileFormats::SMESHsurfaceFormat::SMESHsurfaceFormat
SMESHsurfaceFormat()=default
Default construct.
Foam::dictionary::null
static const dictionary null
An empty dictionary, which is also the parent for all dictionaries.
Definition: dictionary.H:385
UnsortedMeshedSurface.H
Foam::fileFormats::SMESHsurfaceFormat::write
static void write(const fileName &filename, const MeshedSurfaceProxy< Face > &surf, IOstreamOption streamOpt=IOstreamOption(), const dictionary &=dictionary::null)
Write surface mesh components by proxy.
Definition: SMESHsurfaceFormat.C:37
Foam::name
word name(const complex &c)
Return string representation of complex.
Definition: complex.C:76
Foam::IOstreamOption
The IOstreamOption is a simple container for options an IOstream can normally have.
Definition: IOstreamOption.H:63
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:121
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::MeshedSurface
A surface geometry mesh with zone information, not to be confused with the similarly named surfaceMes...
Definition: triSurfaceTools.H:80
Foam::fileFormats::SMESHsurfaceFormat
Write tetgen SMESH format (Tetgen http://tetgen.berlios.de)
Definition: SMESHsurfaceFormat.H:66
MeshedSurface.H