QuantLib: a free/open-source library for quantitative finance
Fully annotated sources - version 1.32
Loading...
Searching...
No Matches
Public Member Functions | Private Attributes | List of all members
DirichletBC Class Reference

Neumann boundary condition (i.e., constant value) More...

#include <ql/methods/finitedifferences/boundarycondition.hpp>

+ Inheritance diagram for DirichletBC:
+ Collaboration diagram for DirichletBC:

Public Member Functions

 DirichletBC (Real value, Side side)
 
void applyBeforeApplying (TridiagonalOperator &) const override
 
void applyAfterApplying (Array &) const override
 
void applyBeforeSolving (TridiagonalOperator &, Array &rhs) const override
 
void applyAfterSolving (Array &) const override
 
void setTime (Time) override
 
- Public Member Functions inherited from BoundaryCondition< TridiagonalOperator >
virtual ~BoundaryCondition ()=default
 
virtual void applyBeforeApplying (operator_type &) const=0
 
virtual void applyAfterApplying (array_type &) const=0
 
virtual void applyBeforeSolving (operator_type &, array_type &rhs) const=0
 
virtual void applyAfterSolving (array_type &) const=0
 
virtual void setTime (Time t)=0
 

Private Attributes

Real value_
 
Side side_
 

Additional Inherited Members

- Public Types inherited from BoundaryCondition< TridiagonalOperator >
enum  Side
 
typedef TridiagonalOperator operator_type
 
typedef Operator::array_type array_type
 

Detailed Description

Neumann boundary condition (i.e., constant value)

Definition at line 96 of file boundarycondition.hpp.

Constructor & Destructor Documentation

◆ DirichletBC()

DirichletBC ( Real  value,
Side  side 
)

Definition at line 73 of file boundarycondition.cpp.

Member Function Documentation

◆ applyBeforeApplying()

void applyBeforeApplying ( TridiagonalOperator ) const
overridevirtual

This method modifies an operator \( L \) before it is applied to an array \( u \) so that \( v = Lu \) will satisfy the given condition.

Implements BoundaryCondition< TridiagonalOperator >.

Definition at line 76 of file boundarycondition.cpp.

+ Here is the call graph for this function:

◆ applyAfterApplying()

void applyAfterApplying ( Array u) const
override

Definition at line 89 of file boundarycondition.cpp.

+ Here is the call graph for this function:

◆ applyBeforeSolving()

void applyBeforeSolving ( TridiagonalOperator L,
Array rhs 
) const
override

Definition at line 102 of file boundarycondition.cpp.

+ Here is the call graph for this function:

◆ applyAfterSolving()

void applyAfterSolving ( Array ) const
override

Definition at line 118 of file boundarycondition.cpp.

◆ setTime()

void setTime ( Time  t)
overridevirtual

This method sets the current time for time-dependent boundary conditions.

Implements BoundaryCondition< TridiagonalOperator >.

Definition at line 104 of file boundarycondition.hpp.

Member Data Documentation

◆ value_

Real value_
private

Definition at line 107 of file boundarycondition.hpp.

◆ side_

Side side_
private

Definition at line 108 of file boundarycondition.hpp.