← Back to branch summary

~ubuntu-branches/ubuntu/raring/quantlib-refman-html/raring

« back to all changes in this revision

Viewing changes to html/class_quant_lib_1_1_dirichlet_b_c.html

  • Committer: Package Import Robot
  • Author(s): Dirk Eddelbuettel
  • Date: 2012-03-31 10:10:45 UTC
  • mfrom: (1.2.14)
  • Revision ID: package-import@ubuntu.com-20120331101045-60ilq20a9um9bzx3
Tags: 1.2-1
* New upstream release

* As before, re-packaged upstream file QuantLib-docs-1.2.html.tar.gz 
  as described in the copyright file included with the Debian package.

* debian/control: Updated Standards-Version: to current version 

Show diffs side-by-side

added added

removed removed

Lines of Context:
html/class_quant_lib_1_1_dirichlet_b_c.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
5
5
<meta name="robots" content="none">
6
 
<title>QuantLib: DirichletBC Class Reference</title>
 
6
<title>DirichletBC Class Reference</title>
7
7
<link rel="stylesheet" href="quantlib.css" type="text/css">
8
8
<link rel="stylesheet" href="print.css" type="text/css" media="print">
9
9
<link rel="shortcut icon" href="favicon.ico" type="image/x-icon">
21
21
</div>
22
22
<div id="menu">
23
23
 
24
 
<h3 class="navbartitle">Version 1.1</h3>
 
24
<h3 class="navbartitle">Version 1.2</h3>
25
25
 
26
26
<hr>
27
27
 
59
59
<div id="content">
60
60
<!--Doxygen-generated content-->
61
61
 
62
 
<!-- Generated by Doxygen 1.7.3 -->
 
62
<!-- Generated by Doxygen 1.7.6.1 -->
63
63
  <div id="nav-path" class="navpath">
64
64
    <ul>
65
65
      <li class="navelem"><b>QuantLib</b>      </li>
66
66
      <li class="navelem"><a class="el" href="class_quant_lib_1_1_dirichlet_b_c.html">DirichletBC</a>      </li>
 
67
    </ul>
 
68
  </div>
67
69
</div>
68
70
<div class="header">
69
71
  <div class="summary">
70
72
<a href="#pub-methods">Public Member Functions</a>  </div>
71
73
  <div class="headertitle">
72
 
<h1>DirichletBC Class Reference<div class="ingroups"><a class="el" href="group__findiff.html">Finite-differences framework</a></div></h1>  </div>
73
 
</div>
 
74
<div class="title">DirichletBC Class Reference<div class="ingroups"><a class="el" href="group__findiff.html">Finite-differences framework</a></div></div>  </div>
 
75
</div><!--header-->
74
76
<div class="contents">
75
77
<!-- doxytag: class="QuantLib::DirichletBC" --><!-- doxytag: inherits="BoundaryCondition&lt; TridiagonalOperator &gt;" -->
76
78
<p>Neumann boundary condition (i.e., constant value)  
77
 
<a href="#_details">More...</a></p>
 
79
 <a href="class_quant_lib_1_1_dirichlet_b_c.html#details">More...</a></p>
78
80
 
79
81
<p><code>#include &lt;ql/methods/finitedifferences/boundarycondition.hpp&gt;</code></p>
80
82
<div class="dynheader">
97
99
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_dirichlet_b_c.html#a7468ddf74a36a677b124dfcf09015a22">applyAfterSolving</a> (<a class="el" href="class_quant_lib_1_1_array.html">Array</a> &amp;) const </td></tr>
98
100
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_dirichlet_b_c.html#a6e60101b2af13783da6aa3d7cee67acb">setTime</a> (<a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a>)</td></tr>
99
101
</table>
100
 
<hr/><a name="_details"></a><h2>Detailed Description</h2>
 
102
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
101
103
<div class="textblock"><p>Neumann boundary condition (i.e., constant value) </p>
102
 
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000042">Possible enhancements:</a></b></dt><dd>generalize to time-dependent conditions.</dd></dl>
 
104
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000043">Possible enhancements:</a></b></dt><dd>generalize to time-dependent conditions.</dd></dl>
103
105
</div><hr/><h2>Member Function Documentation</h2>
104
106
<a class="anchor" id="ab906412b49c195a549d177f62342ef0d"></a><!-- doxytag: member="QuantLib::DirichletBC::applyBeforeApplying" ref="ab906412b49c195a549d177f62342ef0d" args="(TridiagonalOperator &amp;) const " -->
105
107
<div class="memitem">
106
108
<div class="memproto">
107
109
      <table class="memname">
108
110
        <tr>
109
 
          <td class="memname">void applyBeforeApplying </td>
 
111
          <td class="memname">void <a class="el" href="class_quant_lib_1_1_dirichlet_b_c.html#ab906412b49c195a549d177f62342ef0d">applyBeforeApplying</a> </td>
110
112
          <td>(</td>
111
113
          <td class="paramtype"><a class="el" href="class_quant_lib_1_1_tridiagonal_operator.html">TridiagonalOperator</a> &amp;&#160;</td>
112
114
          <td class="paramname"></td><td>)</td>
115
117
      </table>
116
118
</div>
117
119
<div class="memdoc">
118
 
<p>This method modifies an operator <img class="formulaInl" alt="$ L $" src="form_46.png"/> before it is applied to an array <img class="formulaInl" alt="$ u $" src="form_268.png"/> so that <img class="formulaInl" alt="$ v = Lu $" src="form_269.png"/> will satisfy the given condition. </p>
 
120
<p>This method modifies an operator <img class="formulaInl" alt="$ L $" src="form_46.png"/> before it is applied to an array <img class="formulaInl" alt="$ u $" src="form_271.png"/> so that <img class="formulaInl" alt="$ v = Lu $" src="form_272.png"/> will satisfy the given condition. </p>
119
121
 
120
122
<p>Implements <a class="el" href="class_quant_lib_1_1_boundary_condition.html#a54cb24c54bd6209f5050ff45f49f5c4d">BoundaryCondition&lt; TridiagonalOperator &gt;</a>.</p>
121
123
 
126
128
<div class="memproto">
127
129
      <table class="memname">
128
130
        <tr>
129
 
          <td class="memname">void applyAfterApplying </td>
 
131
          <td class="memname">void <a class="el" href="class_quant_lib_1_1_dirichlet_b_c.html#a518faf0242362b370a0b7686ed73f88c">applyAfterApplying</a> </td>
130
132
          <td>(</td>
131
133
          <td class="paramtype"><a class="el" href="class_quant_lib_1_1_array.html">Array</a> &amp;&#160;</td>
132
134
          <td class="paramname"></td><td>)</td>
135
137
      </table>
136
138
</div>
137
139
<div class="memdoc">
138
 
<p>This method modifies an array <img class="formulaInl" alt="$ u $" src="form_268.png"/> so that it satisfies the given condition. </p>
 
140
<p>This method modifies an array <img class="formulaInl" alt="$ u $" src="form_271.png"/> so that it satisfies the given condition. </p>
139
141
 
140
142
<p>Implements <a class="el" href="class_quant_lib_1_1_boundary_condition.html#ad39ad7ad5ed0434b46036b0179e225f6">BoundaryCondition&lt; TridiagonalOperator &gt;</a>.</p>
141
143
 
146
148
<div class="memproto">
147
149
      <table class="memname">
148
150
        <tr>
149
 
          <td class="memname">void applyBeforeSolving </td>
 
151
          <td class="memname">void <a class="el" href="class_quant_lib_1_1_dirichlet_b_c.html#a64b4db3a4c8c7be8a29a179de646e929">applyBeforeSolving</a> </td>
150
152
          <td>(</td>
151
153
          <td class="paramtype"><a class="el" href="class_quant_lib_1_1_tridiagonal_operator.html">TridiagonalOperator</a> &amp;&#160;</td>
152
154
          <td class="paramname">, </td>
165
167
      </table>
166
168
</div>
167
169
<div class="memdoc">
168
 
<p>This method modifies an operator <img class="formulaInl" alt="$ L $" src="form_46.png"/> before the linear system <img class="formulaInl" alt="$ Lu' = u $" src="form_270.png"/> is solved so that <img class="formulaInl" alt="$ u' $" src="form_271.png"/> will satisfy the given condition. </p>
 
170
<p>This method modifies an operator <img class="formulaInl" alt="$ L $" src="form_46.png"/> before the linear system <img class="formulaInl" alt="$ Lu' = u $" src="form_273.png"/> is solved so that <img class="formulaInl" alt="$ u' $" src="form_274.png"/> will satisfy the given condition. </p>
169
171
 
170
172
<p>Implements <a class="el" href="class_quant_lib_1_1_boundary_condition.html#a3b7d9d45ad90d4008c468da1fa4261f0">BoundaryCondition&lt; TridiagonalOperator &gt;</a>.</p>
171
173
 
176
178
<div class="memproto">
177
179
      <table class="memname">
178
180
        <tr>
179
 
          <td class="memname">void applyAfterSolving </td>
 
181
          <td class="memname">void <a class="el" href="class_quant_lib_1_1_dirichlet_b_c.html#a7468ddf74a36a677b124dfcf09015a22">applyAfterSolving</a> </td>
180
182
          <td>(</td>
181
183
          <td class="paramtype"><a class="el" href="class_quant_lib_1_1_array.html">Array</a> &amp;&#160;</td>
182
184
          <td class="paramname"></td><td>)</td>
185
187
      </table>
186
188
</div>
187
189
<div class="memdoc">
188
 
<p>This method modifies an array <img class="formulaInl" alt="$ u $" src="form_268.png"/> so that it satisfies the given condition. </p>
 
190
<p>This method modifies an array <img class="formulaInl" alt="$ u $" src="form_271.png"/> so that it satisfies the given condition. </p>
189
191
 
190
192
<p>Implements <a class="el" href="class_quant_lib_1_1_boundary_condition.html#a22a8d3cbef1d118eda60ed4c5e8cf6a9">BoundaryCondition&lt; TridiagonalOperator &gt;</a>.</p>
191
193
 
196
198
<div class="memproto">
197
199
      <table class="memname">
198
200
        <tr>
199
 
          <td class="memname">void setTime </td>
 
201
          <td class="memname">void <a class="el" href="class_quant_lib_1_1_dirichlet_b_c.html#a6e60101b2af13783da6aa3d7cee67acb">setTime</a> </td>
200
202
          <td>(</td>
201
203
          <td class="paramtype"><a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a>&#160;</td>
202
204
          <td class="paramname"><em>t</em></td><td>)</td>
211
213
 
212
214
</div>
213
215
</div>
214
 
</div>
 
216
</div><!-- contents -->
215
217
 
216
218
</div>
217
219
 
218
220
<div class="footer">
219
221
<div class="endmatter">
220
222
Documentation generated by
221
 
<a href="http://www.doxygen.org">Doxygen</a> 1.7.3
 
223
<a href="http://www.doxygen.org">Doxygen</a> 1.7.6.1
222
224
</div>
223
225
</div>
224
226