ensightSetWriter.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 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 Class
27  Foam::ensightSetWriter
28 
29 Description
30 
31 SourceFiles
32  ensightSetWriter.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef ensightSetWriter_H
37 #define ensightSetWriter_H
38 
39 #include "writer.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class ensightSetWriter Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 template<class Type>
51 class ensightSetWriter
52 :
53  public writer<Type>
54 {
55 
56 public:
57 
58  //- Runtime type information
59  TypeName("ensight");
60 
61 
62  // Constructors
63 
64  //- Construct null
66 
67 
68  //- Destructor
69  virtual ~ensightSetWriter();
70 
71 
72  // Member Functions
73 
74  virtual fileName getFileName
75  (
76  const coordSet&,
77  const wordList&
78  ) const;
79 
80  virtual void write
81  (
82  const coordSet&,
83  const wordList&,
84  const List<const Field<Type>*>&,
85  Ostream&
86  ) const;
87 
88  virtual void write
89  (
90  const bool writeTracks,
91  const PtrList<coordSet>&,
92  const wordList& valueSetNames,
93  const List<List<Field<Type>>>&,
94  Ostream&
95  ) const;
96 };
97 
98 
99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
100 
101 } // End namespace Foam
102 
103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
104 
105 #ifdef NoRepository
106  #include "ensightSetWriter.C"
107 #endif
108 
109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
110 
111 #endif
112 
113 // ************************************************************************* //
Foam::fileName
A class for handling file names.
Definition: fileName.H:69
Foam::ensightSetWriter::getFileName
virtual fileName getFileName(const coordSet &, const wordList &) const
Generate file name with correct extension.
Definition: ensightSetWriter.C:54
Foam::ensightSetWriter::ensightSetWriter
ensightSetWriter()
Construct null.
Definition: ensightSetWriter.C:38
Foam::ensightSetWriter::TypeName
TypeName("ensight")
Runtime type information.
Foam::Field
Generic templated field type.
Definition: Field.H:63
ensightSetWriter.C
Foam::PtrList
A list of pointers to objects of type <T>, with allocation/deallocation management of the pointers....
Definition: List.H:62
Foam::writer
Base class for graphics format writing. Entry points are.
Definition: writer.H:80
Foam::coordSet
Holds list of sampling positions.
Definition: coordSet.H:53
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::ensightSetWriter::~ensightSetWriter
virtual ~ensightSetWriter()
Destructor.
Definition: ensightSetWriter.C:46
Foam::List< word >
Foam::Ostream
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:56
writer.H
Foam::ensightSetWriter::write
virtual void write(const coordSet &, const wordList &, const List< const Field< Type > * > &, Ostream &) const
General entry point for writing.
Definition: ensightSetWriter.C:69
Foam::ensightSetWriter
Definition: ensightSetWriter.H:50