ensightStream.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 | 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::ensightStream
26 
27 Description
28  Abstract base class for writing Ensight data
29 
30 SourceFiles
31  ensightStream.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef ensightStream_H
36 #define ensightStream_H
37 
38 #include "fileName.H"
39 #include "scalarField.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 
47 /*---------------------------------------------------------------------------*\
48  Class ensightStream Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 class ensightStream
52 {
53  // Private data
54 
55  const fileName name_;
56 
57  // Private Member Functions
58 
59  //- Disallow default bitwise copy construct
61 
62  //- Disallow default bitwise assignment
63  void operator=(const ensightStream&);
64 
65 
66 public:
67 
68  // Constructors
69 
70  //- Construct from components
71  ensightStream(const fileName& f)
72  :
73  name_(f)
74  {}
75 
76 
77  //- Destructor
78  virtual ~ensightStream()
79  {}
80 
81 
82  // Member Functions
83 
84  const fileName& name() const
85  {
86  return name_;
87  }
88 
89  virtual bool ascii() const = 0;
90 
91  virtual void write(const char*) = 0;
92 
93  virtual void write(const int) = 0;
94 
95  virtual void write(const scalarField&) = 0;
96 
97  virtual void write(const List<int>&) = 0;
98 
99  virtual void writePartHeader(const label) = 0;
100 
101 
102 
103 };
104 
105 
106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
107 
108 } // End namespace Foam
109 
110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
111 
112 #endif
113 
114 // ************************************************************************* //
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
A class for handling file names.
Definition: fileName.H:69
virtual void write(const char *)=0
Abstract base class for writing Ensight data.
Definition: ensightStream.H:50
virtual ~ensightStream()
Destructor.
Definition: ensightStream.H:77
virtual bool ascii() const =0
labelList f(nPoints)
const fileName & name() const
Definition: ensightStream.H:83
virtual void writePartHeader(const label)=0
Namespace for OpenFOAM.