LinearSolverFunction.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 dftefeLinearSolverFunction_h
#define dftefeLinearSolverFunction_h
 
#include <utils/TypeConfig.h>
#include <utils/MemorySpaceType.h>
#include <utils/MPITypes.h>
#include <linearAlgebra/Vector.h>
#include <linearAlgebra/MultiVector.h>
#include <linearAlgebra/OperatorContext.h>
#include <linearAlgebra/BlasLapackTypedef.h>
 
namespace dftefe
{
  namespace linearAlgebra
  {
    template <typename ValueTypeOperator,
              typename ValueTypeOperand,
              utils::MemorySpace memorySpace>
    class LinearSolverFunction
    {
    public:
      using ValueType =
        blasLapack::scalar_type<ValueTypeOperator, ValueTypeOperand>;
 
    public:
      virtual ~LinearSolverFunction() = default;
 
      virtual const OperatorContext<ValueTypeOperator,
                                    ValueTypeOperand,
                                    memorySpace> &
      getAxContext() const = 0;
 
      virtual const OperatorContext<ValueTypeOperator,
                                    ValueTypeOperand,
                                    memorySpace> &
      getPCContext() const = 0;
 
      virtual void
      setSolution(const MultiVector<ValueTypeOperand, memorySpace> &x) = 0;
 
      virtual void
      getSolution(
        linearAlgebra::MultiVector<ValueType, memorySpace> &solution) = 0;
 
      virtual const MultiVector<ValueTypeOperand, memorySpace> &
      getRhs() const = 0;
 
      virtual const MultiVector<ValueType, memorySpace> &
      getInitialGuess() const = 0;
 
      virtual const utils::mpi::MPIComm &
      getMPIComm() const = 0;
    }; // end of class LinearSolverFunction
  }    // end of namespace linearAlgebra
} // end of namespace dftefe
#endif // dftefeLinearSolverFunction_h