votca 2024.2-dev
Loading...
Searching...
No Matches
Overlap_filter.h
Go to the documentation of this file.
1/*
2 * Copyright 2009-2020 The VOTCA Development Team
3 * (http://www.votca.org)
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License")
6 *
7 * You may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 *
18 */
19
20#pragma once
21#ifndef VOTCA_XTP_OVERLAP_FILTER_H
22#define VOTCA_XTP_OVERLAP_FILTER_H
23
24// Local VOTCA includes
26
27namespace votca {
28namespace xtp {
29
36 public:
37 std::string Identify() const final { return "overlap"; }
38
39 void Initialize(const tools::Property& options) final;
40
41 void Info(Logger& log) const final;
42
43 void UpdateHist(const Orbitals& orb, QMState state) final;
44
45 bool NeedsInitialState() const final { return true; }
46
47 std::vector<Index> CalcIndeces(const Orbitals& orb,
48 QMStateType type) const final;
49
50 void WriteToCpt(CheckpointWriter& w) final;
51
52 void ReadFromCpt(CheckpointReader& r) final;
53
54 private:
55 Eigen::VectorXd CalculateOverlap(const Orbitals& orb, QMStateType type) const;
56 Eigen::MatrixXd CalcAOCoeffs(const Orbitals& orb, QMStateType type) const;
57
58 Eigen::MatrixXd CalcExcitonAORepresentation(const Orbitals& orb,
59 QMStateType type) const;
60 double threshold_ = 0.0;
61
62 Eigen::VectorXd laststatecoeff_;
63};
64
65} // namespace xtp
66} // namespace votca
67
68#endif // VOTCA_XTP_OVERLAP_FILTER_H
class to manage program options with xml serialization functionality
Definition property.h:55
Logger is used for thread-safe output of messages.
Definition logger.h:164
container for molecular orbitals
Definition orbitals.h:46
overlap_filter tracks states according to their overlap with a previous state
void WriteToCpt(CheckpointWriter &w) final
void UpdateHist(const Orbitals &orb, QMState state) final
std::string Identify() const final
void ReadFromCpt(CheckpointReader &r) final
Eigen::MatrixXd CalcExcitonAORepresentation(const Orbitals &orb, QMStateType type) const
void Initialize(const tools::Property &options) final
void Info(Logger &log) const final
Eigen::VectorXd CalculateOverlap(const Orbitals &orb, QMStateType type) const
Eigen::VectorXd laststatecoeff_
std::vector< Index > CalcIndeces(const Orbitals &orb, QMStateType type) const final
Eigen::MatrixXd CalcAOCoeffs(const Orbitals &orb, QMStateType type) const
bool NeedsInitialState() const final
Identifier for QMstates. Strings like S1 are converted into enum +zero indexed int.
Definition qmstate.h:132
Base Class for statefilter.
base class for all analysis tools
Definition basebead.h:33