Files
CFDEMcoupling-PFM/doc/doxygen/html/classFoam_1_1regionModel.html
2012-07-17 15:56:10 +02:00

148 lines
15 KiB
HTML

<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
<!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"/>
<title>CFDEMcoupling: Foam::regionModel Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javaScript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.6.3 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<img id="MSearchSelect" src="search/search.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)"/>
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</div>
</li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
</ul>
</div>
<div class="navpath"><b>Foam</b>::<a class="el" href="classFoam_1_1regionModel.html">regionModel</a>
</div>
</div>
<div class="contents">
<h1>Foam::regionModel Class Reference</h1><!-- doxytag: class="Foam::regionModel" --><div class="dynheader">
Inheritance diagram for Foam::regionModel:</div>
<div class="dynsection">
<div class="center"><img src="classFoam_1_1regionModel__inherit__graph.png" border="0" usemap="#Foam_1_1regionModel_inherit__map" alt="Inheritance graph"/></div>
<map name="Foam_1_1regionModel_inherit__map" id="Foam_1_1regionModel_inherit__map">
<area shape="rect" href="classFoam_1_1allRegion.html" title="Foam::allRegion" alt="" coords="5,83,120,112"/><area shape="rect" href="classFoam_1_1differentialRegion.html" title="Foam::differentialRegion" alt="" coords="144,83,307,112"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for Foam::regionModel:</div>
<div class="dynsection">
<div class="center"><img src="classFoam_1_1regionModel__coll__graph.png" border="0" usemap="#Foam_1_1regionModel_coll__map" alt="Collaboration graph"/></div>
<map name="Foam_1_1regionModel_coll__map" id="Foam_1_1regionModel_coll__map">
<area shape="rect" href="classFoam_1_1cfdemCloud.html" title="Foam::cfdemCloud" alt="" coords="5,5,136,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classFoam_1_1regionModel-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7506a18471ea321837765a9950e21fb8"></a><!-- doxytag: member="Foam::regionModel::TypeName" ref="a7506a18471ea321837765a9950e21fb8" args="(&quot;regionModel&quot;)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>TypeName</b> (&quot;regionModel&quot;)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abb2dafdc57f1efa575b9829fa9db361e"></a><!-- doxytag: member="Foam::regionModel::declareRunTimeSelectionTable" ref="abb2dafdc57f1efa575b9829fa9db361e" args="(autoPtr, regionModel, dictionary,(const dictionary &amp;dict, cfdemCloud &amp;sm),(dict, sm))" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>declareRunTimeSelectionTable</b> (autoPtr, <a class="el" href="classFoam_1_1regionModel.html">regionModel</a>, dictionary,(const dictionary &amp;dict, <a class="el" href="classFoam_1_1cfdemCloud.html">cfdemCloud</a> &amp;sm),(dict, sm))</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9f225ced949a8a4ef4c769f7f64566f9"></a><!-- doxytag: member="Foam::regionModel::regionModel" ref="a9f225ced949a8a4ef4c769f7f64566f9" args="(const dictionary &amp;dict, cfdemCloud &amp;sm)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>regionModel</b> (const dictionary &amp;dict, <a class="el" href="classFoam_1_1cfdemCloud.html">cfdemCloud</a> &amp;sm)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac9954522ba717b8ba47c05a5d9dfc590"></a><!-- doxytag: member="Foam::regionModel::defineRegion" ref="ac9954522ba717b8ba47c05a5d9dfc590" args="() const =0" -->
virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><b>defineRegion</b> () const =0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afe29d58a762868a54bc1fc4deea238b8"></a><!-- doxytag: member="Foam::regionModel::expandRegion" ref="afe29d58a762868a54bc1fc4deea238b8" args="(volVectorField &amp;) const =0" -->
virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><b>expandRegion</b> (volVectorField &amp;) const =0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abfaf950c2bd57b56e84e32f2a73f04be"></a><!-- doxytag: member="Foam::regionModel::resetVolFields" ref="abfaf950c2bd57b56e84e32f2a73f04be" args="(volVectorField &amp;) const =0" -->
virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><b>resetVolFields</b> (volVectorField &amp;) const =0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af98767fa4da2c5cfdf8b9dcf14d12cde"></a><!-- doxytag: member="Foam::regionModel::reAllocArrays" ref="af98767fa4da2c5cfdf8b9dcf14d12cde" args="() const " -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>reAllocArrays</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af5c192b5ad9ca09bc5b7039b88c69772"></a><!-- doxytag: member="Foam::regionModel::inRegion" ref="af5c192b5ad9ca09bc5b7039b88c69772" args="() const " -->
double **const &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>inRegion</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="accd6e77ca5c03fee9a3629d7386f39b2"></a><!-- doxytag: member="Foam::regionModel::outRegion" ref="accd6e77ca5c03fee9a3629d7386f39b2" args="() const " -->
double **const &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>outRegion</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7506a18471ea321837765a9950e21fb8"></a><!-- doxytag: member="Foam::regionModel::TypeName" ref="a7506a18471ea321837765a9950e21fb8" args="(&quot;regionModel&quot;)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>TypeName</b> (&quot;regionModel&quot;)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abb2dafdc57f1efa575b9829fa9db361e"></a><!-- doxytag: member="Foam::regionModel::declareRunTimeSelectionTable" ref="abb2dafdc57f1efa575b9829fa9db361e" args="(autoPtr, regionModel, dictionary,(const dictionary &amp;dict, cfdemCloud &amp;sm),(dict, sm))" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>declareRunTimeSelectionTable</b> (autoPtr, <a class="el" href="classFoam_1_1regionModel.html">regionModel</a>, dictionary,(const dictionary &amp;dict, <a class="el" href="classFoam_1_1cfdemCloud.html">cfdemCloud</a> &amp;sm),(dict, sm))</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9f225ced949a8a4ef4c769f7f64566f9"></a><!-- doxytag: member="Foam::regionModel::regionModel" ref="a9f225ced949a8a4ef4c769f7f64566f9" args="(const dictionary &amp;dict, cfdemCloud &amp;sm)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>regionModel</b> (const dictionary &amp;dict, <a class="el" href="classFoam_1_1cfdemCloud.html">cfdemCloud</a> &amp;sm)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac9954522ba717b8ba47c05a5d9dfc590"></a><!-- doxytag: member="Foam::regionModel::defineRegion" ref="ac9954522ba717b8ba47c05a5d9dfc590" args="() const =0" -->
virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><b>defineRegion</b> () const =0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afe29d58a762868a54bc1fc4deea238b8"></a><!-- doxytag: member="Foam::regionModel::expandRegion" ref="afe29d58a762868a54bc1fc4deea238b8" args="(volVectorField &amp;) const =0" -->
virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><b>expandRegion</b> (volVectorField &amp;) const =0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abfaf950c2bd57b56e84e32f2a73f04be"></a><!-- doxytag: member="Foam::regionModel::resetVolFields" ref="abfaf950c2bd57b56e84e32f2a73f04be" args="(volVectorField &amp;) const =0" -->
virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><b>resetVolFields</b> (volVectorField &amp;) const =0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af98767fa4da2c5cfdf8b9dcf14d12cde"></a><!-- doxytag: member="Foam::regionModel::reAllocArrays" ref="af98767fa4da2c5cfdf8b9dcf14d12cde" args="() const " -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>reAllocArrays</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af5c192b5ad9ca09bc5b7039b88c69772"></a><!-- doxytag: member="Foam::regionModel::inRegion" ref="af5c192b5ad9ca09bc5b7039b88c69772" args="() const " -->
double **const &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>inRegion</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="accd6e77ca5c03fee9a3629d7386f39b2"></a><!-- doxytag: member="Foam::regionModel::outRegion" ref="accd6e77ca5c03fee9a3629d7386f39b2" args="() const " -->
double **const &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>outRegion</b> () const </td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af6562b771aea28cfeb461d0879a7b856"></a><!-- doxytag: member="Foam::regionModel::New" ref="af6562b771aea28cfeb461d0879a7b856" args="(const dictionary &amp;dict, cfdemCloud &amp;sm)" -->
static autoPtr&lt; <a class="el" href="classFoam_1_1regionModel.html">regionModel</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>New</b> (const dictionary &amp;dict, <a class="el" href="classFoam_1_1cfdemCloud.html">cfdemCloud</a> &amp;sm)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a653daec5d185244daa848842df0b9d0f"></a><!-- doxytag: member="Foam::regionModel::New" ref="a653daec5d185244daa848842df0b9d0f" args="(const dictionary &amp;dict, cfdemCloud &amp;sm)" -->
static autoPtr&lt; <a class="el" href="classFoam_1_1regionModel.html">regionModel</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>New</b> (const dictionary &amp;dict, <a class="el" href="classFoam_1_1cfdemCloud.html">cfdemCloud</a> &amp;sm)</td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae14827f32ccf9e4a8a86e9fa6253f90f"></a><!-- doxytag: member="Foam::regionModel::dict_" ref="ae14827f32ccf9e4a8a86e9fa6253f90f" args="" -->
const dictionary &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>dict_</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afc4002485234ad991916b0ef2f4d93ed"></a><!-- doxytag: member="Foam::regionModel::particleCloud_" ref="afc4002485234ad991916b0ef2f4d93ed" args="" -->
<a class="el" href="classFoam_1_1cfdemCloud.html">cfdemCloud</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>particleCloud_</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3a9ab4c7691c20f17f5b047945a24683"></a><!-- doxytag: member="Foam::regionModel::inRegion_" ref="a3a9ab4c7691c20f17f5b047945a24683" args="" -->
double **&nbsp;</td><td class="memItemRight" valign="bottom"><b>inRegion_</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac4d035fe832970edec7f9c54c804936b"></a><!-- doxytag: member="Foam::regionModel::outRegion_" ref="ac4d035fe832970edec7f9c54c804936b" args="" -->
double **&nbsp;</td><td class="memItemRight" valign="bottom"><b>outRegion_</b></td></tr>
<tr><td colspan="2"><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af13e699a392354ea780485c6d5e1a6c6"></a><!-- doxytag: member="Foam::regionModel::voidFractionModel" ref="af13e699a392354ea780485c6d5e1a6c6" args="" -->
class&nbsp;</td><td class="memItemRight" valign="bottom"><b>voidFractionModel</b></td></tr>
</table>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>/home/cfdem/CFDEM/CFDEM-x.x-2.0.x/src/lagrangian/cfdemParticle/lnInclude/<a class="el" href="lnInclude_2regionModel_8H_source.html">regionModel.H</a></li>
<li>/home/cfdem/CFDEM/CFDEM-x.x-2.0.x/src/lagrangian/cfdemParticle/subModels/regionModel/regionModel/<a class="el" href="subModels_2regionModel_2regionModel_2regionModel_8H_source.html">regionModel.H</a></li>
<li>/home/cfdem/CFDEM/CFDEM-x.x-2.0.x/src/lagrangian/cfdemParticle/lnInclude/newRegionModel.C</li>
<li>/home/cfdem/CFDEM/CFDEM-x.x-2.0.x/src/lagrangian/cfdemParticle/lnInclude/regionModel.C</li>
<li>/home/cfdem/CFDEM/CFDEM-x.x-2.0.x/src/lagrangian/cfdemParticle/subModels/regionModel/regionModel/newRegionModel.C</li>
<li>/home/cfdem/CFDEM/CFDEM-x.x-2.0.x/src/lagrangian/cfdemParticle/subModels/regionModel/regionModel/regionModel.C</li>
</ul>
</div>
<!--- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&nbsp;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&nbsp;</span>Classes</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Mon Apr 23 19:06:20 2012 for CFDEMcoupling by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>