SolverTypes.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 dftefeSolverTypes_h
#define dftefeSolverTypes_h
 
namespace dftefe
{
  namespace linearAlgebra
  {
    enum class LinearSolverType
    {
      CG
      // For future: GMRES, MINRES, BICG, etc
      //
    };
 
    enum class PCType
    {
      NONE,
      JACOBI
      // Add more sophisticated ones later
    };
 
    enum class LinearSolverReturnType
    {
      SUCCESS,          // The linear solve was successful
      FAILURE,          // generic, no reason known
      MAX_ITER_REACHED, // Max. iteration provided by the user reached before
                        // convergence
      INDEFINITE_PC,    // the preconditioner is usually assumed to be positive
                        // definite
      NAN_RES, // NaN or infinite values found in the evaluation of residual
               // norm
    };
  } // end of namespace linearAlgebra
} // end of namespace dftefe
#endif // dftefeSolverTypes_h