ChebyshevFilter.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 dftefeChebyshevFilter_h
#define dftefeChebyshevFilter_h
 
#include <utils/MemorySpaceType.h>
#include <linearAlgebra/BlasLapackTypedef.h>
#include <linearAlgebra/LinAlgOpContext.h>
#include <linearAlgebra/Vector.h>
#include <linearAlgebra/MultiVector.h>
#include <linearAlgebra/OperatorContext.h>
#include <memory>
 
namespace dftefe
{
  namespace linearAlgebra
  {
    template <typename ValueTypeOperator,
              typename ValueTypeOperand,
              utils::MemorySpace memorySpace>
    void
    ChebyshevFilter(
      const OperatorContext<ValueTypeOperator, ValueTypeOperand, memorySpace>
        &A,
      const OperatorContext<ValueTypeOperator, ValueTypeOperand, memorySpace>
        &                                         BInv,
      MultiVector<ValueTypeOperand, memorySpace> &eigenSubspaceGuess,
      const size_type                             polynomialDegree,
      const double                                wantedSpectrumLowerBound,
      const double                                wantedSpectrumUpperBound,
      const double                                unWantedSpectrumUpperBound,
      MultiVector<blasLapack::scalar_type<ValueTypeOperator, ValueTypeOperand>,
                  memorySpace> &                  filteredSubspace);
 
    template <typename ValueTypeOperator,
              typename ValueTypeOperand,
              utils::MemorySpace memorySpace>
    void
    ChebyshevFilterGEP(
      const OperatorContext<ValueTypeOperator, ValueTypeOperand, memorySpace>
        &A,
      const OperatorContext<ValueTypeOperator, ValueTypeOperand, memorySpace>
        &B,
      const OperatorContext<ValueTypeOperator, ValueTypeOperand, memorySpace>
        &                                         BInv,
      MultiVector<ValueTypeOperand, memorySpace> &eigenSubspaceGuess,
      const size_type                             polynomialDegree,
      const double                                wantedSpectrumLowerBound,
      const double                                wantedSpectrumUpperBound,
      const double                                unWantedSpectrumUpperBound,
      MultiVector<blasLapack::scalar_type<ValueTypeOperator, ValueTypeOperand>,
                  memorySpace> &                  filteredSubspace);
 
    template <typename ValueTypeOperator,
              typename ValueTypeOperand,
              utils::MemorySpace memorySpace>
    void
    ResidualChebyshevFilterGEP(
      const OperatorContext<ValueTypeOperator, ValueTypeOperand, memorySpace>
        &A,
      const OperatorContext<ValueTypeOperator, ValueTypeOperand, memorySpace>
        &B,
      const OperatorContext<ValueTypeOperator, ValueTypeOperand, memorySpace>
        &BInv,
      std::vector<blasLapack::real_type<
        blasLapack::scalar_type<ValueTypeOperator, ValueTypeOperand>>>
        &                                         eigenvalues,
      MultiVector<ValueTypeOperand, memorySpace> &eigenSubspaceGuess,
      const size_type                             polynomialDegree,
      const double                                wantedSpectrumLowerBound,
      const double                                wantedSpectrumUpperBound,
      const double                                unWantedSpectrumUpperBound,
      MultiVector<blasLapack::scalar_type<ValueTypeOperator, ValueTypeOperand>,
                  memorySpace> &                  filteredSubspace);
 
  } // end of namespace linearAlgebra
} // end of namespace dftefe
#include <linearAlgebra/ChebyshevFilter.t.cpp>
#endif // dftefeChebyshevFilter_h