qpe::QuantumKapitzaDiracHistory2D Class Reference

Implements the Quantum Kapitza Dirac History2D component. More...

#include <quantumkapitzadirac2d.h>

Public Member Functions
	QuantumKapitzaDiracHistory2D (std::size_t maximumSamples=320u)
	Constructs a Quantum Kapitza Dirac History 2D instance.
void	clear ()
	Clears stored state and returns the component to its empty/default state.
bool	configure (const QuantumKapitzaDirac2DConfig &config, double hbar)
	Returns configure.
void	append (const MomentumSpace2DResult &momentum, double time, bool pulseActive)
	Carries out append.
bool	configured () const noexcept
	Returns configured.
bool	empty () const noexcept
	Returns whether the object contains no data.
const QuantumKapitzaDirac2DConfig &	config () const noexcept
	Returns config.
double	hbar () const noexcept
	Carries out hbar.
const std::vector< QuantumKapitzaDiracSample2D > &	samples () const noexcept
	Samples s.

Private Member Functions
void	trim ()
	Carries out trim.

Private Attributes
std::size_t	maximumSamples_ = 320u
bool	configured_ = false
QuantumKapitzaDirac2DConfig	config_
double	hbar_ = 1.0
std::vector< QuantumKapitzaDiracSample2D >	samples_

Detailed Description

Implements the Quantum Kapitza Dirac History2D component.

The class provides one focused service within the QPE architecture and is documented here independently of the experiment-level Help.

Definition at line 174 of file quantumkapitzadirac2d.h.

Constructor & Destructor Documentation

QuantumKapitzaDiracHistory2D()

qpe::QuantumKapitzaDiracHistory2D::QuantumKapitzaDiracHistory2D ( std::size_t maximumSamples = 320u )

explicit

Constructs a Quantum Kapitza Dirac History 2D instance.

Parameters

maximumSamples

The maximum samples value used by the operation.

Definition at line 246 of file quantumkapitzadirac2d.cpp.

Member Function Documentation

append()

void qpe::QuantumKapitzaDiracHistory2D::append	(	const MomentumSpace2DResult &	momentum,
		double	time,
		bool	pulseActive )

Carries out append.

Parameters

momentum	The momentum value used by the operation.
time	Simulation time in solver units.
pulseActive	The pulse active value used by the operation.

Definition at line 273 of file quantumkapitzadirac2d.cpp.

References config_, configured_, qpe::QuantumKapitzaDirac2D::measure(), samples_, and trim().

Referenced by MainWindow::advanceSimulation(), MainWindow::resetSimulation(), qpe::tests::runQuantumKapitzaDirac2DTests(), and MainWindow::singleStep().

clear()

void qpe::QuantumKapitzaDiracHistory2D::clear

(

)

Clears stored state and returns the component to its empty/default state.

Definition at line 251 of file quantumkapitzadirac2d.cpp.

References config_, configured_, hbar_, and samples_.

Referenced by configure(), and MainWindow::resetSimulation().

config()

const QuantumKapitzaDirac2DConfig & qpe::QuantumKapitzaDiracHistory2D::config ( ) const

inlinenoexcept

Returns config.

Definition at line 216 of file quantumkapitzadirac2d.h.

References config_.

Referenced by configure(), and QuantumKapitzaDiracPlotWidget::paintEvent().

configure()

bool qpe::QuantumKapitzaDiracHistory2D::configure	(	const QuantumKapitzaDirac2DConfig &	config,
		double	hbar )

Returns configure.

Parameters

config	Configuration to apply.
hbar	The hbar value used by the operation.

Definition at line 259 of file quantumkapitzadirac2d.cpp.

References clear(), config(), config_, configured_, qpe::QuantumKapitzaDirac2DConfig::enabled, hbar(), hbar_, and qpe::QuantumKapitzaDirac2D::validateConfig().

Referenced by MainWindow::resetSimulation(), and qpe::tests::runQuantumKapitzaDirac2DTests().

configured()

bool qpe::QuantumKapitzaDiracHistory2D::configured ( ) const

inlinenoexcept

Returns configured.

Definition at line 207 of file quantumkapitzadirac2d.h.

References configured_.

Referenced by MainWindow::advanceSimulation(), QuantumKapitzaDiracPlotWidget::paintEvent(), MainWindow::singleStep(), and MainWindow::updateQuantumKapitzaDiracAnalysis().

empty()

bool qpe::QuantumKapitzaDiracHistory2D::empty ( ) const

inlinenoexcept

Returns whether the object contains no data.

Parameters

empty

The empty value used by the operation.

Definition at line 212 of file quantumkapitzadirac2d.h.

References samples_.

Referenced by QuantumKapitzaDiracPlotWidget::paintEvent(), qpe::tests::runQuantumKapitzaDirac2DTests(), and MainWindow::updateQuantumKapitzaDiracAnalysis().

hbar()

double qpe::QuantumKapitzaDiracHistory2D::hbar ( ) const

inlinenoexcept

Carries out hbar.

Definition at line 220 of file quantumkapitzadirac2d.h.

References hbar_.

Referenced by configure(), QuantumKapitzaDiracPlotWidget::paintEvent(), and MainWindow::updateQuantumKapitzaDiracAnalysis().

samples()

const std::vector< QuantumKapitzaDiracSample2D > & qpe::QuantumKapitzaDiracHistory2D::samples ( ) const

inlinenoexcept

Samples s.

Definition at line 224 of file quantumkapitzadirac2d.h.

References samples_.

Referenced by QuantumKapitzaDiracPlotWidget::paintEvent(), qpe::tests::runQuantumKapitzaDirac2DTests(), and MainWindow::updateQuantumKapitzaDiracAnalysis().

trim()

void qpe::QuantumKapitzaDiracHistory2D::trim ( )

private

Carries out trim.

Definition at line 283 of file quantumkapitzadirac2d.cpp.

References maximumSamples_, and samples_.

Referenced by append().

Member Data Documentation

config_

QuantumKapitzaDirac2DConfig qpe::QuantumKapitzaDiracHistory2D::config_

private

Definition at line 234 of file quantumkapitzadirac2d.h.

Referenced by append(), clear(), config(), and configure().

configured_

bool qpe::QuantumKapitzaDiracHistory2D::configured_ = false

private

Definition at line 233 of file quantumkapitzadirac2d.h.

Referenced by append(), clear(), configure(), and configured().

hbar_

double qpe::QuantumKapitzaDiracHistory2D::hbar_ = 1.0

private

Definition at line 235 of file quantumkapitzadirac2d.h.

Referenced by clear(), configure(), and hbar().

maximumSamples_

std::size_t qpe::QuantumKapitzaDiracHistory2D::maximumSamples_ = 320u

private

Definition at line 232 of file quantumkapitzadirac2d.h.

Referenced by trim().

samples_

std::vector<QuantumKapitzaDiracSample2D> qpe::QuantumKapitzaDiracHistory2D::samples_

private

Definition at line 236 of file quantumkapitzadirac2d.h.

Referenced by append(), clear(), empty(), samples(), and trim().

---

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

• core/quantum/quantumkapitzadirac2d.h
• core/quantum/quantumkapitzadirac2d.cpp