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

153 lines
17 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::voidFractionModel 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_1voidFractionModel.html">voidFractionModel</a>
</div>
</div>
<div class="contents">
<h1>Foam::voidFractionModel Class Reference</h1><!-- doxytag: class="Foam::voidFractionModel" --><div class="dynheader">
Inheritance diagram for Foam::voidFractionModel:</div>
<div class="dynsection">
<div class="center"><img src="classFoam_1_1voidFractionModel__inherit__graph.png" border="0" usemap="#Foam_1_1voidFractionModel_inherit__map" alt="Inheritance graph"/></div>
<map name="Foam_1_1voidFractionModel_inherit__map" id="Foam_1_1voidFractionModel_inherit__map">
<area shape="rect" href="classFoam_1_1bigParticleVoidFraction.html" title="Foam::bigParticleVoidFraction" alt="" coords="223,5,415,35"/><area shape="rect" href="classFoam_1_1centreVoidFraction.html" title="Foam::centreVoidFraction" alt="" coords="235,59,403,88"/><area shape="rect" href="classFoam_1_1dividedVoidFraction.html" title="Foam::dividedVoidFraction" alt="" coords="232,112,405,141"/><area shape="rect" href="classFoam_1_1dividedVoidFractionMS.html" title="Foam::dividedVoidFractionMS" alt="" coords="221,165,416,195"/><area shape="rect" href="classFoam_1_1GaussVoidFraction.html" title="Foam::GaussVoidFraction" alt="" coords="233,219,404,248"/><area shape="rect" href="classFoam_1_1voidFractionModelMS.html" title="Foam::voidFractionModelMS" alt="" coords="225,272,412,301"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for Foam::voidFractionModel:</div>
<div class="dynsection">
<div class="center"><img src="classFoam_1_1voidFractionModel__coll__graph.png" border="0" usemap="#Foam_1_1voidFractionModel_coll__map" alt="Collaboration graph"/></div>
<map name="Foam_1_1voidFractionModel_coll__map" id="Foam_1_1voidFractionModel_coll__map">
<area shape="rect" href="classFoam_1_1cfdemCloud.html" title="Foam::cfdemCloud" alt="" coords="24,5,155,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classFoam_1_1voidFractionModel-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="a31ff4b5bc92e99872bc227890c4d4bda"></a><!-- doxytag: member="Foam::voidFractionModel::TypeName" ref="a31ff4b5bc92e99872bc227890c4d4bda" args="(&quot;voidFractionModel&quot;)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>TypeName</b> (&quot;voidFractionModel&quot;)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af4627599c9ceb92a897fd78dfed33453"></a><!-- doxytag: member="Foam::voidFractionModel::declareRunTimeSelectionTable" ref="af4627599c9ceb92a897fd78dfed33453" args="(autoPtr, voidFractionModel, 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_1voidFractionModel.html">voidFractionModel</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="a404c1ea373fb70d0134633552c053edc"></a><!-- doxytag: member="Foam::voidFractionModel::voidFractionModel" ref="a404c1ea373fb70d0134633552c053edc" args="(const dictionary &amp;dict, cfdemCloud &amp;sm)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>voidFractionModel</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="af9ac92e7a2a65359357f2e3068399683"></a><!-- doxytag: member="Foam::voidFractionModel::setvoidFraction" ref="af9ac92e7a2a65359357f2e3068399683" args="(double **const &amp;, double **&amp;, double **&amp;, double **&amp;) const =0" -->
virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><b>setvoidFraction</b> (double **const &amp;, double **&amp;, double **&amp;, double **&amp;) const =0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a03694f15c0337f9a0169ec7efafe8991"></a><!-- doxytag: member="Foam::voidFractionModel::voidFractionInterp" ref="a03694f15c0337f9a0169ec7efafe8991" args="() const " -->
tmp&lt; volScalarField &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>voidFractionInterp</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeb721074e8b305d03d1588f53e1704e3"></a><!-- doxytag: member="Foam::voidFractionModel::resetVoidFractions" ref="aeb721074e8b305d03d1588f53e1704e3" args="() const " -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>resetVoidFractions</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af44df4fbfd7ba4439599267348c8b341"></a><!-- doxytag: member="Foam::voidFractionModel::undoVoidFractions" ref="af44df4fbfd7ba4439599267348c8b341" args="(double **const &amp;) const " -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>undoVoidFractions</b> (double **const &amp;) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae2a984a5c93cac7ecd1f5f81a7535b1e"></a><!-- doxytag: member="Foam::voidFractionModel::cellsPerParticle" ref="ae2a984a5c93cac7ecd1f5f81a7535b1e" args="() const " -->
double **const &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>cellsPerParticle</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5884e9fd5038f4ceeff8568986bf721c"></a><!-- doxytag: member="Foam::voidFractionModel::maxCellsPerParticle" ref="a5884e9fd5038f4ceeff8568986bf721c" args="() const " -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>maxCellsPerParticle</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a43ef59f30f79a56816f55dba6cb86cda"></a><!-- doxytag: member="Foam::voidFractionModel::reAllocArrays" ref="a43ef59f30f79a56816f55dba6cb86cda" 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="a31ff4b5bc92e99872bc227890c4d4bda"></a><!-- doxytag: member="Foam::voidFractionModel::TypeName" ref="a31ff4b5bc92e99872bc227890c4d4bda" args="(&quot;voidFractionModel&quot;)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>TypeName</b> (&quot;voidFractionModel&quot;)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af4627599c9ceb92a897fd78dfed33453"></a><!-- doxytag: member="Foam::voidFractionModel::declareRunTimeSelectionTable" ref="af4627599c9ceb92a897fd78dfed33453" args="(autoPtr, voidFractionModel, 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_1voidFractionModel.html">voidFractionModel</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="a404c1ea373fb70d0134633552c053edc"></a><!-- doxytag: member="Foam::voidFractionModel::voidFractionModel" ref="a404c1ea373fb70d0134633552c053edc" args="(const dictionary &amp;dict, cfdemCloud &amp;sm)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>voidFractionModel</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="af9ac92e7a2a65359357f2e3068399683"></a><!-- doxytag: member="Foam::voidFractionModel::setvoidFraction" ref="af9ac92e7a2a65359357f2e3068399683" args="(double **const &amp;, double **&amp;, double **&amp;, double **&amp;) const =0" -->
virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><b>setvoidFraction</b> (double **const &amp;, double **&amp;, double **&amp;, double **&amp;) const =0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a766db4f55dc5b25390c606b43aa0b0d6"></a><!-- doxytag: member="Foam::voidFractionModel::voidFractionInterp" ref="a766db4f55dc5b25390c606b43aa0b0d6" args="() const " -->
tmp&lt; volScalarField &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>voidFractionInterp</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeb721074e8b305d03d1588f53e1704e3"></a><!-- doxytag: member="Foam::voidFractionModel::resetVoidFractions" ref="aeb721074e8b305d03d1588f53e1704e3" args="() const " -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>resetVoidFractions</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af44df4fbfd7ba4439599267348c8b341"></a><!-- doxytag: member="Foam::voidFractionModel::undoVoidFractions" ref="af44df4fbfd7ba4439599267348c8b341" args="(double **const &amp;) const " -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>undoVoidFractions</b> (double **const &amp;) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a394589ef3f45269de3fcf07c9cd84209"></a><!-- doxytag: member="Foam::voidFractionModel::cellsPerParticle" ref="a394589ef3f45269de3fcf07c9cd84209" args="() const " -->
double **const &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>cellsPerParticle</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5884e9fd5038f4ceeff8568986bf721c"></a><!-- doxytag: member="Foam::voidFractionModel::maxCellsPerParticle" ref="a5884e9fd5038f4ceeff8568986bf721c" args="() const " -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>maxCellsPerParticle</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a43ef59f30f79a56816f55dba6cb86cda"></a><!-- doxytag: member="Foam::voidFractionModel::reAllocArrays" ref="a43ef59f30f79a56816f55dba6cb86cda" args="() const " -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>reAllocArrays</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="a45f0da91bc52547baad873e5d3e280d3"></a><!-- doxytag: member="Foam::voidFractionModel::New" ref="a45f0da91bc52547baad873e5d3e280d3" args="(const dictionary &amp;dict, cfdemCloud &amp;sm)" -->
static autoPtr&lt; <a class="el" href="classFoam_1_1voidFractionModel.html">voidFractionModel</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="a7013de4503f77ad6df41ebd4aae4a27d"></a><!-- doxytag: member="Foam::voidFractionModel::New" ref="a7013de4503f77ad6df41ebd4aae4a27d" args="(const dictionary &amp;dict, cfdemCloud &amp;sm)" -->
static autoPtr&lt; <a class="el" href="classFoam_1_1voidFractionModel.html">voidFractionModel</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="aac072438de7b134d1423f075cad0d03d"></a><!-- doxytag: member="Foam::voidFractionModel::dict_" ref="aac072438de7b134d1423f075cad0d03d" 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="a13e6044fd1f24d1ad90ac27c02e7cfed"></a><!-- doxytag: member="Foam::voidFractionModel::particleCloud_" ref="a13e6044fd1f24d1ad90ac27c02e7cfed" 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="a75fd67d425b5ddea4f5608d8c7aefd82"></a><!-- doxytag: member="Foam::voidFractionModel::voidfractionPrev_" ref="a75fd67d425b5ddea4f5608d8c7aefd82" args="" -->
volScalarField&nbsp;</td><td class="memItemRight" valign="bottom"><b>voidfractionPrev_</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad5073be42c4ade51623cef6ced9973ff"></a><!-- doxytag: member="Foam::voidFractionModel::voidfractionNext_" ref="ad5073be42c4ade51623cef6ced9973ff" args="" -->
volScalarField&nbsp;</td><td class="memItemRight" valign="bottom"><b>voidfractionNext_</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a47113396f0daddcf7c7cb105b41deebe"></a><!-- doxytag: member="Foam::voidFractionModel::cellsPerParticle_" ref="a47113396f0daddcf7c7cb105b41deebe" args="" -->
double **&nbsp;</td><td class="memItemRight" valign="bottom"><b>cellsPerParticle_</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a496db24414a632427504a7761c7b99a8"></a><!-- doxytag: member="Foam::voidFractionModel::maxCellsPerParticle_" ref="a496db24414a632427504a7761c7b99a8" args="" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>maxCellsPerParticle_</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_2voidFractionModel_8H_source.html">voidFractionModel.H</a></li>
<li>/home/cfdem/CFDEM/CFDEM-x.x-2.0.x/src/lagrangian/cfdemParticle/subModels/voidFractionModel/voidFractionModel/<a class="el" href="subModels_2voidFractionModel_2voidFractionModel_2voidFractionModel_8H_source.html">voidFractionModel.H</a></li>
<li>/home/cfdem/CFDEM/CFDEM-x.x-2.0.x/src/lagrangian/cfdemParticle/lnInclude/newVoidFractionModel.C</li>
<li>/home/cfdem/CFDEM/CFDEM-x.x-2.0.x/src/lagrangian/cfdemParticle/lnInclude/voidFractionModel.C</li>
<li>/home/cfdem/CFDEM/CFDEM-x.x-2.0.x/src/lagrangian/cfdemParticle/subModels/voidFractionModel/voidFractionModel/newVoidFractionModel.C</li>
<li>/home/cfdem/CFDEM/CFDEM-x.x-2.0.x/src/lagrangian/cfdemParticle/subModels/voidFractionModel/voidFractionModel/voidFractionModel.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:21 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>