phasicFlow/doc/code-documentation/html/setFieldList_8cpp_source.html

206 lines
20 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="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.">
<title>PhasicFlow: src/phasicFlow/setFieldList/setFieldList.cpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function() { init_search(); });
/* @license-end */
</script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" >
<tbody>
<tr>
<td id="projectlogo"><a href="https://github.com/PhasicFlow"><img alt="Logo" src="phasicFlow_logo.png"></a></td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</td>
</tr>
<tr>
<td id="projectbrief">
<a href="https://https://cemf.ir">www.cemf.ir</a>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('setFieldList_8cpp_source.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">setFieldList.cpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="setFieldList_8cpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*------------------------------- phasicFlow ---------------------------------</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> O C enter of</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> O O E ngineering and</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> O O M ultiscale modeling of</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> OOOOOOO F luid flow </span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">------------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> Copyright (C): www.cemf.ir</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> email: hamid.r.norouzi AT gmail.com</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">------------------------------------------------------------------------------ </span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">Licence:</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<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>&#160;<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>&#160;<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>&#160;<span class="comment"> </span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<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>&#160;<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>&#160;<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>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="comment">-----------------------------------------------------------------------------*/</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; </div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; </div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="setFieldList_8hpp.html">setFieldList.hpp</a>&quot;</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; </div>
<div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="classpFlow_1_1setFieldList.html#a371caec5118a7107207dfbe970b00d34"> 24</a></span>&#160;<span class="keywordtype">bool</span> <a class="code" href="classpFlow_1_1setFieldList.html#a371caec5118a7107207dfbe970b00d34">pFlow::setFieldList::readSetFieldList</a>(<span class="keyword">const</span> <a class="code" href="classpFlow_1_1dictionary.html">dictionary</a>&amp; dict)</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;{</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; this-&gt;clear();</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <a class="code" href="classpFlow_1_1List.html">wordList</a> Keys = dict.<a class="code" href="classpFlow_1_1dictionary.html#a4ec29cc19fce60018543fdd6d7ebf971">dataEntryKeywords</a>();</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <span class="keywordflow">for</span>(<span class="keyword">const</span> <span class="keyword">auto</span>&amp; key:Keys)</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; {</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; this-&gt;emplace_back( dict.<a class="code" href="classpFlow_1_1dictionary.html#a713abeb5a65a5982d48bebb237e19722">dataEntryRef</a>(key));</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; }</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; </div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;}</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; </div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="keywordtype">bool</span> <a class="code" href="classpFlow_1_1setFieldList.html#a4c69c45fdc17483b13be9b2b1a83c3fb">pFlow::setFieldList::writeSetFieldList</a></div>
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="classpFlow_1_1setFieldList.html#a4c69c45fdc17483b13be9b2b1a83c3fb"> 38</a></span>&#160;(</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <a class="code" href="classpFlow_1_1dictionary.html">dictionary</a>&amp; dict</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;)<span class="keyword">const</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;{</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; dict = dict_;</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;}</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; </div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<a class="code" href="classpFlow_1_1setFieldList.html#aa69848b595397b66f2be84cd1424cae1">pFlow::setFieldList::setFieldList</a></div>
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="classpFlow_1_1setFieldList.html#aa69848b595397b66f2be84cd1424cae1"> 47</a></span>&#160;(</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keyword">const</span> <a class="code" href="classpFlow_1_1dictionary.html">dictionary</a>&amp; dict</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;)</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;:</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; dict_(dict)</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;{</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <span class="keywordflow">if</span>(!readSetFieldList(dict_))</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; {</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <a class="code" href="error_8hpp.html#aad22a1cd3b45a97ac8cd195f06fe61fe">fatalExit</a>;</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; }</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;}</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; </div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; </div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;<span class="keywordtype">bool</span> <a class="code" href="classpFlow_1_1setFieldList.html#a6ce0c64db98eb6144d363dbfc86104eb">pFlow::setFieldList::read</a></div>
<div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="classpFlow_1_1setFieldList.html#a6ce0c64db98eb6144d363dbfc86104eb"> 61</a></span>&#160;(</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <span class="keyword">const</span> <a class="code" href="classpFlow_1_1dictionary.html">dictionary</a>&amp; dict</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;)</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;{</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; dict_ = dict;</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="keywordflow">return</span> readSetFieldList(dict);</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;}</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; </div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;<span class="keywordtype">bool</span> <a class="code" href="classpFlow_1_1setFieldList.html#a6964e9f1f100001543fdb044fa7fc896">pFlow::setFieldList::write</a></div>
<div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="classpFlow_1_1setFieldList.html#a6964e9f1f100001543fdb044fa7fc896"> 70</a></span>&#160;(</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <a class="code" href="classpFlow_1_1dictionary.html">dictionary</a>&amp; dict</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;)<span class="keyword">const</span></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;{</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <span class="keywordflow">return</span> writeSetFieldList(dict);</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;}</div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="aclasspFlow_1_1List_html"><div class="ttname"><a href="classpFlow_1_1List.html">pFlow::List&lt; word &gt;</a></div></div>
<div class="ttc" id="asetFieldList_8hpp_html"><div class="ttname"><a href="setFieldList_8hpp.html">setFieldList.hpp</a></div></div>
<div class="ttc" id="aerror_8hpp_html_aad22a1cd3b45a97ac8cd195f06fe61fe"><div class="ttname"><a href="error_8hpp.html#aad22a1cd3b45a97ac8cd195f06fe61fe">fatalExit</a></div><div class="ttdeci">#define fatalExit</div><div class="ttdoc">Fatal exit.</div><div class="ttdef"><b>Definition:</b> <a href="error_8hpp_source.html#l00098">error.hpp:98</a></div></div>
<div class="ttc" id="aclasspFlow_1_1setFieldList_html_a4c69c45fdc17483b13be9b2b1a83c3fb"><div class="ttname"><a href="classpFlow_1_1setFieldList.html#a4c69c45fdc17483b13be9b2b1a83c3fb">pFlow::setFieldList::writeSetFieldList</a></div><div class="ttdeci">bool writeSetFieldList(dictionary &amp;dict) const</div><div class="ttdef"><b>Definition:</b> <a href="setFieldList_8cpp_source.html#l00038">setFieldList.cpp:38</a></div></div>
<div class="ttc" id="aclasspFlow_1_1setFieldList_html_aa69848b595397b66f2be84cd1424cae1"><div class="ttname"><a href="classpFlow_1_1setFieldList.html#aa69848b595397b66f2be84cd1424cae1">pFlow::setFieldList::setFieldList</a></div><div class="ttdeci">setFieldList(const dictionary &amp;dict)</div><div class="ttdef"><b>Definition:</b> <a href="setFieldList_8cpp_source.html#l00047">setFieldList.cpp:47</a></div></div>
<div class="ttc" id="aclasspFlow_1_1setFieldList_html_a6964e9f1f100001543fdb044fa7fc896"><div class="ttname"><a href="classpFlow_1_1setFieldList.html#a6964e9f1f100001543fdb044fa7fc896">pFlow::setFieldList::write</a></div><div class="ttdeci">bool write(dictionary &amp;dict) const</div><div class="ttdef"><b>Definition:</b> <a href="setFieldList_8cpp_source.html#l00070">setFieldList.cpp:70</a></div></div>
<div class="ttc" id="aclasspFlow_1_1setFieldList_html_a6ce0c64db98eb6144d363dbfc86104eb"><div class="ttname"><a href="classpFlow_1_1setFieldList.html#a6ce0c64db98eb6144d363dbfc86104eb">pFlow::setFieldList::read</a></div><div class="ttdeci">bool read(const dictionary &amp;dict)</div><div class="ttdef"><b>Definition:</b> <a href="setFieldList_8cpp_source.html#l00061">setFieldList.cpp:61</a></div></div>
<div class="ttc" id="aclasspFlow_1_1setFieldList_html_a371caec5118a7107207dfbe970b00d34"><div class="ttname"><a href="classpFlow_1_1setFieldList.html#a371caec5118a7107207dfbe970b00d34">pFlow::setFieldList::readSetFieldList</a></div><div class="ttdeci">bool readSetFieldList(const dictionary &amp;dict)</div><div class="ttdef"><b>Definition:</b> <a href="setFieldList_8cpp_source.html#l00024">setFieldList.cpp:24</a></div></div>
<div class="ttc" id="aclasspFlow_1_1dictionary_html_a713abeb5a65a5982d48bebb237e19722"><div class="ttname"><a href="classpFlow_1_1dictionary.html#a713abeb5a65a5982d48bebb237e19722">pFlow::dictionary::dataEntryRef</a></div><div class="ttdeci">dataEntry &amp; dataEntryRef(const word &amp;keyword)</div><div class="ttdoc">ref to a subdictioanry fatalExit if not found/not a dataEntry</div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8cpp_source.html#l00613">dictionary.cpp:613</a></div></div>
<div class="ttc" id="aclasspFlow_1_1dictionary_html_a4ec29cc19fce60018543fdd6d7ebf971"><div class="ttname"><a href="classpFlow_1_1dictionary.html#a4ec29cc19fce60018543fdd6d7ebf971">pFlow::dictionary::dataEntryKeywords</a></div><div class="ttdeci">wordList dataEntryKeywords() const</div><div class="ttdoc">return a list of all dataEntries (non-nullptr) keywords</div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8cpp_source.html#l00719">dictionary.cpp:719</a></div></div>
<div class="ttc" id="aclasspFlow_1_1dictionary_html"><div class="ttname"><a href="classpFlow_1_1dictionary.html">pFlow::dictionary</a></div><div class="ttdoc">Dictionary holds a set of data entries or sub-dictionaries that are enclosed in a curely braces or ar...</div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8hpp_source.html#l00067">dictionary.hpp:67</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_9b7c0f625f4f6d33472b6a893e385484.html">setFieldList</a></li><li class="navelem"><a class="el" href="setFieldList_8cpp.html">setFieldList.cpp</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
</ul>
</div>
</body>
</html>