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

198 lines
13 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: /home/cfdem/CFDEM/CFDEM-x.x-2.0.x/src/lagrangian/cfdemParticle/lnInclude/voidFractionModel.H Source File</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><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><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="files.html"><span>File&nbsp;List</span></a></li>
</ul>
</div>
<h1>/home/cfdem/CFDEM/CFDEM-x.x-2.0.x/src/lagrangian/cfdemParticle/lnInclude/voidFractionModel.H</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*---------------------------------------------------------------------------*\</span>
<a name="l00002"></a>00002 <span class="comment"> ========= |</span>
<a name="l00003"></a>00003 <span class="comment"> \\ / F ield | OpenFOAM: The Open Source CFD Toolbox</span>
<a name="l00004"></a>00004 <span class="comment"> \\ / O peration |</span>
<a name="l00005"></a>00005 <span class="comment"> \\ / A nd | Copyright (C) 1991-2005 OpenCFD Ltd.</span>
<a name="l00006"></a>00006 <span class="comment"> \\/ M anipulation |</span>
<a name="l00007"></a>00007 <span class="comment">-------------------------------------------------------------------------------</span>
<a name="l00008"></a>00008 <span class="comment">License</span>
<a name="l00009"></a>00009 <span class="comment"> This file is part of OpenFOAM.</span>
<a name="l00010"></a>00010 <span class="comment"></span>
<a name="l00011"></a>00011 <span class="comment"> OpenFOAM is free software; you can redistribute it and/or modify it</span>
<a name="l00012"></a>00012 <span class="comment"> under the terms of the GNU General Public License as published by the</span>
<a name="l00013"></a>00013 <span class="comment"> Free Software Foundation; either version 2 of the License, or (at your</span>
<a name="l00014"></a>00014 <span class="comment"> option) any later version.</span>
<a name="l00015"></a>00015 <span class="comment"></span>
<a name="l00016"></a>00016 <span class="comment"> OpenFOAM is distributed in the hope that it will be useful, but WITHOUT</span>
<a name="l00017"></a>00017 <span class="comment"> ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or</span>
<a name="l00018"></a>00018 <span class="comment"> FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License</span>
<a name="l00019"></a>00019 <span class="comment"> for more details.</span>
<a name="l00020"></a>00020 <span class="comment"></span>
<a name="l00021"></a>00021 <span class="comment"> You should have received a copy of the GNU General Public License</span>
<a name="l00022"></a>00022 <span class="comment"> along with OpenFOAM; if not, write to the Free Software Foundation,</span>
<a name="l00023"></a>00023 <span class="comment"> Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</span>
<a name="l00024"></a>00024 <span class="comment"></span>
<a name="l00025"></a>00025 <span class="comment">Class</span>
<a name="l00026"></a>00026 <span class="comment"> voidFractionModel</span>
<a name="l00027"></a>00027 <span class="comment"></span>
<a name="l00028"></a>00028 <span class="comment">Description</span>
<a name="l00029"></a>00029 <span class="comment"></span>
<a name="l00030"></a>00030 <span class="comment">\*---------------------------------------------------------------------------*/</span>
<a name="l00031"></a>00031
<a name="l00032"></a>00032 <span class="preprocessor">#ifndef voidFractionModel_H</span>
<a name="l00033"></a>00033 <span class="preprocessor"></span><span class="preprocessor">#define voidFractionModel_H</span>
<a name="l00034"></a>00034 <span class="preprocessor"></span>
<a name="l00035"></a>00035 <span class="preprocessor">#include &quot;fvCFD.H&quot;</span>
<a name="l00036"></a>00036 <span class="preprocessor">#include &quot;cfdemCloud.H&quot;</span>
<a name="l00037"></a>00037 <span class="comment">// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //</span>
<a name="l00038"></a>00038
<a name="l00039"></a>00039 <span class="keyword">namespace </span>Foam
<a name="l00040"></a>00040 {
<a name="l00041"></a>00041
<a name="l00042"></a>00042 <span class="comment">/*---------------------------------------------------------------------------*\</span>
<a name="l00043"></a>00043 <span class="comment"> Class voidFractionModel Declaration</span>
<a name="l00044"></a>00044 <span class="comment">\*---------------------------------------------------------------------------*/</span>
<a name="l00045"></a>00045
<a name="l00046"></a><a class="code" href="classFoam_1_1voidFractionModel.html">00046</a> <span class="keyword">class </span><a class="code" href="classFoam_1_1voidFractionModel.html">voidFractionModel</a>
<a name="l00047"></a>00047 {
<a name="l00048"></a>00048
<a name="l00049"></a>00049 <span class="keyword">protected</span>:
<a name="l00050"></a>00050
<a name="l00051"></a>00051 <span class="comment">// Protected data</span>
<a name="l00052"></a>00052 <span class="keyword">const</span> dictionary&amp; dict_;
<a name="l00053"></a>00053
<a name="l00054"></a>00054 <a class="code" href="classFoam_1_1cfdemCloud.html">cfdemCloud</a>&amp; particleCloud_;
<a name="l00055"></a>00055
<a name="l00056"></a>00056 <span class="keyword">mutable</span> volScalarField voidfractionPrev_;
<a name="l00057"></a>00057
<a name="l00058"></a>00058 <span class="keyword">mutable</span> volScalarField voidfractionNext_;
<a name="l00059"></a>00059
<a name="l00060"></a>00060 <span class="keyword">mutable</span> <span class="keywordtype">double</span> ** cellsPerParticle_;
<a name="l00061"></a>00061
<a name="l00062"></a>00062 <span class="keywordtype">int</span> maxCellsPerParticle_;
<a name="l00063"></a>00063
<a name="l00064"></a>00064 <span class="comment">// Protected member functions</span>
<a name="l00065"></a>00065
<a name="l00066"></a>00066 <span class="keyword">public</span>:
<a name="l00067"></a>00067
<a name="l00068"></a>00068 <span class="comment">//- Runtime type information</span>
<a name="l00069"></a>00069 TypeName(<span class="stringliteral">&quot;voidFractionModel&quot;</span>);
<a name="l00070"></a>00070
<a name="l00071"></a>00071 <span class="comment">// Declare runtime constructor selection table</span>
<a name="l00072"></a>00072
<a name="l00073"></a>00073 declareRunTimeSelectionTable
<a name="l00074"></a>00074 (
<a name="l00075"></a>00075 autoPtr,
<a name="l00076"></a>00076 <a class="code" href="classFoam_1_1voidFractionModel.html">voidFractionModel</a>,
<a name="l00077"></a>00077 dictionary,
<a name="l00078"></a>00078 (
<a name="l00079"></a>00079 <span class="keyword">const</span> dictionary&amp; dict,
<a name="l00080"></a>00080 <a class="code" href="classFoam_1_1cfdemCloud.html">cfdemCloud</a>&amp; sm
<a name="l00081"></a>00081 ),
<a name="l00082"></a>00082 (dict,sm)
<a name="l00083"></a>00083 );
<a name="l00084"></a>00084
<a name="l00085"></a>00085
<a name="l00086"></a>00086 <span class="comment">// Constructors</span>
<a name="l00087"></a>00087
<a name="l00088"></a>00088 <span class="comment">//- Construct from components</span>
<a name="l00089"></a>00089 <a class="code" href="classFoam_1_1voidFractionModel.html">voidFractionModel</a>
<a name="l00090"></a>00090 (
<a name="l00091"></a>00091 <span class="keyword">const</span> dictionary&amp; dict,
<a name="l00092"></a>00092 <a class="code" href="classFoam_1_1cfdemCloud.html">cfdemCloud</a>&amp; sm
<a name="l00093"></a>00093 );
<a name="l00094"></a>00094
<a name="l00095"></a>00095
<a name="l00096"></a>00096 <span class="comment">// Destructor</span>
<a name="l00097"></a>00097
<a name="l00098"></a>00098 <span class="keyword">virtual</span> ~<a class="code" href="classFoam_1_1voidFractionModel.html">voidFractionModel</a>();
<a name="l00099"></a>00099
<a name="l00100"></a>00100
<a name="l00101"></a>00101 <span class="comment">// Selector</span>
<a name="l00102"></a>00102
<a name="l00103"></a>00103 <span class="keyword">static</span> autoPtr&lt;voidFractionModel&gt; New
<a name="l00104"></a>00104 (
<a name="l00105"></a>00105 <span class="keyword">const</span> dictionary&amp; dict,
<a name="l00106"></a>00106 <a class="code" href="classFoam_1_1cfdemCloud.html">cfdemCloud</a>&amp; sm
<a name="l00107"></a>00107 );
<a name="l00108"></a>00108
<a name="l00109"></a>00109
<a name="l00110"></a>00110 <span class="comment">// public member functions</span>
<a name="l00111"></a>00111 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setvoidFraction(<span class="keywordtype">double</span>** <span class="keyword">const</span>&amp;,<span class="keywordtype">double</span>**&amp;,<span class="keywordtype">double</span>**&amp;,<span class="keywordtype">double</span>**&amp;) <span class="keyword">const</span> = 0;
<a name="l00112"></a>00112
<a name="l00113"></a>00113 tmp&lt;volScalarField&gt; voidFractionInterp() <span class="keyword">const</span>;
<a name="l00114"></a>00114
<a name="l00115"></a>00115 <span class="keywordtype">void</span> resetVoidFractions() <span class="keyword">const</span>;
<a name="l00116"></a>00116
<a name="l00117"></a>00117 <span class="keywordtype">void</span> undoVoidFractions(<span class="keywordtype">double</span>**<span class="keyword">const</span>&amp;) <span class="keyword">const</span>;
<a name="l00118"></a>00118
<a name="l00119"></a>00119 <span class="keywordtype">double</span>** <span class="keyword">const</span>&amp; cellsPerParticle() <span class="keyword">const</span>;
<a name="l00120"></a>00120
<a name="l00121"></a>00121 <span class="keywordtype">int</span> maxCellsPerParticle() <span class="keyword">const</span>;
<a name="l00122"></a>00122
<a name="l00123"></a>00123 <span class="keywordtype">void</span> reAllocArrays() <span class="keyword">const</span>;
<a name="l00124"></a>00124 };
<a name="l00125"></a>00125
<a name="l00126"></a>00126
<a name="l00127"></a>00127 <span class="comment">// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //</span>
<a name="l00128"></a>00128
<a name="l00129"></a>00129 } <span class="comment">// End namespace Foam</span>
<a name="l00130"></a>00130
<a name="l00131"></a>00131 <span class="comment">// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //</span>
<a name="l00132"></a>00132
<a name="l00133"></a>00133 <span class="preprocessor">#endif</span>
<a name="l00134"></a>00134 <span class="preprocessor"></span>
<a name="l00135"></a>00135 <span class="comment">// ************************************************************************* //</span>
</pre></div></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:18 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>