solver_relaxation.h

Go to the documentation of this file.

// -----------------------------------------------------------------------------
//
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR LGPL-2.1-or-later
// Copyright (C) 2010 - 2024 by the deal.II authors
//
// This file is part of the deal.II library.
//
// Detailed license information governing the source code and contributions
// can be found in LICENSE.md and CONTRIBUTING.md at the top level directory.
//
// -----------------------------------------------------------------------------
 
#ifndef dealii_solver_relaxation_h
#define dealii_solver_relaxation_h
 
 
#include <deal.II/base/config.h>
 
#include <deal.II/base/enable_observer_pointer.h>
#include <deal.II/base/logstream.h>
#include <deal.II/base/template_constraints.h>
 
#include <deal.II/lac/solver.h>
#include <deal.II/lac/solver_control.h>
 
DEAL_II_NAMESPACE_OPEN
 
template <typename VectorType = Vector<double>>
DEAL_II_CXX20_REQUIRES(concepts::is_vector_space_vector<VectorType>)
class SolverRelaxation : public SolverBase<VectorType>
{
public:
  struct AdditionalData
  {};
 
  SolverRelaxation(SolverControl        &cn,
                   const AdditionalData &data = AdditionalData());
 
  template <typename MatrixType, typename RelaxationType>
  DEAL_II_CXX20_REQUIRES(
    (concepts::is_linear_operator_on<MatrixType, VectorType> &&
     requires(const RelaxationType &R, VectorType &a, VectorType &b) {
       R.step(a, b);
     }))
  void solve(const MatrixType     &A,
             VectorType           &x,
             const VectorType     &b,
             const RelaxationType &R);
};
 
//----------------------------------------------------------------------//
 
template <typename VectorType>
DEAL_II_CXX20_REQUIRES(concepts::is_vector_space_vector<VectorType>)
SolverRelaxation<VectorType>::SolverRelaxation(SolverControl &cn,
                                               const AdditionalData &)
  : SolverBase<VectorType>(cn)
{}
 
 
 
template <typename VectorType>
DEAL_II_CXX20_REQUIRES(concepts::is_vector_space_vector<VectorType>)
template <typename MatrixType, typename RelaxationType>
DEAL_II_CXX20_REQUIRES(
  (concepts::is_linear_operator_on<MatrixType, VectorType> &&
   requires(const RelaxationType &R, VectorType &a, VectorType &b) {
     R.step(a, b);
   }))
void SolverRelaxation<VectorType>::solve(const MatrixType     &A,
                                         VectorType           &x,
                                         const VectorType     &b,
                                         const RelaxationType &R)
{
  GrowingVectorMemory<VectorType> mem;
  SolverControl::State            conv = SolverControl::iterate;
 
  // Memory allocation
  typename VectorMemory<VectorType>::Pointer Vr(mem);
  VectorType                                &r = *Vr;
  r.reinit(x);
  typename VectorMemory<VectorType>::Pointer Vd(mem);
  VectorType                                &d = *Vd;
  d.reinit(x);
 
  LogStream::Prefix prefix("Relaxation");
 
  int iter = 0;
  // Main loop
  for (; conv == SolverControl::iterate; ++iter)
    {
      // Compute residual
      A.vmult(r, x);
      r.sadd(-1., 1., b);
 
      // The required norm of the
      // (preconditioned)
      // residual is computed in
      // criterion() and stored
      // in res.
      conv = this->iteration_status(iter, r.l2_norm(), x);
      if (conv != SolverControl::iterate)
        break;
      R.step(x, b);
    }
 
  // in case of failure: throw exception
  AssertThrow(conv == SolverControl::success,
              SolverControl::NoConvergence(iter, r.l2_norm()));
  // otherwise exit as normal
}
 
 
DEAL_II_NAMESPACE_CLOSE
 
#endif