All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
ensightSetWriter.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-2023 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::ensightSetWriter
26 
27 Description
28 
29 SourceFiles
30  ensightSetWriter.C
31 
32 \*---------------------------------------------------------------------------*/
33 
34 #ifndef ensightSetWriter_H
35 #define ensightSetWriter_H
36 
37 #include "setWriter.H"
38 
39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
40 
41 namespace Foam
42 {
43 
44 /*---------------------------------------------------------------------------*\
45  Class ensightSetWriter Declaration
46 \*---------------------------------------------------------------------------*/
47 
48 class ensightSetWriter
49 :
50  public setWriter
51 {
52 public:
53 
54  //- Runtime type information
55  TypeName("ensight");
56 
57 
58  // Constructors
59 
60  //- Inherit constructors
62 
63  //- Construct and return a clone
64  virtual autoPtr<setWriter> clone() const
65  {
66  return autoPtr<setWriter>(new ensightSetWriter(*this));
67  }
68 
69 
70  //- Destructor
71  virtual ~ensightSetWriter();
72 
73 
74  // Member Functions
75 
76  //- Write a coordSet and associated data
77  virtual void write
78  (
79  const fileName& outputDir,
80  const fileName& setName,
81  const coordSet& set,
82  const wordList& valueSetNames
83  #define TypeValueSetsConstArg(Type, nullArg) \
84  , const UPtrList<const Field<Type>>& Type##ValueSets
87  ) const;
88 };
89 
90 
91 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
92 
93 } // End namespace Foam
94 
95 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
96 
97 #endif
98 
99 // ************************************************************************* //
Pre-declare SubField and related Field type.
Definition: Field.H:83
A templated 1D list of pointers to objects of type <T>, where the size of the array is known and used...
Definition: UPtrList.H:66
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: autoPtr.H:51
Holds list of sampling positions.
Definition: coordSet.H:51
virtual autoPtr< setWriter > clone() const
Construct and return a clone.
virtual void write(const fileName &outputDir, const fileName &setName, const coordSet &set, const wordList &valueSetNames #define TypeValueSetsConstArg(Type, nullArg)) const
Write a coordSet and associated data.
virtual ~ensightSetWriter()
Destructor.
TypeName("ensight")
Runtime type information.
A class for handling file names.
Definition: fileName.H:82
Base class for writing coordinate sets with data.
Definition: setWriter.H:64
setWriter(const IOstream::streamFormat writeFormat, const IOstream::compressionType writeCompression)
Construct given write options.
Definition: setWriter.C:249
#define TypeValueSetsConstArg(Type, nullArg)
Namespace for OpenFOAM.
FOR_ALL_FIELD_TYPES(makeFieldSourceTypedef)