Files
CFDEMcoupling-PUBLIC/doc/doxygen/html/classFoam_1_1probeModel.html
2016-01-15 11:16:47 +01:00

203 lines
15 KiB
HTML

<!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.6"/>
<title>CFDEMcoupling: Foam::probeModel Class 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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.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 style="padding-left: 0.5em;">
<div id="projectname">CFDEMcoupling
&#160;<span id="projectnumber">2.4</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;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">
<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>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a></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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>Foam</b></li><li class="navelem"><a class="el" href="classFoam_1_1probeModel.html">probeModel</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classFoam_1_1probeModel-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Foam::probeModel Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for Foam::probeModel:</div>
<div class="dyncontent">
<div class="center"><img src="classFoam_1_1probeModel__inherit__graph.png" border="0" usemap="#Foam_1_1probeModel_inherit__map" alt="Inheritance graph"/></div>
<map name="Foam_1_1probeModel_inherit__map" id="Foam_1_1probeModel_inherit__map">
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for Foam::probeModel:</div>
<div class="dyncontent">
<div class="center"><img src="classFoam_1_1probeModel__coll__graph.png" border="0" usemap="#Foam_1_1probeModel_coll__map" alt="Collaboration graph"/></div>
<map name="Foam_1_1probeModel_coll__map" id="Foam_1_1probeModel_coll__map">
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFoam_1_1probeModel_1_1fieldGroup.html">fieldGroup</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:afd04f9754a8ac08f558ce45adeef2a70"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afd04f9754a8ac08f558ce45adeef2a70"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>TypeName</b> (&quot;probeModel&quot;)</td></tr>
<tr class="separator:afd04f9754a8ac08f558ce45adeef2a70"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aec165220c64da1cb35d217a801cafb17"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aec165220c64da1cb35d217a801cafb17"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>declareRunTimeSelectionTable</b> (autoPtr, <a class="el" href="classFoam_1_1probeModel.html">probeModel</a>, dictionary,(const dictionary &amp;dict, <a class="el" href="classFoam_1_1cfdemCloud.html">cfdemCloud</a> &amp;sm, wordtypeName, char *logFileName),(dict, sm, typeName, logFileName))</td></tr>
<tr class="separator:aec165220c64da1cb35d217a801cafb17"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8e02a00dd661cee60d24127ec76aad80"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8e02a00dd661cee60d24127ec76aad80"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>probeModel</b> (const dictionary &amp;dict, <a class="el" href="classFoam_1_1cfdemCloud.html">cfdemCloud</a> &amp;sm, word typeName, char *logFileName)</td></tr>
<tr class="separator:a8e02a00dd661cee60d24127ec76aad80"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a300a6df1db69f0692133e1ac6529788d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a300a6df1db69f0692133e1ac6529788d"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>initialize</b> (word typeName, word logFileName) const </td></tr>
<tr class="separator:a300a6df1db69f0692133e1ac6529788d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac9b7fda9ecb8939cf33fd2cb3f9ed33f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac9b7fda9ecb8939cf33fd2cb3f9ed33f"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>setOutputFile</b> () const </td></tr>
<tr class="separator:ac9b7fda9ecb8939cf33fd2cb3f9ed33f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3e1b295c0857b7436b534c8f95ae06d4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3e1b295c0857b7436b534c8f95ae06d4"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>writeHeader</b> () const </td></tr>
<tr class="separator:a3e1b295c0857b7436b534c8f95ae06d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1f6adbbfaaf445112fc76a6b81e63851"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1f6adbbfaaf445112fc76a6b81e63851"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>writeProbe</b> (int index, Field&lt; scalar &gt; sValues, Field&lt; vector &gt; vValues) const </td></tr>
<tr class="separator:a1f6adbbfaaf445112fc76a6b81e63851"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1d1074e918c59e9fb1474ab093a1a640"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1d1074e918c59e9fb1474ab093a1a640"></a>
virtual bool&#160;</td><td class="memItemRight" valign="bottom"><b>checkIDForPrint</b> (int) const </td></tr>
<tr class="separator:a1d1074e918c59e9fb1474ab093a1a640"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae94d0e762c113499dbaea87fcc246324"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae94d0e762c113499dbaea87fcc246324"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>setCounter</b> () const </td></tr>
<tr class="separator:ae94d0e762c113499dbaea87fcc246324"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8a241ca6bfe00f352e076df71f73c550"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8a241ca6bfe00f352e076df71f73c550"></a>
virtual bool&#160;</td><td class="memItemRight" valign="bottom"><b>active</b> () const </td></tr>
<tr class="separator:a8a241ca6bfe00f352e076df71f73c550"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad112a93936c7191aa15db71b30e0e501"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad112a93936c7191aa15db71b30e0e501"></a>
virtual std::vector<br class="typebreak"/>
&lt; std::vector&lt; double * &gt; &gt; *&#160;</td><td class="memItemRight" valign="bottom"><b>getVprobe</b> ()</td></tr>
<tr class="separator:ad112a93936c7191aa15db71b30e0e501"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a252a4fa39275f65b0f29512f2ac8ce1f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a252a4fa39275f65b0f29512f2ac8ce1f"></a>
virtual std::vector<br class="typebreak"/>
&lt; std::vector&lt; double &gt; &gt; *&#160;</td><td class="memItemRight" valign="bottom"><b>getSprobe</b> ()</td></tr>
<tr class="separator:a252a4fa39275f65b0f29512f2ac8ce1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2845f319ee36a5bad09f81346e225eaa"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2845f319ee36a5bad09f81346e225eaa"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>clearProbes</b> () const </td></tr>
<tr class="separator:a2845f319ee36a5bad09f81346e225eaa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8db2eb92d78be83f8f7df4f5a76948eb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8db2eb92d78be83f8f7df4f5a76948eb"></a>
const char *&#160;</td><td class="memItemRight" valign="bottom"><b>wordToChar</b> (word &amp;) const </td></tr>
<tr class="separator:a8db2eb92d78be83f8f7df4f5a76948eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:aab5c435400d667f0c9f497cbf6840857"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aab5c435400d667f0c9f497cbf6840857"></a>
static autoPtr&lt; <a class="el" href="classFoam_1_1probeModel.html">probeModel</a> &gt;&#160;</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, word typeName, char *logFileName)</td></tr>
<tr class="separator:aab5c435400d667f0c9f497cbf6840857"><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:ae6ed8d28710dda49fc036908b38a03f8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae6ed8d28710dda49fc036908b38a03f8"></a>
<a class="el" href="classFoam_1_1probeModel_1_1fieldGroup.html">fieldGroup</a>&lt; scalar &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>scalarFields_</b></td></tr>
<tr class="separator:ae6ed8d28710dda49fc036908b38a03f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1914398e47934d79dea93c25aeb00893"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1914398e47934d79dea93c25aeb00893"></a>
<a class="el" href="classFoam_1_1probeModel_1_1fieldGroup.html">fieldGroup</a>&lt; vector &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>vectorFields_</b></td></tr>
<tr class="separator:a1914398e47934d79dea93c25aeb00893"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a8a128ee1da51019e2b73d6c0014e068a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8a128ee1da51019e2b73d6c0014e068a"></a>
const dictionary &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>dict_</b></td></tr>
<tr class="separator:a8a128ee1da51019e2b73d6c0014e068a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad0eef4ac58f65aa154d730089f22d29e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad0eef4ac58f65aa154d730089f22d29e"></a>
<a class="el" href="classFoam_1_1cfdemCloud.html">cfdemCloud</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>particleCloud_</b></td></tr>
<tr class="separator:ad0eef4ac58f65aa154d730089f22d29e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>/home/cgoniva/CFDEM/CFDEM-x.x-2.1.x/CFDEMcoupling-PUBLIC/src/lagrangian/cfdemParticle/subModels/probeModel/probeModel/<a class="el" href="probeModel_8H_source.html">probeModel.H</a></li>
<li>/home/cgoniva/CFDEM/CFDEM-x.x-2.1.x/CFDEMcoupling-PUBLIC/src/lagrangian/cfdemParticle/subModels/probeModel/probeModel/newProbeModel.C</li>
<li>/home/cgoniva/CFDEM/CFDEM-x.x-2.1.x/CFDEMcoupling-PUBLIC/src/lagrangian/cfdemParticle/subModels/probeModel/probeModel/probeModel.C</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Sep 11 2015 15:26:21 for CFDEMcoupling by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>