L2ProjectionLinearSolverFunction.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 dftefeL2ProjectionLinearSolverFunction_h
#define dftefeL2ProjectionLinearSolverFunction_h
 
#include <utils/TypeConfig.h>
#include <utils/MemorySpaceType.h>
#include <linearAlgebra/LinearAlgebraTypes.h>
#include <linearAlgebra/LinearSolverFunction.h>
#include <linearAlgebra/OperatorContext.h>
#include <basis/CFEOverlapOperatorContext.h>
#include <linearAlgebra/PreconditionerJacobi.h>
#include <linearAlgebra/PreconditionerNone.h>
#include <basis/FEBasisManager.h>
#include <basis/FEBasisOperations.h>
#include <basis/FEBasisDataStorage.h>
#include <quadrature/QuadratureValuesContainer.h>
#include <vector>
#include <memory>
 
namespace dftefe
{
  namespace basis
  {
    template <typename ValueTypeOperator,
              typename ValueTypeOperand,
              utils::MemorySpace memorySpace,
              size_type          dim>
    class L2ProjectionLinearSolverFunction
      : public linearAlgebra::
          LinearSolverFunction<ValueTypeOperator, ValueTypeOperand, memorySpace>
    {
    public:
      using ValueType =
        linearAlgebra::blasLapack::scalar_type<ValueTypeOperator,
                                               ValueTypeOperand>;
 
    public:
      L2ProjectionLinearSolverFunction(
        std::shared_ptr<const FEBasisManager<ValueTypeOperand,
                                             ValueTypeOperator,
                                             memorySpace,
                                             dim>> cfeBasisManager,
        std::shared_ptr<const CFEOverlapOperatorContext<ValueTypeOperator,
                                                        ValueTypeOperand,
                                                        memorySpace,
                                                        dim>>
          cfeBasisDataStorageOverlapMatrix,
        std::shared_ptr<
          const FEBasisDataStorage<ValueTypeOperator, memorySpace>>
          cfeBasisDataStorageRhs,
        const quadrature::QuadratureValuesContainer<
          linearAlgebra::blasLapack::scalar_type<ValueTypeOperator,
                                                 ValueTypeOperand>,
          memorySpace> &                        inp,
        const linearAlgebra::PreconditionerType pcType,
        std::shared_ptr<linearAlgebra::LinAlgOpContext<memorySpace>>
                        linAlgOpContext,
        const size_type maxCellBlock,
        const size_type maxFieldBlock);
 
      ~L2ProjectionLinearSolverFunction() = default;
 
      const linearAlgebra::
        OperatorContext<ValueTypeOperator, ValueTypeOperand, memorySpace> &
        getAxContext() const override;
 
      const linearAlgebra::
        OperatorContext<ValueTypeOperator, ValueTypeOperand, memorySpace> &
        getPCContext() const override;
 
      void
      setSolution(
        const linearAlgebra::MultiVector<ValueType, memorySpace> &x) override;
 
      void
      getSolution(
        linearAlgebra::MultiVector<ValueType, memorySpace> &solution) override;
 
      const linearAlgebra::MultiVector<ValueTypeOperand, memorySpace> &
      getRhs() const override;
 
      const linearAlgebra::MultiVector<ValueType, memorySpace> &
      getInitialGuess() const override;
 
      const utils::mpi::MPIComm &
      getMPIComm() const override;
 
    private:
      std::shared_ptr<
        const basis::
          FEBasisManager<ValueTypeOperand, ValueTypeOperator, memorySpace, dim>>
        d_feBasisManager;
      std::shared_ptr<const CFEOverlapOperatorContext<ValueTypeOperator,
                                                      ValueTypeOperand,
                                                      memorySpace,
                                                      dim>>
        d_AxContext;
      std::shared_ptr<const linearAlgebra::OperatorContext<ValueTypeOperator,
                                                           ValueTypeOperand,
                                                           memorySpace>>
                                                               d_PCContext;
      linearAlgebra::MultiVector<ValueType, memorySpace>       d_x;
      linearAlgebra::MultiVector<ValueType, memorySpace>       d_b;
      linearAlgebra::PreconditionerType                        d_pcType;
      const linearAlgebra::MultiVector<ValueType, memorySpace> d_initial;
      std::shared_ptr<const utils::mpi::MPIPatternP2P<memorySpace>>
                      d_mpiPatternP2P;
      const size_type d_maxCellBlock, d_maxFieldBlock;
    }; // end of class L2ProjectionLinearSolverFunction
  }    // namespace basis
} // end of namespace dftefe
#include <basis/L2ProjectionLinearSolverFunction.t.cpp>
#endif // dftefeL2ProjectionLinearSolverFunction_h