Page MenuHomec4science

class_input.html
No OneTemporary

File Metadata

Created
Sat, Jul 12, 21:34

class_input.html

<!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: Input Class 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="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('class_input.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="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_input-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Input Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>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, <a class="el" href="class_input.html" title="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. ">Input</a> object needs 3 matrix to define the system : InitialConditionMatrix, CoefficientMatrix, FunctionMatrix. Matrix are defined to be vector of vector of double. <a class="el" href="class_input.html" title="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. ">Input</a> variables are given to the input class by the constructor. The other methods are getter allowing the access to theses private attributes.
<a href="class_input.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_input_8h_source.html">Input.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:abae3f379d3f157cf42dc857309832dba"><td class="memItemLeft" align="right" valign="top"><a id="abae3f379d3f157cf42dc857309832dba"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_input.html#abae3f379d3f157cf42dc857309832dba">Input</a> ()</td></tr>
<tr class="memdesc:abae3f379d3f157cf42dc857309832dba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor allowing the definition of the system we want to solve. In this class, the three input matrix were hardcode with the order of the system. <br /></td></tr>
<tr class="separator:abae3f379d3f157cf42dc857309832dba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6e9028a0843a2db4271a4e3bf3eb941f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_input.html#a6e9028a0843a2db4271a4e3bf3eb941f">Input</a> (double time_step, int dimension, int order, int number_steps, int write_output_timestep, const vector&lt; vector&lt; double &gt;&gt; &amp;initial_condition_matrix, const vector&lt; vector&lt; double &gt;&gt; &amp;changing_matrix, const vector&lt; vector&lt; double &gt;&gt; &amp;past_step_matrix)</td></tr>
<tr class="memdesc:a6e9028a0843a2db4271a4e3bf3eb941f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor of the class allowing the definition of the system. <a href="#a6e9028a0843a2db4271a4e3bf3eb941f">More...</a><br /></td></tr>
<tr class="separator:a6e9028a0843a2db4271a4e3bf3eb941f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae6eae7ea32488c4ce43a027b3b2fabc2"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_input.html#ae6eae7ea32488c4ce43a027b3b2fabc2">AskNumberToUser</a> ()</td></tr>
<tr class="memdesc:ae6eae7ea32488c4ce43a027b3b2fabc2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Method allowing the asking of a number to the user. The user will enter this input number thank to the keyboard. <a href="#ae6eae7ea32488c4ce43a027b3b2fabc2">More...</a><br /></td></tr>
<tr class="separator:ae6eae7ea32488c4ce43a027b3b2fabc2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a47ccd0138fd87abb7ddbaae502930c45"><td class="memItemLeft" align="right" valign="top"><a id="a47ccd0138fd87abb7ddbaae502930c45"></a>
double &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_input.html#a47ccd0138fd87abb7ddbaae502930c45">GetTimestep</a> () const</td></tr>
<tr class="memdesc:a47ccd0138fd87abb7ddbaae502930c45"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the time step attribute. <br /></td></tr>
<tr class="separator:a47ccd0138fd87abb7ddbaae502930c45"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1fff5b534cc24e5ac8651366fa9cc8c1"><td class="memItemLeft" align="right" valign="top"><a id="a1fff5b534cc24e5ac8651366fa9cc8c1"></a>
unsigned long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_input.html#a1fff5b534cc24e5ac8651366fa9cc8c1">GetDimension</a> () const</td></tr>
<tr class="memdesc:a1fff5b534cc24e5ac8651366fa9cc8c1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the dimension attribute. <br /></td></tr>
<tr class="separator:a1fff5b534cc24e5ac8651366fa9cc8c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab4191112b8950f47f14a4407816b07d5"><td class="memItemLeft" align="right" valign="top"><a id="ab4191112b8950f47f14a4407816b07d5"></a>
int &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_input.html#ab4191112b8950f47f14a4407816b07d5">GetOrder</a> () const</td></tr>
<tr class="memdesc:ab4191112b8950f47f14a4407816b07d5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the solver attribute. <br /></td></tr>
<tr class="separator:ab4191112b8950f47f14a4407816b07d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aef65eb3f06d64b552f38d57935cb5352"><td class="memItemLeft" align="right" valign="top"><a id="aef65eb3f06d64b552f38d57935cb5352"></a>
int &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_input.html#aef65eb3f06d64b552f38d57935cb5352">GetNumberSteps</a> () const</td></tr>
<tr class="memdesc:aef65eb3f06d64b552f38d57935cb5352"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the overall number of steps attribute. <br /></td></tr>
<tr class="separator:aef65eb3f06d64b552f38d57935cb5352"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae42ae51a450a823789f86b02bfbbcb0e"><td class="memItemLeft" align="right" valign="top"><a id="ae42ae51a450a823789f86b02bfbbcb0e"></a>
int &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_input.html#ae42ae51a450a823789f86b02bfbbcb0e">GetWriteOutputTimestep</a> () const</td></tr>
<tr class="memdesc:ae42ae51a450a823789f86b02bfbbcb0e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the Timestep defining when we write the output solution. <br /></td></tr>
<tr class="separator:ae42ae51a450a823789f86b02bfbbcb0e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a13947607d3f8e48c5d4db22d729f2674"><td class="memItemLeft" align="right" valign="top"><a id="a13947607d3f8e48c5d4db22d729f2674"></a>
vector&lt; vector&lt; double &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_input.html#a13947607d3f8e48c5d4db22d729f2674">GetInitialConditionMatrix</a> () const</td></tr>
<tr class="memdesc:a13947607d3f8e48c5d4db22d729f2674"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the initial condition matrix. <br /></td></tr>
<tr class="separator:a13947607d3f8e48c5d4db22d729f2674"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad4cbcaa4be06227c960cf30629af44ea"><td class="memItemLeft" align="right" valign="top"><a id="ad4cbcaa4be06227c960cf30629af44ea"></a>
vector&lt; vector&lt; double &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_input.html#ad4cbcaa4be06227c960cf30629af44ea">GetCoefficientMatrix</a> () const</td></tr>
<tr class="memdesc:ad4cbcaa4be06227c960cf30629af44ea"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the changing matrix corresponding to several states when the program run. <br /></td></tr>
<tr class="separator:ad4cbcaa4be06227c960cf30629af44ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab1813f72891b82c461ab2a075fbd8d00"><td class="memItemLeft" align="right" valign="top"><a id="ab1813f72891b82c461ab2a075fbd8d00"></a>
vector&lt; vector&lt; double &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_input.html#ab1813f72891b82c461ab2a075fbd8d00">GetFunctionMatrix</a> () const</td></tr>
<tr class="memdesc:ab1813f72891b82c461ab2a075fbd8d00"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the past step corresponding to i-1 for the function defining the problem. <br /></td></tr>
<tr class="separator:ab1813f72891b82c461ab2a075fbd8d00"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af2db35ba67c8a8ccd23bef6a482fc291"><td class="memItemLeft" align="right" valign="top"><a id="af2db35ba67c8a8ccd23bef6a482fc291"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_input.html#af2db35ba67c8a8ccd23bef6a482fc291">~Input</a> ()</td></tr>
<tr class="memdesc:af2db35ba67c8a8ccd23bef6a482fc291"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor allowing the liberation of memory. <br /></td></tr>
<tr class="separator:af2db35ba67c8a8ccd23bef6a482fc291"><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>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, <a class="el" href="class_input.html" title="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. ">Input</a> object needs 3 matrix to define the system : InitialConditionMatrix, CoefficientMatrix, FunctionMatrix. Matrix are defined to be vector of vector of double. <a class="el" href="class_input.html" title="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. ">Input</a> variables are given to the input class by the constructor. The other methods are getter allowing the access to theses private attributes. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a6e9028a0843a2db4271a4e3bf3eb941f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6e9028a0843a2db4271a4e3bf3eb941f">&#9670;&nbsp;</a></span>Input()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Input::Input </td>
<td>(</td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>time_step</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>dimension</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>order</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>number_steps</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>write_output_timestep</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const vector&lt; vector&lt; double &gt;&gt; &amp;&#160;</td>
<td class="paramname"><em>initial_condition_matrix</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const vector&lt; vector&lt; double &gt;&gt; &amp;&#160;</td>
<td class="paramname"><em>changing_matrix</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const vector&lt; vector&lt; double &gt;&gt; &amp;&#160;</td>
<td class="paramname"><em>past_step_matrix</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">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor of the class allowing the definition of the system. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">time_step</td><td>: Double representing the time step we will use in the ODE solver. </td></tr>
<tr><td class="paramname">dimension</td><td>: Integer representing the dimension of the system. </td></tr>
<tr><td class="paramname">order</td><td>: Integer representing the order of the system. </td></tr>
<tr><td class="paramname">number_steps</td><td>: Integer representing the overall number of steps we will do to solve the system. </td></tr>
<tr><td class="paramname">write_output_timestep</td><td>: Integer representing the steps when we write the solutions </td></tr>
<tr><td class="paramname">initial_condition_matrix</td><td>: Matrix (which is a vector of vector of double) representing the initial conditions of the system. </td></tr>
<tr><td class="paramname">changing_matrix</td><td>: Matrix (which is a vector of vector of double) containing the value of the function defining the system for all the step we want to compute. </td></tr>
<tr><td class="paramname">past_step_matrix</td><td>: Matrix (which is a vector of vector of double) allowing the definition of the RHS of the ODE. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ae6eae7ea32488c4ce43a027b3b2fabc2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae6eae7ea32488c4ce43a027b3b2fabc2">&#9670;&nbsp;</a></span>AskNumberToUser()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Input::AskNumberToUser </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Method allowing the asking of a number to the user. The user will enter this input number thank to the keyboard. </p>
<dl class="section return"><dt>Returns</dt><dd>: Returns the integer number given by the user. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="_input_8h_source.html">Input.h</a></li>
<li>Input.cpp</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="class_input.html">Input</a></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>

Event Timeline