<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">insertionRegion.hpp</div></div>
</div><!--header-->
<divclass="contents">
<ahref="insertionRegion_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="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="ttc"id="aclasspFlow_1_1insertionRegion_html_a6213c36141284c7076c29445514d610e"><divclass="ttname"><ahref="classpFlow_1_1insertionRegion.html#a6213c36141284c7076c29445514d610e">pFlow::insertionRegion::numInserted_</a></div><divclass="ttdeci">uint32 numInserted_</div><divclass="ttdoc">number of inserted particles</div><divclass="ttdef"><b>Definition:</b><ahref="insertionRegion_8hpp_source.html#l00106">insertionRegion.hpp:106</a></div></div>
<divclass="ttc"id="aclasspFlow_1_1insertionRegion_html_addee41d6ac047acd59c85e776d4e6fb9"><divclass="ttname"><ahref="classpFlow_1_1insertionRegion.html#addee41d6ac047acd59c85e776d4e6fb9">pFlow::insertionRegion::type_</a></div><divclass="ttdeci">word type_</div><divclass="ttdoc">type of insertion region</div><divclass="ttdef"><b>Definition:</b><ahref="insertionRegion_8hpp_source.html#l00109">insertionRegion.hpp:109</a></div></div>
<divclass="ttc"id="aclasspFlow_1_1insertionRegion_html_ab381dc3f8dadd5cf3ea1ca00167243bb"><divclass="ttname"><ahref="classpFlow_1_1insertionRegion.html#ab381dc3f8dadd5cf3ea1ca00167243bb">pFlow::insertionRegion::numberToBeInserted</a></div><divclass="ttdeci">uint32 numberToBeInserted(uint32 iter, real t, real dt)</div><divclass="ttdef"><b>Definition:</b><ahref="insertionRegion_8cpp_source.html#l00174">insertionRegion.cpp:174</a></div></div>
<divclass="ttc"id="aclasspFlow_1_1insertionRegion_html_a1b0314bc3fd7745b79bb6a8695b80529"><divclass="ttname"><ahref="classpFlow_1_1insertionRegion.html#a1b0314bc3fd7745b79bb6a8695b80529">pFlow::insertionRegion::Insertion</a></div><divclass="ttdeci">const auto & Insertion() const</div><divclass="ttdef"><b>Definition:</b><ahref="insertionRegion_8hpp_source.html#l00167">insertionRegion.hpp:167</a></div></div>
<divclass="ttc"id="aclasspFlow_1_1insertionRegion_html_a14b0f1d26ae509ecdc74746fe58d76cf"><divclass="ttname"><ahref="classpFlow_1_1insertionRegion.html#a14b0f1d26ae509ecdc74746fe58d76cf">pFlow::insertionRegion::insertionRegion</a></div><divclass="ttdeci">insertionRegion(const word &name, const insertion &instn)</div><divclass="ttdoc">Construct from a dictionary.</div><divclass="ttdef"><b>Definition:</b><ahref="insertionRegion_8cpp_source.html#l00152">insertionRegion.cpp:152</a></div></div>
<divclass="ttc"id="aclasspFlow_1_1insertionRegion_html_a066802e40cc1e667b535479d0263f5f0"><divclass="ttname"><ahref="classpFlow_1_1insertionRegion.html#a066802e40cc1e667b535479d0263f5f0">pFlow::insertionRegion::pRegion</a></div><divclass="ttdeci">auto & pRegion()</div><divclass="ttdef"><b>Definition:</b><ahref="insertionRegion_8hpp_source.html#l00196">insertionRegion.hpp:196</a></div></div>
<divclass="ttc"id="aclasspFlow_1_1insertionRegion_html_ae355b601249331cd5c4facb48df43223"><divclass="ttname"><ahref="classpFlow_1_1insertionRegion.html#ae355b601249331cd5c4facb48df43223">pFlow::insertionRegion::pStruct</a></div><divclass="ttdeci">const pointStructure & pStruct() const</div><divclass="ttdef"><b>Definition:</b><ahref="insertionRegion_8cpp_source.html#l00168">insertionRegion.cpp:168</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_1baseTimeControl_html_ab9f4b4bc506595a36f3994a0ebc6ad5b"><divclass="ttname"><ahref="classpFlow_1_1baseTimeControl.html#ab9f4b4bc506595a36f3994a0ebc6ad5b">pFlow::baseTimeControl::timeEvent</a></div><divclass="ttdeci">bool timeEvent(uint32 iter, real t, real dt) const</div><divclass="ttdef"><b>Definition:</b><ahref="baseTimeControl_8cpp_source.html#l00078">baseTimeControl.cpp:78</a></div></div>
<divclass="ttc"id="aclasspFlow_1_1insertionRegion_html_a039352410860be5593f442d3238c7eef"><divclass="ttname"><ahref="classpFlow_1_1insertionRegion.html#a039352410860be5593f442d3238c7eef">pFlow::insertionRegion::setFieldList</a></div><divclass="ttdeci">const auto & setFieldList() const</div><divclass="ttdef"><b>Definition:</b><ahref="insertionRegion_8hpp_source.html#l00201">insertionRegion.hpp:201</a></div></div>
<divclass="ttc"id="aclasspFlow_1_1insertionRegion_html"><divclass="ttname"><ahref="classpFlow_1_1insertionRegion.html">pFlow::insertionRegion</a></div><divclass="ttdoc">This class defines all the necessary enteties for defining an insertion region.</div><divclass="ttdef"><b>Definition:</b><ahref="insertionRegion_8hpp_source.html#l00086">insertionRegion.hpp:86</a></div></div>
<divclass="ttc"id="aclasspFlow_1_1insertionRegion_html_a6964e9f1f100001543fdb044fa7fc896"><divclass="ttname"><ahref="classpFlow_1_1insertionRegion.html#a6964e9f1f100001543fdb044fa7fc896">pFlow::insertionRegion::write</a></div><divclass="ttdeci">bool write(dictionary &dict) const</div><divclass="ttdoc">read from dictionary</div><divclass="ttdef"><b>Definition:</b><ahref="insertionRegion_8hpp_source.html#l00217">insertionRegion.hpp:217</a></div></div>
<divclass="ttc"id="aclasspFlow_1_1insertionRegion_html_a4d3dfef53630882b1fe95583bd46d4c9"><divclass="ttname"><ahref="classpFlow_1_1insertionRegion.html#a4d3dfef53630882b1fe95583bd46d4c9">pFlow::insertionRegion::mixture_</a></div><divclass="ttdeci">uniquePtr< shapeMixture > mixture_</div><divclass="ttdoc">mixture of shapes</div><divclass="ttdef"><b>Definition:</b><ahref="insertionRegion_8hpp_source.html#l00115">insertionRegion.hpp:115</a></div></div>
<divclass="ttc"id="aclasspFlow_1_1insertionRegion_html_a9f6977fce84078d4dba954133f452a90"><divclass="ttname"><ahref="classpFlow_1_1insertionRegion.html#a9f6977fce84078d4dba954133f452a90">pFlow::insertionRegion::setFieldDict_</a></div><divclass="ttdeci">uniquePtr< dictionary > setFieldDict_</div><divclass="ttdoc">dictionary for set field</div><divclass="ttdef"><b>Definition:</b><ahref="insertionRegion_8hpp_source.html#l00118">insertionRegion.hpp:118</a></div></div>
<divclass="ttc"id="aclasspFlow_1_1insertionRegion_html_a4d648c95047d94b13db4407584c2c804"><divclass="ttname"><ahref="classpFlow_1_1insertionRegion.html#a4d648c95047d94b13db4407584c2c804">pFlow::insertionRegion::tControl_</a></div><divclass="ttdeci">baseTimeControl tControl_</div><divclass="ttdoc">time control for insertion events</div><divclass="ttdef"><b>Definition:</b><ahref="insertionRegion_8hpp_source.html#l00100">insertionRegion.hpp:100</a></div></div>
<divclass="ttc"id="aclasspFlow_1_1insertionRegion_html_a5a9652837ba1c412a239fec1ff02e88b"><divclass="ttname"><ahref="classpFlow_1_1insertionRegion.html#a5a9652837ba1c412a239fec1ff02e88b">pFlow::insertionRegion::name</a></div><divclass="ttdeci">const auto & name() const</div><divclass="ttdoc">Const ref to name of the region.</div><divclass="ttdef"><b>Definition:</b><ahref="insertionRegion_8hpp_source.html#l00151">insertionRegion.hpp:151</a></div></div>
<divclass="ttc"id="aclasspFlow_1_1insertionRegion_html_a6af97f6ba06d4ad5536c61070cd26f2f"><divclass="ttname"><ahref="classpFlow_1_1insertionRegion.html#a6af97f6ba06d4ad5536c61070cd26f2f">pFlow::insertionRegion::insertion_</a></div><divclass="ttdeci">const insertion & insertion_</div><divclass="ttdoc">ref to insertion</div><divclass="ttdef"><b>Definition:</b><ahref="insertionRegion_8hpp_source.html#l00097">insertionRegion.hpp:97</a></div></div>
<divclass="ttc"id="aclasspFlow_1_1insertionRegion_html_a8026dacb3b6f9b6da0cf123ba9571e59"><divclass="ttname"><ahref="classpFlow_1_1insertionRegion.html#a8026dacb3b6f9b6da0cf123ba9571e59">pFlow::insertionRegion::setFieldList_</a></div><divclass="ttdeci">anyList setFieldList_</div><divclass="ttdoc">list of (filedName type value) for the fields</div><divclass="ttdef"><b>Definition:</b><ahref="insertionRegion_8hpp_source.html#l00121">insertionRegion.hpp:121</a></div></div>
<divclass="ttc"id="aclasspFlow_1_1insertionRegion_html_a892ddcb9cba6f50b0396cdb7bf1b4f6a"><divclass="ttname"><ahref="classpFlow_1_1insertionRegion.html#a892ddcb9cba6f50b0396cdb7bf1b4f6a">pFlow::insertionRegion::dict_</a></div><divclass="ttdeci">const dictionary & dict_</div><divclass="ttdoc">insertion region dictionary</div><divclass="ttdef"><b>Definition:</b><ahref="insertionRegion_8hpp_source.html#l00094">insertionRegion.hpp:94</a></div></div>
<divclass="ttc"id="aclasspFlow_1_1insertionRegion_html_ab67fc1d3e31af0938ee28d49e7b848ef"><divclass="ttname"><ahref="classpFlow_1_1insertionRegion.html#ab67fc1d3e31af0938ee28d49e7b848ef">pFlow::insertionRegion::type</a></div><divclass="ttdeci">const auto & type() const</div><divclass="ttdoc">return type of insertion region</div><divclass="ttdef"><b>Definition:</b><ahref="insertionRegion_8hpp_source.html#l00157">insertionRegion.hpp:157</a></div></div>
<divclass="ttc"id="aclasspFlow_1_1insertionRegion_html_aa364cd422ed5085c750de4a19a321f7f"><divclass="ttname"><ahref="classpFlow_1_1insertionRegion.html#aa364cd422ed5085c750de4a19a321f7f">pFlow::insertionRegion::writeInsertionRegion</a></div><divclass="ttdeci">bool writeInsertionRegion(dictionary &dict) const</div><divclass="ttdoc">write to dictionary</div><divclass="ttdef"><b>Definition:</b><ahref="insertionRegion_8cpp_source.html#l00102">insertionRegion.cpp:102</a></div></div>
<divclass="ttc"id="aclasspFlow_1_1insertionRegion_html_ab7b8db8337aea6bfd4e3a5b69d5d0a6a"><divclass="ttname"><ahref="classpFlow_1_1insertionRegion.html#ab7b8db8337aea6bfd4e3a5b69d5d0a6a">pFlow::insertionRegion::mixture</a></div><divclass="ttdeci">auto & mixture()</div><divclass="ttdef"><b>Definition:</b><ahref="insertionRegion_8hpp_source.html#l00191">insertionRegion.hpp:191</a></div></div>
<divclass="ttc"id="aclasspFlow_1_1insertionRegion_html_a9e81e11944c2000f458fdb15b0b44d1a"><divclass="ttname"><ahref="classpFlow_1_1insertionRegion.html#a9e81e11944c2000f458fdb15b0b44d1a">pFlow::insertionRegion::dict</a></div><divclass="ttdeci">const auto & dict() const</div><divclass="ttdef"><b>Definition:</b><ahref="insertionRegion_8hpp_source.html#l00162">insertionRegion.hpp:162</a></div></div>
<divclass="ttc"id="aclasspFlow_1_1insertionRegion_html_afd780271a9c45061cfdc62f5c3fc9929"><divclass="ttname"><ahref="classpFlow_1_1insertionRegion.html#afd780271a9c45061cfdc62f5c3fc9929">pFlow::insertionRegion::name_</a></div><divclass="ttdeci">const word name_</div><divclass="ttdoc">name of this region</div><divclass="ttdef"><b>Definition:</b><ahref="insertionRegion_8hpp_source.html#l00091">insertionRegion.hpp:91</a></div></div>
<divclass="ttc"id="aclasspFlow_1_1insertionRegion_html_afdb6cd97d8e5679758ebf8161edf1d70"><divclass="ttname"><ahref="classpFlow_1_1insertionRegion.html#afdb6cd97d8e5679758ebf8161edf1d70">pFlow::insertionRegion::insertionTime</a></div><divclass="ttdeci">bool insertionTime(uint32 iter, real t, real dt) const</div><divclass="ttdef"><b>Definition:</b><ahref="insertionRegion_8hpp_source.html#l00174">insertionRegion.hpp:174</a></div></div>
<divclass="ttc"id="aclasspFlow_1_1insertionRegion_html_af5c2a2fe246051f18b23a3fd1bf23249"><divclass="ttname"><ahref="classpFlow_1_1insertionRegion.html#af5c2a2fe246051f18b23a3fd1bf23249">pFlow::insertionRegion::pRegion_</a></div><divclass="ttdeci">uniquePtr< peakableRegion > pRegion_</div><divclass="ttdoc">peakable region of points</div><divclass="ttdef"><b>Definition:</b><ahref="insertionRegion_8hpp_source.html#l00112">insertionRegion.hpp:112</a></div></div>
<divclass="ttc"id="aclasspFlow_1_1insertionRegion_html_ac29edb543b14ed93013258583f9684a1"><divclass="ttname"><ahref="classpFlow_1_1insertionRegion.html#ac29edb543b14ed93013258583f9684a1">pFlow::insertionRegion::rate_</a></div><divclass="ttdeci">real rate_</div><divclass="ttdoc">rate of insertion</div><divclass="ttdef"><b>Definition:</b><ahref="insertionRegion_8hpp_source.html#l00103">insertionRegion.hpp:103</a></div></div>
<divclass="ttc"id="aclasspFlow_1_1insertionRegion_html_adcd85aab41f3f4715afb2d17e5f8d53d"><divclass="ttname"><ahref="classpFlow_1_1insertionRegion.html#adcd85aab41f3f4715afb2d17e5f8d53d">pFlow::insertionRegion::readInsertionRegion</a></div><divclass="ttdeci">bool readInsertionRegion(const dictionary &dict)</div><divclass="ttdoc">read from dictionary</div><divclass="ttdef"><b>Definition:</b><ahref="insertionRegion_8cpp_source.html#l00067">insertionRegion.cpp:67</a></div></div>
<divclass="ttc"id="aclasspFlow_1_1dictionary_html"><divclass="ttname"><ahref="classpFlow_1_1dictionary.html">pFlow::dictionary</a></div><divclass="ttdoc">Dictionary holds a set of data entries or sub-dictionaries that are enclosed in a curely braces or ar...</div><divclass="ttdef"><b>Definition:</b><ahref="dictionary_8hpp_source.html#l00067">dictionary.hpp:67</a></div></div>
<divclass="ttc"id="aclasspFlow_1_1insertion_html"><divclass="ttname"><ahref="classpFlow_1_1insertion.html">pFlow::insertion</a></div><divclass="ttdoc">Base class for particle insertion.</div><divclass="ttdef"><b>Definition:</b><ahref="insertion_8hpp_source.html#l00035">insertion.hpp:35</a></div></div>
