threed-beam-fea/docs/html/structfea_1_1_equation.html

225 lines
12 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.9.1"/>
<title>3D Beam Finite Element Code: fea::Equation Struct 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>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script><script src="http://cdn.mathjax.org/mathjax/latest/MathJax.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="projectlogo"><img alt="Logo" src="logo_64x64.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">3D Beam Finite Element Code
&#160;<span id="projectnumber">1.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
<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><a href="namespaces.html"><span>Namespaces</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="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</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)">
</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"><a class="el" href="namespacefea.html">fea</a></li><li class="navelem"><a class="el" href="structfea_1_1_equation.html">Equation</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-attribs">Public Attributes</a> &#124;
<a href="structfea_1_1_equation-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">fea::Equation Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A linear multipoint constraint.
<a href="structfea_1_1_equation.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="containers_8h_source.html">containers.h</a>&gt;</code></p>
<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">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfea_1_1_equation_1_1_term.html">Term</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A single term in the equation constraint. <a href="structfea_1_1_equation_1_1_term.html#details">More...</a><br /></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:a22d1668ad3cefaea597761eebb7c8a24"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfea_1_1_equation.html#a22d1668ad3cefaea597761eebb7c8a24">Equation</a> ()</td></tr>
<tr class="separator:a22d1668ad3cefaea597761eebb7c8a24"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1b996fd725fe977202ecd15cba6254ef"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfea_1_1_equation.html#a1b996fd725fe977202ecd15cba6254ef">Equation</a> (const std::vector&lt; <a class="el" href="structfea_1_1_equation_1_1_term.html">Term</a> &gt; &amp;_terms)</td></tr>
<tr class="memdesc:a1b996fd725fe977202ecd15cba6254ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="#a1b996fd725fe977202ecd15cba6254ef">More...</a><br /></td></tr>
<tr class="separator:a1b996fd725fe977202ecd15cba6254ef"><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:a270e2fc1882bbc16abb25e280d51141f"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="structfea_1_1_equation_1_1_term.html">Term</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfea_1_1_equation.html#a270e2fc1882bbc16abb25e280d51141f">terms</a></td></tr>
<tr class="separator:a270e2fc1882bbc16abb25e280d51141f"><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 linear multipoint constraint. </p>
<p><a class="el" href="structfea_1_1_equation.html" title="A linear multipoint constraint. ">Equation</a> constraints are defined by a series of terms that sum to zero, e.g. <code>t1 + t2 + t3 ... = 0</code>, where <code>tn</code> is the <code>n</code>th term. Each term specifies the node number, degree of freedom and coefficient. The node number and degree of freedom specify which nodal variable (either nodal displacement or rotation) is involved with the equation constraint, and coefficient is multiplied by the specified nodal variable when forming the equation. Note, the equation sums to zero, so in order to specify that 2 nodal degrees of freedom are equal their coefficients should be equal and opposite.</p>
<div class="fragment"><div class="line"><span class="comment">// Create an empty equation</span></div>
<div class="line"><a class="code" href="structfea_1_1_equation.html">fea::Equation</a> eqn;</div>
<div class="line"></div>
<div class="line"><span class="comment">// Stipulate that the x and y displacement for the first node must be equal</span></div>
<div class="line"><span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> node_number = 0;</div>
<div class="line">eqn.<a class="code" href="structfea_1_1_equation.html#a270e2fc1882bbc16abb25e280d51141f">terms</a>.push_back(<a class="code" href="structfea_1_1_equation_1_1_term.html">fea::Equation::Term</a>(node_number, <a class="code" href="namespacefea.html#aeaca75d33e81b79c9282f3e69a238d72a0bfcf6fc693c952c376a1d9eb9cf03fb">fea::DOF::DISPLACEMENT_X</a>, 1.0));</div>
<div class="line">eqn.<a class="code" href="structfea_1_1_equation.html#a270e2fc1882bbc16abb25e280d51141f">terms</a>.push_back(<a class="code" href="structfea_1_1_equation_1_1_term.html">fea::Equation::Term</a>(node_number, <a class="code" href="namespacefea.html#aeaca75d33e81b79c9282f3e69a238d72ad39e7a11a71cac64252cb1fb1d94c7f9">fea::DOF::DISPLACEMENT_Y</a>, -1.0);</div>
</div><!-- fragment --> </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a22d1668ad3cefaea597761eebb7c8a24"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">fea::Equation::Equation </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Default constructor </p>
</div>
</div>
<a class="anchor" id="a1b996fd725fe977202ecd15cba6254ef"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">fea::Equation::Equation </td>
<td>(</td>
<td class="paramtype">const std::vector&lt; <a class="el" href="structfea_1_1_equation_1_1_term.html">Term</a> &gt; &amp;&#160;</td>
<td class="paramname"><em>_terms</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">terms.</td><td><code>std::vector&lt;<a class="el" href="structfea_1_1_equation_1_1_term.html" title="A single term in the equation constraint. ">Term</a>&gt;</code>. A list of terms that sum to zero.k </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a270e2fc1882bbc16abb25e280d51141f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector&lt;<a class="el" href="structfea_1_1_equation_1_1_term.html">Term</a>&gt; fea::Equation::terms</td>
</tr>
</table>
</div><div class="memdoc">
<p>A list of terms that sum to zero. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>include/<a class="el" href="containers_8h_source.html">containers.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Oct 3 2016 22:38:16 for 3D Beam Finite Element Code by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.9.1
</small></address>
</body>
</html>