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

295 lines
14 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::Tie 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_tie.html">Tie</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structfea_1_1_tie-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">fea::Tie Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Places linear springs between all degrees of freedom of 2 nodes.
<a href="structfea_1_1_tie.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="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a3542331e92a5ab360e5b56b41b4e52e7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfea_1_1_tie.html#a3542331e92a5ab360e5b56b41b4e52e7">Tie</a> ()</td></tr>
<tr class="memdesc:a3542331e92a5ab360e5b56b41b4e52e7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default Constructor. <a href="#a3542331e92a5ab360e5b56b41b4e52e7">More...</a><br /></td></tr>
<tr class="separator:a3542331e92a5ab360e5b56b41b4e52e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a59e7666d7560877514f0e33487677a78"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfea_1_1_tie.html#a59e7666d7560877514f0e33487677a78">Tie</a> (unsigned int _node_number_1, unsigned int _node_number_2, double _lmult, double _rmult)</td></tr>
<tr class="memdesc:a59e7666d7560877514f0e33487677a78"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="#a59e7666d7560877514f0e33487677a78">More...</a><br /></td></tr>
<tr class="separator:a59e7666d7560877514f0e33487677a78"><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:ab990eb9740340ad753fba08c9398bc17"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfea_1_1_tie.html#ab990eb9740340ad753fba08c9398bc17">node_number_1</a></td></tr>
<tr class="separator:ab990eb9740340ad753fba08c9398bc17"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac6e72cd3090c0778d54aa54fdcd3c3fc"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfea_1_1_tie.html#ac6e72cd3090c0778d54aa54fdcd3c3fc">node_number_2</a></td></tr>
<tr class="separator:ac6e72cd3090c0778d54aa54fdcd3c3fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aff1afe96a1c7f146950a4409f20cf40e"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfea_1_1_tie.html#aff1afe96a1c7f146950a4409f20cf40e">lmult</a></td></tr>
<tr class="separator:aff1afe96a1c7f146950a4409f20cf40e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0749f1dff71abd77be8630965792f212"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfea_1_1_tie.html#a0749f1dff71abd77be8630965792f212">rmult</a></td></tr>
<tr class="separator:a0749f1dff71abd77be8630965792f212"><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>Places linear springs between all degrees of freedom of 2 nodes. </p>
<p>To form a tie specify the 2 nodes that will be linked as well as the spring constants for translational and rotational degrees of freedom. All translational degrees of freedom will be assigned the same spring constant. The same is true for rotational degrees of freedom, although the spring constant does not have to be the same as that used for the translational DOFs. </p><div class="fragment"><div class="line"><span class="comment">// create the tie between node2 and node3</span></div>
<div class="line"><span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> nn1 = 1; <span class="comment">// i.e. the second node in the node list</span></div>
<div class="line"><span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> nn2 = 2; <span class="comment">// i.e. the third node in the node list</span></div>
<div class="line"></div>
<div class="line"><span class="comment">// define the spring constant for x, y, and z translational DOFs</span></div>
<div class="line"><span class="keywordtype">double</span> <a class="code" href="structfea_1_1_tie.html#aff1afe96a1c7f146950a4409f20cf40e">lmult</a> = 100.0;</div>
<div class="line"></div>
<div class="line"><span class="comment">// define the spring constant for x, y, and z rotational DOFs</span></div>
<div class="line"><span class="keywordtype">double</span> <a class="code" href="structfea_1_1_tie.html#a0749f1dff71abd77be8630965792f212">rmult</a> = 100.0;</div>
<div class="line"></div>
<div class="line"><span class="comment">// form the tie</span></div>
<div class="line"><a class="code" href="structfea_1_1_tie.html">fea::Tie</a> tie1(nn1, nn2, lmult, rmult);</div>
</div><!-- fragment --> </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a3542331e92a5ab360e5b56b41b4e52e7"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">fea::Tie::Tie </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>
<p>All member variables are set to 0. </p>
</div>
</div>
<a class="anchor" id="a59e7666d7560877514f0e33487677a78"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">fea::Tie::Tie </td>
<td>(</td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>_node_number_1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>_node_number_2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>_lmult</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>_rmult</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</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="paramdir">[in]</td><td class="paramname">node_number_1</td><td><code>unsigned int</code>. Index of the first node. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">node_number_2</td><td><code>unsigned int</code>. Index of the second node. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">lmult</td><td><code>double</code>. Spring constant for the translational degrees of freedom. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">rmult</td><td><code>double</code>. Spring constant for the rotational degrees of freedom. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="aff1afe96a1c7f146950a4409f20cf40e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double fea::Tie::lmult</td>
</tr>
</table>
</div><div class="memdoc">
<p>multiplier for the linear spring. </p>
</div>
</div>
<a class="anchor" id="ab990eb9740340ad753fba08c9398bc17"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int fea::Tie::node_number_1</td>
</tr>
</table>
</div><div class="memdoc">
<p>The first element's index involved in the constraint. </p>
</div>
</div>
<a class="anchor" id="ac6e72cd3090c0778d54aa54fdcd3c3fc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int fea::Tie::node_number_2</td>
</tr>
</table>
</div><div class="memdoc">
<p>The second element's index involved in the constraint. </p>
</div>
</div>
<a class="anchor" id="a0749f1dff71abd77be8630965792f212"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double fea::Tie::rmult</td>
</tr>
</table>
</div><div class="memdoc">
<p>multiplier for the rotational spring. </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>