All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
ensightStream.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2020 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 
58 public:
59 
60  // Constructors
61 
62  //- Construct from components
63  ensightStream(const fileName& f)
64  :
65  name_(f)
66  {}
67 
68  //- Disallow default bitwise copy construction
69  ensightStream(const ensightStream&) = delete;
70 
71 
72  //- Destructor
73  virtual ~ensightStream()
74  {}
75 
76 
77  // Member Functions
78 
79  const fileName& name() const
80  {
81  return name_;
82  }
83 
84  virtual bool ascii() const = 0;
85 
86  virtual void write(const char*) = 0;
87 
88  virtual void write(const int) = 0;
89 
90  virtual void write(const scalarField&) = 0;
91 
92  virtual void write(const List<int>&) = 0;
93 
94  virtual void writePartHeader(const label) = 0;
95 
96 
97  // Member Operators
98 
99  //- Disallow default bitwise assignment
100  void operator=(const ensightStream&) = delete;
101 };
102 
103 
104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
105 
106 } // End namespace Foam
107 
108 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
109 
110 #endif
111 
112 // ************************************************************************* //
ensightStream(const fileName &f)
Construct from components.
Definition: ensightStream.H:62
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:79
virtual void write(const char *)=0
Abstract base class for writing Ensight data.
Definition: ensightStream.H:50
virtual ~ensightStream()
Destructor.
Definition: ensightStream.H:72
virtual bool ascii() const =0
void operator=(const ensightStream &)=delete
Disallow default bitwise assignment.
labelList f(nPoints)
const fileName & name() const
Definition: ensightStream.H:78
virtual void writePartHeader(const label)=0
Namespace for OpenFOAM.