manolas
/
threed-beam-fea
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
threed-beam-fea/docs/html/structfea_1_1_force.html

267 lines
12 KiB
HTML
Raw Blame History

<!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.10"/>
<title>3D Beam Finite Element Code: fea::Force 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 id="projectalign" 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.10 -->
<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_force.html">Force</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_force-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">fea::Force Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A nodal force to enforce.
<a href="structfea_1_1_force.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:a93dc2d161dcecb97d3cf11231d3c3c6d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfea_1_1_force.html#a93dc2d161dcecb97d3cf11231d3c3c6d">Force</a> ()</td></tr>
<tr class="memdesc:a93dc2d161dcecb97d3cf11231d3c3c6d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default Constructor. <a href="#a93dc2d161dcecb97d3cf11231d3c3c6d">More...</a><br /></td></tr>
<tr class="separator:a93dc2d161dcecb97d3cf11231d3c3c6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aee9eb661d238d6b8bf2e69fde1161c0c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfea_1_1_force.html#aee9eb661d238d6b8bf2e69fde1161c0c">Force</a> (unsigned int _node, unsigned int _dof, double _value)</td></tr>
<tr class="memdesc:aee9eb661d238d6b8bf2e69fde1161c0c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="#aee9eb661d238d6b8bf2e69fde1161c0c">More...</a><br /></td></tr>
<tr class="separator:aee9eb661d238d6b8bf2e69fde1161c0c"><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:a9c8775a2687d7ee6056f2667b3b81e7b"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfea_1_1_force.html#a9c8775a2687d7ee6056f2667b3b81e7b">node</a></td></tr>
<tr class="separator:a9c8775a2687d7ee6056f2667b3b81e7b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4230fda618e98c1a01e5effbbec346f4"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfea_1_1_force.html#a4230fda618e98c1a01e5effbbec346f4">dof</a></td></tr>
<tr class="separator:a4230fda618e98c1a01e5effbbec346f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad3752a20c2da0ddceb0e318517265444"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfea_1_1_force.html#ad3752a20c2da0ddceb0e318517265444">value</a></td></tr>
<tr class="separator:ad3752a20c2da0ddceb0e318517265444"><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 nodal force to enforce. </p>
<p>Set by specifying the node where the force will be applied, which degree of freedom will be affected, and the value to apply.</p>
<div class="fragment"><div class="line"><span class="comment">// define the node number to constrain</span></div>
<div class="line"><span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> nn1 = 0;</div>
<div class="line"><span class="comment">// define the value to hold the nodal DOF at</span></div>
<div class="line"><span class="keywordtype">double</span> value = 0.0;</div>
<div class="line"><a class="code" href="structfea_1_1_force.html">fea::Force</a> force(nn1, <a class="code" href="namespacefea.html#aeaca75d33e81b79c9282f3e69a238d72a0bfcf6fc693c952c376a1d9eb9cf03fb">fea::DOF::DISPLACEMENT_X</a>, value);</div>
</div><!-- fragment --> </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a93dc2d161dcecb97d3cf11231d3c3c6d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">fea::Force::Force </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 values are set to zero. </p>
</div>
</div>
<a class="anchor" id="aee9eb661d238d6b8bf2e69fde1161c0c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">fea::Force::Force </td>
<td>(</td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>_node</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>_dof</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>_value</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</td><td><code>unsigned int</code>. The index of the node. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">dof</td><td><code>unsigned int</code>. Degree of freedom to constrain (See <a class="el" href="namespacefea.html#aeaca75d33e81b79c9282f3e69a238d72" title="Convenience enumerator for specifying the active degree of freedom in a constraint. ">fea::DOF</a>). </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">value</td><td><code>double</code>. The prescribed value for the force. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a4230fda618e98c1a01e5effbbec346f4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int fea::Force::dof</td>
</tr>
</table>
</div><div class="memdoc">
<p>The index of the dof to constrain. The <a class="el" href="namespacefea.html#aeaca75d33e81b79c9282f3e69a238d72" title="Convenience enumerator for specifying the active degree of freedom in a constraint. ">fea::DOF</a> enum can be used for specification or the integer values can be used directly <code>0==d_x</code>, <code>1==d_y</code>, ... </p>
</div>
</div>
<a class="anchor" id="a9c8775a2687d7ee6056f2667b3b81e7b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int fea::Force::node</td>
</tr>
</table>
</div><div class="memdoc">
<p>The index of the node to apply the force </p>
</div>
</div>
<a class="anchor" id="ad3752a20c2da0ddceb0e318517265444"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double fea::Force::value</td>
</tr>
</table>
</div><div class="memdoc">
<p>The value of the force to apply. </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 Thu Nov 5 2015 10:34:37 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.10
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink