Code map

Naming scheme

Each file in the framework revolves around a single concept, and is named after this concept.

See also

Sec. Code organization.

FilenameFwd.h

forward-declaring header

Filename.h

normal header file

impl/Filename.tcc

implementation header file containing template definitions, situated in subdirectory impl under the directory of the corresponding header

Filename.cc

implementation file, containing non-template definitions

Headers under directories details are mostly very technical, often used for code generation.

elements

composites

Act

the Act helper class for defining Composites

BinarySystem

class BinarySystem

Composite

the Composite class and the maker function composite::make() and metafunction composite::result_of::make

frees

This directory contains the definitions of elementary free building blocks.

Note

Since most of the files are extremely special here, and the directory’s content is continually extending and is subject to changes according to the framework’s usage, we are listing only the most typical files here.

Mode

the classes (Pumped)(Lossy)Mode, together with numerous helpers to handle harmonic-oscillator mode operators, states, and dynamics

MultiLevel

the class MultiLevel

TimeIndependentMatrixHamiltonian

defines class TimeIndependentMatrixHamiltonian

interactions

This directory contains the definitions of elementary interaction building blocks.

quantumdata

ArrayBase, DensityOperator, DimensionsBookkeeper, StateVector, Types

define classes quantumdata::ArrayBase, quantumdata::DensityOperator, DimensionsBookkeeper, quantumdata::StateVector, and quantumdata::Types, respectively

LazyDensityOperator & LazyDensityOperatorSliceIterator

define classes quantumdata::LazyDensityOperator and quantumdata::ldo::DiagonalIterator together with the function quantumdata::partialTrace()

NegPT

the function quantumdata::negPT()

NonOrthogonalDensityOperator, NonOrthogonalStateVector, Transformation

define the infrastructure for representing quantumdata in non-orthogonal bases (covariant-contravariant formalism) INCOMPLETE

quantumoperator

Sigma, Tridiagonal

define classes quantumoperator::Sigma and quantumoperator::Tridiagonal, respectively

quantumtrajectory

DO_Display, EnsembleMCWF, Master, MCWF_Trajectory, ProjectingMCWF_Trajectory, & Pars...

define classes quantumtrajectory::DO_Display, quantumtrajectory::EnsembleMCWF, quantumtrajectory::Master, quantumtrajectory::MCWF_Trajectory, quantumtrajectory::ProjectingMCWF_Trajectory, respectively & the corresponding parameter classes

Evolution

the function evolve()

EvolutionHigh

collecting header, to be included by scripts

scripts

This directory contains the clients of the framework, the actual programs corresponding to various physical systems. The same note applies as for the frees above, we are describing only some typical files.

1particle1mode

a very flexible script describing the motion of a single polarizable particle in a cavity mode with different geometries

QbitMode_C++QED

a qbit interacting with a harmonic-oscillator mode through Jaynes-Cummings interaction

Ring

a single polarizable particle moving along two modes (ring cavity)

structure

Averaged, DynamicsBase, ElementLiouvillean, Exact, FreeExact, Free, Hamiltonian, Interaction, Liouvillean, QuantumSystem, TridiagonalHamiltonian

classes structure::Averaged, structure::DynamicsBase, structure::ElementLiouvillean, structure::Exact, structure::FreeExact, structure::Free, structure::Hamiltonian, structure::Interaction, structure::Liouvillean, structure::QuantumSystem, structure::TridiagonalHamiltonian, respectively

ElementAveraged

defines class structure::ElementAveraged and the generic implementations structure::averaged::DiagonalDO, structure::averaged::Collecting

MatrixOfHamiltonian

defines function calculateMatrix()

Structure

collecting header, to be included by trajectories and composites

SubSystem

helper classes for composites

utils

• Utility modules