AmrSmoother.h

Go to the documentation of this file.

//
// Class AmrSmoother
//   Interface to Ifpack2 smoothers of the Trilinos package.
//
// Copyright (c) 2017 - 2020, Matthias Frey, Paul Scherrer Institut, Villigen PSI, Switzerland
// All rights reserved
//
// Implemented as part of the PhD thesis
// "Precise Simulations of Multibunches in High Intensity Cyclotrons"
//
// This file is part of OPAL.
//
// OPAL is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// You should have received a copy of the GNU General Public License
// along with OPAL. If not, see <https://www.gnu.org/licenses/>.
//
#ifndef AMR_SMOOTHER_H
#define AMR_SMOOTHER_H
 
#include <string>
 
#include "AmrMultiGridDefs.h"
 
#include "Ifpack2_Factory.hpp"
 
class AmrSmoother {
    
public:
    typedef amr::global_ordinal_t   go_t;
    typedef amr::local_ordinal_t    lo_t;
    typedef amr::scalar_t           scalar_t;
    typedef amr::node_t             node_t;
    typedef amr::matrix_t           matrix_t;
    typedef amr::vector_t           vector_t;
    typedef Ifpack2::Preconditioner<scalar_t,
                                    lo_t,
                                    go_t,
                                    node_t
            > preconditioner_t;
    
    enum Smoother {
        GAUSS_SEIDEL = 0,
        SGS,    // symmetric Gauss-Seidel
        JACOBI //,
//         SOR
    };
    
public:
    AmrSmoother(const Teuchos::RCP<const matrix_t>& A,
                const Smoother& smoother,
                lo_t nSweeps);
    
    ~AmrSmoother();
    
    void smooth(const Teuchos::RCP<vector_t>& x,
                const Teuchos::RCP<vector_t>& b);
    
    static Smoother convertToEnumSmoother(const std::string& smoother);
    
private:
    void initParameter_m(const Smoother& smoother,
                         lo_t nSweeps);
    
    
private:
    Teuchos::RCP<preconditioner_t> prec_mp;
    
    Teuchos::RCP<Teuchos::ParameterList> params_mp;
};
 
#endif