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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<meta name="robots" content="none">
<title>QuantLib: BoundaryCondition Class Template Reference</title>
<link rel="stylesheet" href="quantlib.css" type="text/css">
<link rel="stylesheet" href="print.css" type="text/css" media="print">
<link rel="shortcut icon" href="favicon.ico" type="image/x-icon">
<link rel="icon" href="favicon.ico" type="image/x-icon">
</head>
<body>
<div id="container">
<div id="header">
<img class="titleimage"
src="QL-title.jpg" width="212" height="47" border="0"
alt="QuantLib">
<br>
<h3 class="subtitle">A free/open-source library for quantitative finance</h3>
</div>
<div id="menu">
<h3 class="navbartitle">Version 0.9.0</h3>
<hr>
<h3 class="navbartitle">Getting started</h3>
<ul class="navbarlist">
<li class="navlink"><a href="index.html">Introduction</a></li>
<li class="navlink"><a href="overview.html">Project overview</a></li>
<li class="navlink"><a href="where.html">Where to get QuantLib</a></li>
<li class="navlink"><a href="install.html">Installation</a></li>
<li class="navlink"><a href="config.html">Configuration</a></li>
<li class="navlink"><a href="usage.html">Usage</a></li>
<li class="navlink"><a href="history.html">Version history</a></li>
<li class="navlink"><a href="resources.html">Additional resources</a></li>
<li class="navlink"><a href="group.html">The QuantLib group</a></li>
<li class="navlink"><a href="license.html">Copyright and license</a></li>
</ul>
<hr>
<h3 class="navbartitle">Reference manual</h3>
<ul class="navbarlist">
<li class="navlink"><a href="modules.html">Modules</a></li>
<li class="navlink"><a href="hierarchy.html">Class Hierarchy</a></li>
<li class="navlink"><a href="annotated.html">Compound List</a></li>
<li class="navlink"><a href="files.html">File List</a></li>
<li class="navlink"><a href="functions.html">Compound Members</a></li>
<li class="navlink"><a href="globals.html">File Members</a></li>
<li class="navlink"><a href="bug.html">Known Bugs</a></li>
<li class="navlink"><a href="caveats.html">Caveats</a></li>
<li class="navlink"><a href="test.html">Test Suite</a></li>
<li class="navlink"><a href="examples.html">Examples</a></li>
</ul>
</div>
<div id="content">
<!--Doxygen-generated content-->
<!-- Generated by Doxygen 1.5.4 -->
<div class="nav">
<a class="el" href="namespace_quant_lib.html">QuantLib</a>::<a class="el" href="class_quant_lib_1_1_boundary_condition.html">BoundaryCondition</a></div>
<h1>BoundaryCondition Class Template Reference<br>
<small>
[<a class="el" href="group__findiff.html">Finite-differences framework</a>]</small>
</h1><!-- doxytag: class="QuantLib::BoundaryCondition" --><code>#include <ql/methods/finitedifferences/boundarycondition.hpp></code>
<p>
<div class="dynheader">
Inheritance diagram for BoundaryCondition:</div>
<div class="dynsection">
<p><center><img src="class_quant_lib_1_1_boundary_condition__inherit__graph.png" border="0" usemap="#_boundary_condition__inherit__map" alt="Inheritance graph"></center>
<map name="_boundary_condition__inherit__map">
<area shape="rect" href="class_quant_lib_1_1_dirichlet_b_c.html" title="Neumann boundary condition (i.e., constant value)." alt="" coords="207,5,521,32"><area shape="rect" href="class_quant_lib_1_1_neumann_b_c.html" title="Neumann boundary condition (i.e., constant derivative)." alt="" coords="201,56,527,83"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="class_quant_lib_1_1_boundary_condition-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template<class Operator><br>
class QuantLib::BoundaryCondition< Operator ></h3>
Abstract boundary condition class for finite difference problems.
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_boundary_condition.html#8c0137d7160ad71b6ed265c53c99ed00">Side</a> { <b>None</b>,
<b>Upper</b>,
<b>Lower</b>
}</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="158330dcc465dcd323e801d462791ac4"></a><!-- doxytag: member="QuantLib::BoundaryCondition::operator_type" ref="158330dcc465dcd323e801d462791ac4" args="" -->
typedef Operator </td><td class="memItemRight" valign="bottom"><b>operator_type</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="736e8d4a0263c9dd7a6f33aa7615c767"></a><!-- doxytag: member="QuantLib::BoundaryCondition::array_type" ref="736e8d4a0263c9dd7a6f33aa7615c767" args="" -->
typedef Operator::array_type </td><td class="memItemRight" valign="bottom"><b>array_type</b></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_boundary_condition.html#54cb24c54bd6209f5050ff45f49f5c4d">applyBeforeApplying</a> (operator_type &) const =0</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_boundary_condition.html#d39ad7ad5ed0434b46036b0179e225f6">applyAfterApplying</a> (array_type &) const =0</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_boundary_condition.html#3b7d9d45ad90d4008c468da1fa4261f0">applyBeforeSolving</a> (operator_type &, array_type &rhs) const =0</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_boundary_condition.html#22a8d3cbef1d118eda60ed4c5e8cf6a9">applyAfterSolving</a> (array_type &) const =0</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_boundary_condition.html#f133a9178f8e738a5e5c51670cb37b1a">setTime</a> (<a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a> t)=0</td></tr>
</table>
<hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="8c0137d7160ad71b6ed265c53c99ed00"></a><!-- doxytag: member="QuantLib::BoundaryCondition::Side" ref="8c0137d7160ad71b6ed265c53c99ed00" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="class_quant_lib_1_1_boundary_condition.html#8c0137d7160ad71b6ed265c53c99ed00">Side</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl compact><dt><b><a class="el" href="todo.html#_todo000031">Possible enhancements:</a></b></dt><dd>Generalize for n-dimensional conditions </dd></dl>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="54cb24c54bd6209f5050ff45f49f5c4d"></a><!-- doxytag: member="QuantLib::BoundaryCondition::applyBeforeApplying" ref="54cb24c54bd6209f5050ff45f49f5c4d" args="(operator_type &) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void applyBeforeApplying </td>
<td>(</td>
<td class="paramtype">operator_type & </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This method modifies an operator <img class="formulaInl" alt="$ L $" src="form_50.png"> before it is applied to an array <img class="formulaInl" alt="$ u $" src="form_203.png"> so that <img class="formulaInl" alt="$ v = Lu $" src="form_204.png"> will satisfy the given condition.
</div>
</div><p>
<a class="anchor" name="d39ad7ad5ed0434b46036b0179e225f6"></a><!-- doxytag: member="QuantLib::BoundaryCondition::applyAfterApplying" ref="d39ad7ad5ed0434b46036b0179e225f6" args="(array_type &) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void applyAfterApplying </td>
<td>(</td>
<td class="paramtype">array_type & </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This method modifies an array <img class="formulaInl" alt="$ u $" src="form_203.png"> so that it satisfies the given condition.
</div>
</div><p>
<a class="anchor" name="3b7d9d45ad90d4008c468da1fa4261f0"></a><!-- doxytag: member="QuantLib::BoundaryCondition::applyBeforeSolving" ref="3b7d9d45ad90d4008c468da1fa4261f0" args="(operator_type &, array_type &rhs) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void applyBeforeSolving </td>
<td>(</td>
<td class="paramtype">operator_type & </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">array_type & </td>
<td class="paramname"> <em>rhs</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This method modifies an operator <img class="formulaInl" alt="$ L $" src="form_50.png"> before the linear system <img class="formulaInl" alt="$ Lu' = u $" src="form_205.png"> is solved so that <img class="formulaInl" alt="$ u' $" src="form_206.png"> will satisfy the given condition.
</div>
</div><p>
<a class="anchor" name="22a8d3cbef1d118eda60ed4c5e8cf6a9"></a><!-- doxytag: member="QuantLib::BoundaryCondition::applyAfterSolving" ref="22a8d3cbef1d118eda60ed4c5e8cf6a9" args="(array_type &) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void applyAfterSolving </td>
<td>(</td>
<td class="paramtype">array_type & </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This method modifies an array <img class="formulaInl" alt="$ u $" src="form_203.png"> so that it satisfies the given condition.
</div>
</div><p>
<a class="anchor" name="f133a9178f8e738a5e5c51670cb37b1a"></a><!-- doxytag: member="QuantLib::BoundaryCondition::setTime" ref="f133a9178f8e738a5e5c51670cb37b1a" args="(Time t)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void setTime </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a> </td>
<td class="paramname"> <em>t</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This method sets the current time for time-dependent boundary conditions.
<p>Implemented in <a class="el" href="class_quant_lib_1_1_neumann_b_c.html#6e60101b2af13783da6aa3d7cee67acb">NeumannBC</a>, and <a class="el" href="class_quant_lib_1_1_dirichlet_b_c.html#6e60101b2af13783da6aa3d7cee67acb">DirichletBC</a>.</p>
</div>
</div><p>
</div>
<div class="footer">
<div class="endmatter">
Documentation generated by
<a href="http://www.doxygen.org">Doxygen</a> 1.5.4
</div>
</div>
</div>
</body>
</html>
|
