votca::xtp::Localisation_filter Class Reference

Localisation_filter tracks states according to how localised they are in a specific region. More...

#include <Localisation_filter.h>

Inheritance diagram for votca::xtp::Localisation_filter:

Collaboration diagram for votca::xtp::Localisation_filter:

Public Member Functions
std::string	Identify () const final
void	Initialize (const tools::Property &options) final
void	Info (Logger &log) const final
bool	NeedsInitialState () const final
void	UpdateHist (const Orbitals &orb, QMState state) final
std::vector< Index >	CalcIndeces (const Orbitals &orb, QMStateType type) const final
void	WriteToCpt (CheckpointWriter &w) final
void	ReadFromCpt (CheckpointReader &r) final
Public Member Functions inherited from votca::xtp::StateFilter_base
	StateFilter_base ()=default
virtual	~StateFilter_base ()=default
virtual std::string	Identify () const =0
virtual void	Initialize (const tools::Property &)=0
virtual void	Info (Logger &) const =0
virtual bool	NeedsInitialState () const =0
virtual void	UpdateHist (const Orbitals &, QMState)=0
virtual std::vector< Index >	CalcIndeces (const Orbitals &, QMStateType) const =0
virtual void	WriteToCpt (CheckpointWriter &)=0
virtual void	ReadFromCpt (CheckpointReader &)=0

Private Attributes
QMFragment< double >	fragment_

Additional Inherited Members
Protected Member Functions inherited from votca::xtp::StateFilter_base
std::vector< Index >	ReduceAndSortIndecesUp (const Eigen::VectorXd &overlap, Index offset, double threshold) const
std::vector< Index >	ReduceAndSortIndecesDown (const Eigen::VectorXd &overlap, Index offset, double threshold) const

Detailed Description

Localisation_filter tracks states according to how localised they are in a specific region.

Definition at line 37 of file Localisation_filter.h.

Member Function Documentation

CalcIndeces()

std::vector< Index > votca::xtp::Localisation_filter::CalcIndeces ( const Orbitals &  orb, QMStateType  type  ) const

finalvirtual

Implements votca::xtp::StateFilter_base.

Definition at line 42 of file Localisation_filter.cc.

Identify()

std::string votca::xtp::Localisation_filter::Identify ( ) const

inlinefinalvirtual

Implements votca::xtp::StateFilter_base.

Definition at line 39 of file Localisation_filter.h.

Info()

void votca::xtp::Localisation_filter::Info ( Logger &  log ) const

finalvirtual

Implements votca::xtp::StateFilter_base.

Definition at line 35 of file Localisation_filter.cc.

Initialize()

void votca::xtp::Localisation_filter::Initialize ( const tools::Property &  options )

finalvirtual

Implements votca::xtp::StateFilter_base.

Definition at line 29 of file Localisation_filter.cc.

NeedsInitialState()

bool votca::xtp::Localisation_filter::NeedsInitialState ( ) const

inlinefinalvirtual

Implements votca::xtp::StateFilter_base.

Definition at line 45 of file Localisation_filter.h.

ReadFromCpt()

void votca::xtp::Localisation_filter::ReadFromCpt ( CheckpointReader &  r )

finalvirtual

Implements votca::xtp::StateFilter_base.

Definition at line 69 of file Localisation_filter.cc.

UpdateHist()

void votca::xtp::Localisation_filter::UpdateHist ( const Orbitals &  orb, QMState  state  )

finalvirtual

Implements votca::xtp::StateFilter_base.

Definition at line 40 of file Localisation_filter.cc.

WriteToCpt()

void votca::xtp::Localisation_filter::WriteToCpt ( CheckpointWriter &  w )

finalvirtual

Implements votca::xtp::StateFilter_base.

Definition at line 65 of file Localisation_filter.cc.

Member Data Documentation

fragment_

QMFragment<double> votca::xtp::Localisation_filter::fragment_

private

Definition at line 57 of file Localisation_filter.h.

---

The documentation for this class was generated from the following files:

• xtp/src/libxtp/statefilters/Localisation_filter.h
• xtp/src/libxtp/statefilters/Localisation_filter.cc