Homec4science
Diffusion SP4E-TB-TL-FR (master) Browse

R7571/exercises/week10/starting_point/html/class_compute_potential_energy.html
99ebb26e62c0master

Last Change
Raw File

class_compute_potential_energy.html
View Options

<!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>particles: ComputePotentialEnergy 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/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">particles
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- 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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="class_compute_potential_energy-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ComputePotentialEnergy Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="class_compute.html" title="Base class for all compute. ">Compute</a> potential energy of system.
<a href="class_compute_potential_energy.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="compute__potential__energy_8hh_source.html">compute_potential_energy.hh</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ComputePotentialEnergy:</div>
<div class="dyncontent">
<div class="center"><img src="class_compute_potential_energy__inherit__graph.png" border="0" usemap="#_compute_potential_energy_inherit__map" alt="Inheritance graph"/></div>
<map name="_compute_potential_energy_inherit__map" id="_compute_potential_energy_inherit__map">
<area shape="rect" id="node2" href="class_compute_energy.html" title="Base class for energy computation. " alt="" coords="31,80,147,107"/>
<area shape="rect" id="node3" href="class_compute.html" title="Base class for all compute. " alt="" coords="51,5,126,32"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ComputePotentialEnergy:</div>
<div class="dyncontent">
<div class="center"><img src="class_compute_potential_energy__coll__graph.png" border="0" usemap="#_compute_potential_energy_coll__map" alt="Collaboration graph"/></div>
<map name="_compute_potential_energy_coll__map" id="_compute_potential_energy_coll__map">
<area shape="rect" id="node2" href="class_compute_energy.html" title="Base class for energy computation. " alt="" coords="5,81,121,108"/>
<area shape="rect" id="node3" href="class_compute.html" title="Base class for all compute. " alt="" coords="101,5,175,32"/>
<area shape="rect" id="node4" href="class_compute_interaction.html" title="Base class for interaction computation. " alt="" coords="146,81,282,108"/>
</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="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a0196ca1a7f73ae2f33ceefb2a1ef1c32"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_compute_potential_energy.html#a0196ca1a7f73ae2f33ceefb2a1ef1c32">ComputePotentialEnergy</a> (<a class="el" href="class_compute_interaction.html">ComputeInteraction</a> &amp;<a class="el" href="class_compute_potential_energy.html#a9268406ab56949a9bbcf32a76df702d2">cForces</a>)</td></tr>
<tr class="separator:a0196ca1a7f73ae2f33ceefb2a1ef1c32"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac317673ba4569f9ad93986d42c16ee3f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_compute_potential_energy.html#ac317673ba4569f9ad93986d42c16ee3f">compute</a> (<a class="el" href="class_system.html">System</a> &amp;system) override</td></tr>
<tr class="memdesc:ac317673ba4569f9ad93986d42c16ee3f"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="class_compute.html" title="Base class for all compute. ">Compute</a> is pure virtual. <a href="#ac317673ba4569f9ad93986d42c16ee3f">More...</a><br /></td></tr>
<tr class="separator:ac317673ba4569f9ad93986d42c16ee3f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_compute_energy"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_compute_energy')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_compute_energy.html">ComputeEnergy</a></td></tr>
<tr class="memitem:af83aa4331b80c52c4078e3800add8f59 inherit pub_methods_class_compute_energy"><td class="memItemLeft" align="right" valign="top"><a class="el" href="my__types_8hh.html#a445a5f0e2a34c9d97d69a3c2d1957907">Real</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_compute_energy.html#af83aa4331b80c52c4078e3800add8f59">getValue</a> ()</td></tr>
<tr class="separator:af83aa4331b80c52c4078e3800add8f59 inherit pub_methods_class_compute_energy"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_compute"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_compute')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_compute.html">Compute</a></td></tr>
<tr class="memitem:a6caca9d07be25d7c0a921b5d781fedb5 inherit pub_methods_class_compute"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_compute.html#a6caca9d07be25d7c0a921b5d781fedb5">~Compute</a> ()=default</td></tr>
<tr class="memdesc:a6caca9d07be25d7c0a921b5d781fedb5 inherit pub_methods_class_compute"><td class="mdescLeft">&#160;</td><td class="mdescRight">Virtual destructor needed because we have subclasses. <a href="class_compute.html#a6caca9d07be25d7c0a921b5d781fedb5">More...</a><br /></td></tr>
<tr class="separator:a6caca9d07be25d7c0a921b5d781fedb5 inherit pub_methods_class_compute"><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:a9268406ab56949a9bbcf32a76df702d2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_compute_interaction.html">ComputeInteraction</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_compute_potential_energy.html#a9268406ab56949a9bbcf32a76df702d2">cForces</a></td></tr>
<tr class="separator:a9268406ab56949a9bbcf32a76df702d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_attribs_class_compute_energy"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_class_compute_energy')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="class_compute_energy.html">ComputeEnergy</a></td></tr>
<tr class="memitem:aa731dc3aa3181c50aea8c599bec172ca inherit pro_attribs_class_compute_energy"><td class="memItemLeft" align="right" valign="top"><a class="el" href="my__types_8hh.html#a445a5f0e2a34c9d97d69a3c2d1957907">Real</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_compute_energy.html#aa731dc3aa3181c50aea8c599bec172ca">value</a></td></tr>
<tr class="separator:aa731dc3aa3181c50aea8c599bec172ca inherit pro_attribs_class_compute_energy"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="class_compute.html" title="Base class for all compute. ">Compute</a> potential energy of system. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a0196ca1a7f73ae2f33ceefb2a1ef1c32"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0196ca1a7f73ae2f33ceefb2a1ef1c32">&#9670;&nbsp;</a></span>ComputePotentialEnergy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ComputePotentialEnergy::ComputePotentialEnergy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_compute_interaction.html">ComputeInteraction</a> &amp;&#160;</td>
<td class="paramname"><em>cForces</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ac317673ba4569f9ad93986d42c16ee3f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac317673ba4569f9ad93986d42c16ee3f">&#9670;&nbsp;</a></span>compute()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ComputePotentialEnergy::compute </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_system.html">System</a> &amp;&#160;</td>
<td class="paramname"><em>system</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="class_compute.html" title="Base class for all compute. ">Compute</a> is pure virtual. </p>
<p>Implements <a class="el" href="class_compute.html#a8fe99fecbd1ad5d7a7d55be84ee5c262">Compute</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a9268406ab56949a9bbcf32a76df702d2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9268406ab56949a9bbcf32a76df702d2">&#9670;&nbsp;</a></span>cForces</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_compute_interaction.html">ComputeInteraction</a>&amp; ComputePotentialEnergy::cForces</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="compute__potential__energy_8hh_source.html">compute_potential_energy.hh</a></li>
<li><a class="el" href="compute__potential__energy_8cc.html">compute_potential_energy.cc</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
c4science · Help