mirror of
https://github.com/PhasicFlow/phasicFlow.git
synced 2025-06-22 16:28:30 +00:00
first commit of documentation
This commit is contained in:
@ -0,0 +1,154 @@
|
||||
<!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"/>
|
||||
<title>PhasicFlow: Member List</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>
|
||||
<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" cellpadding="0">
|
||||
<tbody>
|
||||
<tr style="height: 56px;">
|
||||
<td id="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname"><a href="https://cemf.ir">PhasicFlow</a>
|
||||
 <span id="projectnumber"><a href="https://cemf.ir">v0.1</a></span>
|
||||
</div>
|
||||
<div id="projectbrief"><a href="www.github.com/PhasicFlow">www.cemf.ir</a></div>
|
||||
</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>
|
||||
</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('classpFlow_1_1InsertionRegion.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">InsertionRegion< ShapeType > Member List</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p>This is the complete list of members for <a class="el" href="classpFlow_1_1InsertionRegion.html">InsertionRegion< ShapeType ></a>, including all inherited members.</p>
|
||||
<table class="directory">
|
||||
<tr class="even"><td class="entry"><a class="el" href="classpFlow_1_1timeFlowControl.html#a1ebee6449f6428d4d4597b61e8b5c15a">addToNumInserted</a>(size_t newInserted)</td><td class="entry"><a class="el" href="classpFlow_1_1timeFlowControl.html">timeFlowControl</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="classpFlow_1_1InsertionRegion.html#a7e637e102a6242c3b999828e73d0ea1c">checkForContact</a>(const realx3Vector &pos, const realVector &diams, const realx3 &p, const real &d)</td><td class="entry"><a class="el" href="classpFlow_1_1InsertionRegion.html">InsertionRegion< ShapeType ></a></td><td class="entry"><span class="mlabel">protected</span><span class="mlabel">static</span></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="classpFlow_1_1InsertionRegion.html#acc863d85d662202ba8b08e691372887b">clone</a>() const</td><td class="entry"><a class="el" href="classpFlow_1_1InsertionRegion.html">InsertionRegion< ShapeType ></a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="classpFlow_1_1InsertionRegion.html#a29ec0c24a53d9f0f38289002f302848e">clonePtr</a>() const</td><td class="entry"><a class="el" href="classpFlow_1_1InsertionRegion.html">InsertionRegion< ShapeType ></a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="classpFlow_1_1timeFlowControl.html#aec7a9ba664af18fb17da1eb822b1ee14">endTime_</a></td><td class="entry"><a class="el" href="classpFlow_1_1timeFlowControl.html">timeFlowControl</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="classpFlow_1_1InsertionRegion.html#a1bb3e9d2da5b4a5c9c9f09b1304be566">InsertionRegion</a>(const dictionary &dict, const ShapeType &shapes)</td><td class="entry"><a class="el" href="classpFlow_1_1InsertionRegion.html">InsertionRegion< ShapeType ></a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="classpFlow_1_1InsertionRegion.html#adf4ca3a49e4b5294e52f42c0c9291a2d">InsertionRegion</a>(const InsertionRegion< ShapeType > &)=default</td><td class="entry"><a class="el" href="classpFlow_1_1InsertionRegion.html">InsertionRegion< ShapeType ></a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="classpFlow_1_1InsertionRegion.html#ad6955fe0e1f275d2b382fd7fdc887a0d">InsertionRegion</a>(InsertionRegion< ShapeType > &&)=default</td><td class="entry"><a class="el" href="classpFlow_1_1InsertionRegion.html">InsertionRegion< ShapeType ></a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="classpFlow_1_1insertionRegion.html#a6a584c29486dcdcffe29aad303313bf2">insertionRegion</a>(const dictionary &dict)</td><td class="entry"><a class="el" href="classpFlow_1_1insertionRegion.html">insertionRegion</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="classpFlow_1_1insertionRegion.html#aa88946badc7fec0a74d87e12c3af96c5">insertionRegion</a>(const insertionRegion &src)</td><td class="entry"><a class="el" href="classpFlow_1_1insertionRegion.html">insertionRegion</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="classpFlow_1_1insertionRegion.html#a1d3747d5b6da01d087026ed3b36d7b51">insertionRegion</a>(insertionRegion &&)=default</td><td class="entry"><a class="el" href="classpFlow_1_1insertionRegion.html">insertionRegion</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="classpFlow_1_1timeFlowControl.html#a9eaa41444bd1a7536cf7ed29783d6dda">insertionTime</a>(real currentTime, real dt)</td><td class="entry"><a class="el" href="classpFlow_1_1timeFlowControl.html">timeFlowControl</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="classpFlow_1_1InsertionRegion.html#a7aca664f39c4a6e73d6666a36ad687ce">insertParticles</a>(real currentTime, real dt, wordVector &names, realx3Vector &pos, bool &insertionOccured)</td><td class="entry"><a class="el" href="classpFlow_1_1InsertionRegion.html">InsertionRegion< ShapeType ></a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="classpFlow_1_1timeFlowControl.html#a51bea3b14070614ca348b0574b4fd741">interval_</a></td><td class="entry"><a class="el" href="classpFlow_1_1timeFlowControl.html">timeFlowControl</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="classpFlow_1_1insertionRegion.html#a4d3dfef53630882b1fe95583bd46d4c9">mixture_</a></td><td class="entry"><a class="el" href="classpFlow_1_1insertionRegion.html">insertionRegion</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="classpFlow_1_1insertionRegion.html#a5a9652837ba1c412a239fec1ff02e88b">name</a>() const</td><td class="entry"><a class="el" href="classpFlow_1_1insertionRegion.html">insertionRegion</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="classpFlow_1_1insertionRegion.html#a50fd7d13a0f7a6007ca5027b3bb8765a">name_</a></td><td class="entry"><a class="el" href="classpFlow_1_1insertionRegion.html">insertionRegion</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="classpFlow_1_1timeFlowControl.html#a16987f9942190579ad06d5d67adfc67d">numberToBeInserted</a>(real currentTime)</td><td class="entry"><a class="el" href="classpFlow_1_1timeFlowControl.html">timeFlowControl</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="classpFlow_1_1timeFlowControl.html#a2137233941e7ea15b94415eaabaf765b">numInserted_</a></td><td class="entry"><a class="el" href="classpFlow_1_1timeFlowControl.html">timeFlowControl</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="classpFlow_1_1InsertionRegion.html#ae0c5078f30c9290e44b2479694bf615a">operator=</a>(const InsertionRegion< ShapeType > &)=default</td><td class="entry"><a class="el" href="classpFlow_1_1InsertionRegion.html">InsertionRegion< ShapeType ></a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="classpFlow_1_1InsertionRegion.html#a460129a54ab8eb10a929857de1b2810e">operator=</a>(InsertionRegion< ShapeType > &&)=default</td><td class="entry"><a class="el" href="classpFlow_1_1InsertionRegion.html">InsertionRegion< ShapeType ></a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="classpFlow_1_1insertionRegion.html#afa380e4b94afa07580a93e670ee73488">pFlow::insertionRegion::operator=</a>(const insertionRegion &)</td><td class="entry"><a class="el" href="classpFlow_1_1insertionRegion.html">insertionRegion</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="classpFlow_1_1insertionRegion.html#a41f69642c152fc1cdc040b7b67ae7052">pFlow::insertionRegion::operator=</a>(insertionRegion &&)=default</td><td class="entry"><a class="el" href="classpFlow_1_1insertionRegion.html">insertionRegion</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="classpFlow_1_1insertionRegion.html#af5c2a2fe246051f18b23a3fd1bf23249">pRegion_</a></td><td class="entry"><a class="el" href="classpFlow_1_1insertionRegion.html">insertionRegion</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="classpFlow_1_1timeFlowControl.html#ac29edb543b14ed93013258583f9684a1">rate_</a></td><td class="entry"><a class="el" href="classpFlow_1_1timeFlowControl.html">timeFlowControl</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="classpFlow_1_1insertionRegion.html#a6ce0c64db98eb6144d363dbfc86104eb">read</a>(const dictionary &dict)</td><td class="entry"><a class="el" href="classpFlow_1_1insertionRegion.html">insertionRegion</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="classpFlow_1_1insertionRegion.html#adcd85aab41f3f4715afb2d17e5f8d53d">readInsertionRegion</a>(const dictionary &dict)</td><td class="entry"><a class="el" href="classpFlow_1_1insertionRegion.html">insertionRegion</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="classpFlow_1_1timeFlowControl.html#a965f20676739fa59a7a27457add2ae61">readTimeFlowControl</a>(const dictionary &dict)</td><td class="entry"><a class="el" href="classpFlow_1_1timeFlowControl.html">timeFlowControl</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="classpFlow_1_1insertionRegion.html#a15fbbe0e71be0193e2e08117999ba287">setFields</a>() const</td><td class="entry"><a class="el" href="classpFlow_1_1insertionRegion.html">insertionRegion</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="classpFlow_1_1insertionRegion.html#a1669e69306d7e94fa98270dfa5a024cd">setFields_</a></td><td class="entry"><a class="el" href="classpFlow_1_1insertionRegion.html">insertionRegion</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="classpFlow_1_1InsertionRegion.html#a2930483c30fb6c335a8a9a70b485f0fc">shapes_</a></td><td class="entry"><a class="el" href="classpFlow_1_1InsertionRegion.html">InsertionRegion< ShapeType ></a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="classpFlow_1_1timeFlowControl.html#a9da50a81b9da4200db555ac368c98ea1">startTime_</a></td><td class="entry"><a class="el" href="classpFlow_1_1timeFlowControl.html">timeFlowControl</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="classpFlow_1_1timeFlowControl.html#ac2fd9715da4fcd3790fcda568f735ce8">timeFlowControl</a>(const dictionary &dict)</td><td class="entry"><a class="el" href="classpFlow_1_1timeFlowControl.html">timeFlowControl</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="classpFlow_1_1timeFlowControl.html#a34a2411f69a8d0d96e56c57941d8df04">totalInserted</a>() const</td><td class="entry"><a class="el" href="classpFlow_1_1timeFlowControl.html">timeFlowControl</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="classpFlow_1_1insertionRegion.html#addee41d6ac047acd59c85e776d4e6fb9">type_</a></td><td class="entry"><a class="el" href="classpFlow_1_1insertionRegion.html">insertionRegion</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="classpFlow_1_1insertionRegion.html#a2f6fa523f8b578780851796118cd1339">TypeInfoNV</a>("insertionRegion")</td><td class="entry"><a class="el" href="classpFlow_1_1insertionRegion.html">insertionRegion</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="classpFlow_1_1InsertionRegion.html#a61a91dc0a6702ccc073c635c6c8cfbb8">TypeInfoTemplateNV</a>("insertionRegion", ShapeType)</td><td class="entry"><a class="el" href="classpFlow_1_1InsertionRegion.html">InsertionRegion< ShapeType ></a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="classpFlow_1_1insertionRegion.html#a6964e9f1f100001543fdb044fa7fc896">write</a>(dictionary &dict) const</td><td class="entry"><a class="el" href="classpFlow_1_1insertionRegion.html">insertionRegion</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="classpFlow_1_1insertionRegion.html#aa364cd422ed5085c750de4a19a321f7f">writeInsertionRegion</a>(dictionary &dict) const</td><td class="entry"><a class="el" href="classpFlow_1_1insertionRegion.html">insertionRegion</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="classpFlow_1_1timeFlowControl.html#a6901db0c788489c5e8a317c034774401">writeTimeFlowControl</a>(dictionary &dict) const</td><td class="entry"><a class="el" href="classpFlow_1_1timeFlowControl.html">timeFlowControl</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="classpFlow_1_1insertionRegion.html#ad3cf9dd715e172184050bd4b4a5a6051">~insertionRegion</a>()=default</td><td class="entry"><a class="el" href="classpFlow_1_1insertionRegion.html">insertionRegion</a></td><td class="entry"></td></tr>
|
||||
</table></div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
<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>
|
Reference in New Issue
Block a user