CompactListListIO.C
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) 2022-2023 OpenCFD Ltd.
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 \*---------------------------------------------------------------------------*/
27 
28 #include "CompactListList.H"
29 #include "Istream.H"
30 
31 // * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * * //
32 
33 template<class T>
35 :
36  offsets_(is),
37  values_(is)
38 {
39  // Optionally: enforceSizeSanity();
40 }
41 
42 
43 // * * * * * * * * * * * * * * * IOstream Operators * * * * * * * * * * * * //
44 
45 template<class T>
47 {
48  offsets_.readList(is);
49  values_.readList(is);
50  // Optionally: enforceSizeSanity();
51  return is;
52 }
53 
54 
55 template<class T>
57 (
58  Ostream& os,
59  const label shortLen
60 ) const
61 {
62  offsets_.writeList(os, shortLen);
63  values_.writeList(os, shortLen);
64  return os;
65 }
66 
67 
68 template<class T>
70 (
71  Ostream& os,
72  const label shortLen
73 ) const
74 {
75  const CompactListList<T>& mat = *this;
76 
77  const auto oldFmt = os.format(IOstreamOption::ASCII);
78 
79  // Write like multi-line matrix of rows (ASCII)
80  // TBD: with/without indenting?
81 
82  const label nRows = mat.length();
83 
84  os << nRows << nl << token::BEGIN_LIST << nl;
85 
86  for (label i = 0; i < nRows; ++i)
87  {
88  mat.localList(i).writeList(os, shortLen) << nl;
89  }
90 
91  os << token::END_LIST << nl;
92  os.format(oldFmt);
93 
94  return os;
95 }
96 
97 
98 // ************************************************************************* //
Ostream & writeList(Ostream &os, const label shortLen=0) const
Write CompactListList as offsets/values pair.
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
constexpr char nl
The newline &#39;\n&#39; character (0x0a)
Definition: Ostream.H:50
"ascii" (normal default)
Begin list [isseparator].
Definition: token.H:161
UList< T > localList(const label i)
Return non-const access to sub-list (no subscript checking)
CompactListList() noexcept=default
Default construct.
End list [isseparator].
Definition: token.H:162
A packed storage of objects of type <T> using an offset table for access.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:56
OBJstream os(runTime.globalPath()/outputName)
Ostream & writeMatrix(Ostream &os, const label shortLen=0) const
Write CompactListList as a formatted matrix of values (ASCII)
Istream & readList(Istream &is)
Read CompactListList as offsets/values pair from Istream, discards current list contents.
label length() const noexcept
The primary size (the number of rows/sublists)
streamFormat format() const noexcept
Get the current stream format.