JacobiPreconditioner.h

Go to the documentation of this file.

/******************************************************************************
 * Copyright (c) 2021.                                                        *
 * The Regents of the University of Michigan and DFT-EFE developers.          *
 *                                                                            *
 * This file is part of the DFT-EFE code.                                     *
 *                                                                            *
 * DFT-EFE is free software: you can redistribute it and/or modify            *
 *   it under the terms of the Lesser GNU General Public License as           *
 *   published by the Free Software Foundation, either version 3 of           *
 *   the License, or (at your option) any later version.                      *
 *                                                                            *
 * DFT-EFE is distributed in the hope that it will be useful, but             *
 *   WITHOUT ANY WARRANTY; without even the implied warranty                  *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.                     *
 *   See the Lesser GNU General Public License for more details.              *
 *                                                                            *
 * You should have received a copy of the GNU Lesser General Public           *
 *   License at the top level of DFT-EFE distribution.  If not, see           *
 *   <https://www.gnu.org/licenses/>.                                         *
 ******************************************************************************/
 
/*
 * @author Bikash Kanungo
 */
 
#ifndef dftefeJacobiPreconditioner_h
#define dftefeJacobiPreconditioner_h
 
#include <linearAlgebra/Vector.h>
#include <linearAlgebra/Preconditioner.h>
#include <utils/MemorySpaceType.h>
namespace dftefe
{
  namespace linearAlgebra
  {
    template <typename ValueType, utils::MemorySpace memorySpace>
    class JacobiPreconditioner : public Preconditioner<ValueType, memorySpace>
    {
    public:
      JacobiPreconditioner(const Vector<ValueType, memorySpace> &diagVector);
 
      ~JacobiPreconditioner() = default;
 
      void
      apply(Vector<ValueType, memorySpace> &x) const override;
 
      Vector<ValueType, memorySpace>
      apply(const Vector<ValueType, memorySpace> &x) const override;
 
    private:
      Vector<ValueType, memorySpace> d_invDiagVector;
    };
  } // end of namespace linearAlgebra
} // end of namespace dftefe
#endif // dftefeJacobiPreconditioner_h