Quantum 3xplorer (Q3)
An AI-native quantum simulation engine
Loading...
Searching...
No Matches
q3::QuantumStateInterpolator Class Referenceabstract

#include <init.hpp>

+ Inheritance diagram for q3::QuantumStateInterpolator:

Public Member Functions

virtual ~QuantumStateInterpolator ()=default
 
virtual std::string description () const =0
 One line for logs: the method and the size of the model.
 
virtual std::map< std::string, Real > diagnostics () const
 
virtual std::vector< Real > eigenvalues_at (const Vector3D &kpoint) const =0
 Ascending eigenvalues in Rydberg at one k-point in crystal coordinates.
 
virtual int number_of_bands () const =0
 Number of eigenvalues returned per k-point.
 

Detailed Description

Definition at line 38 of file init.hpp.

Constructor & Destructor Documentation

◆ ~QuantumStateInterpolator()

virtual q3::QuantumStateInterpolator::~QuantumStateInterpolator ( )
virtualdefault

Member Function Documentation

◆ description()

virtual std::string q3::QuantumStateInterpolator::description ( ) const
pure virtual

One line for logs: the method and the size of the model.

Implemented in q3::LocalOrbitalQuantumStateInterpolator.

Referenced by q3::InterpolationResultsDocument::describe_model().

◆ diagnostics()

virtual std::map< std::string, Real > q3::QuantumStateInterpolator::diagnostics ( ) const
inlinevirtual

Method-specific numbers worth reporting beside the results – a model's size, a weight identity it checked – keyed by a name fit for a JSON report. Empty by default; a method with nothing to add adds nothing.

Reimplemented in q3::LocalOrbitalQuantumStateInterpolator.

Definition at line 57 of file init.hpp.

Referenced by q3::InterpolationResultsDocument::describe_model().

◆ eigenvalues_at()

virtual std::vector< Real > q3::QuantumStateInterpolator::eigenvalues_at ( const Vector3D &  kpoint) const
pure virtual

Ascending eigenvalues in Rydberg at one k-point in crystal coordinates.

Implemented in q3::LocalOrbitalQuantumStateInterpolator.

Referenced by q3::InterpolatedBandStructureCalculator::compute(), and q3::InterpolatedDensityOfStatesCalculator::compute().

◆ number_of_bands()

virtual int q3::QuantumStateInterpolator::number_of_bands ( ) const
pure virtual

Number of eigenvalues returned per k-point.

Implemented in q3::LocalOrbitalQuantumStateInterpolator.

Referenced by q3::InterpolationResultsDocument::describe_model().


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