<metaname="description"content="PhasicFlow is an open-source parallel DEM (discrete element method) package for simulating granular flow. It is developed in C++ and can be exectued on both GPU (like CUDA) and CPU.">
<!-- iframe showing the search results (closed by default) -->
<divid="MSearchResultsWindow">
<iframesrc="javascript:void(0)"frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<divclass="header">
<divclass="headertitle">
<divclass="title">Ostream.hpp</div></div>
</div><!--header-->
<divclass="contents">
<ahref="Ostream_8hpp.html">Go to the documentation of this file.</a><divclass="fragment"><divclass="line"><aname="l00001"></a><spanclass="lineno"> 1</span> <spanclass="comment">/*------------------------------- phasicFlow ---------------------------------</span></div>
<divclass="line"><aname="l00002"></a><spanclass="lineno"> 2</span> <spanclass="comment"> O C enter of</span></div>
<divclass="line"><aname="l00003"></a><spanclass="lineno"> 3</span> <spanclass="comment"> O O E ngineering and</span></div>
<divclass="line"><aname="l00004"></a><spanclass="lineno"> 4</span> <spanclass="comment"> O O M ultiscale modeling of</span></div>
<divclass="line"><aname="l00005"></a><spanclass="lineno"> 5</span> <spanclass="comment"> OOOOOOO F luid flow </span></div>
<divclass="line"><aname="l00011"></a><spanclass="lineno"> 11</span> <spanclass="comment"> This file is part of phasicFlow code. It is a free software for simulating </span></div>
<divclass="line"><aname="l00012"></a><spanclass="lineno"> 12</span> <spanclass="comment"> granular and multiphase flows. You can redistribute it and/or modify it under</span></div>
<divclass="line"><aname="l00013"></a><spanclass="lineno"> 13</span> <spanclass="comment"> the terms of GNU General Public License v3 or any other later versions. </span></div>
<divclass="line"><aname="l00015"></a><spanclass="lineno"> 15</span> <spanclass="comment"> phasicFlow is distributed to help others in their research in the field of </span></div>
<divclass="line"><aname="l00016"></a><spanclass="lineno"> 16</span> <spanclass="comment"> granular and multiphase flows, but WITHOUT ANY WARRANTY; without even the</span></div>
<divclass="line"><aname="l00017"></a><spanclass="lineno"> 17</span> <spanclass="comment"> implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.</span></div>
<divclass="line"><aname="l00020"></a><spanclass="lineno"> 20</span> <spanclass="comment">// based on OpenFOAM stream, with some modifications/simplifications</span></div>
<divclass="line"><aname="l00021"></a><spanclass="lineno"> 21</span> <spanclass="comment">// to be tailored to our needs</span></div>
<divclass="ttc"id="aclasspFlow_1_1Ostream_html_ad49e7395bb1832b095b5567656beae88"><divclass="ttname"><ahref="classpFlow_1_1Ostream.html#ad49e7395bb1832b095b5567656beae88">pFlow::Ostream::writeQuoted</a></div><divclass="ttdeci">iOstream & writeQuoted(const word &str, const bool quoted=true) override</div><divclass="ttdoc">Write std::string surrounded by quotes.</div><divclass="ttdef"><b>Definition:</b><ahref="Ostream_8cpp_source.html#l00108">Ostream.cpp:108</a></div></div>
<divclass="ttc"id="aclasspFlow_1_1Ostream_html_ada47b7405e5eaa26f35e795f291164bf"><divclass="ttname"><ahref="classpFlow_1_1Ostream.html#ada47b7405e5eaa26f35e795f291164bf">pFlow::Ostream::flags</a></div><divclass="ttdeci">virtual ios_base::fmtflags flags() const</div><divclass="ttdoc">Return flags of output stream.</div><divclass="ttdef"><b>Definition:</b><ahref="Ostream_8cpp_source.html#l00298">Ostream.cpp:298</a></div></div>
<divclass="ttc"id="aclasspFlow_1_1token_html"><divclass="ttname"><ahref="classpFlow_1_1token.html">pFlow::token</a></div><divclass="ttdoc">Token class based on OpenFOAM stream, with some modifications/simplifications to be tailored to our n...</div><divclass="ttdef"><b>Definition:</b><ahref="token_8hpp_source.html#l00044">token.hpp:44</a></div></div>
<divclass="ttc"id="anamespacepFlow_html_abd01e8e67e3d94cab04ecaaf4f85ac1b"><divclass="ttname"><ahref="namespacepFlow.html#abd01e8e67e3d94cab04ecaaf4f85ac1b">pFlow::uint32</a></div><divclass="ttdeci">unsigned int uint32</div><divclass="ttdef"><b>Definition:</b><ahref="builtinTypes_8hpp_source.html#l00056">builtinTypes.hpp:56</a></div></div>
<divclass="ttc"id="aclasspFlow_1_1Ostream_html_af77f129924f44cbdb7d5d002f7f0a61e"><divclass="ttname"><ahref="classpFlow_1_1Ostream.html#af77f129924f44cbdb7d5d002f7f0a61e">pFlow::Ostream::width</a></div><divclass="ttdeci">int width() const override</div><divclass="ttdoc">Get width of output field.</div><divclass="ttdef"><b>Definition:</b><ahref="Ostream_8cpp_source.html#l00324">Ostream.cpp:324</a></div></div>
<divclass="ttc"id="anamespacepFlow_html_a94809bdb48183ff3ef62935d56f5c1e0"><divclass="ttname"><ahref="namespacepFlow.html#a94809bdb48183ff3ef62935d56f5c1e0">pFlow::int64</a></div><divclass="ttdeci">long long int int64</div><divclass="ttdef"><b>Definition:</b><ahref="builtinTypes_8hpp_source.html#l00052">builtinTypes.hpp:52</a></div></div>
<divclass="ttc"id="aclasspFlow_1_1Ostream_html_a18da76f3c773f1784901873f098b896e"><divclass="ttname"><ahref="classpFlow_1_1Ostream.html#a18da76f3c773f1784901873f098b896e">pFlow::Ostream::endOfBinaryStreaming</a></div><divclass="ttdeci">void endOfBinaryStreaming() override</div><divclass="ttdoc">Reach end of file add a new line and flush stream.</div><divclass="ttdef"><b>Definition:</b><ahref="Ostream_8cpp_source.html#l00280">Ostream.cpp:280</a></div></div>
<divclass="ttc"id="aclasspFlow_1_1Ostream_html_a52e17bea3e2fb1ff4031131c11807bc0"><divclass="ttname"><ahref="classpFlow_1_1Ostream.html#a52e17bea3e2fb1ff4031131c11807bc0">pFlow::Ostream::fill</a></div><divclass="ttdeci">char fill() const override</div><divclass="ttdoc">Get the current padding character.</div><divclass="ttdef"><b>Definition:</b><ahref="Ostream_8cpp_source.html#l00312">Ostream.cpp:312</a></div></div>
<divclass="ttc"id="aclasspFlow_1_1Ostream_html_a8ad456dfdbf8aaf3eecec232dbe0904d"><divclass="ttname"><ahref="classpFlow_1_1Ostream.html#a8ad456dfdbf8aaf3eecec232dbe0904d">pFlow::Ostream::precision</a></div><divclass="ttdeci">int precision() const override</div><divclass="ttdoc">Get precision of output field.</div><divclass="ttdef"><b>Definition:</b><ahref="Ostream_8cpp_source.html#l00336">Ostream.cpp:336</a></div></div>
<divclass="ttc"id="aclasspFlow_1_1Ostream_html_acf38748c4b2c640351e6f5bfde221904"><divclass="ttname"><ahref="classpFlow_1_1Ostream.html#acf38748c4b2c640351e6f5bfde221904">pFlow::Ostream::endl</a></div><divclass="ttdeci">void endl() override</div><divclass="ttdoc">Add newline and flush stream.</div><divclass="ttdef"><b>Definition:</b><ahref="Ostream_8cpp_source.html#l00292">Ostream.cpp:292</a></div></div>
<divclass="ttc"id="aclasspFlow_1_1Ostream_html_a093459b3399aba6fe0f57bbbc2925bc2"><divclass="ttname"><ahref="classpFlow_1_1Ostream.html#a093459b3399aba6fe0f57bbbc2925bc2">pFlow::Ostream::name</a></div><divclass="ttdeci">virtual word & name()</div><divclass="ttdoc">Return non-const access to the name of the stream.</div><divclass="ttdef"><b>Definition:</b><ahref="Ostream_8hpp_source.html#l00077">Ostream.hpp:77</a></div></div>
<divclass="ttc"id="aclasspFlow_1_1Ostream_html_a754ce9966caae1ee331378bf4a87269b"><divclass="ttname"><ahref="classpFlow_1_1Ostream.html#a754ce9966caae1ee331378bf4a87269b">pFlow::Ostream::name</a></div><divclass="ttdeci">virtual const word & name() const</div><divclass="ttdoc">Return the name of the stream.</div><divclass="ttdef"><b>Definition:</b><ahref="Ostream_8hpp_source.html#l00071">Ostream.hpp:71</a></div></div>
<divclass="ttc"id="aclasspFlow_1_1Ostream_html_aac74c7c64e14f3c4e96908948ff6f53d"><divclass="ttname"><ahref="classpFlow_1_1Ostream.html#aac74c7c64e14f3c4e96908948ff6f53d">pFlow::Ostream::startOfBinaryStreaming</a></div><divclass="ttdeci">void startOfBinaryStreaming() override</div><divclass="ttdoc">Add a new line and flush stream.</div><divclass="ttdef"><b>Definition:</b><ahref="Ostream_8cpp_source.html#l00274">Ostream.cpp:274</a></div></div>
<divclass="ttc"id="aclasspFlow_1_1Ostream_html_a3b953d926859ea70e86d084d118064c1"><divclass="ttname"><ahref="classpFlow_1_1Ostream.html#a3b953d926859ea70e86d084d118064c1">pFlow::Ostream::writeBinaryBlockFlag</a></div><divclass="ttdeci">iOstream & writeBinaryBlockFlag() override</div><divclass="ttdoc">Write the flag to indicate the start of a binary block.</div><divclass="ttdef"><b>Definition:</b><ahref="Ostream_8cpp_source.html#l00252">Ostream.cpp:252</a></div></div>
<divclass="ttc"id="aclasspFlow_1_1Ostream_html_a901ca61e6e4d3b687af62dc6a9aa082f"><divclass="ttname"><ahref="classpFlow_1_1Ostream.html#a901ca61e6e4d3b687af62dc6a9aa082f">pFlow::Ostream::Ostream</a></div><divclass="ttdeci">Ostream(std::ostream &os, const word &streamName, writeFormat wf=ASCII)</div><divclass="ttdoc">Construct from components.</div><divclass="ttdef"><b>Definition:</b><ahref="Ostream_8cpp_source.html#l00027">Ostream.cpp:27</a></div></div>
<divclass="ttc"id="aclasspFlow_1_1Ostream_html_a85c6b56e0bda057d90907932ea9647ac"><divclass="ttname"><ahref="classpFlow_1_1Ostream.html#a85c6b56e0bda057d90907932ea9647ac">pFlow::Ostream::stdStream</a></div><divclass="ttdeci">virtual std::ostream & stdStream()</div><divclass="ttdoc">Access to underlying std::ostream.</div><divclass="ttdef"><b>Definition:</b><ahref="Ostream_8hpp_source.html#l00177">Ostream.hpp:177</a></div></div>
<divclass="ttc"id="aclasspFlow_1_1Ostream_html_af20ae96d3a771bd807d36aae8cfd0d4b"><divclass="ttname"><ahref="classpFlow_1_1Ostream.html#af20ae96d3a771bd807d36aae8cfd0d4b">pFlow::Ostream::os_</a></div><divclass="ttdeci">std::ostream & os_</div><divclass="ttdoc">Output stream.</div><divclass="ttdef"><b>Definition:</b><ahref="Ostream_8hpp_source.html#l00051">Ostream.hpp:51</a></div></div>
<divclass="ttc"id="anamespacepFlow_html_aeefdb2888fa3c58f2454ef004419e6a5"><divclass="ttname"><ahref="namespacepFlow.html#aeefdb2888fa3c58f2454ef004419e6a5">pFlow::uint64</a></div><divclass="ttdeci">unsigned long long int uint64</div><divclass="ttdef"><b>Definition:</b><ahref="builtinTypes_8hpp_source.html#l00058">builtinTypes.hpp:58</a></div></div>
<divclass="ttc"id="aclasspFlow_1_1Ostream_html_af0296de2f120be163c138350c0c26507"><divclass="ttname"><ahref="classpFlow_1_1Ostream.html#af0296de2f120be163c138350c0c26507">pFlow::Ostream::write</a></div><divclass="ttdeci">bool write(const token &tok) override</div><divclass="ttdoc">Write token to stream or otherwise handle it.</div><divclass="ttdef"><b>Definition:</b><ahref="Ostream_8cpp_source.html#l00051">Ostream.cpp:51</a></div></div>
<divclass="ttc"id="aclasspFlow_1_1Ostream_html_a444078bffd7c9b7b28f4f84161b1578c"><divclass="ttname"><ahref="classpFlow_1_1Ostream.html#a444078bffd7c9b7b28f4f84161b1578c">pFlow::Ostream::stdStream</a></div><divclass="ttdeci">virtual const std::ostream & stdStream() const</div><divclass="ttdoc">Const access to underlying std::ostream.</div><divclass="ttdef"><b>Definition:</b><ahref="Ostream_8hpp_source.html#l00183">Ostream.hpp:183</a></div></div>
<divclass="ttc"id="aclasspFlow_1_1Ostream_html"><divclass="ttname"><ahref="classpFlow_1_1Ostream.html">pFlow::Ostream</a></div><divclass="ttdoc">Standard output stream for BINARY and ASCII formats.</div><divclass="ttdef"><b>Definition:</b><ahref="Ostream_8hpp_source.html#l00039">Ostream.hpp:39</a></div></div>
<divclass="ttc"id="aclasspFlow_1_1iOstream_html"><divclass="ttname"><ahref="classpFlow_1_1iOstream.html">pFlow::iOstream</a></div><divclass="ttdoc">Interface class for any output stream.</div><divclass="ttdef"><b>Definition:</b><ahref="iOstream_8hpp_source.html#l00059">iOstream.hpp:59</a></div></div>