NewtonRaphsonSolver.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 Avirup Sircar
 */
 
#ifndef dftefeNewtonRaphsonSolver_h
#define dftefeNewtonRaphsonSolver_h
 
#include <utils/TypeConfig.h>
#include <linearAlgebra/LinearAlgebraTypes.h>
#include <linearAlgebra/NewtonRaphsonSolverFunction.h>
 
namespace dftefe
{
  namespace linearAlgebra
  {
    template <typename ValueType>
    class NewtonRaphsonSolver
    {
    public:
      NewtonRaphsonSolver(const size_type maxIter,
                          const double    tolerance,
                          const double    forceTolerance);
 
      ~NewtonRaphsonSolver() = default;
 
      NewtonRaphsonError
      solve(
        NewtonRaphsonSolverFunction<ValueType> &newtonRaphsonSolverFunction);
 
      ValueType
      getResidual();
 
    private:
      size_type d_maxIter;
      double    d_tolerance;
      double    d_forceTolerance;
      ValueType d_residual;
      bool      d_isSolved;
    }; // end of class NewtonRaphsonSolver
  }    // end of namespace linearAlgebra
} // end of namespace dftefe
#include <linearAlgebra/NewtonRaphsonSolver.t.cpp>
#endif // dftefeNewtonRaphsonSolver_h