← Back to branch summary

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

« back to all changes in this revision

Viewing changes to html/class_quant_lib_1_1_boundary_condition.html

  • Committer: Package Import Robot
  • Author(s): Dirk Eddelbuettel
  • Date: 2015-07-12 10:50:34 UTC
  • mfrom: (1.2.15)
  • Revision ID: package-import@ubuntu.com-20150712105034-pejpkaou89lhme9j
Tags: 1.6-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/rules: Added target 'patch' to sustitute reference to external
  MathJax.js with a local file URI.
* debian/control: Added Suggests: on libjs-mathjax and javascript-common

* debian/missing-sources/jquery.js: Added

* 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_boundary_condition.html
1
 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
 
<html>
 
1
<!-- HTML header for doxygen 1.8.9.1-->
 
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 
3
<html xmlns="http://www.w3.org/1999/xhtml">
3
4
<head>
4
 
<meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
5
 
<meta name="robots" content="none">
6
 
<title>BoundaryCondition&lt; Operator &gt; Class Template Reference</title>
7
 
<link rel="stylesheet" href="quantlib.css" type="text/css">
8
 
<link rel="stylesheet" href="print.css" type="text/css" media="print">
9
 
<link rel="shortcut icon" href="favicon.ico" type="image/x-icon">
10
 
<link rel="icon" href="favicon.ico" type="image/x-icon">
 
5
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 
6
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
 
7
<meta name="generator" content="Doxygen 1.8.9.1"/>
 
8
<title>QuantLib: BoundaryCondition&lt; Operator &gt; Class Template Reference</title>
 
9
<link href='http://fonts.googleapis.com/css?family=Merriweather+Sans:800' rel='stylesheet' type='text/css'>
 
10
<link href="tabs.css" rel="stylesheet" type="text/css"/>
 
11
<script type="text/javascript" src="jquery.js"></script>
 
12
<script type="text/javascript" src="dynsections.js"></script>
 
13
<link href="search/search.css" rel="stylesheet" type="text/css"/>
 
14
<script type="text/javascript" src="search/search.js"></script>
 
15
<script type="text/javascript">
 
16
  $(document).ready(function() {
 
17
    if ($('.searchresults').length > 0) { searchBox.DOMSearchField().focus(); }
 
18
  });
 
19
</script>
 
20
<link rel="search" href="search_opensearch.php?v=opensearch.xml" type="application/opensearchdescription+xml" title="QuantLib"/>
 
21
<script type="text/x-mathjax-config">
 
22
  MathJax.Hub.Config({
 
23
    extensions: ["tex2jax.js"],
 
24
    jax: ["input/TeX","output/HTML-CSS"],
 
25
});
 
26
</script><script src="file://usr/share/javascript/mathjax/MathJax.js"></script>
 
27
<link href="doxygen.css" rel="stylesheet" type="text/css" />
 
28
<link href="quantlibextra.css" rel="stylesheet" type="text/css"/>
11
29
</head>
12
30
<body>
13
 
 
14
 
<div id="container">
15
 
<div id="header">
16
 
<img class="titleimage"
17
 
 src="QL-title.jpg" width="185" height="50" border="0"
18
 
 alt="QuantLib">
19
 
<br>
20
 
<h3 class="subtitle">A free/open-source library for quantitative finance</h3>
21
 
</div>
22
 
<div id="menu">
23
 
 
24
 
<h3 class="navbartitle">Version 1.2</h3>
25
 
 
26
 
<hr>
27
 
 
28
 
<h3 class="navbartitle">Getting started</h3>
29
 
<ul class="navbarlist">
30
 
<li class="navlink"><a href="index.html">Introduction</a></li>
31
 
<li class="navlink"><a href="where.html">Where to get QuantLib</a></li>
32
 
<li class="navlink"><a href="install.html">Installation</a></li>
33
 
<li class="navlink"><a href="config.html">Configuration</a></li>
34
 
<li class="navlink"><a href="usage.html">Usage</a></li>
35
 
<li class="navlink"><a href="history.html">Version history</a></li>
36
 
<li class="navlink"><a href="resources.html">Additional resources</a></li>
37
 
<li class="navlink"><a href="group.html">The QuantLib group</a></li>
38
 
<li class="navlink"><a href="license.html">Copyright and license</a></li>
39
 
</ul>
40
 
 
41
 
<hr>
42
 
 
43
 
<h3 class="navbartitle">Reference manual</h3>
44
 
<ul class="navbarlist">
45
 
<li class="navlink"><a href="modules.html">Modules</a></li>
46
 
<li class="navlink"><a href="hierarchy.html">Class Hierarchy</a></li>
47
 
<li class="navlink"><a href="annotated.html">Compound List</a></li>
48
 
<li class="navlink"><a href="files.html">File List</a></li>
49
 
<li class="navlink"><a href="functions.html">Compound Members</a></li>
50
 
<li class="navlink"><a href="globals.html">File Members</a></li>
51
 
<li class="navlink"><a href="todo.html">Todo List</a></li>
52
 
<li class="navlink"><a href="bug.html">Known Bugs</a></li>
53
 
<li class="navlink"><a href="caveats.html">Caveats</a></li>
54
 
<li class="navlink"><a href="test.html">Test Suite</a></li>
55
 
<li class="navlink"><a href="examples.html">Examples</a></li>
56
 
</ul>
57
 
</div>
58
 
 
59
 
<div id="content">
60
 
<!--Doxygen-generated content-->
61
 
 
62
 
<!-- Generated by Doxygen 1.7.6.1 -->
63
 
  <div id="nav-path" class="navpath">
64
 
    <ul>
65
 
      <li class="navelem"><b>QuantLib</b>      </li>
66
 
      <li class="navelem"><a class="el" href="class_quant_lib_1_1_boundary_condition.html">BoundaryCondition</a>      </li>
67
 
    </ul>
68
 
  </div>
69
 
</div>
 
31
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
 
32
<div id="titlearea">
 
33
<table cellspacing="0" cellpadding="0">
 
34
 <tbody>
 
35
 <tr style="height: 56px;">
 
36
  <td style="padding-left: 0.5em;">
 
37
   <div id="projectname"><a href="http://quantlib.org">
 
38
       <img alt="QuantLib" src="QL-title.jpg"></a>
 
39
   <div id="projectbrief">A free/open-source library for quantitative finance</div>
 
40
   <div id="projectnumber">Reference manual - version 1.6</div>
 
41
   </div>
 
42
  </td>
 
43
 </tr>
 
44
 </tbody>
 
45
</table>
 
46
</div>
 
47
<!-- end header part -->
 
48
<!-- Generated by Doxygen 1.8.9.1 -->
 
49
<script type="text/javascript">
 
50
var searchBox = new SearchBox("searchBox", "search",false,'Search');
 
51
</script>
 
52
  <div id="navrow1" class="tabs">
 
53
    <ul class="tablist">
 
54
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
 
55
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
 
56
      <li><a href="modules.html"><span>Modules</span></a></li>
 
57
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
 
58
      <li><a href="examples.html"><span>Examples</span></a></li>
 
59
      <li>
 
60
        <div id="MSearchBox" class="MSearchBoxInactive">
 
61
          <div class="left">
 
62
            <form id="FSearchBox" action="search.php" method="get">
 
63
              <img id="MSearchSelect" src="search/mag.png" alt=""/>
 
64
              <input type="text" id="MSearchField" name="query" value="Search" size="20" accesskey="S" 
 
65
                     onfocus="searchBox.OnSearchFieldFocus(true)" 
 
66
                     onblur="searchBox.OnSearchFieldFocus(false)"/>
 
67
            </form>
 
68
          </div><div class="right"></div>
 
69
        </div>
 
70
      </li>
 
71
    </ul>
 
72
  </div>
 
73
  <div id="navrow2" class="tabs2">
 
74
    <ul class="tablist">
 
75
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
 
76
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
 
77
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
 
78
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
 
79
    </ul>
 
80
  </div>
 
81
<div id="nav-path" class="navpath">
 
82
  <ul>
 
83
<li class="navelem"><a class="el" href="namespace_quant_lib.html">QuantLib</a></li><li class="navelem"><a class="el" href="class_quant_lib_1_1_boundary_condition.html">BoundaryCondition</a></li>  </ul>
 
84
</div>
 
85
</div><!-- top -->
70
86
<div class="header">
71
87
  <div class="summary">
72
88
<a href="#pub-types">Public Types</a> &#124;
73
 
<a href="#pub-methods">Public Member Functions</a>  </div>
 
89
<a href="#pub-methods">Public Member Functions</a> &#124;
 
90
<a href="class_quant_lib_1_1_boundary_condition-members.html">List of all members</a>  </div>
74
91
  <div class="headertitle">
75
 
<div class="title">BoundaryCondition&lt; Operator &gt; Class Template Reference<div class="ingroups"><a class="el" href="group__findiff.html">Finite-differences framework</a></div></div>  </div>
 
92
<div class="title">BoundaryCondition&lt; Operator &gt; Class Template Reference<span class="mlabels"><span class="mlabel">abstract</span></span><div class="ingroups"><a class="el" href="group__findiff.html">Finite-differences framework</a></div></div>  </div>
76
93
</div><!--header-->
77
94
<div class="contents">
78
 
<!-- doxytag: class="QuantLib::BoundaryCondition" -->
 
95
 
79
96
<p>Abstract boundary condition class for finite difference problems.  
80
97
 <a href="class_quant_lib_1_1_boundary_condition.html#details">More...</a></p>
81
98
 
82
99
<p><code>#include &lt;ql/methods/finitedifferences/boundarycondition.hpp&gt;</code></p>
83
 
 
84
 
<p><a href="class_quant_lib_1_1_boundary_condition-members.html">List of all members.</a></p>
85
100
<table class="memberdecls">
86
 
<tr><td colspan="2"><h2><a name="pub-types"></a>
 
101
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
87
102
Public Types</h2></td></tr>
88
 
<tr><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_boundary_condition.html#a8c0137d7160ad71b6ed265c53c99ed00">Side</a> { <b>None</b>, 
 
103
<tr class="memitem:ga8c0137d7160ad71b6ed265c53c99ed00"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__findiff.html#ga8c0137d7160ad71b6ed265c53c99ed00">Side</a> { <b>None</b>, 
89
104
<b>Upper</b>, 
90
105
<b>Lower</b>
91
106
 }</td></tr>
92
 
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a158330dcc465dcd323e801d462791ac4"></a><!-- doxytag: member="QuantLib::BoundaryCondition::operator_type" ref="a158330dcc465dcd323e801d462791ac4" args="" -->
 
107
<tr class="separator:ga8c0137d7160ad71b6ed265c53c99ed00"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
108
<tr class="memitem:a158330dcc465dcd323e801d462791ac4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a158330dcc465dcd323e801d462791ac4"></a>
93
109
typedef Operator&#160;</td><td class="memItemRight" valign="bottom"><b>operator_type</b></td></tr>
94
 
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a736e8d4a0263c9dd7a6f33aa7615c767"></a><!-- doxytag: member="QuantLib::BoundaryCondition::array_type" ref="a736e8d4a0263c9dd7a6f33aa7615c767" args="" -->
 
110
<tr class="separator:a158330dcc465dcd323e801d462791ac4"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
111
<tr class="memitem:a736e8d4a0263c9dd7a6f33aa7615c767"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a736e8d4a0263c9dd7a6f33aa7615c767"></a>
95
112
typedef Operator::array_type&#160;</td><td class="memItemRight" valign="bottom"><b>array_type</b></td></tr>
96
 
<tr><td colspan="2"><h2><a name="pub-methods"></a>
 
113
<tr class="separator:a736e8d4a0263c9dd7a6f33aa7615c767"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
114
</table><table class="memberdecls">
 
115
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
97
116
Public Member Functions</h2></td></tr>
98
 
<tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_boundary_condition.html#a54cb24c54bd6209f5050ff45f49f5c4d">applyBeforeApplying</a> (operator_type &amp;) const =0</td></tr>
99
 
<tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_boundary_condition.html#ad39ad7ad5ed0434b46036b0179e225f6">applyAfterApplying</a> (array_type &amp;) const =0</td></tr>
100
 
<tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_boundary_condition.html#a3b7d9d45ad90d4008c468da1fa4261f0">applyBeforeSolving</a> (operator_type &amp;, array_type &amp;rhs) const =0</td></tr>
101
 
<tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_boundary_condition.html#a22a8d3cbef1d118eda60ed4c5e8cf6a9">applyAfterSolving</a> (array_type &amp;) const =0</td></tr>
102
 
<tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_boundary_condition.html#af133a9178f8e738a5e5c51670cb37b1a">setTime</a> (<a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a> t)=0</td></tr>
 
117
<tr class="memitem:a54cb24c54bd6209f5050ff45f49f5c4d"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_boundary_condition.html#a54cb24c54bd6209f5050ff45f49f5c4d">applyBeforeApplying</a> (operator_type &amp;) const =0</td></tr>
 
118
<tr class="separator:a54cb24c54bd6209f5050ff45f49f5c4d"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
119
<tr class="memitem:ad39ad7ad5ed0434b46036b0179e225f6"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_boundary_condition.html#ad39ad7ad5ed0434b46036b0179e225f6">applyAfterApplying</a> (array_type &amp;) const =0</td></tr>
 
120
<tr class="separator:ad39ad7ad5ed0434b46036b0179e225f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
121
<tr class="memitem:a3b7d9d45ad90d4008c468da1fa4261f0"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_boundary_condition.html#a3b7d9d45ad90d4008c468da1fa4261f0">applyBeforeSolving</a> (operator_type &amp;, array_type &amp;rhs) const =0</td></tr>
 
122
<tr class="separator:a3b7d9d45ad90d4008c468da1fa4261f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
123
<tr class="memitem:a22a8d3cbef1d118eda60ed4c5e8cf6a9"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_boundary_condition.html#a22a8d3cbef1d118eda60ed4c5e8cf6a9">applyAfterSolving</a> (array_type &amp;) const =0</td></tr>
 
124
<tr class="separator:a22a8d3cbef1d118eda60ed4c5e8cf6a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
125
<tr class="memitem:af133a9178f8e738a5e5c51670cb37b1a"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_boundary_condition.html#af133a9178f8e738a5e5c51670cb37b1a">setTime</a> (<a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a> t)=0</td></tr>
 
126
<tr class="separator:af133a9178f8e738a5e5c51670cb37b1a"><td class="memSeparator" colspan="2">&#160;</td></tr>
103
127
</table>
104
 
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
105
 
<div class="textblock"><h3>template&lt;class Operator&gt;<br/>
 
128
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 
129
<div class="textblock"><h3>template&lt;class Operator&gt;<br />
106
130
class QuantLib::BoundaryCondition&lt; Operator &gt;</h3>
107
131
 
108
132
<p>Abstract boundary condition class for finite difference problems. </p>
109
 
</div><hr/><h2>Member Enumeration Documentation</h2>
110
 
<a class="anchor" id="a8c0137d7160ad71b6ed265c53c99ed00"></a><!-- doxytag: member="QuantLib::BoundaryCondition::Side" ref="a8c0137d7160ad71b6ed265c53c99ed00" args="" -->
111
 
<div class="memitem">
112
 
<div class="memproto">
113
 
      <table class="memname">
114
 
        <tr>
115
 
          <td class="memname">enum <a class="el" href="class_quant_lib_1_1_boundary_condition.html#a8c0137d7160ad71b6ed265c53c99ed00">Side</a></td>
116
 
        </tr>
117
 
      </table>
118
 
</div>
119
 
<div class="memdoc">
120
 
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000044">Possible enhancements:</a></b></dt><dd>Generalize for n-dimensional conditions </dd></dl>
121
 
 
122
 
</div>
123
 
</div>
124
 
<hr/><h2>Member Function Documentation</h2>
125
 
<a class="anchor" id="a54cb24c54bd6209f5050ff45f49f5c4d"></a><!-- doxytag: member="QuantLib::BoundaryCondition::applyBeforeApplying" ref="a54cb24c54bd6209f5050ff45f49f5c4d" args="(operator_type &amp;) const =0" -->
126
 
<div class="memitem">
127
 
<div class="memproto">
128
 
      <table class="memname">
129
 
        <tr>
130
 
          <td class="memname">virtual void <a class="el" href="class_quant_lib_1_1_boundary_condition.html#a54cb24c54bd6209f5050ff45f49f5c4d">applyBeforeApplying</a> </td>
 
133
</div><h2 class="groupheader">Member Function Documentation</h2>
 
134
<a class="anchor" id="a54cb24c54bd6209f5050ff45f49f5c4d"></a>
 
135
<div class="memitem">
 
136
<div class="memproto">
 
137
<table class="mlabels">
 
138
  <tr>
 
139
  <td class="mlabels-left">
 
140
      <table class="memname">
 
141
        <tr>
 
142
          <td class="memname">virtual void applyBeforeApplying </td>
131
143
          <td>(</td>
132
144
          <td class="paramtype">operator_type &amp;&#160;</td>
133
145
          <td class="paramname"></td><td>)</td>
134
 
          <td> const<code> [pure virtual]</code></td>
 
146
          <td> const</td>
135
147
        </tr>
136
148
      </table>
137
 
</div>
138
 
<div class="memdoc">
139
 
<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>
 
149
  </td>
 
150
  <td class="mlabels-right">
 
151
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
 
152
  </tr>
 
153
</table>
 
154
</div><div class="memdoc">
 
155
<p>This method modifies an operator \( L \) before it is applied to an array \( u \) so that \( v = Lu \) will satisfy the given condition. </p>
140
156
 
141
157
<p>Implemented in <a class="el" href="class_quant_lib_1_1_dirichlet_b_c.html#ab906412b49c195a549d177f62342ef0d">DirichletBC</a>, and <a class="el" href="class_quant_lib_1_1_neumann_b_c.html#ab906412b49c195a549d177f62342ef0d">NeumannBC</a>.</p>
142
158
 
143
159
</div>
144
160
</div>
145
 
<a class="anchor" id="ad39ad7ad5ed0434b46036b0179e225f6"></a><!-- doxytag: member="QuantLib::BoundaryCondition::applyAfterApplying" ref="ad39ad7ad5ed0434b46036b0179e225f6" args="(array_type &amp;) const =0" -->
 
161
<a class="anchor" id="ad39ad7ad5ed0434b46036b0179e225f6"></a>
146
162
<div class="memitem">
147
163
<div class="memproto">
 
164
<table class="mlabels">
 
165
  <tr>
 
166
  <td class="mlabels-left">
148
167
      <table class="memname">
149
168
        <tr>
150
 
          <td class="memname">virtual void <a class="el" href="class_quant_lib_1_1_boundary_condition.html#ad39ad7ad5ed0434b46036b0179e225f6">applyAfterApplying</a> </td>
 
169
          <td class="memname">virtual void applyAfterApplying </td>
151
170
          <td>(</td>
152
171
          <td class="paramtype">array_type &amp;&#160;</td>
153
172
          <td class="paramname"></td><td>)</td>
154
 
          <td> const<code> [pure virtual]</code></td>
 
173
          <td> const</td>
155
174
        </tr>
156
175
      </table>
157
 
</div>
158
 
<div class="memdoc">
159
 
<p>This method modifies an array <img class="formulaInl" alt="$ u $" src="form_271.png"/> so that it satisfies the given condition. </p>
 
176
  </td>
 
177
  <td class="mlabels-right">
 
178
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
 
179
  </tr>
 
180
</table>
 
181
</div><div class="memdoc">
 
182
<p>This method modifies an array \( u \) so that it satisfies the given condition. </p>
160
183
 
161
184
<p>Implemented in <a class="el" href="class_quant_lib_1_1_dirichlet_b_c.html#a518faf0242362b370a0b7686ed73f88c">DirichletBC</a>, and <a class="el" href="class_quant_lib_1_1_neumann_b_c.html#a518faf0242362b370a0b7686ed73f88c">NeumannBC</a>.</p>
162
185
 
163
186
</div>
164
187
</div>
165
 
<a class="anchor" id="a3b7d9d45ad90d4008c468da1fa4261f0"></a><!-- doxytag: member="QuantLib::BoundaryCondition::applyBeforeSolving" ref="a3b7d9d45ad90d4008c468da1fa4261f0" args="(operator_type &amp;, array_type &amp;rhs) const =0" -->
 
188
<a class="anchor" id="a3b7d9d45ad90d4008c468da1fa4261f0"></a>
166
189
<div class="memitem">
167
190
<div class="memproto">
 
191
<table class="mlabels">
 
192
  <tr>
 
193
  <td class="mlabels-left">
168
194
      <table class="memname">
169
195
        <tr>
170
 
          <td class="memname">virtual void <a class="el" href="class_quant_lib_1_1_boundary_condition.html#a3b7d9d45ad90d4008c468da1fa4261f0">applyBeforeSolving</a> </td>
 
196
          <td class="memname">virtual void applyBeforeSolving </td>
171
197
          <td>(</td>
172
198
          <td class="paramtype">operator_type &amp;&#160;</td>
173
199
          <td class="paramname">, </td>
181
207
        <tr>
182
208
          <td></td>
183
209
          <td>)</td>
184
 
          <td></td><td> const<code> [pure virtual]</code></td>
 
210
          <td></td><td> const</td>
185
211
        </tr>
186
212
      </table>
187
 
</div>
188
 
<div class="memdoc">
189
 
<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>
 
213
  </td>
 
214
  <td class="mlabels-right">
 
215
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
 
216
  </tr>
 
217
</table>
 
218
</div><div class="memdoc">
 
219
<p>This method modifies an operator \( L \) before the linear system \( Lu&#39; = u \) is solved so that \( u&#39; \) will satisfy the given condition. </p>
190
220
 
191
221
<p>Implemented in <a class="el" href="class_quant_lib_1_1_dirichlet_b_c.html#a64b4db3a4c8c7be8a29a179de646e929">DirichletBC</a>, and <a class="el" href="class_quant_lib_1_1_neumann_b_c.html#a64b4db3a4c8c7be8a29a179de646e929">NeumannBC</a>.</p>
192
222
 
193
223
</div>
194
224
</div>
195
 
<a class="anchor" id="a22a8d3cbef1d118eda60ed4c5e8cf6a9"></a><!-- doxytag: member="QuantLib::BoundaryCondition::applyAfterSolving" ref="a22a8d3cbef1d118eda60ed4c5e8cf6a9" args="(array_type &amp;) const =0" -->
 
225
<a class="anchor" id="a22a8d3cbef1d118eda60ed4c5e8cf6a9"></a>
196
226
<div class="memitem">
197
227
<div class="memproto">
 
228
<table class="mlabels">
 
229
  <tr>
 
230
  <td class="mlabels-left">
198
231
      <table class="memname">
199
232
        <tr>
200
 
          <td class="memname">virtual void <a class="el" href="class_quant_lib_1_1_boundary_condition.html#a22a8d3cbef1d118eda60ed4c5e8cf6a9">applyAfterSolving</a> </td>
 
233
          <td class="memname">virtual void applyAfterSolving </td>
201
234
          <td>(</td>
202
235
          <td class="paramtype">array_type &amp;&#160;</td>
203
236
          <td class="paramname"></td><td>)</td>
204
 
          <td> const<code> [pure virtual]</code></td>
 
237
          <td> const</td>
205
238
        </tr>
206
239
      </table>
207
 
</div>
208
 
<div class="memdoc">
209
 
<p>This method modifies an array <img class="formulaInl" alt="$ u $" src="form_271.png"/> so that it satisfies the given condition. </p>
 
240
  </td>
 
241
  <td class="mlabels-right">
 
242
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
 
243
  </tr>
 
244
</table>
 
245
</div><div class="memdoc">
 
246
<p>This method modifies an array \( u \) so that it satisfies the given condition. </p>
210
247
 
211
248
<p>Implemented in <a class="el" href="class_quant_lib_1_1_dirichlet_b_c.html#a7468ddf74a36a677b124dfcf09015a22">DirichletBC</a>, and <a class="el" href="class_quant_lib_1_1_neumann_b_c.html#a7468ddf74a36a677b124dfcf09015a22">NeumannBC</a>.</p>
212
249
 
213
250
</div>
214
251
</div>
215
 
<a class="anchor" id="af133a9178f8e738a5e5c51670cb37b1a"></a><!-- doxytag: member="QuantLib::BoundaryCondition::setTime" ref="af133a9178f8e738a5e5c51670cb37b1a" args="(Time t)=0" -->
 
252
<a class="anchor" id="af133a9178f8e738a5e5c51670cb37b1a"></a>
216
253
<div class="memitem">
217
254
<div class="memproto">
 
255
<table class="mlabels">
 
256
  <tr>
 
257
  <td class="mlabels-left">
218
258
      <table class="memname">
219
259
        <tr>
220
 
          <td class="memname">virtual void <a class="el" href="class_quant_lib_1_1_boundary_condition.html#af133a9178f8e738a5e5c51670cb37b1a">setTime</a> </td>
 
260
          <td class="memname">virtual void setTime </td>
221
261
          <td>(</td>
222
262
          <td class="paramtype"><a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a>&#160;</td>
223
263
          <td class="paramname"><em>t</em></td><td>)</td>
224
 
          <td><code> [pure virtual]</code></td>
 
264
          <td></td>
225
265
        </tr>
226
266
      </table>
227
 
</div>
228
 
<div class="memdoc">
 
267
  </td>
 
268
  <td class="mlabels-right">
 
269
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
 
270
  </tr>
 
271
</table>
 
272
</div><div class="memdoc">
229
273
<p>This method sets the current time for time-dependent boundary conditions. </p>
230
274
 
231
275
<p>Implemented in <a class="el" href="class_quant_lib_1_1_dirichlet_b_c.html#a6e60101b2af13783da6aa3d7cee67acb">DirichletBC</a>, and <a class="el" href="class_quant_lib_1_1_neumann_b_c.html#a6e60101b2af13783da6aa3d7cee67acb">NeumannBC</a>.</p>
233
277
</div>
234
278
</div>
235
279
</div><!-- contents -->
236
 
 
237
 
</div>
238
 
 
239
 
<div class="footer">
240
 
<div class="endmatter">
241
 
Documentation generated by
242
 
<a href="http://www.doxygen.org">Doxygen</a> 1.7.6.1
243
 
</div>
244
 
</div>
245
 
 
246
 
</div>
247
 
 
 
280
<!-- HTML footer for doxygen 1.8.9.1-->
 
281
<!-- start footer part -->
 
282
<hr class="footer"/><address class="footer"><small>
 
283
Generated by <a href="http://www.doxygen.org/index.html">Doxygen</a>
 
284
1.8.9.1
 
285
</small></address>
248
286
</body>
249
287
</html>