All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
csvSetWriter.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::csvSetWriter
26 
27 Description
28  Write set in csv format
29 
30 SourceFiles
31  csvSetWriter.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef csvSetWriter_H
36 #define csvSetWriter_H
37 
38 #include "setWriter.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class csvSetWriter Declaration
47 \*---------------------------------------------------------------------------*/
48 
49 class csvSetWriter
50 :
51  public setWriter
52 {
53 private:
54 
55  // Private Data
56 
57  //- Separator character
58  const char separator_;
59 
60 
61 protected:
62 
63  // Protected Member Functions
64 
65  //- Write a value separator
66  virtual void writeValueSeparator(Ostream& os) const;
67 
68  //- Write a segment separator
69  virtual void writeSegmentSeparator(Ostream& os) const;
70 
71 
72 public:
73 
74  //- Runtime type information
75  TypeName("csv");
76 
77 
78  // Constructors
79 
80  //- Construct given write options
82  (
83  const IOstream::streamFormat writeFormat,
84  const IOstream::compressionType writeCompression
85  );
86 
87  //- Construct from dictionary
89 
90  //- Construct copy
91  csvSetWriter(const csvSetWriter& writer);
92 
93  //- Construct and return a clone
94  virtual autoPtr<setWriter> clone() const
95  {
96  return autoPtr<setWriter>(new csvSetWriter(*this));
97  }
98 
99 
100  //- Destructor
101  virtual ~csvSetWriter();
102 
103 
104  // Member Functions
105 
106  //- Write a coordSet and associated data
107  virtual void write
108  (
109  const fileName& outputDir,
110  const fileName& setName,
111  const coordSet& set,
112  const wordList& valueSetNames
113  #define TypeValueSetsConstArg(Type, nullArg) \
114  , const UPtrList<const Field<Type>>& Type##ValueSets
116  #undef TypeValueSetsConstArg
117  ) const;
118 };
119 
120 
121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
122 
123 } // End namespace Foam
124 
125 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
126 
127 #endif
128 
129 // ************************************************************************* //
Pre-declare SubField and related Field type.
Definition: Field.H:83
streamFormat
Enumeration for the format of data in the stream.
Definition: IOstream.H:87
compressionType
Enumeration for the format of data in the stream.
Definition: IOstream.H:194
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:57
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
Write set in csv format.
Definition: csvSetWriter.H:51
virtual autoPtr< setWriter > clone() const
Construct and return a clone.
Definition: csvSetWriter.H:93
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.
Definition: csvSetWriter.C:91
virtual void writeSegmentSeparator(Ostream &os) const
Write a segment separator.
Definition: csvSetWriter.C:51
csvSetWriter(const IOstream::streamFormat writeFormat, const IOstream::compressionType writeCompression)
Construct given write options.
Definition: csvSetWriter.C:58
virtual void writeValueSeparator(Ostream &os) const
Write a value separator.
Definition: csvSetWriter.C:45
virtual ~csvSetWriter()
Destructor.
Definition: csvSetWriter.C:84
TypeName("csv")
Runtime type information.
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
A class for handling file names.
Definition: fileName.H:82
Base class for writing coordinate sets with data.
Definition: setWriter.H:64
#define TypeValueSetsConstArg(Type, nullArg)
Namespace for OpenFOAM.
FOR_ALL_FIELD_TYPES(makeFieldSourceTypedef)
dictionary dict