Every k-point's verdict, and the summary of the whole. More...

#include <band_classification.hpp>

Static Public Member Functions
static BandClassification	every_band_kept (int number_of_kpoints, int number_of_bands)

Public Attributes
std::vector< KPointBandClassification >	kpoints

BandClassificationSummary	summary

Detailed Description

Every k-point's verdict, and the summary of the whole.

Definition at line 22 of file band_classification.hpp.

Member Function Documentation

◆ every_band_kept()

static BandClassification q3::BandClassification::every_band_kept	(	int	number_of_kpoints,
		int	number_of_bands
	)

inlinestatic

The classification of a window that keeps everything and freezes nothing: an isolated manifold, where the bands ARE the states. It lets the gauge, the composition and the localisation run as one code path whether the subspace was chosen or given.

Definition at line 32 of file band_classification.hpp.

References q3::KPointBandClassification::kept_bands, kpoints, and q3::KPointBandClassification::roles.

Referenced by q3::IsolatedManifoldSelection::choose().

Member Data Documentation

◆ kpoints

std::vector<KPointBandClassification> q3::BandClassification::kpoints

Definition at line 23 of file band_classification.hpp.

Referenced by q3::ProjectabilityDisentanglementSelection::choose(), q3::BandClassifier::classify(), every_band_kept(), q3::WannierConstructionInputs::overlaps_in_gauge(), and q3::WannierConstructionInputs::projections_restricted_to().

◆ summary

BandClassificationSummary q3::BandClassification::summary

Definition at line 24 of file band_classification.hpp.

Referenced by q3::ProjectabilityDisentanglementSelection::choose(), and q3::BandClassifier::classify().

The documentation for this struct was generated from the following file:

src/layer_4_computation/interpolator/method/wannier/internal/band_classification.hpp