QuantLib: a free/open-source library for quantitative finance
fully annotated source code - version 1.34
Loading...
Searching...
No Matches
cranknicolsonscheme.hpp
Go to the documentation of this file.
1/* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2
3/*
4 Copyright (C) 2019 Klaus Spanderen
5
6 This file is part of QuantLib, a free-software/open-source library
7 for financial quantitative analysts and developers - http://quantlib.org/
8
9 QuantLib is free software: you can redistribute it and/or modify it
10 under the terms of the QuantLib license. You should have received a
11 copy of the license along with this program; if not, please email
12 <quantlib-dev@lists.sf.net>. The license is also available online at
13 <http://quantlib.org/license.shtml>.
14
15 This program is distributed in the hope that it will be useful, but WITHOUT
16 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
17 FOR A PARTICULAR PURPOSE. See the license for more details.
18*/
19
20/*! \file cranknicolsonscheme.hpp
21 \brief Crank-Nicolson scheme
22*/
23
24#ifndef quantlib_crank_nicolson_scheme_hpp
25#define quantlib_crank_nicolson_scheme_hpp
26
28
29namespace QuantLib {
30
31 /*! In one dimension the Crank-Nicolson scheme is equivalent to the
32 Douglas scheme and in higher dimensions it is usually inferior to
33 operator splitting methods like Craig-Sneyd or Hundsdorfer-Verwer.
34 */
35 class ExplicitEulerScheme;
36
38 public:
39 // typedefs
45
46 // constructors
48 Real theta,
49 const ext::shared_ptr<FdmLinearOpComposite>& map,
50 const bc_set& bcSet = bc_set(),
51 Real relTol = 1e-8,
54
55 void step(array_type& a, Time t);
56 void setStep(Time dt);
57
59 protected:
61 const Real theta_;
62 const ext::shared_ptr<ExplicitEulerScheme> explicit_;
63 const ext::shared_ptr<ImplicitEulerScheme> implicit_;
64 };
65}
66
67#endif
traits::operator_type operator_type
const ext::shared_ptr< ImplicitEulerScheme > implicit_
traits::condition_type condition_type
OperatorTraits< FdmLinearOp > traits
void step(array_type &a, Time t)
const ext::shared_ptr< ExplicitEulerScheme > explicit_
std::vector< ext::shared_ptr< bc_type > > bc_set
Operator::array_type array_type
condition to be applied at every time step
const DefaultType & t
Real Time
continuous quantity with 1-year units
Definition: types.hpp:62
QL_REAL Real
real number
Definition: types.hpp:50
std::size_t Size
size of a container
Definition: types.hpp:58
Real theta
Implicit-Euler scheme.
Definition: any.hpp:35