mirror of
https://github.com/PhasicFlow/phasicFlow.git
synced 2025-07-28 03:27:05 +00:00
documentation for v1.0
This commit is contained in:
HRN
@ -105,46 +105,64 @@ $(document).ready(function(){initNavTree('helperTstream_8hpp_source.html',''); i
|
||||
<div class="title">helperTstream.hpp</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
<a href="helperTstream_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#ifndef __helperTstream_hpp__</span></div>
|
||||
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define __helperTstream_hpp__</span></div>
|
||||
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>  </div>
|
||||
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>  </div>
|
||||
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>  </div>
|
||||
<div class="line"><a name="l00006"></a><span class="lineno"><a class="line" href="helperTstream_8hpp.html#a0a312db11262484e0216af6c618d43dc"> 6</a></span> <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="helperTstream_8hpp.html#a0a312db11262484e0216af6c618d43dc">validTokenForStream</a>(<span class="keyword">const</span> token tok)</div>
|
||||
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> {</div>
|
||||
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>  <span class="keywordflow">if</span>( tok.good() && !tok.isPunctuation() )<span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
|
||||
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>  <span class="keywordflow">if</span>( tok == token::SPACE) <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
|
||||
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>  <span class="keywordflow">if</span>( tok == token::TAB) <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
|
||||
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>  <span class="keywordflow">if</span>( tok == token::NL) <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
|
||||
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>  <span class="keywordflow">if</span>( tok == token::NULL_TOKEN )<span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
|
||||
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>  </div>
|
||||
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>  <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
|
||||
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> }</div>
|
||||
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  </div>
|
||||
<div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="helperTstream_8hpp.html#af05c433191cc653e68d17345d392acf8"> 17</a></span> <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="helperTstream_8hpp.html#af05c433191cc653e68d17345d392acf8">isBeginToken</a>(<span class="keyword">const</span> token& tok)</div>
|
||||
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> {</div>
|
||||
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  <span class="keywordflow">if</span>( tok.good() && !tok.isPunctuation() )<span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
|
||||
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  <span class="keywordflow">if</span>( tok == token::BEGIN_LIST) <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
|
||||
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  <span class="keywordflow">if</span>( tok == token::BEGIN_BLOCK) <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
|
||||
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  <span class="keywordflow">if</span>( tok == token::BEGIN_SQR) <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
|
||||
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
|
||||
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> }</div>
|
||||
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  </div>
|
||||
<div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="helperTstream_8hpp.html#ab25086a03d5bdef146887d8720c647fd"> 26</a></span> <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="helperTstream_8hpp.html#ab25086a03d5bdef146887d8720c647fd">isEndToken</a>(<span class="keyword">const</span> token& tok)</div>
|
||||
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> {</div>
|
||||
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <span class="keywordflow">if</span>( tok.good() && !tok.isPunctuation() )<span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
|
||||
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <span class="keywordflow">if</span>( tok == token::END_LIST) <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
|
||||
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="keywordflow">if</span>( tok == token::END_BLOCK)<span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
|
||||
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="keywordflow">if</span>( tok == token::END_SQR) <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
|
||||
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
|
||||
<a href="helperTstream_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*------------------------------- phasicFlow ---------------------------------</span></div>
|
||||
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> O C enter of</span></div>
|
||||
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> O O E ngineering and</span></div>
|
||||
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> O O M ultiscale modeling of</span></div>
|
||||
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> OOOOOOO F luid flow </span></div>
|
||||
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">------------------------------------------------------------------------------</span></div>
|
||||
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> Copyright (C): www.cemf.ir</span></div>
|
||||
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> email: hamid.r.norouzi AT gmail.com</span></div>
|
||||
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">------------------------------------------------------------------------------ </span></div>
|
||||
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">Licence:</span></div>
|
||||
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> This file is part of phasicFlow code. It is a free software for simulating </span></div>
|
||||
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> granular and multiphase flows. You can redistribute it and/or modify it under</span></div>
|
||||
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> the terms of GNU General Public License v3 or any other later versions. </span></div>
|
||||
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> </span></div>
|
||||
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> phasicFlow is distributed to help others in their research in the field of </span></div>
|
||||
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> granular and multiphase flows, but WITHOUT ANY WARRANTY; without even the</span></div>
|
||||
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.</span></div>
|
||||
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"></span> </div>
|
||||
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">-----------------------------------------------------------------------------*/</span></div>
|
||||
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#ifndef __helperTstream_hpp__</span></div>
|
||||
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define __helperTstream_hpp__</span></div>
|
||||
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  </div>
|
||||
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  </div>
|
||||
<div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="helperTstream_8hpp.html#a0a312db11262484e0216af6c618d43dc"> 24</a></span> <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="helperTstream_8hpp.html#a0a312db11262484e0216af6c618d43dc">validTokenForStream</a>(<span class="keyword">const</span> token tok)</div>
|
||||
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> {</div>
|
||||
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <span class="keywordflow">if</span>( tok.good() && !tok.isPunctuation() )<span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
|
||||
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <span class="keywordflow">if</span>( tok == token::SPACE) <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
|
||||
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <span class="keywordflow">if</span>( tok == token::TAB) <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
|
||||
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <span class="keywordflow">if</span>( tok == token::NL) <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
|
||||
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="keywordflow">if</span>( tok == token::NULL_TOKEN )<span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
|
||||
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  </div>
|
||||
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
|
||||
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> }</div>
|
||||
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  </div>
|
||||
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#endif // __helperTstream__</span></div>
|
||||
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="helperTstream_8hpp.html#af05c433191cc653e68d17345d392acf8"> 35</a></span> <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="helperTstream_8hpp.html#af05c433191cc653e68d17345d392acf8">isBeginToken</a>(<span class="keyword">const</span> token& tok)</div>
|
||||
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> {</div>
|
||||
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keywordflow">if</span>( tok.good() && !tok.isPunctuation() )<span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
|
||||
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keywordflow">if</span>( tok == token::BEGIN_LIST) <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
|
||||
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keywordflow">if</span>( tok == token::BEGIN_BLOCK) <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
|
||||
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keywordflow">if</span>( tok == token::BEGIN_SQR) <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
|
||||
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
|
||||
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> }</div>
|
||||
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  </div>
|
||||
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="helperTstream_8hpp.html#ab25086a03d5bdef146887d8720c647fd"> 44</a></span> <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="helperTstream_8hpp.html#ab25086a03d5bdef146887d8720c647fd">isEndToken</a>(<span class="keyword">const</span> token& tok)</div>
|
||||
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> {</div>
|
||||
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keywordflow">if</span>( tok.good() && !tok.isPunctuation() )<span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
|
||||
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keywordflow">if</span>( tok == token::END_LIST) <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
|
||||
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keywordflow">if</span>( tok == token::END_BLOCK)<span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
|
||||
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keywordflow">if</span>( tok == token::END_SQR) <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
|
||||
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
|
||||
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> }</div>
|
||||
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  </div>
|
||||
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="preprocessor">#endif // __helperTstream__</span></div>
|
||||
</div><!-- fragment --></div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<div class="ttc" id="ahelperTstream_8hpp_html_ab25086a03d5bdef146887d8720c647fd"><div class="ttname"><a href="helperTstream_8hpp.html#ab25086a03d5bdef146887d8720c647fd">isEndToken</a></div><div class="ttdeci">bool isEndToken(const token &tok)</div><div class="ttdef"><b>Definition:</b> <a href="helperTstream_8hpp_source.html#l00026">helperTstream.hpp:26</a></div></div>
|
||||
<div class="ttc" id="ahelperTstream_8hpp_html_a0a312db11262484e0216af6c618d43dc"><div class="ttname"><a href="helperTstream_8hpp.html#a0a312db11262484e0216af6c618d43dc">validTokenForStream</a></div><div class="ttdeci">bool validTokenForStream(const token tok)</div><div class="ttdef"><b>Definition:</b> <a href="helperTstream_8hpp_source.html#l00006">helperTstream.hpp:6</a></div></div>
|
||||
<div class="ttc" id="ahelperTstream_8hpp_html_af05c433191cc653e68d17345d392acf8"><div class="ttname"><a href="helperTstream_8hpp.html#af05c433191cc653e68d17345d392acf8">isBeginToken</a></div><div class="ttdeci">bool isBeginToken(const token &tok)</div><div class="ttdef"><b>Definition:</b> <a href="helperTstream_8hpp_source.html#l00017">helperTstream.hpp:17</a></div></div>
|
||||
<div class="ttc" id="ahelperTstream_8hpp_html_ab25086a03d5bdef146887d8720c647fd"><div class="ttname"><a href="helperTstream_8hpp.html#ab25086a03d5bdef146887d8720c647fd">isEndToken</a></div><div class="ttdeci">bool isEndToken(const token &tok)</div><div class="ttdef"><b>Definition:</b> <a href="helperTstream_8hpp_source.html#l00044">helperTstream.hpp:44</a></div></div>
|
||||
<div class="ttc" id="ahelperTstream_8hpp_html_a0a312db11262484e0216af6c618d43dc"><div class="ttname"><a href="helperTstream_8hpp.html#a0a312db11262484e0216af6c618d43dc">validTokenForStream</a></div><div class="ttdeci">bool validTokenForStream(const token tok)</div><div class="ttdef"><b>Definition:</b> <a href="helperTstream_8hpp_source.html#l00024">helperTstream.hpp:24</a></div></div>
|
||||
<div class="ttc" id="ahelperTstream_8hpp_html_af05c433191cc653e68d17345d392acf8"><div class="ttname"><a href="helperTstream_8hpp.html#af05c433191cc653e68d17345d392acf8">isBeginToken</a></div><div class="ttdeci">bool isBeginToken(const token &tok)</div><div class="ttdef"><b>Definition:</b> <a href="helperTstream_8hpp_source.html#l00035">helperTstream.hpp:35</a></div></div>
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_cd7a5046d028e114fc17b2ebc2bd02d2.html">phasicFlow</a></li><li class="navelem"><a class="el" href="dir_b13948a90891cb8a59f39ab8c50a8102.html">streams</a></li><li class="navelem"><a class="el" href="dir_b2caccb873e135ff3742e2ceb4fb3fb1.html">TStream</a></li><li class="navelem"><a class="el" href="helperTstream_8hpp.html">helperTstream.hpp</a></li>
|
||||
|
||||
Reference in New Issue
Block a user