Homec4science
Diffusion GooseFEM (gh-pages) Browse

rGOOSEFEM/namespaceGooseFEM.html
4e3b20a7c308gh-pages

Last Change
Raw File

namespaceGooseFEM.html
View Options

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GooseFEM: GooseFEM Namespace 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>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="cookie.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/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js"></script>
<script type="text/javascript" src="darkmode_toggle.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 id="projectrow">
<td id="projectalign">
<div id="projectname">GooseFEM<span id="projectnumber">&#160;1.4.1.dev2+g78f16df</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.10.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('namespaceGooseFEM.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#namespaces">Namespaces</a> &#124;
<a href="#nested-classes">Classes</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">GooseFEM Namespace Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Toolbox to perform finite element computations.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="namespaces" name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespaceGooseFEM_1_1array__type" id="r_namespaceGooseFEM_1_1array__type"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceGooseFEM_1_1array__type.html">array_type</a></td></tr>
<tr class="memdesc:namespaceGooseFEM_1_1array__type"><td class="mdescLeft">&#160;</td><td class="mdescRight">Container type. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:namespaceGooseFEM_1_1Element" id="r_namespaceGooseFEM_1_1Element"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceGooseFEM_1_1Element.html">Element</a></td></tr>
<tr class="memdesc:namespaceGooseFEM_1_1Element"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="namespaceGooseFEM_1_1Element.html" title="Element quadrature and interpolation.">Element</a> quadrature and interpolation. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:namespaceGooseFEM_1_1Iterate" id="r_namespaceGooseFEM_1_1Iterate"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceGooseFEM_1_1Iterate.html">Iterate</a></td></tr>
<tr class="memdesc:namespaceGooseFEM_1_1Iterate"><td class="mdescLeft">&#160;</td><td class="mdescRight">Support function for iterations in end-user programs. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:namespaceGooseFEM_1_1Mesh" id="r_namespaceGooseFEM_1_1Mesh"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceGooseFEM_1_1Mesh.html">Mesh</a></td></tr>
<tr class="memdesc:namespaceGooseFEM_1_1Mesh"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generic mesh operations, and simple mesh definitions. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:namespaceGooseFEM_1_1Tyings" id="r_namespaceGooseFEM_1_1Tyings"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceGooseFEM_1_1Tyings.html">Tyings</a></td></tr>
<tr class="memdesc:namespaceGooseFEM_1_1Tyings"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tools to store and apply nodal/DOF tyings. <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 id="nested-classes" 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="classGooseFEM_1_1Matrix.html">Matrix</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sparse matrix. <a href="classGooseFEM_1_1Matrix.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGooseFEM_1_1MatrixBase.html">MatrixBase</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">CRTP base class for a matrix. <a href="classGooseFEM_1_1MatrixBase.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGooseFEM_1_1MatrixDiagonal.html">MatrixDiagonal</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Diagonal matrix. <a href="classGooseFEM_1_1MatrixDiagonal.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGooseFEM_1_1MatrixDiagonalBase.html">MatrixDiagonalBase</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">CRTP base class for a partitioned matrix with tying. <a href="classGooseFEM_1_1MatrixDiagonalBase.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGooseFEM_1_1MatrixDiagonalPartitioned.html">MatrixDiagonalPartitioned</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Diagonal and partitioned matrix. <a href="classGooseFEM_1_1MatrixDiagonalPartitioned.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGooseFEM_1_1MatrixPartitioned.html">MatrixPartitioned</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sparse matrix partitioned in an unknown and a prescribed part. <a href="classGooseFEM_1_1MatrixPartitioned.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGooseFEM_1_1MatrixPartitionedBase.html">MatrixPartitionedBase</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">CRTP base class for a partitioned matrix. <a href="classGooseFEM_1_1MatrixPartitionedBase.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGooseFEM_1_1MatrixPartitionedSolver.html">MatrixPartitionedSolver</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Solve \( x_u = A_{uu}^{-1} (b_u - A_{up} * x_p) \) for <code>A</code> of the MatrixPartitioned() class. <a href="classGooseFEM_1_1MatrixPartitionedSolver.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGooseFEM_1_1MatrixPartitionedTyings.html">MatrixPartitionedTyings</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sparse matrix from with dependent DOFs are eliminated, and the remaining (small) independent system is partitioned in an unknown and a prescribed part. <a href="classGooseFEM_1_1MatrixPartitionedTyings.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGooseFEM_1_1MatrixPartitionedTyingsBase.html">MatrixPartitionedTyingsBase</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">CRTP base class for a partitioned matrix with tying. <a href="classGooseFEM_1_1MatrixPartitionedTyingsBase.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGooseFEM_1_1MatrixPartitionedTyingsSolver.html">MatrixPartitionedTyingsSolver</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Solver for MatrixPartitionedTyings(). <a href="classGooseFEM_1_1MatrixPartitionedTyingsSolver.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGooseFEM_1_1MatrixSolver.html">MatrixSolver</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Solve \( x = A^{-1} b \), for <code>A</code> of the <a class="el" href="classGooseFEM_1_1Matrix.html" title="Sparse matrix.">GooseFEM::Matrix()</a> class. <a href="classGooseFEM_1_1MatrixSolver.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGooseFEM_1_1MatrixSolverBase.html">MatrixSolverBase</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">CRTP base class for a solver class. <a href="classGooseFEM_1_1MatrixSolverBase.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGooseFEM_1_1MatrixSolverPartitionedBase.html">MatrixSolverPartitionedBase</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">CRTP base class for a extra functions for a partitioned solver class. <a href="classGooseFEM_1_1MatrixSolverPartitionedBase.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGooseFEM_1_1MatrixSolverSingleBase.html">MatrixSolverSingleBase</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">CRTP base class for a solver class. <a href="classGooseFEM_1_1MatrixSolverSingleBase.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGooseFEM_1_1Vector.html">Vector</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Class to switch between storage types. <a href="classGooseFEM_1_1Vector.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGooseFEM_1_1VectorPartitioned.html">VectorPartitioned</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Class to switch between storage types, based on a mesh and DOFs that are partitioned in: <a href="classGooseFEM_1_1VectorPartitioned.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGooseFEM_1_1VectorPartitionedTyings.html">VectorPartitionedTyings</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Class to switch between storage types. <a href="classGooseFEM_1_1VectorPartitionedTyings.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 id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ae97cd438b259a7ed4c0414cb40817b36" id="r_ae97cd438b259a7ed4c0414cb40817b36"><td class="memTemplParams" colspan="2">template&lt;<a class="el" href="#acb082fa83b6ad7cf3a04bd7a181cce81">class</a> <a class="el" href="#acb082fa83b6ad7cf3a04bd7a181cce81">T</a> , <a class="el" href="#acb082fa83b6ad7cf3a04bd7a181cce81">class</a> <a class="el" href="#acb082fa83b6ad7cf3a04bd7a181cce81">R</a> &gt; </td></tr>
<tr class="memitem:ae97cd438b259a7ed4c0414cb40817b36"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="#acb082fa83b6ad7cf3a04bd7a181cce81">void</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#ae97cd438b259a7ed4c0414cb40817b36">asTensor</a> (<a class="el" href="#acb082fa83b6ad7cf3a04bd7a181cce81">const</a> <a class="el" href="#acb082fa83b6ad7cf3a04bd7a181cce81">T</a> &amp;<a class="el" href="#acb082fa83b6ad7cf3a04bd7a181cce81">arg</a>, <a class="el" href="#acb082fa83b6ad7cf3a04bd7a181cce81">R</a> &amp;<a class="el" href="#acb082fa83b6ad7cf3a04bd7a181cce81">ret</a>)</td></tr>
<tr class="memdesc:ae97cd438b259a7ed4c0414cb40817b36"><td class="mdescLeft">&#160;</td><td class="mdescRight">"Broadcast" a scalar stored in an array (e.g. <br /></td></tr>
<tr class="separator:ae97cd438b259a7ed4c0414cb40817b36"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acb082fa83b6ad7cf3a04bd7a181cce81" id="r_acb082fa83b6ad7cf3a04bd7a181cce81"><td class="memTemplParams" colspan="2">template&lt;class T , class S &gt; </td></tr>
<tr class="memitem:acb082fa83b6ad7cf3a04bd7a181cce81"><td class="memTemplItemLeft" align="right" valign="top">auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#acb082fa83b6ad7cf3a04bd7a181cce81">AsTensor</a> (const T &amp;arg, const S &amp;shape)</td></tr>
<tr class="memdesc:acb082fa83b6ad7cf3a04bd7a181cce81"><td class="mdescLeft">&#160;</td><td class="mdescRight">"Broadcast" a scalar stored in an array (e.g. <br /></td></tr>
<tr class="separator:acb082fa83b6ad7cf3a04bd7a181cce81"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8664cf1049c77e8aab7b6a6a36b331a6" id="r_a8664cf1049c77e8aab7b6a6a36b331a6"><td class="memTemplParams" colspan="2">template&lt;class T , class I , size_t L&gt; </td></tr>
<tr class="memitem:a8664cf1049c77e8aab7b6a6a36b331a6"><td class="memTemplItemLeft" align="right" valign="top">auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a8664cf1049c77e8aab7b6a6a36b331a6">AsTensor</a> (const T &amp;arg, const I(&amp;shape)[L])</td></tr>
<tr class="memdesc:a8664cf1049c77e8aab7b6a6a36b331a6"><td class="mdescLeft">&#160;</td><td class="mdescRight">"Broadcast" a scalar stored in an array (e.g. <br /></td></tr>
<tr class="separator:a8664cf1049c77e8aab7b6a6a36b331a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4b030695a10a6675a3ac744cae91fb18" id="r_a4b030695a10a6675a3ac744cae91fb18"><td class="memTemplParams" colspan="2">template&lt;size_t rank, class T &gt; </td></tr>
<tr class="memitem:a4b030695a10a6675a3ac744cae91fb18"><td class="memTemplItemLeft" align="right" valign="top">auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a4b030695a10a6675a3ac744cae91fb18">AsTensor</a> (const T &amp;arg, size_t n)</td></tr>
<tr class="memdesc:a4b030695a10a6675a3ac744cae91fb18"><td class="mdescLeft">&#160;</td><td class="mdescRight">"Broadcast" a scalar stored in an array (e.g. <br /></td></tr>
<tr class="separator:a4b030695a10a6675a3ac744cae91fb18"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae104b1e65ffc417c046f5ff928383f2b" id="r_ae104b1e65ffc417c046f5ff928383f2b"><td class="memTemplParams" colspan="2">template&lt;class T &gt; </td></tr>
<tr class="memitem:ae104b1e65ffc417c046f5ff928383f2b"><td class="memTemplItemLeft" align="right" valign="top">auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#ae104b1e65ffc417c046f5ff928383f2b">AsTensor</a> (size_t rank, const T &amp;arg, size_t n)</td></tr>
<tr class="memdesc:ae104b1e65ffc417c046f5ff928383f2b"><td class="mdescLeft">&#160;</td><td class="mdescRight">"Broadcast" a scalar stored in an array (e.g. <br /></td></tr>
<tr class="separator:ae104b1e65ffc417c046f5ff928383f2b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a44250985d5b267678f934c824f062235" id="r_a44250985d5b267678f934c824f062235"><td class="memTemplParams" colspan="2">template&lt;<a class="el" href="#acb082fa83b6ad7cf3a04bd7a181cce81">class</a> <a class="el" href="#acb082fa83b6ad7cf3a04bd7a181cce81">T</a> &gt; </td></tr>
<tr class="memitem:a44250985d5b267678f934c824f062235"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="#acb082fa83b6ad7cf3a04bd7a181cce81">T</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a44250985d5b267678f934c824f062235">as3d</a> (<a class="el" href="#acb082fa83b6ad7cf3a04bd7a181cce81">const</a> <a class="el" href="#acb082fa83b6ad7cf3a04bd7a181cce81">T</a> &amp;<a class="el" href="#acb082fa83b6ad7cf3a04bd7a181cce81">arg</a>)</td></tr>
<tr class="memdesc:a44250985d5b267678f934c824f062235"><td class="mdescLeft">&#160;</td><td class="mdescRight">Zero-pad columns to a matrix until is that shape <code>[m, 3]</code>. <br /></td></tr>
<tr class="separator:a44250985d5b267678f934c824f062235"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa169946ddb934c098cabaac0bf28d130" id="r_aa169946ddb934c098cabaac0bf28d130"><td class="memTemplParams" colspan="2">template&lt;<a class="el" href="#acb082fa83b6ad7cf3a04bd7a181cce81">class</a> <a class="el" href="#acb082fa83b6ad7cf3a04bd7a181cce81">T</a> &gt; </td></tr>
<tr class="memitem:aa169946ddb934c098cabaac0bf28d130"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="#acb082fa83b6ad7cf3a04bd7a181cce81">bool</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#aa169946ddb934c098cabaac0bf28d130">is_unique</a> (<a class="el" href="#acb082fa83b6ad7cf3a04bd7a181cce81">const</a> <a class="el" href="#acb082fa83b6ad7cf3a04bd7a181cce81">T</a> &amp;<a class="el" href="#acb082fa83b6ad7cf3a04bd7a181cce81">arg</a>)</td></tr>
<tr class="memdesc:aa169946ddb934c098cabaac0bf28d130"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true is a list is unique (has not duplicate items). <br /></td></tr>
<tr class="separator:aa169946ddb934c098cabaac0bf28d130"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a022c22b8131b0958dbf07d86ae08af16" id="r_a022c22b8131b0958dbf07d86ae08af16"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a022c22b8131b0958dbf07d86ae08af16">version</a> ()</td></tr>
<tr class="memdesc:a022c22b8131b0958dbf07d86ae08af16"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return version string, e.g. <br /></td></tr>
<tr class="separator:a022c22b8131b0958dbf07d86ae08af16"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae2657752229dbc35738f1971cfa363b1" id="r_ae2657752229dbc35738f1971cfa363b1"><td class="memItemLeft" align="right" valign="top">std::vector&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae2657752229dbc35738f1971cfa363b1">version_dependencies</a> ()</td></tr>
<tr class="memdesc:ae2657752229dbc35738f1971cfa363b1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return versions of this library and of all of its dependencies. <br /></td></tr>
<tr class="separator:ae2657752229dbc35738f1971cfa363b1"><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>Toolbox to perform finite element computations. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a44250985d5b267678f934c824f062235" name="a44250985d5b267678f934c824f062235"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a44250985d5b267678f934c824f062235">&#9670;&#160;</a></span>as3d()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;<a class="el" href="#acb082fa83b6ad7cf3a04bd7a181cce81">class</a> <a class="el" href="#acb082fa83b6ad7cf3a04bd7a181cce81">T</a> &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="#acb082fa83b6ad7cf3a04bd7a181cce81">T</a> GooseFEM::as3d </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#acb082fa83b6ad7cf3a04bd7a181cce81">const</a> <a class="el" href="#acb082fa83b6ad7cf3a04bd7a181cce81">T</a> &amp;</td> <td class="paramname"><span class="paramname"><em>arg</em></span></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>Zero-pad columns to a matrix until is that shape <code>[m, 3]</code>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">arg</td><td>A "nodevec" (<code>arg.shape(1) &lt;= 3</code>). </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Corresponding "nodevec" in 3-d (<code>ret.shape(1) == 3</code>) </dd></dl>
<p class="definition">Definition at line <a class="el" href="Allocate_8h_source.html#l00223">223</a> of file <a class="el" href="Allocate_8h_source.html">Allocate.h</a>.</p>
</div>
</div>
<a id="a8664cf1049c77e8aab7b6a6a36b331a6" name="a8664cf1049c77e8aab7b6a6a36b331a6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8664cf1049c77e8aab7b6a6a36b331a6">&#9670;&#160;</a></span>AsTensor() <span class="overload">[1/4]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , class I , size_t L&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">auto GooseFEM::AsTensor </td>
<td>(</td>
<td class="paramtype">const T &amp;</td> <td class="paramname"><span class="paramname"><em>arg</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const I(&amp;)</td> <td class="paramname"><span class="paramname"><em>shape</em>[L]</span>&#160;)</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>"Broadcast" a scalar stored in an array (e.g. </p>
<p><code>[r, s]</code>) to the same scalar of all tensor components of a tensor of certain rank (e.g. for rank 2: <code>[r, s, i, j]</code>).</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">arg</td><td>An array with scalars. </td></tr>
<tr><td class="paramname">shape</td><td>The shape of the added tensor dimensions (e.g.: <code>[i, j]</code>). </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Corresponding array with tensors. </dd></dl>
<p class="definition">Definition at line <a class="el" href="Allocate_8h_source.html#l00176">176</a> of file <a class="el" href="Allocate_8h_source.html">Allocate.h</a>.</p>
</div>
</div>
<a id="acb082fa83b6ad7cf3a04bd7a181cce81" name="acb082fa83b6ad7cf3a04bd7a181cce81"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acb082fa83b6ad7cf3a04bd7a181cce81">&#9670;&#160;</a></span>AsTensor() <span class="overload">[2/4]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , class S &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">auto GooseFEM::AsTensor </td>
<td>(</td>
<td class="paramtype">const T &amp;</td> <td class="paramname"><span class="paramname"><em>arg</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const S &amp;</td> <td class="paramname"><span class="paramname"><em>shape</em></span>&#160;)</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>"Broadcast" a scalar stored in an array (e.g. </p>
<p><code>[r, s]</code>) to the same scalar of all tensor components of a tensor of certain rank (e.g. for rank 2: <code>[r, s, i, j]</code>).</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">arg</td><td>An array with scalars. </td></tr>
<tr><td class="paramname">shape</td><td>The shape of the added tensor dimensions (e.g.: <code>[i, j]</code>). </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Corresponding array with tensors. </dd></dl>
<p class="definition">Definition at line <a class="el" href="Allocate_8h_source.html#l00167">167</a> of file <a class="el" href="Allocate_8h_source.html">Allocate.h</a>.</p>
</div>
</div>
<a id="ae97cd438b259a7ed4c0414cb40817b36" name="ae97cd438b259a7ed4c0414cb40817b36"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae97cd438b259a7ed4c0414cb40817b36">&#9670;&#160;</a></span>asTensor()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;<a class="el" href="#acb082fa83b6ad7cf3a04bd7a181cce81">class</a> <a class="el" href="#acb082fa83b6ad7cf3a04bd7a181cce81">T</a> , <a class="el" href="#acb082fa83b6ad7cf3a04bd7a181cce81">class</a> <a class="el" href="#acb082fa83b6ad7cf3a04bd7a181cce81">R</a> &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="#acb082fa83b6ad7cf3a04bd7a181cce81">void</a> GooseFEM::asTensor </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#acb082fa83b6ad7cf3a04bd7a181cce81">const</a> <a class="el" href="#acb082fa83b6ad7cf3a04bd7a181cce81">T</a> &amp;</td> <td class="paramname"><span class="paramname"><em>arg</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="#acb082fa83b6ad7cf3a04bd7a181cce81">R</a> &amp;</td> <td class="paramname"><span class="paramname"><em>ret</em></span>&#160;)</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>"Broadcast" a scalar stored in an array (e.g. </p>
<p><code>[r, s]</code>) to the same scalar of all tensor components of a tensor of certain rank (e.g. for rank 2: <code>[r, s, i, j]</code>).</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">arg</td><td>An array with scalars. </td></tr>
<tr><td class="paramname">ret</td><td>Corresponding array with tensors. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="Allocate_8h_source.html#l00153">153</a> of file <a class="el" href="Allocate_8h_source.html">Allocate.h</a>.</p>
</div>
</div>
<a id="a4b030695a10a6675a3ac744cae91fb18" name="a4b030695a10a6675a3ac744cae91fb18"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4b030695a10a6675a3ac744cae91fb18">&#9670;&#160;</a></span>AsTensor() <span class="overload">[3/4]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;size_t rank, class T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">auto GooseFEM::AsTensor </td>
<td>(</td>
<td class="paramtype">const T &amp;</td> <td class="paramname"><span class="paramname"><em>arg</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>n</em></span>&#160;)</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>"Broadcast" a scalar stored in an array (e.g. </p>
<p><code>[r, s]</code>) to the same scalar of all tensor components of a tensor of certain rank (e.g. for rank 2: <code>[r, s, n, n]</code>).</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">rank</td><td>Number of tensor dimensions (number of dimensions to add to the input). </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">arg</td><td>An array with scalars. </td></tr>
<tr><td class="paramname">n</td><td>The shape along each of the added dimensions. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Corresponding array with tensors. </dd></dl>
<p class="definition">Definition at line <a class="el" href="Allocate_8h_source.html#l00192">192</a> of file <a class="el" href="Allocate_8h_source.html">Allocate.h</a>.</p>
</div>
</div>
<a id="ae104b1e65ffc417c046f5ff928383f2b" name="ae104b1e65ffc417c046f5ff928383f2b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae104b1e65ffc417c046f5ff928383f2b">&#9670;&#160;</a></span>AsTensor() <span class="overload">[4/4]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">auto GooseFEM::AsTensor </td>
<td>(</td>
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>rank</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const T &amp;</td> <td class="paramname"><span class="paramname"><em>arg</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>n</em></span>&#160;)</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>"Broadcast" a scalar stored in an array (e.g. </p>
<p><code>[r, s]</code>) to the same scalar of all tensor components of a tensor of certain rank (e.g. for rank 2: <code>[r, s, n, n]</code>).</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">rank</td><td>Number of tensor dimensions (number of dimensions to add to the input). </td></tr>
<tr><td class="paramname">arg</td><td>An array with scalars. </td></tr>
<tr><td class="paramname">n</td><td>The shape along each of the added dimensions. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Corresponding array with tensors. </dd></dl>
<p class="definition">Definition at line <a class="el" href="Allocate_8h_source.html#l00209">209</a> of file <a class="el" href="Allocate_8h_source.html">Allocate.h</a>.</p>
</div>
</div>
<a id="aa169946ddb934c098cabaac0bf28d130" name="aa169946ddb934c098cabaac0bf28d130"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa169946ddb934c098cabaac0bf28d130">&#9670;&#160;</a></span>is_unique()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;<a class="el" href="#acb082fa83b6ad7cf3a04bd7a181cce81">class</a> <a class="el" href="#acb082fa83b6ad7cf3a04bd7a181cce81">T</a> &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="#acb082fa83b6ad7cf3a04bd7a181cce81">bool</a> GooseFEM::is_unique </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#acb082fa83b6ad7cf3a04bd7a181cce81">const</a> <a class="el" href="#acb082fa83b6ad7cf3a04bd7a181cce81">T</a> &amp;</td> <td class="paramname"><span class="paramname"><em>arg</em></span></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>Returns true is a list is unique (has not duplicate items). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">arg</td><td>Array-like. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if <code>arg</code> is unique. </dd></dl>
<p class="definition">Definition at line <a class="el" href="assertions_8h_source.html#l00020">20</a> of file <a class="el" href="assertions_8h_source.html">assertions.h</a>.</p>
</div>
</div>
<a id="a022c22b8131b0958dbf07d86ae08af16" name="a022c22b8131b0958dbf07d86ae08af16"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a022c22b8131b0958dbf07d86ae08af16">&#9670;&#160;</a></span>version()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string GooseFEM::version </td>
<td>(</td>
<td class="paramname"><span class="paramname"></span></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>Return version string, e.g. </p>
<p><code>"0.8.0"</code> </p><dl class="section return"><dt>Returns</dt><dd>String. </dd></dl>
<p class="definition">Definition at line <a class="el" href="version_8h_source.html#l00055">55</a> of file <a class="el" href="version_8h_source.html">version.h</a>.</p>
</div>
</div>
<a id="ae2657752229dbc35738f1971cfa363b1" name="ae2657752229dbc35738f1971cfa363b1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae2657752229dbc35738f1971cfa363b1">&#9670;&#160;</a></span>version_dependencies()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::vector&lt; std::string &gt; GooseFEM::version_dependencies </td>
<td>(</td>
<td class="paramname"><span class="paramname"></span></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>Return versions of this library and of all of its dependencies. </p>
<p>The output is a list of strings, e.g.:: </p><pre class="fragment"> "goosefem=0.7.0",
"xtensor=0.20.1"
...
</pre> <dl class="section return"><dt>Returns</dt><dd>List of strings. </dd></dl>
<p class="definition">Definition at line <a class="el" href="version_8h_source.html#l00070">70</a> of file <a class="el" href="version_8h_source.html">version.h</a>.</p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespaceGooseFEM.html">GooseFEM</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0 </li>
</ul>
</div>
</body>
</html>
c4science · Help