IOPosition.C
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-2022 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 \*---------------------------------------------------------------------------*/
25 
26 #include "IOPosition.H"
27 #include "polyMesh.H"
28 
29 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
30 
31 template<class CloudType>
33 :
35  (
36  IOobject
37  (
38  "positions",
39  c.time().name(),
40  c,
41  IOobject::MUST_READ,
42  IOobject::NO_WRITE
43  )
44  ),
45  cloud_(c)
46 {}
47 
48 
49 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
50 
51 template<class CloudType>
53 {
54  return regIOobject::write(cloud_.size());
55 }
56 
57 
58 template<class CloudType>
60 {
61  os << cloud_.size() << nl << token::BEGIN_LIST << nl;
62 
63  forAllConstIter(typename CloudType, cloud_, iter)
64  {
65  iter().writePosition(os);
66  os << nl;
67  }
68 
69  os << token::END_LIST << endl;
70 
71  return os.good();
72 }
73 
74 
75 template<class CloudType>
77 {
78  token firstToken(is);
79 
80  if (firstToken.isLabel())
81  {
82  label s = firstToken.labelToken();
83 
84  // Read beginning of contents
85  is.readBeginList
86  (
87  "IOPosition<CloudType>::readData(Istream&, CloudType&)"
88  );
89 
90  for (label i=0; i<s; i++)
91  {
92  // Read position only
93  c.append(new typename CloudType::particleType(is, false));
94  }
95 
96  // Read end of contents
97  is.readEndList("IOPosition<CloudType>::readData(Istream&, CloudType&)");
98  }
99  else if (firstToken.isPunctuation())
100  {
101  if (firstToken.pToken() != token::BEGIN_LIST)
102  {
104  (
105  is
106  ) << "incorrect first token, '(', found "
107  << firstToken.info() << exit(FatalIOError);
108  }
109 
110  token lastToken(is);
111  while
112  (
113  !(
114  lastToken.isPunctuation()
115  && lastToken.pToken() == token::END_LIST
116  )
117  )
118  {
119  is.putBack(lastToken);
120 
121  // Read position only
122  c.append(new typename CloudType::particleType(is, false));
123  is >> lastToken;
124  }
125  }
126  else
127  {
129  (
130  is
131  ) << "incorrect first token, expected <int> or '(', found "
132  << firstToken.info() << exit(FatalIOError);
133  }
134 
135  // Check state of IOstream
136  is.check
137  (
138  "void IOPosition<CloudType>::readData(Istream&, CloudType&)"
139  );
140 }
141 
142 
143 // ************************************************************************* //
#define forAllConstIter(Container, container, iter)
Iterate across all elements in the container object of type.
Definition: UList.H:477
ParcelType particleType
Definition: Cloud.H:128
Templated base class for dsmc cloud.
Definition: DSMCCloud.H:79
virtual bool writeData(Ostream &os) const
Pure virtual writaData function.
Definition: IOPosition.C:59
virtual bool write(const bool write=true) const
Write using setting from DB.
Definition: IOPosition.C:52
virtual bool readData(Istream &)
Inherit readData from regIOobject.
IOPosition(const CloudType &)
Construct from cloud.
Definition: IOPosition.C:32
IOobject defines the attributes of an object for which implicit objectRegistry management is supporte...
Definition: IOobject.H:99
virtual bool check(const char *operation) const
Check IOstream status for given operation.
Definition: IOstream.C:92
bool good() const
Return true if next operation might succeed.
Definition: IOstream.H:330
An Istream is an abstract base class for all input systems (streams, files, token lists etc)....
Definition: Istream.H:60
char readEndList(const char *funcName)
Definition: Istream.C:148
char readBeginList(const char *funcName)
Definition: Istream.C:127
void putBack(const token &)
Put back token.
Definition: Istream.C:30
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:57
regIOobject is an abstract class derived from IOobject to handle automatic object registration with t...
Definition: regIOobject.H:55
virtual bool write(const bool write=true) const
Write using setting from DB.
A token holds items read from Istream.
Definition: token.H:73
bool isLabel() const
Definition: tokenI.H:392
bool isPunctuation() const
Definition: tokenI.H:243
@ BEGIN_LIST
Definition: token.H:106
@ END_LIST
Definition: token.H:107
punctuationToken pToken() const
Definition: tokenI.H:248
label labelToken() const
Definition: tokenI.H:397
InfoProxy< token > info() const
Return info proxy.
Definition: token.H:391
#define FatalIOErrorInFunction(ios)
Report an error message using Foam::FatalIOError.
Definition: error.H:318
gmvFile<< "tracers "<< particles.size()<< nl;forAllConstIter(Cloud< passiveParticle >, particles, iter){ gmvFile<< iter().position().x()<< " ";}gmvFile<< nl;forAllConstIter(Cloud< passiveParticle >, particles, iter){ gmvFile<< iter().position().y()<< " ";}gmvFile<< nl;forAllConstIter(Cloud< passiveParticle >, particles, iter){ gmvFile<< iter().position().z()<< " ";}gmvFile<< nl;forAll(lagrangianScalarNames, i){ word name=lagrangianScalarNames[i];IOField< scalar > s(IOobject(name, runTime.name(), cloud::prefix, mesh, IOobject::MUST_READ, IOobject::NO_WRITE))
const dimensionedScalar c
Speed of light in a vacuum.
void write(std::ostream &os, const bool binary, List< floatScalar > &fField)
Write floats ascii or binary.
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:124
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
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:251
IOerror FatalIOError
word name(const complex &)
Return a string representation of a complex.
Definition: complex.C:47
static const char nl
Definition: Ostream.H:260