Homec4science
Diffusion GooseFEM (master) Browse

rGOOSEFEM/classGooseFEM_1_1MatrixSolverBase.html
4e3b20a7c308master

Last Change
Raw File

classGooseFEM_1_1MatrixSolverBase.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::MatrixSolverBase&lt; D &gt; Class Template 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('classGooseFEM_1_1MatrixSolverBase.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="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classGooseFEM_1_1MatrixSolverBase-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">GooseFEM::MatrixSolverBase&lt; D &gt; Class Template Reference</div></div>
</div><!--header-->
<div class="contents">
<p>CRTP base class for a solver class.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="Matrix_8h_source.html">GooseFEM/Matrix.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:aa2ac4c3089a8709a1de1c12503d7c132" id="r_aa2ac4c3089a8709a1de1c12503d7c132"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">using</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa2ac4c3089a8709a1de1c12503d7c132">derived_type</a> = <a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">D</a></td></tr>
<tr class="memdesc:aa2ac4c3089a8709a1de1c12503d7c132"><td class="mdescLeft">&#160;</td><td class="mdescRight">Underlying type. <br /></td></tr>
<tr class="separator:aa2ac4c3089a8709a1de1c12503d7c132"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a21b8b7185de0c9e920efa6aed13399cc" id="r_a21b8b7185de0c9e920efa6aed13399cc"><td class="memTemplParams" colspan="2">template&lt;<a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">class</a> <a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">M</a> &gt; </td></tr>
<tr class="memitem:a21b8b7185de0c9e920efa6aed13399cc"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">void</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a21b8b7185de0c9e920efa6aed13399cc">solve</a> (<a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">M</a> &amp;<a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">A</a>, <a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">const</a> <a class="el" href="namespaceGooseFEM_1_1array__type.html#adad35bf4db4c7eb54c25136f0f3d34d1">array_type::tensor</a>&lt; <a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">double</a>, 2 &gt; &amp;<a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">b</a>, <a class="el" href="namespaceGooseFEM_1_1array__type.html#adad35bf4db4c7eb54c25136f0f3d34d1">array_type::tensor</a>&lt; <a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">double</a>, 2 &gt; &amp;<a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">x</a>)</td></tr>
<tr class="memdesc:a21b8b7185de0c9e920efa6aed13399cc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Solve \( x = A^{-1} b \). <br /></td></tr>
<tr class="separator:a21b8b7185de0c9e920efa6aed13399cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9e2aa99f4416402b708fac3fa16bb230" id="r_a9e2aa99f4416402b708fac3fa16bb230"><td class="memTemplParams" colspan="2">template&lt;<a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">class</a> <a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">M</a> &gt; </td></tr>
<tr class="memitem:a9e2aa99f4416402b708fac3fa16bb230"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">void</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a9e2aa99f4416402b708fac3fa16bb230">solve</a> (<a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">M</a> &amp;<a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">A</a>, <a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">const</a> <a class="el" href="namespaceGooseFEM_1_1array__type.html#adad35bf4db4c7eb54c25136f0f3d34d1">array_type::tensor</a>&lt; <a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">double</a>, 1 &gt; &amp;<a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">b</a>, <a class="el" href="namespaceGooseFEM_1_1array__type.html#adad35bf4db4c7eb54c25136f0f3d34d1">array_type::tensor</a>&lt; <a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">double</a>, 1 &gt; &amp;<a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">x</a>)</td></tr>
<tr class="memdesc:a9e2aa99f4416402b708fac3fa16bb230"><td class="mdescLeft">&#160;</td><td class="mdescRight">Solve \( x = A^{-1} b \). <br /></td></tr>
<tr class="separator:a9e2aa99f4416402b708fac3fa16bb230"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template&lt;<a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">class</a> <a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">D</a>&gt;<br />
class GooseFEM::MatrixSolverBase&lt; D &gt;</div><p>CRTP base class for a solver class. </p>
<p class="definition">Definition at line <a class="el" href="Matrix_8h_source.html#l00026">26</a> of file <a class="el" href="Matrix_8h_source.html">Matrix.h</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="aa2ac4c3089a8709a1de1c12503d7c132" name="aa2ac4c3089a8709a1de1c12503d7c132"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa2ac4c3089a8709a1de1c12503d7c132">&#9670;&#160;</a></span>derived_type</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;<a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">class</a> <a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">D</a> &gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">using</a> <a class="el" href="classGooseFEM_1_1MatrixSolverBase.html">GooseFEM::MatrixSolverBase</a>&lt; <a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">D</a> &gt;::derived_type = <a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">D</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Underlying type. </p>
<p class="definition">Definition at line <a class="el" href="Matrix_8h_source.html#l00031">31</a> of file <a class="el" href="Matrix_8h_source.html">Matrix.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a9e2aa99f4416402b708fac3fa16bb230" name="a9e2aa99f4416402b708fac3fa16bb230"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9e2aa99f4416402b708fac3fa16bb230">&#9670;&#160;</a></span>solve() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;<a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">class</a> <a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">D</a> &gt; </div>
<div class="memtemplate">
template&lt;<a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">class</a> <a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">M</a> &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">void</a> <a class="el" href="classGooseFEM_1_1MatrixSolverBase.html">GooseFEM::MatrixSolverBase</a>&lt; <a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">D</a> &gt;::solve </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">M</a> &amp;</td> <td class="paramname"><span class="paramname"><em>A</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">const</a> <a class="el" href="namespaceGooseFEM_1_1array__type.html#adad35bf4db4c7eb54c25136f0f3d34d1">array_type::tensor</a>&lt; <a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">double</a>, 1 &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>b</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceGooseFEM_1_1array__type.html#adad35bf4db4c7eb54c25136f0f3d34d1">array_type::tensor</a>&lt; <a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">double</a>, 1 &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>x</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>Solve \( x = A^{-1} b \). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">A</td><td><a class="el" href="namespaceGooseFEM.html" title="Toolbox to perform finite element computations.">GooseFEM</a> (sparse) matrix, see e.g. <a class="el" href="classGooseFEM_1_1Matrix.html" title="Sparse matrix.">GooseFEM::Matrix()</a>. </td></tr>
<tr><td class="paramname">b</td><td>dofval [ndof]. </td></tr>
<tr><td class="paramname">x</td><td>(overwritten) dofval [ndof]. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="Matrix_8h_source.html#l00068">68</a> of file <a class="el" href="Matrix_8h_source.html">Matrix.h</a>.</p>
</div>
</div>
<a id="a21b8b7185de0c9e920efa6aed13399cc" name="a21b8b7185de0c9e920efa6aed13399cc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a21b8b7185de0c9e920efa6aed13399cc">&#9670;&#160;</a></span>solve() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;<a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">class</a> <a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">D</a> &gt; </div>
<div class="memtemplate">
template&lt;<a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">class</a> <a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">M</a> &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">void</a> <a class="el" href="classGooseFEM_1_1MatrixSolverBase.html">GooseFEM::MatrixSolverBase</a>&lt; <a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">D</a> &gt;::solve </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">M</a> &amp;</td> <td class="paramname"><span class="paramname"><em>A</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">const</a> <a class="el" href="namespaceGooseFEM_1_1array__type.html#adad35bf4db4c7eb54c25136f0f3d34d1">array_type::tensor</a>&lt; <a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">double</a>, 2 &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>b</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceGooseFEM_1_1array__type.html#adad35bf4db4c7eb54c25136f0f3d34d1">array_type::tensor</a>&lt; <a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">double</a>, 2 &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>x</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>Solve \( x = A^{-1} b \). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">A</td><td><a class="el" href="namespaceGooseFEM.html" title="Toolbox to perform finite element computations.">GooseFEM</a> (sparse) matrix, see e.g. <a class="el" href="classGooseFEM_1_1Matrix.html" title="Sparse matrix.">GooseFEM::Matrix()</a>. </td></tr>
<tr><td class="paramname">b</td><td>nodevec [nelem, ndim]. </td></tr>
<tr><td class="paramname">x</td><td>(overwritten) nodevec [nelem, ndim]. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="Matrix_8h_source.html#l00053">53</a> of file <a class="el" href="Matrix_8h_source.html">Matrix.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>GooseFEM/<a class="el" href="Matrix_8h_source.html">Matrix.h</a></li>
</ul>
</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="navelem"><a class="el" href="classGooseFEM_1_1MatrixSolverBase.html">MatrixSolverBase</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