DUNE-FEM (unstable)

preconditioner.hh
1// SPDX-FileCopyrightText: Copyright © DUNE Project contributors, see file LICENSE.md in module root
2// SPDX-License-Identifier: LicenseRef-GPL-2.0-only-with-DUNE-exception
3// -*- tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
4// vi: set et ts=4 sw=2 sts=2:
5#ifndef DUNE_ISTL_PRECONDITIONER_HH
6#define DUNE_ISTL_PRECONDITIONER_HH
7
8#include <dune-istl-config.hh> // DUNE_ISTL_SUPPORT_OLD_CATEGORY_INTERFACE
10
11#include "solvercategory.hh"
12
13namespace Dune {
18 //=====================================================================
31 //=====================================================================
32 template<class X, class Y>
34 public:
36 typedef X domain_type;
38 typedef Y range_type;
40 typedef typename X::field_type field_type;
41
70 virtual void pre (X& x, Y& b) = 0;
71
82 virtual void apply (X& v, const Y& d) = 0;
83
92 virtual void post (X& x) = 0;
93
96#if DUNE_ISTL_SUPPORT_OLD_CATEGORY_INTERFACE
97 {
98 DUNE_THROW(Dune::Exception,"It is necessary to implement the category method in a derived classes, in the future this method will pure virtual.");
99 }
100#else
101 = 0;
102#endif
103
105 virtual ~Preconditioner () {}
106
107 };
108
112}
113#endif
Base class for Dune-Exceptions.
Definition: exceptions.hh:96
Base class for matrix free definition of preconditioners.
Definition: preconditioner.hh:33
virtual void post(X &x)=0
Clean up.
virtual void apply(X &v, const Y &d)=0
Apply one step of the preconditioner to the system A(v)=d.
virtual ~Preconditioner()
every abstract base class has a virtual destructor
Definition: preconditioner.hh:105
Y range_type
The range type of the preconditioner.
Definition: preconditioner.hh:38
X domain_type
The domain type of the preconditioner.
Definition: preconditioner.hh:36
virtual SolverCategory::Category category() const =0
Category of the preconditioner (see SolverCategory::Category)
X::field_type field_type
The field type of the preconditioner.
Definition: preconditioner.hh:40
virtual void pre(X &x, Y &b)=0
Prepare the preconditioner.
A few common exception classes.
#define DUNE_THROW(E, m)
Definition: exceptions.hh:218
Dune namespace.
Definition: alignedallocator.hh:13
Category
Definition: solvercategory.hh:23
Creative Commons License   |  Legal Statements / Impressum  |  Hosted by TU Dresden  |  generated with Hugo v0.111.3 (Nov 21, 23:30, 2024)