-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path_newton_solver_8hh_source.html
121 lines (119 loc) · 11.3 KB
/
_newton_solver_8hh_source.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
<!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">
<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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>adamantine: /home/bt2/Documents/adamantine_doc/doxygen/adamantine-master/source/NewtonSolver.hh Source File</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>
<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="projectalign" style="padding-left: 0.5em;">
<div id="projectname">adamantine
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></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="dir_b2f33c71d4aa5e7af42a1ca61ff5af1b.html">source</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">NewtonSolver.hh</div> </div>
</div><!--header-->
<div class="contents">
<a href="_newton_solver_8hh.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* SPDX-FileCopyrightText: Copyright (c) 2016 - 2024, the adamantine authors.</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>  </div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#ifndef NEWTON_SOLVER_HH</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#define NEWTON_SOLVER_HH</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>  </div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include <<a class="code" href="types_8hh.html">types.hh</a>></span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>  </div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include <deal.II/lac/la_parallel_vector.h></span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>  </div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include <functional></span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>  </div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="keyword">namespace </span><a class="code" href="namespaceadamantine.html">adamantine</a></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> {</div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  </div>
<div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="classadamantine_1_1_newton_solver.html"> 17</a></span> <span class="keyword">class </span><a class="code" href="classadamantine_1_1_newton_solver.html">NewtonSolver</a></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> {</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <a class="code" href="classadamantine_1_1_newton_solver.html#ad60a5156b3f01286ba86e9d6e40544a0">NewtonSolver</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> max_it, <span class="keywordtype">double</span> tolerance);</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  </div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keywordtype">void</span> <a class="code" href="classadamantine_1_1_newton_solver.html#a2624c2efdab71abc39da2b43df9507a3">solve</a>(std::function<dealii::LA::distributed::Vector<double>(</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  dealii::LA::distributed::Vector<double> <span class="keyword">const</span> &)> <span class="keyword">const</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  &compute_residual,</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  std::function<dealii::LA::distributed::Vector<double>(</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  dealii::LA::distributed::Vector<double> <span class="keyword">const</span> &)> <span class="keyword">const</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  &compute_inv_jacobian,</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  dealii::LA::distributed::Vector<double> &y);</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  </div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="keyword">private</span>:</div>
<div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="classadamantine_1_1_newton_solver.html#aa6b4628bac3a4959b95f47aa7fd6afb4"> 50</a></span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classadamantine_1_1_newton_solver.html#aa6b4628bac3a4959b95f47aa7fd6afb4">_max_it</a>;</div>
<div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="classadamantine_1_1_newton_solver.html#adb644da5e052b13487caf47c835c9ea0"> 54</a></span>  <span class="keywordtype">double</span> <a class="code" href="classadamantine_1_1_newton_solver.html#adb644da5e052b13487caf47c835c9ea0">_tolerance</a>;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> };</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> } <span class="comment">// namespace adamantine</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  </div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclassadamantine_1_1_newton_solver_html"><div class="ttname"><a href="classadamantine_1_1_newton_solver.html">adamantine::NewtonSolver</a></div><div class="ttdef"><b>Definition:</b> <a href="_newton_solver_8hh_source.html#l00017">NewtonSolver.hh:18</a></div></div>
<div class="ttc" id="aclassadamantine_1_1_newton_solver_html_a2624c2efdab71abc39da2b43df9507a3"><div class="ttname"><a href="classadamantine_1_1_newton_solver.html#a2624c2efdab71abc39da2b43df9507a3">adamantine::NewtonSolver::solve</a></div><div class="ttdeci">void solve(std::function< dealii::LA::distributed::Vector< double >(dealii::LA::distributed::Vector< double > const &)> const &compute_residual, std::function< dealii::LA::distributed::Vector< double >(dealii::LA::distributed::Vector< double > const &)> const &compute_inv_jacobian, dealii::LA::distributed::Vector< double > &y)</div><div class="ttdef"><b>Definition:</b> <a href="_newton_solver_8cc_source.html#l00014">NewtonSolver.cc:14</a></div></div>
<div class="ttc" id="aclassadamantine_1_1_newton_solver_html_aa6b4628bac3a4959b95f47aa7fd6afb4"><div class="ttname"><a href="classadamantine_1_1_newton_solver.html#aa6b4628bac3a4959b95f47aa7fd6afb4">adamantine::NewtonSolver::_max_it</a></div><div class="ttdeci">unsigned int _max_it</div><div class="ttdef"><b>Definition:</b> <a href="_newton_solver_8hh_source.html#l00050">NewtonSolver.hh:50</a></div></div>
<div class="ttc" id="aclassadamantine_1_1_newton_solver_html_ad60a5156b3f01286ba86e9d6e40544a0"><div class="ttname"><a href="classadamantine_1_1_newton_solver.html#ad60a5156b3f01286ba86e9d6e40544a0">adamantine::NewtonSolver::NewtonSolver</a></div><div class="ttdeci">NewtonSolver(unsigned int max_it, double tolerance)</div><div class="ttdef"><b>Definition:</b> <a href="_newton_solver_8cc_source.html#l00009">NewtonSolver.cc:9</a></div></div>
<div class="ttc" id="aclassadamantine_1_1_newton_solver_html_adb644da5e052b13487caf47c835c9ea0"><div class="ttname"><a href="classadamantine_1_1_newton_solver.html#adb644da5e052b13487caf47c835c9ea0">adamantine::NewtonSolver::_tolerance</a></div><div class="ttdeci">double _tolerance</div><div class="ttdef"><b>Definition:</b> <a href="_newton_solver_8hh_source.html#l00054">NewtonSolver.hh:54</a></div></div>
<div class="ttc" id="anamespaceadamantine_html"><div class="ttname"><a href="namespaceadamantine.html">adamantine</a></div><div class="ttdef"><b>Definition:</b> <a href="_beam_heat_source_properties_8hh_source.html#l00014">BeamHeatSourceProperties.hh:15</a></div></div>
<div class="ttc" id="atypes_8hh_html"><div class="ttname"><a href="types_8hh.html">types.hh</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>