-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathBoundary_8h_source.html
More file actions
110 lines (108 loc) · 15.2 KB
/
Boundary_8h_source.html
File metadata and controls
110 lines (108 loc) · 15.2 KB
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
<!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.11"/>
<title>openPSTD: /home/omar/Software/cpp/openPSTD/kernel/core/Boundary.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="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/javascript">
$(document).ready(function() { init_search(); });
</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="projectlogo"><img alt="Logo" src="logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">openPSTD
 <span id="projectnumber">2.0</span>
</div>
<div id="projectbrief">Open source simulation for sound propagation in urban environments</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="kernelstructure.html"><span>Kernel Structure</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</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_dc43877d82dd332f9fb2071fcca799d6.html">kernel</a></li><li class="navelem"><a class="el" href="dir_5215f8c381c24c03346eeeea66185b9a.html">core</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">Boundary.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// This file is part of openPSTD. //</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> <span class="comment">// openPSTD is free software: you can redistribute it and/or modify //</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// it under the terms of the GNU General Public License as published by //</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">// the Free Software Foundation, either version 3 of the License, or //</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// (at your option) any later version. //</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">// //</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// openPSTD is distributed in the hope that it will be useful, //</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">// but WITHOUT ANY WARRANTY; without even the implied warranty of //</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the //</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// GNU General Public License for more details. //</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// //</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// You should have received a copy of the GNU General Public License //</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// along with openPSTD. If not, see <http://www.gnu.org/licenses/>. //</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">// //</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"></span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">//</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">// Date: 17-9-15</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">//</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">//</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">// Authors: 0mar Richardson</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">//</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">//</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">// Purpose: Modelling boundaries between domains.</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">//</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment">//</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"></span><span class="preprocessor">#ifndef OPENPSTD_BOUNDARY_H</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#define OPENPSTD_BOUNDARY_H</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">#include "Domain.h"</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="keyword">namespace </span><a class="code" href="namespaceOpenPSTD.html">OpenPSTD</a></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> {</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keyword">namespace </span>Kernel</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  {</div><div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="classOpenPSTD_1_1Kernel_1_1Boundary.html"> 48</a></span>  <span class="keyword">class </span><a class="code" href="classOpenPSTD_1_1Kernel_1_1Boundary.html">Boundary</a></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  {</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="classOpenPSTD_1_1Kernel_1_1Boundary.html#aa333d1644132e21e371707fe371bb734"> 52</a></span>  std::shared_ptr<Domain> <a class="code" href="classOpenPSTD_1_1Kernel_1_1Boundary.html#aa333d1644132e21e371707fe371bb734">domain1</a>;</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div><div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="classOpenPSTD_1_1Kernel_1_1Boundary.html#a368179eebcda5301858583cd33e0562f"> 55</a></span>  std::shared_ptr<Domain> <a class="code" href="classOpenPSTD_1_1Kernel_1_1Boundary.html#a368179eebcda5301858583cd33e0562f">domain2</a>;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div><div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="classOpenPSTD_1_1Kernel_1_1Boundary.html#a7bb1ddfd5ace3e69066f94a25fa136f4"> 58</a></span>  <a class="code" href="namespaceOpenPSTD_1_1Kernel.html#a0f823ca4b06f6f755fdded496aabd876">CalcDirection</a> <a class="code" href="classOpenPSTD_1_1Kernel_1_1Boundary.html#a7bb1ddfd5ace3e69066f94a25fa136f4">type</a>;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <a class="code" href="classOpenPSTD_1_1Kernel_1_1Boundary.html#a6fda0708a5402fa5cec401b05437cdd9">Boundary</a>(std::shared_ptr<Domain> domain1, std::shared_ptr<Domain> domain2, <a class="code" href="namespaceOpenPSTD_1_1Kernel.html#a0f823ca4b06f6f755fdded496aabd876">CalcDirection</a> type);</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  };</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  }</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> }</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> </div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="preprocessor">#endif //OPENPSTD_BOUNDARY_H</span></div><div class="ttc" id="namespaceOpenPSTD_html"><div class="ttname"><a href="namespaceOpenPSTD.html">OpenPSTD</a></div><div class="ttdoc">This is the general namespace of the OpenPSTD application. </div><div class="ttdef"><b>Definition:</b> Boundary.cpp:33</div></div>
<div class="ttc" id="namespaceOpenPSTD_1_1Kernel_html_a0f823ca4b06f6f755fdded496aabd876"><div class="ttname"><a href="namespaceOpenPSTD_1_1Kernel.html#a0f823ca4b06f6f755fdded496aabd876">OpenPSTD::Kernel::CalcDirection</a></div><div class="ttdeci">CalcDirection</div><div class="ttdoc">Helper enums - used to distinguish horizontal boundaries from vertical boundaries. </div><div class="ttdef"><b>Definition:</b> kernel_functions.h:71</div></div>
<div class="ttc" id="classOpenPSTD_1_1Kernel_1_1Boundary_html_a368179eebcda5301858583cd33e0562f"><div class="ttname"><a href="classOpenPSTD_1_1Kernel_1_1Boundary.html#a368179eebcda5301858583cd33e0562f">OpenPSTD::Kernel::Boundary::domain2</a></div><div class="ttdeci">std::shared_ptr< Domain > domain2</div><div class="ttdoc">Second of the domains separated by the boundary. </div><div class="ttdef"><b>Definition:</b> Boundary.h:55</div></div>
<div class="ttc" id="classOpenPSTD_1_1Kernel_1_1Boundary_html"><div class="ttname"><a href="classOpenPSTD_1_1Kernel_1_1Boundary.html">OpenPSTD::Kernel::Boundary</a></div><div class="ttdoc">Models a boundary between two domains. </div><div class="ttdef"><b>Definition:</b> Boundary.h:48</div></div>
<div class="ttc" id="classOpenPSTD_1_1Kernel_1_1Boundary_html_a7bb1ddfd5ace3e69066f94a25fa136f4"><div class="ttname"><a href="classOpenPSTD_1_1Kernel_1_1Boundary.html#a7bb1ddfd5ace3e69066f94a25fa136f4">OpenPSTD::Kernel::Boundary::type</a></div><div class="ttdeci">CalcDirection type</div><div class="ttdoc">Whether the boundary is used for horizontal or vertical computations. </div><div class="ttdef"><b>Definition:</b> Boundary.h:58</div></div>
<div class="ttc" id="classOpenPSTD_1_1Kernel_1_1Boundary_html_aa333d1644132e21e371707fe371bb734"><div class="ttname"><a href="classOpenPSTD_1_1Kernel_1_1Boundary.html#aa333d1644132e21e371707fe371bb734">OpenPSTD::Kernel::Boundary::domain1</a></div><div class="ttdeci">std::shared_ptr< Domain > domain1</div><div class="ttdoc">First of the domains separated by the boundary. </div><div class="ttdef"><b>Definition:</b> Boundary.h:52</div></div>
<div class="ttc" id="classOpenPSTD_1_1Kernel_1_1Boundary_html_a6fda0708a5402fa5cec401b05437cdd9"><div class="ttname"><a href="classOpenPSTD_1_1Kernel_1_1Boundary.html#a6fda0708a5402fa5cec401b05437cdd9">OpenPSTD::Kernel::Boundary::Boundary</a></div><div class="ttdeci">Boundary(std::shared_ptr< Domain > domain1, std::shared_ptr< Domain > domain2, CalcDirection type)</div><div class="ttdoc">Creates a boundary of given type between the given domains, together with its orientation. </div><div class="ttdef"><b>Definition:</b> Boundary.cpp:36</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Mar 2 2016 23:11:55 for openPSTD by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>