qpe::QuantumVortexHistory2D Class Reference

Implements the Quantum Vortex History2D component. More...

#include <quantumvortex2d.h>

Public Member Functions
	QuantumVortexHistory2D (std::size_t maxSamples=1400u)
	Performs quantum vortex history2 d.
void	clear ()
	Performs clear.
void	configure (const QuantumVortexInitialState2DConfig &config, const QuantumVortexTrap2D &trap)
	Returns configure.
bool	configured () const noexcept
	Returns configured.
bool	empty () const noexcept
	Performs empty.
void	append (double time, const ComplexField2D &field, double hbar)
	Performs append.
const QuantumVortexInitialState2DConfig &	config () const noexcept
	Returns config.
const QuantumVortexTrap2D &	trap () const noexcept
	Performs trap.
const std::vector< QuantumVortexSample2D > &	samples () const noexcept
	Samples s.

Private Member Functions
void	trim ()
	Performs trim.

Private Attributes
std::size_t	maxSamples_ = 1400u
bool	configured_ = false
QuantumVortexInitialState2DConfig	config_
QuantumVortexTrap2D	trap_
std::vector< QuantumVortexSample2D >	samples_

Detailed Description

Implements the Quantum Vortex 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 177 of file quantumvortex2d.h.

Constructor & Destructor Documentation

QuantumVortexHistory2D()

qpe::QuantumVortexHistory2D::QuantumVortexHistory2D ( std::size_t maxSamples = 1400u )

explicit

Performs quantum vortex history2 d.

Parameters

maxSamples

The max samples value used by the operation.

Definition at line 285 of file quantumvortex2d.cpp.

Member Function Documentation

append()

void qpe::QuantumVortexHistory2D::append	(	double	time,
		const ComplexField2D &	field,
		double	hbar )

Performs append.

Parameters

time	Simulation time in solver units.
field	Field data to read or modify.
hbar	The hbar value used by the operation.

Definition at line 311 of file quantumvortex2d.cpp.

References qpe::QuantumVortex2D::angularMomentumZ(), qpe::QuantumVortexTrap2D::centerX, qpe::QuantumVortexTrap2D::centerY, config_, configured_, qpe::QuantumVortex2D::detectCore(), qpe::ComplexField2D::empty(), qpe::ComplexField2D::norm2(), samples_, trap_, and trim().

Referenced by MainWindow::recordTimeSeriesSample(), and qpe::tests::runQuantumVortex2DTests().

clear()

void qpe::QuantumVortexHistory2D::clear

(

)

Performs clear.

Definition at line 290 of file quantumvortex2d.cpp.

References config_, configured_, samples_, and trap_.

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

config()

const QuantumVortexInitialState2DConfig & qpe::QuantumVortexHistory2D::config ( ) const

noexcept

Returns config.

Definition at line 326 of file quantumvortex2d.cpp.

References config_.

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

configure()

void qpe::QuantumVortexHistory2D::configure	(	const QuantumVortexInitialState2DConfig &	config,
		const QuantumVortexTrap2D &	trap )

Returns configure.

Parameters

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

Definition at line 298 of file quantumvortex2d.cpp.

References clear(), config(), config_, configured_, trap(), trap_, qpe::QuantumVortexTrap2D::valid, and qpe::QuantumVortex2D::validateConfig().

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

configured()

bool qpe::QuantumVortexHistory2D::configured ( ) const

noexcept

Returns configured.

Definition at line 308 of file quantumvortex2d.cpp.

References configured_.

Referenced by QuantumVortexPlotWidget::paintEvent(), MainWindow::recordTimeSeriesSample(), and MainWindow::updateVortexAnalysis().

empty()

bool qpe::QuantumVortexHistory2D::empty ( ) const

noexcept

Performs empty.

Definition at line 309 of file quantumvortex2d.cpp.

References samples_.

Referenced by QuantumVortexPlotWidget::paintEvent(), and MainWindow::updateVortexAnalysis().

samples()

const std::vector< QuantumVortexSample2D > & qpe::QuantumVortexHistory2D::samples ( ) const

noexcept

Samples s.

Definition at line 328 of file quantumvortex2d.cpp.

References samples_.

Referenced by QuantumVortexPlotWidget::paintEvent(), qpe::tests::runQuantumVortex2DTests(), and MainWindow::updateVortexAnalysis().

trap()

const QuantumVortexTrap2D & qpe::QuantumVortexHistory2D::trap ( ) const

noexcept

Performs trap.

Definition at line 327 of file quantumvortex2d.cpp.

References trap_.

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

trim()

void qpe::QuantumVortexHistory2D::trim ( )

private

Performs trim.

Definition at line 330 of file quantumvortex2d.cpp.

References maxSamples_, and samples_.

Referenced by append().

Member Data Documentation

config_

QuantumVortexInitialState2DConfig qpe::QuantumVortexHistory2D::config_

private

Definition at line 237 of file quantumvortex2d.h.

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

configured_

bool qpe::QuantumVortexHistory2D::configured_ = false

private

Definition at line 236 of file quantumvortex2d.h.

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

maxSamples_

std::size_t qpe::QuantumVortexHistory2D::maxSamples_ = 1400u

private

Definition at line 235 of file quantumvortex2d.h.

Referenced by trim().

samples_

std::vector<QuantumVortexSample2D> qpe::QuantumVortexHistory2D::samples_

private

Definition at line 239 of file quantumvortex2d.h.

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

trap_

QuantumVortexTrap2D qpe::QuantumVortexHistory2D::trap_

private

Definition at line 238 of file quantumvortex2d.h.

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

---

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

• core/quantum/quantumvortex2d.h
• core/quantum/quantumvortex2d.cpp