2023-03-27 10:16:23 -07:00
<!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" / >
2023-04-23 12:52:57 -07:00
< 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." >
2023-03-27 10:16:23 -07:00
< title > PhasicFlow: src/phasicFlow/structuredData/peakableRegion/peakableRegion/peakableRegion.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& dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function() { init_search(); });
/* @license-end */
< / script >
2023-04-02 11:35:43 -07:00
< 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 >
2023-03-27 10:16:23 -07:00
< 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" >
2023-04-14 10:28:41 -07:00
< table cellspacing = "0" >
2023-03-27 10:16:23 -07:00
< tbody >
2023-04-14 10:28:41 -07:00
< tr >
< td id = "projectlogo" > < a href = "https://github.com/PhasicFlow" > < img alt = "Logo" src = "phasicFlow_logo.png" > < / a > < / td >
2023-03-27 10:16:23 -07:00
< 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 >
2023-04-14 10:28:41 -07:00
< tr >
< td id = "projectbrief" >
< a href = "https://https://cemf.ir" > www.cemf.ir< / a >
< / td >
< / tr >
2023-03-27 10:16:23 -07:00
< / tbody >
< / table >
< / div >
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3& 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& dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('peakableRegion_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" > peakableRegion.cpp< / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
< a href = "peakableRegion_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 >   < 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 >   < / div >
2025-01-10 13:02:07 +03:30
< div class = "line" > < a name = "l00021" > < / a > < span class = "lineno" > 21< / span >   < span class = "preprocessor" > #include " < a class = "code" href = "peakableRegion_8hpp.html" > peakableRegion.hpp< / a > " < / span > < / div >
< div class = "line" > < a name = "l00022" > < / a > < span class = "lineno" > 22< / span >   < span class = "preprocessor" > #include " < a class = "code" href = "dictionary_8hpp.html" > dictionary.hpp< / a > " < / 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" > 24< / span >   < a class = "code" href = "classpFlow_1_1peakableRegion.html#abf43b56be2edb758022e5748d0adc983" > pFlow::peakableRegion::peakableRegion< / a > < / div >
< div class = "line" > < a name = "l00025" > < / a > < span class = "lineno" > < a class = "line" href = "classpFlow_1_1peakableRegion.html#abf43b56be2edb758022e5748d0adc983" > 25< / a > < / span >   (< / div >
< div class = "line" > < a name = "l00026" > < / a > < span class = "lineno" > 26< / span >   < span class = "keyword" > const< / span > < a class = "code" href = "namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99" > word< / a > & type, < / div >
< div class = "line" > < a name = "l00027" > < / a > < span class = "lineno" > 27< / span >   < span class = "keyword" > const< / span > < a class = "code" href = "classpFlow_1_1dictionary.html" > dictionary< / a > & dict< / div >
2023-03-27 10:16:23 -07:00
< div class = "line" > < a name = "l00028" > < / a > < span class = "lineno" > 28< / span >   )< / div >
< div class = "line" > < a name = "l00029" > < / a > < span class = "lineno" > 29< / span >   {< / div >
< div class = "line" > < a name = "l00030" > < / a > < span class = "lineno" > 30< / span >   < a class = "code" href = "pFlowMacros_8hpp.html#aee00d54cd02615bc094de03967dde20d" > CONSUME_PARAM< / a > (type);< / div >
< div class = "line" > < a name = "l00031" > < / a > < span class = "lineno" > 31< / span >   < a class = "code" href = "pFlowMacros_8hpp.html#aee00d54cd02615bc094de03967dde20d" > CONSUME_PARAM< / a > (dict);< / div >
< div class = "line" > < a name = "l00032" > < / a > < span class = "lineno" > 32< / 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 >   < a class = "code" href = "classpFlow_1_1uniquePtr.html" > pFlow::uniquePtr< pFlow::peakableRegion> < / a > < a class = "code" href = "classpFlow_1_1peakableRegion.html#a7c89091eec63fb3273bfeac98f38343f" > pFlow::peakableRegion::create< / a > < / div >
< div class = "line" > < a name = "l00036" > < / a > < span class = "lineno" > < a class = "line" href = "classpFlow_1_1peakableRegion.html#a7c89091eec63fb3273bfeac98f38343f" > 36< / a > < / span >   (< / div >
< div class = "line" > < a name = "l00037" > < / a > < span class = "lineno" > 37< / span >   < span class = "keyword" > const< / span > < a class = "code" href = "namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99" > word< / a > & type,< / div >
< div class = "line" > < a name = "l00038" > < / a > < span class = "lineno" > 38< / span >   < span class = "keyword" > const< / span > < a class = "code" href = "classpFlow_1_1dictionary.html" > dictionary< / a > & dict< / div >
< div class = "line" > < a name = "l00039" > < / a > < span class = "lineno" > 39< / span >   )< / div >
2025-01-10 13:02:07 +03:30
< div class = "line" > < a name = "l00040" > < / a > < span class = "lineno" > 40< / span >   { < / div >
< div class = "line" > < a name = "l00041" > < / a > < span class = "lineno" > 41< / span >   < a class = "code" href = "namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99" > word< / a > regionType = < a class = "code" href = "namespacepFlow.html#af4e1df8908797640749fa02e2f5db7a7" > angleBracketsNames< / a > (< span class = "stringliteral" > " peakable" < / span > , type);< / div >
2023-03-27 10:16:23 -07:00
< 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 >   < span class = "keywordflow" > if< / span > ( wordvCtorSelector_.search(regionType) )< / div >
< div class = "line" > < a name = "l00044" > < / a > < span class = "lineno" > 44< / span >   {< / div >
< div class = "line" > < a name = "l00045" > < / a > < span class = "lineno" > 45< / span >   < span class = "keywordflow" > return< / span > wordvCtorSelector_[regionType] (type, dict);< / div >
< div class = "line" > < a name = "l00046" > < / a > < span class = "lineno" > 46< / span >   }< / div >
< div class = "line" > < a name = "l00047" > < / a > < span class = "lineno" > 47< / span >   < span class = "keywordflow" > else< / span > < / div >
< div class = "line" > < a name = "l00048" > < / a > < span class = "lineno" > 48< / span >   {< / div >
< div class = "line" > < a name = "l00049" > < / a > < span class = "lineno" > 49< / span >   < a class = "code" href = "namespacepFlow.html#a9c4454c5f18c8245eaaebf2b4832eab0" > printKeys< / a > < / div >
< div class = "line" > < a name = "l00050" > < / a > < span class = "lineno" > 50< / span >   ( < / div >
2025-01-10 13:02:07 +03:30
< div class = "line" > < a name = "l00051" > < / a > < span class = "lineno" > 51< / span >   < a class = "code" href = "error_8hpp.html#adfe9ae1313e6913aca3f96d3eb67906e" > fatalError< / a > < < < span class = "stringliteral" > " Ctor Selector " < / span > < < regionType < < < span class = "stringliteral" > " does not exist. \n" < / span > < / div >
2023-03-27 10:16:23 -07:00
< div class = "line" > < a name = "l00052" > < / a > < span class = "lineno" > 52< / span >   < < < span class = "stringliteral" > " Avaiable ones are: \n\n" < / span > < / div >
< div class = "line" > < a name = "l00053" > < / a > < span class = "lineno" > 53< / span >   ,< / div >
< div class = "line" > < a name = "l00054" > < / a > < span class = "lineno" > 54< / span >   wordvCtorSelector_< / div >
< div class = "line" > < a name = "l00055" > < / a > < span class = "lineno" > 55< / span >   );< / div >
< div class = "line" > < a name = "l00056" > < / a > < span class = "lineno" > 56< / span >   < a class = "code" href = "error_8hpp.html#aad22a1cd3b45a97ac8cd195f06fe61fe" > fatalExit< / a > ;< / div >
< div class = "line" > < a name = "l00057" > < / a > < span class = "lineno" > 57< / span >   }< / div >
< div class = "line" > < a name = "l00058" > < / a > < span class = "lineno" > 58< / span >   < / div >
< div class = "line" > < a name = "l00059" > < / a > < span class = "lineno" > 59< / span >   < span class = "keywordflow" > return< / span > < span class = "keyword" > nullptr< / span > ;< / div >
< div class = "line" > < a name = "l00060" > < / a > < span class = "lineno" > 60< / span >   }< / div >
< / div > <!-- fragment --> < / div > <!-- contents -->
< / div > <!-- doc - content -->
2025-01-10 13:02:07 +03:30
< 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_1peakableRegion_html_abf43b56be2edb758022e5748d0adc983" > < div class = "ttname" > < a href = "classpFlow_1_1peakableRegion.html#abf43b56be2edb758022e5748d0adc983" > pFlow::peakableRegion::peakableRegion< / a > < / div > < div class = "ttdeci" > peakableRegion(const word & type, const dictionary & dict)< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "peakableRegion_8cpp_source.html#l00025" > peakableRegion.cpp:25< / a > < / div > < / div >
< div class = "ttc" id = "anamespacepFlow_html_a0ebe792a293e8c717bddf60070c0fe99" > < div class = "ttname" > < a href = "namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99" > pFlow::word< / a > < / div > < div class = "ttdeci" > std::string word< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "builtinTypes_8hpp_source.html#l00064" > builtinTypes.hpp:64< / a > < / div > < / div >
2023-03-27 10:16:23 -07:00
< div class = "ttc" id = "anamespacepFlow_html_a9c4454c5f18c8245eaaebf2b4832eab0" > < div class = "ttname" > < a href = "namespacepFlow.html#a9c4454c5f18c8245eaaebf2b4832eab0" > pFlow::printKeys< / a > < / div > < div class = "ttdeci" > iOstream & printKeys(iOstream & os, const wordHashMap< T > & m)< / div > < / div >
2025-01-10 13:02:07 +03:30
< div class = "ttc" id = "anamespacepFlow_html_af4e1df8908797640749fa02e2f5db7a7" > < div class = "ttname" > < a href = "namespacepFlow.html#af4e1df8908797640749fa02e2f5db7a7" > pFlow::angleBracketsNames< / a > < / div > < div class = "ttdeci" > word angleBracketsNames(const word & w1, const word & w2)< / div > < div class = "ttdoc" > Output < w1,w2> < / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "bTypesFunctions_8cpp_source.html#l00156" > bTypesFunctions.cpp:156< / a > < / div > < / div >
2023-03-27 10:16:23 -07:00
< div class = "ttc" id = "adictionary_8hpp_html" > < div class = "ttname" > < a href = "dictionary_8hpp.html" > dictionary.hpp< / a > < / div > < / div >
< div class = "ttc" id = "aclasspFlow_1_1peakableRegion_html_a7c89091eec63fb3273bfeac98f38343f" > < div class = "ttname" > < a href = "classpFlow_1_1peakableRegion.html#a7c89091eec63fb3273bfeac98f38343f" > pFlow::peakableRegion::create< / a > < / div > < div class = "ttdeci" > static uniquePtr< peakableRegion > create(const word & type, const dictionary & dict)< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "peakableRegion_8cpp_source.html#l00036" > peakableRegion.cpp:36< / a > < / div > < / div >
< div class = "ttc" id = "apeakableRegion_8hpp_html" > < div class = "ttname" > < a href = "peakableRegion_8hpp.html" > peakableRegion.hpp< / a > < / div > < / div >
2025-01-10 13:02:07 +03:30
< div class = "ttc" id = "aerror_8hpp_html_adfe9ae1313e6913aca3f96d3eb67906e" > < div class = "ttname" > < a href = "error_8hpp.html#adfe9ae1313e6913aca3f96d3eb67906e" > fatalError< / a > < / div > < div class = "ttdeci" > #define fatalError< / div > < div class = "ttdoc" > Report a fatal error and exit the applicaiton.< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "error_8hpp_source.html#l00070" > error.hpp:70< / a > < / div > < / div >
2023-03-27 10:16:23 -07:00
< div class = "ttc" id = "aclasspFlow_1_1uniquePtr_html" > < div class = "ttname" > < a href = "classpFlow_1_1uniquePtr.html" > pFlow::uniquePtr< pFlow::peakableRegion > < / a > < / div > < / div >
< div class = "ttc" id = "apFlowMacros_8hpp_html_aee00d54cd02615bc094de03967dde20d" > < div class = "ttname" > < a href = "pFlowMacros_8hpp.html#aee00d54cd02615bc094de03967dde20d" > CONSUME_PARAM< / a > < / div > < div class = "ttdeci" > #define CONSUME_PARAM(x)< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "pFlowMacros_8hpp_source.html#l00038" > pFlowMacros.hpp:38< / a > < / div > < / div >
2025-01-10 13:02:07 +03:30
< 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 >
2023-03-27 10:16:23 -07:00
< 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_0b265ec0eb5bc5fbad75b6fd7b5b024b.html" > structuredData< / a > < / li > < li class = "navelem" > < a class = "el" href = "dir_4f9e597021b90228ccac48345da86dec.html" > peakableRegion< / a > < / li > < li class = "navelem" > < a class = "el" href = "dir_fcee4eefc34728867d2bd32b142ae11c.html" > peakableRegion< / a > < / li > < li class = "navelem" > < a class = "el" href = "peakableRegion_8cpp.html" > peakableRegion.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 >
