amg_petsc.h

Go to the documentation of this file.

//-----------------------------------------------------------
//
//    Copyright (C) 2015 by the deal2lkit authors
//
//    This file is part of the deal2lkit library.
//
//    The deal2lkit library is free software; you can use it, redistribute
//    it, and/or modify it under the terms of the GNU Lesser General
//    Public License as published by the Free Software Foundation; either
//    version 2.1 of the License, or (at your option) any later version.
//    The full text of the license can be found in the file LICENSE at
//    the top level of the deal2lkit distribution.
//
//-----------------------------------------------------------
 
#ifndef amg_petsc_preconditioner_h
#define amg_petsc_preconditioner_h
 
#include <deal.II/base/config.h>
 
#ifdef DEAL_II_WITH_PETSC
 
#  include <deal.II/base/parameter_acceptor.h>
 
#  include <deal.II/lac/petsc_precondition.h>
 
namespace ParsedLAC
{
  class PETScAMGPreconditioner
    : public dealii::ParameterAcceptor,
      public dealii::PETScWrappers::PreconditionBoomerAMG
  {
  public:
    using RelaxationType = dealii::PETScWrappers::PreconditionBoomerAMG::
      AdditionalData::RelaxationType;
    PETScAMGPreconditioner(
      const std::string   &name                             = "",
      const bool           symmetric_operator               = false,
      const double         strong_threshold                 = 0.25,
      const double         max_row_sum                      = 0.9,
      const unsigned int   aggressive_coarsening_num_levels = 0,
      const bool           output_details                   = false,
      const RelaxationType relaxation_type_up   = RelaxationType::SORJacobi,
      const RelaxationType relaxation_type_down = RelaxationType::SORJacobi,
      const RelaxationType relaxation_type_coarse =
        RelaxationType::GaussianElimination,
      const unsigned int n_sweeps_coarse = 1,
      const double       tol             = 0.0,
      const unsigned int max_iter        = 1,
      const bool         w_cycle         = false);
 
    void
    initialize(const dealii::PETScWrappers::MatrixBase &matrix);
 
  private:
    void
    add_parameters();
 
    bool symmetric_operator;
 
    double strong_threshold;
 
    double max_row_sum;
 
    unsigned int aggressive_coarsening_num_levels;
 
    bool output_details;
 
    RelaxationType relaxation_type_up;
 
    RelaxationType relaxation_type_down;
 
    RelaxationType relaxation_type_coarse;
 
    unsigned int n_sweeps_coarse;
 
    double tol;
 
    unsigned int max_iter;
 
    bool w_cycle;
  };
 
 
} // namespace ParsedLAC
 
#endif // DEAL_II_WITH_PETSC
 
#endif