DFT-EFE
 
Loading...
Searching...
No Matches
ChebyshevFilteredEigenSolver.h
Go to the documentation of this file.
1/******************************************************************************
2 * Copyright (c) 2021. *
3 * The Regents of the University of Michigan and DFT-EFE developers. *
4 * *
5 * This file is part of the DFT-EFE code. *
6 * *
7 * DFT-EFE is free software: you can redistribute it and/or modify *
8 * it under the terms of the Lesser GNU General Public License as *
9 * published by the Free Software Foundation, either version 3 of *
10 * the License, or (at your option) any later version. *
11 * *
12 * DFT-EFE is distributed in the hope that it will be useful, but *
13 * WITHOUT ANY WARRANTY; without even the implied warranty *
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. *
15 * See the Lesser GNU General Public License for more details. *
16 * *
17 * You should have received a copy of the GNU Lesser General Public *
18 * License at the top level of DFT-EFE distribution. If not, see *
19 * <https://www.gnu.org/licenses/>. *
20 ******************************************************************************/
21
22/*
23 * @author Avirup Sircar
24 */
25
26#ifndef dftefeChebyshevFilteredEigenSolver_h
27#define dftefeChebyshevFilteredEigenSolver_h
28
38#include <memory>
39#include <utils/Profiler.h>
40
41namespace dftefe
42{
43 namespace linearAlgebra
44 {
46 {
50 };
51
63 template <typename ValueTypeOperator,
64 typename ValueTypeOperand,
65 utils::MemorySpace memorySpace>
67 : public HermitianIterativeEigenSolver<ValueTypeOperator,
68 ValueTypeOperand,
69 memorySpace>
70 {
71 public:
78 using ValueType =
81 using OpContext =
82 typename HermitianIterativeEigenSolver<ValueTypeOperator,
83 ValueTypeOperand,
84 memorySpace>::OpContext;
85
86 public:
91 const double wantedSpectrumLowerBound,
92 const double wantedSpectrumUpperBound,
93 const double unWantedSpectrumUpperBound,
94 const double polynomialDegree,
95 const double illConditionTolerance,
97 const ElpaScalapackManager & elpaScala,
98 bool isResidualChebyshevFilter = true,
99 const size_type eigenVectorBatchSize = 0,
100 OrthogonalizationType orthoType =
102 bool storeIntermediateSubspaces = false);
103
109
110 void
111 reinit(const double wantedSpectrumLowerBound,
112 const double wantedSpectrumUpperBound,
113 const double unWantedSpectrumUpperBound,
114 const double polynomialDegree,
115 const double illConditionTolerance,
117
119 solve(const OpContext & A,
120 std::vector<RealType> & eigenValues,
122 bool computeEigenVectors = false,
123 const OpContext &B = IdentityOperatorContext<ValueTypeOperator,
124 ValueTypeOperand,
125 memorySpace>(),
126 const OpContext &BInv =
127 IdentityOperatorContext<ValueTypeOperator,
128 ValueTypeOperand,
129 memorySpace>()) override;
130
133
136
137 private:
146
147 std::shared_ptr<MultiVector<ValueType, memorySpace>> d_filteredSubspace,
149
150 std::shared_ptr<MultiVector<ValueType, memorySpace>> d_XinBatchSmall,
152
153 std::shared_ptr<
156
157 std::shared_ptr<
160
164
165 std::shared_ptr<const utils::mpi::MPIPatternP2P<memorySpace>>
169
171
172 }; // end of class ChebyshevFilteredEigenSolver
173 } // end of namespace linearAlgebra
174} // end of namespace dftefe
176#endif // dftefeChebyshevFilteredEigenSolver_h
A derived class of OperatorContext to encapsulate the action of a discrete operator on vectors,...
Definition: ChebyshevFilteredEigenSolver.h:70
std::shared_ptr< MultiVector< ValueType, memorySpace > > d_XinBatchSmall
Definition: ChebyshevFilteredEigenSolver.h:150
std::shared_ptr< RayleighRitzEigenSolver< ValueTypeOperator, ValueType, memorySpace > > d_rr
Definition: ChebyshevFilteredEigenSolver.h:155
const bool d_isResidualChebyFilter
Definition: ChebyshevFilteredEigenSolver.h:162
MultiVector< ValueTypeOperand, memorySpace > * d_eigenSubspaceGuess
Definition: ChebyshevFilteredEigenSolver.h:143
std::shared_ptr< MultiVector< ValueType, memorySpace > > d_filteredSubspace
Definition: ChebyshevFilteredEigenSolver.h:147
double d_polynomialDegree
Definition: ChebyshevFilteredEigenSolver.h:141
utils::Profiler d_p
Definition: ChebyshevFilteredEigenSolver.h:161
std::shared_ptr< MultiVector< ValueType, memorySpace > > d_filteredSubspaceOrtho
Definition: ChebyshevFilteredEigenSolver.h:148
double d_wantedSpectrumUpperBound
Definition: ChebyshevFilteredEigenSolver.h:139
MultiVector< ValueType, memorySpace > & getFilteredSubspace()
Definition: ChebyshevFilteredEigenSolver.t.cpp:446
void reinit(const double wantedSpectrumLowerBound, const double wantedSpectrumUpperBound, const double unWantedSpectrumUpperBound, const double polynomialDegree, const double illConditionTolerance, MultiVector< ValueTypeOperand, memorySpace > &eigenSubspaceGuess)
Definition: ChebyshevFilteredEigenSolver.t.cpp:123
MultiVector< ValueType, memorySpace > & getOrthogonalizedFilteredSubspace()
Definition: ChebyshevFilteredEigenSolver.t.cpp:467
double d_unWantedSpectrumUpperBound
Definition: ChebyshevFilteredEigenSolver.h:140
blasLapack::real_type< ValueType > RealType
Definition: ChebyshevFilteredEigenSolver.h:80
std::shared_ptr< MultiVector< ValueType, memorySpace > > d_XoutBatch
Definition: ChebyshevFilteredEigenSolver.h:151
std::shared_ptr< MultiVector< ValueType, memorySpace > > d_XoutBatchSmall
Definition: ChebyshevFilteredEigenSolver.h:151
bool d_printL2Norms
Definition: ChebyshevFilteredEigenSolver.h:167
double d_wantedSpectrumLowerBound
Definition: ChebyshevFilteredEigenSolver.h:138
size_type d_batchSizeSmall
Definition: ChebyshevFilteredEigenSolver.h:163
typename HermitianIterativeEigenSolver< ValueTypeOperator, ValueTypeOperand, memorySpace >::OpContext OpContext
Definition: ChebyshevFilteredEigenSolver.h:84
EigenSolverError solve(const OpContext &A, std::vector< RealType > &eigenValues, MultiVector< ValueType, memorySpace > &eigenVectors, bool computeEigenVectors=false, const OpContext &B=IdentityOperatorContext< ValueTypeOperator, ValueTypeOperand, memorySpace >(), const OpContext &BInv=IdentityOperatorContext< ValueTypeOperator, ValueTypeOperand, memorySpace >()) override
Definition: ChebyshevFilteredEigenSolver.t.cpp:194
const bool d_storeIntermediateSubspaces
Definition: ChebyshevFilteredEigenSolver.h:145
const size_type d_eigenVecBatchSize
Definition: ChebyshevFilteredEigenSolver.h:144
std::shared_ptr< MultiVector< ValueType, memorySpace > > d_XinBatch
Definition: ChebyshevFilteredEigenSolver.h:151
double d_illConditionTolerance
Definition: ChebyshevFilteredEigenSolver.h:142
OrthogonalizationType d_orthoType
Definition: ChebyshevFilteredEigenSolver.h:168
std::shared_ptr< OrthonormalizationFunctions< ValueTypeOperator, ValueType, memorySpace > > d_ortho
Definition: ChebyshevFilteredEigenSolver.h:159
blasLapack::scalar_type< ValueTypeOperator, ValueTypeOperand > ValueType
define ValueType as the superior (bigger set) of the ValueTypeOperator and ValueTypeOperand (e....
Definition: ChebyshevFilteredEigenSolver.h:79
const ElpaScalapackManager * d_elpaScala
Definition: ChebyshevFilteredEigenSolver.h:170
std::shared_ptr< const utils::mpi::MPIPatternP2P< memorySpace > > d_mpiPatternP2P
Definition: ChebyshevFilteredEigenSolver.h:166
Manager class for ELPA and ScaLAPACK.
Definition: ElpaScalapackManager.h:43
Abstract class to encapsulate the action of a discrete operator on vectors, matrices,...
Definition: IdentityOperatorContext.h:53
An class template to encapsulate a MultiVector. A MultiVector is a collection of vectors belonging t...
Definition: MultiVector.h:134
Definition: OrthonormalizationFunctions.h:48
A derived class of OperatorContext to encapsulate the action of a discrete operator on vectors,...
Definition: RayleighRitzEigenSolver.h:58
Definition: Profiler.h:44
typeInternal::real_type< ValueType > real_type
Definition: BlasLapackTypedef.h:177
typeInternal::scalar_type< ValueType1, ValueType2 > scalar_type
Definition: BlasLapackTypedef.h:183
OrthogonalizationType
Definition: ChebyshevFilteredEigenSolver.h:46
MemorySpace
Definition: MemorySpaceType.h:37
dealii includes
Definition: AtomFieldDataSpherical.cpp:31
unsigned int size_type
Definition: TypeConfig.h:8
Definition: LinearAlgebraTypes.h:147