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
|
<!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: DirichletBC Class 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_dirichlet_b_c.html">DirichletBC</a></div>
<h1>DirichletBC Class Reference<br>
<small>
[<a class="el" href="group__findiff.html">Finite-differences framework</a>]</small>
</h1><!-- doxytag: class="QuantLib::DirichletBC" --><!-- doxytag: inherits="QuantLib::BoundaryCondition" --><code>#include <ql/methods/finitedifferences/boundarycondition.hpp></code>
<p>
<div class="dynheader">
Inheritance diagram for DirichletBC:</div>
<div class="dynsection">
<p><center><img src="class_quant_lib_1_1_dirichlet_b_c__inherit__graph.png" border="0" usemap="#_dirichlet_b_c__inherit__map" alt="Inheritance graph"></center>
<map name="_dirichlet_b_c__inherit__map">
<area shape="rect" href="class_quant_lib_1_1_boundary_condition.html" title="Abstract boundary condition class for finite difference problems." alt="" coords="5,7,371,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="class_quant_lib_1_1_dirichlet_b_c-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Neumann boundary condition (i.e., constant value).
<p>
<dl compact><dt><b><a class="el" href="todo.html#_todo000030">Possible enhancements:</a></b></dt><dd>generalize to time-dependent conditions.</dd></dl>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="19ed68ccaf486a93eb99923d75523a29"></a><!-- doxytag: member="QuantLib::DirichletBC::DirichletBC" ref="19ed68ccaf486a93eb99923d75523a29" args="(Real value, Side side)" -->
</td><td class="memItemRight" valign="bottom"><b>DirichletBC</b> (<a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> value, <a class="el" href="class_quant_lib_1_1_boundary_condition.html#8c0137d7160ad71b6ed265c53c99ed00">Side</a> side)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b906412b49c195a549d177f62342ef0d"></a><!-- doxytag: member="QuantLib::DirichletBC::applyBeforeApplying" ref="b906412b49c195a549d177f62342ef0d" args="(TridiagonalOperator &) const " -->
void </td><td class="memItemRight" valign="bottom"><b>applyBeforeApplying</b> (<a class="el" href="class_quant_lib_1_1_tridiagonal_operator.html">TridiagonalOperator</a> &) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="518faf0242362b370a0b7686ed73f88c"></a><!-- doxytag: member="QuantLib::DirichletBC::applyAfterApplying" ref="518faf0242362b370a0b7686ed73f88c" args="(Array &) const " -->
void </td><td class="memItemRight" valign="bottom"><b>applyAfterApplying</b> (<a class="el" href="class_quant_lib_1_1_array.html">Array</a> &) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="64b4db3a4c8c7be8a29a179de646e929"></a><!-- doxytag: member="QuantLib::DirichletBC::applyBeforeSolving" ref="64b4db3a4c8c7be8a29a179de646e929" args="(TridiagonalOperator &, Array &rhs) const " -->
void </td><td class="memItemRight" valign="bottom"><b>applyBeforeSolving</b> (<a class="el" href="class_quant_lib_1_1_tridiagonal_operator.html">TridiagonalOperator</a> &, <a class="el" href="class_quant_lib_1_1_array.html">Array</a> &rhs) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7468ddf74a36a677b124dfcf09015a22"></a><!-- doxytag: member="QuantLib::DirichletBC::applyAfterSolving" ref="7468ddf74a36a677b124dfcf09015a22" args="(Array &) const " -->
void </td><td class="memItemRight" valign="bottom"><b>applyAfterSolving</b> (<a class="el" href="class_quant_lib_1_1_array.html">Array</a> &) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_dirichlet_b_c.html#6e60101b2af13783da6aa3d7cee67acb">setTime</a> (<a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a>)</td></tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="6e60101b2af13783da6aa3d7cee67acb"></a><!-- doxytag: member="QuantLib::DirichletBC::setTime" ref="6e60101b2af13783da6aa3d7cee67acb" args="(Time)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">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> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This method sets the current time for time-dependent boundary conditions.
<p>Implements <a class="el" href="class_quant_lib_1_1_boundary_condition.html#f133a9178f8e738a5e5c51670cb37b1a">BoundaryCondition</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>
|