Homec4science
Diffusion Group15_PCSC_Project (master) Browse

Group15/pcsc_VectorialODE_group15/Documentation/html/_solution_8h_source.html
96863ca9892amaster

Last Change
Raw File

_solution_8h_source.html
View Options

<!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.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>VectorialODE: Solution.h 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="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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</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">VectorialODE
&#160;<span id="projectnumber">https://c4science.ch/source/Group15/repository/master/</span>
</div>
<div id="projectbrief">Caroline Violot and Nicolas Lesimple</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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&amp;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>
</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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('_solution_8h_source.html','');});
/* @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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">Solution.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#ifndef PCSC_VECTORIALODE_GROUP15_SOLUTION_H</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor">#define PCSC_VECTORIALODE_GROUP15_SOLUTION_H</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;</div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="preprocessor">#include &quot;Input.h&quot;</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;</div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="keyword">using namespace </span><a class="code" href="namespacestd.html">std</a>;</div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;</div><div class="line"><a name="l00015"></a><span class="lineno"><a class="line" href="class_solution.html"> 15</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_solution.html">Solution</a> {</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="keyword">private</span>:</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> number_of_rows;</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; <span class="keywordtype">int</span> number_of_columns;</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; vector&lt;vector&lt;double&gt;&gt; solutionODE;</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;public :</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; <a class="code" href="class_solution.html">Solution</a>(); <span class="comment">//Default constructor</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; <span class="keyword">explicit</span> <a class="code" href="class_solution.html">Solution</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> rows, <span class="keywordtype">int</span> columns); <span class="comment">//Overwritten constructor allowing the declaration of the solution matrix and the initialisation to 0</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <span class="keyword">explicit</span> <a class="code" href="class_solution.html">Solution</a>(<span class="keyword">const</span> <a class="code" href="class_input.html">Input</a> &amp;input); <span class="comment">//Overwritten constructor allowing the declaration of the solution matrix taking input object as argument</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <span class="keyword">const</span> <span class="keywordtype">double</span> GetSolutionValueFromIndex(<span class="keywordtype">int</span> rowsIndex, <span class="keywordtype">int</span> columnsIndex) <span class="keyword">const</span>; <span class="comment">//Getter allowing the access to one particular element of the matrix solution</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <span class="keywordtype">void</span> ModifySolutionByColumns(vector&lt;double&gt;&amp; vector, <span class="keywordtype">int</span> position); <span class="comment">//Method that modify the solution matrix by reference</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <span class="keywordtype">void</span> SolutionToFile(<span class="keyword">const</span> <span class="keywordtype">string</span>&amp; filename) <span class="keyword">const</span>; <span class="comment">//Method allowing the writing of the solution in a output file</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; vector&lt;vector&lt;double&gt;&gt; GetSolutionODE();</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; ~<a class="code" href="class_solution.html">Solution</a>(); <span class="comment">//Destructor</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;};</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="preprocessor">#endif //PCSC_VECTORIALODE_GROUP15_SOLUTION_H</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;</div><div class="ttc" id="namespacestd_html"><div class="ttname"><a href="namespacestd.html">std</a></div></div>
<div class="ttc" id="class_solution_html"><div class="ttname"><a href="class_solution.html">Solution</a></div><div class="ttdoc">This class allows the saving in the memory and the writing in a output file of the solution of the OD...</div><div class="ttdef"><b>Definition:</b> Solution.h:15</div></div>
<div class="ttc" id="class_input_html"><div class="ttname"><a href="class_input.html">Input</a></div><div class="ttdoc">Class allowing the saving of all the variables to define the system we want to solve. In fact, it takes as input variable (integer or double): Timestep, Dimension, Order, NumberSteps, WriteOutputTimestep. Moreover, Input object needs 3 matrix to define the system : InitialConditionMatrix, CoefficientMatrix, FunctionMatrix. Matrix are defined to be vector of vector of double. Input variables are given to the input class by the constructor. The other methods are getter allowing the access to theses private attributes. </div><div class="ttdef"><b>Definition:</b> Input.h:16</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><b>Solution.h</b></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
</ul>
</div>
</body>
</html>
c4science · Help