CGLinearSolver.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 dftefeCGLinearSolver_h
#define dftefeCGLinearSolver_h
 
#include <utils/TypeConfig.h>
#include <utils/MemorySpaceType.h>
#include <linearAlgebra/LinearAlgebraTypes.h>
#include <linearAlgebra/LinearAlgebraProfiler.h>
#include <linearAlgebra/LinearSolverImpl.h>
#include <linearAlgebra/LinearSolverFunction.h>
 
namespace dftefe
{
  namespace linearAlgebra
  {
    template <typename ValueTypeOperator,
              typename ValueTypeOperand,
              utils::MemorySpace memorySpace>
    class CGLinearSolver : public LinearSolverImpl<ValueTypeOperator,
                                                   ValueTypeOperand,
                                                   memorySpace>
    {
    public:
      CGLinearSolver(const size_type       maxIter,
                     const double          absoluteTol,
                     const double          relativeTol,
                     const double          divergenceTol,
                     LinearAlgebraProfiler profiler = LinearAlgebraProfiler());
 
      ~CGLinearSolver() = default;
 
      LinearSolverError
      solve(
        LinearSolverFunction<ValueTypeOperator, ValueTypeOperand, memorySpace>
          &linearSolverFunction) override;
 
    private:
      LinearAlgebraProfiler d_profiler;
      size_type             d_maxIter;
      double                d_absoluteTol;
      double                d_relativeTol;
      double                d_divergenceTol;
    }; // end of class CGLinearSolver
  }    // end of namespace linearAlgebra
} // end of namespace dftefe
#include <linearAlgebra/CGLinearSolver.t.cpp>
#endif // dftefeCGLinearSolver_h