xfygogo
/
phasicFlow
mirror of https://github.com/PhasicFlow/phasicFlow.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
phasicFlow/doc/code-documentation/html/structpFlow_1_1array2D.html

336 lines
16 KiB
HTML
Raw Blame History

<!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: array2D&lt; T, nRow, nCol &gt; Struct Template Reference</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('structpFlow_1_1array2D.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="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structpFlow_1_1array2D-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">array2D&lt; T, nRow, nCol &gt; Struct Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for array2D&lt; T, nRow, nCol &gt;:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="structpFlow_1_1array2D__inherit__graph.png" border="0" usemap="#array2D_3_01T_00_01nRow_00_01nCol_01_4_inherit__map" alt="Inheritance graph"/></div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aa9a821fb182bba159b9c6c2c1c6615db"><td class="memItemLeft" align="right" valign="top">T &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structpFlow_1_1array2D.html#aa9a821fb182bba159b9c6c2c1c6615db">operator()</a> (<a class="el" href="namespacepFlow.html#a801d6a451a01953ef8cbae6feb6a3638">size_t</a> i, <a class="el" href="namespacepFlow.html#a801d6a451a01953ef8cbae6feb6a3638">size_t</a> j) noexcept</td></tr>
<tr class="separator:aa9a821fb182bba159b9c6c2c1c6615db"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a46ca0181cb86e0a585ef087346d31f79"><td class="memItemLeft" align="right" valign="top">const T &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structpFlow_1_1array2D.html#a46ca0181cb86e0a585ef087346d31f79">operator()</a> (<a class="el" href="namespacepFlow.html#a801d6a451a01953ef8cbae6feb6a3638">size_t</a> i, <a class="el" href="namespacepFlow.html#a801d6a451a01953ef8cbae6feb6a3638">size_t</a> j) const noexcept</td></tr>
<tr class="separator:a46ca0181cb86e0a585ef087346d31f79"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a20b2abb54d43add1d16c4c4660c43922"><td class="memItemLeft" align="right" valign="top">constexpr <a class="el" href="namespacepFlow.html#a801d6a451a01953ef8cbae6feb6a3638">size_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structpFlow_1_1array2D.html#a20b2abb54d43add1d16c4c4660c43922">size</a> () const noexcept</td></tr>
<tr class="separator:a20b2abb54d43add1d16c4c4660c43922"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a52e80c92825c6871c9f4d683e0b5bb55"><td class="memItemLeft" align="right" valign="top">constexpr <a class="el" href="namespacepFlow.html#a801d6a451a01953ef8cbae6feb6a3638">size_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structpFlow_1_1array2D.html#a52e80c92825c6871c9f4d683e0b5bb55">nCols</a> () const noexcept</td></tr>
<tr class="separator:a52e80c92825c6871c9f4d683e0b5bb55"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af70e6d11e3d0a18de38e5292812bd38b"><td class="memItemLeft" align="right" valign="top">constexpr <a class="el" href="namespacepFlow.html#a801d6a451a01953ef8cbae6feb6a3638">size_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structpFlow_1_1array2D.html#af70e6d11e3d0a18de38e5292812bd38b">nRows</a> () const noexcept</td></tr>
<tr class="separator:af70e6d11e3d0a18de38e5292812bd38b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a5f3dc621168a2e584b18c18631854f7d"><td class="memItemLeft" align="right" valign="top">T&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structpFlow_1_1array2D.html#a5f3dc621168a2e584b18c18631854f7d">elements_</a> [nRow][nCol]</td></tr>
<tr class="separator:a5f3dc621168a2e584b18c18631854f7d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename T, size_t nRow, size_t nCol&gt;<br />
struct pFlow::array2D&lt; T, nRow, nCol &gt;</h3>
<p class="definition">Definition at line <a class="el" href="array2D_8hpp_source.html#l00011">11</a> of file <a class="el" href="array2D_8hpp_source.html">array2D.hpp</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="aa9a821fb182bba159b9c6c2c1c6615db"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa9a821fb182bba159b9c6c2c1c6615db">&#9670;&nbsp;</a></span>operator()() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">T&amp; operator() </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacepFlow.html#a801d6a451a01953ef8cbae6feb6a3638">size_t</a>&#160;</td>
<td class="paramname"><em>i</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespacepFlow.html#a801d6a451a01953ef8cbae6feb6a3638">size_t</a>&#160;</td>
<td class="paramname"><em>j</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="array2D_8hpp_source.html#l00017">17</a> of file <a class="el" href="array2D_8hpp_source.html">array2D.hpp</a>.</p>
</div>
</div>
<a id="a46ca0181cb86e0a585ef087346d31f79"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a46ca0181cb86e0a585ef087346d31f79">&#9670;&nbsp;</a></span>operator()() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const T&amp; operator() </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacepFlow.html#a801d6a451a01953ef8cbae6feb6a3638">size_t</a>&#160;</td>
<td class="paramname"><em>i</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespacepFlow.html#a801d6a451a01953ef8cbae6feb6a3638">size_t</a>&#160;</td>
<td class="paramname"><em>j</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="array2D_8hpp_source.html#l00023">23</a> of file <a class="el" href="array2D_8hpp_source.html">array2D.hpp</a>.</p>
</div>
</div>
<a id="a20b2abb54d43add1d16c4c4660c43922"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a20b2abb54d43add1d16c4c4660c43922">&#9670;&nbsp;</a></span>size()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr <a class="el" href="namespacepFlow.html#a801d6a451a01953ef8cbae6feb6a3638">size_t</a> size </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">constexpr</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="array2D_8hpp_source.html#l00028">28</a> of file <a class="el" href="array2D_8hpp_source.html">array2D.hpp</a>.</p>
</div>
</div>
<a id="a52e80c92825c6871c9f4d683e0b5bb55"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a52e80c92825c6871c9f4d683e0b5bb55">&#9670;&nbsp;</a></span>nCols()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr <a class="el" href="namespacepFlow.html#a801d6a451a01953ef8cbae6feb6a3638">size_t</a> nCols </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">constexpr</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="array2D_8hpp_source.html#l00034">34</a> of file <a class="el" href="array2D_8hpp_source.html">array2D.hpp</a>.</p>
</div>
</div>
<a id="af70e6d11e3d0a18de38e5292812bd38b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af70e6d11e3d0a18de38e5292812bd38b">&#9670;&nbsp;</a></span>nRows()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr <a class="el" href="namespacepFlow.html#a801d6a451a01953ef8cbae6feb6a3638">size_t</a> nRows </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">constexpr</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="array2D_8hpp_source.html#l00039">39</a> of file <a class="el" href="array2D_8hpp_source.html">array2D.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a5f3dc621168a2e584b18c18631854f7d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5f3dc621168a2e584b18c18631854f7d">&#9670;&nbsp;</a></span>elements_</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">T elements_[nRow][nCol]</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="array2D_8hpp_source.html#l00014">14</a> of file <a class="el" href="array2D_8hpp_source.html">array2D.hpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="array2D_8hpp_source.html#l00017">array2D&lt; real, 3uL, 3uL &gt;::operator()()</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>src/phasicFlow/structuredData/zAxis/<a class="el" href="array2D_8hpp_source.html">array2D.hpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespacepFlow.html">pFlow</a></li><li class="navelem"><a class="el" href="structpFlow_1_1array2D.html">array2D</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>
Reference in New Issue View Git Blame Copy Permalink