The base class of the trajectory-bundle condensing the quintessential characteristics of any trajectory. More...

#include <Trajectory.h>

Inheritance diagram for trajectory::Trajectory:

Collaboration diagram for trajectory::Trajectory:

Public Member Functions
void	evolve (double deltaT)
	Propagation for a time interval of exactly deltaT.

std::ostream &	display (std::ostream &, int precision) const
	Displays a limited set of relevant physical and numerical information about the actual state of Trajectory at the actual time instant. More...

std::ostream &	displayParameters (std::ostream &os) const
	print header

std::ostream &	logOnEnd (std::ostream &os) const
	print a log at the end summarizing overall (e.g. time-averaged) physical and numerical data during the run

Getters
double	getTime () const
	actual time instant

double	getDtDid () const
	last perfomed timestep

Entire state i/o
cpputils::iarchive &	readState (cpputils::iarchive &iar)
	read from an archive

cpputils::oarchive &	writeState (cpputils::oarchive &oar) const
	write to an archive

Related Functions
(Note that these are not member functions.)
void	run (Trajectory &trajectory, double time, double deltaT, unsigned sdf, const std::string &ofn, const std::string &initialFileName, int precision, bool displayInfo, bool firstStateDisplay, double autoStopEpsilon, unsigned autoStopRepetition, const std::string &parsedCommandLine)
	Running in deltaT mode (displays in equal time intervals) for a certain time. More...

void	run (Trajectory &, long nDt, double deltaT, unsigned sdf, const std::string &ofn, const std::string &initialFileName, int precision, bool displayInfo, bool firstStateDisplay, double autoStopEpsilon, unsigned autoStopRepetition, const std::string &parsedCommandLine)
	Same as above but runs for a certain number of time intervals deltaT. More...

void	run (Trajectory &, const ParsRun &p)
	Dispatcher. More...

Detailed Description

The base class of the trajectory-bundle condensing the quintessential characteristics of any trajectory.

See also: run(Trajectory&, double, double, unsigned, const std::string&, const std::string&, int, bool, bool) which manifests all the principal functionalities of this class

The i/o of the entire state is performed via Boost.Serialization, and is disabled if this library is not installed

Todo:: Consider the possibility of cloning Trajectories

Definition at line 194 of file Trajectory.h.

Member Function Documentation

std::ostream& trajectory::Trajectory::display	(	std::ostream &	,
		int	precision
	)		const

Displays a limited set of relevant physical and numerical information about the actual state of Trajectory at the actual time instant.

Parameters

precision the precision (number of digits) of display

Friends And Related Function Documentation

void run	(	Trajectory &	trajectory,
		double	time,
		double	deltaT,
		unsigned	sdf,
		const std::string &	ofn,
		const std::string &	initialFileName,
		int	precision,
		bool	displayInfo,
		bool	firstStateDisplay,
		double	autoStopEpsilon,
		unsigned	autoStopRepetition,
		const std::string &	parsedCommandLine
	)

This function manifests all the basic features of Adaptive and the whole idea behind the trajectory bundle.

A Trajectory can

be evolved (propagated in time by given time intervals)
perform i/o of its entire state, that is, a bunch of information necessary for resuming a Trajectory from a certain time instant
display relevant physical and numerical information about its actual state at any time (e.g. a set of quantum averages in the case of a quantum trajectory)

Note: While the entire state can be huge (e.g. the state vector or density operator in the case of a quantum trajectory) the relevant information in an actual numerical experiment is usually much less (a set of quantum averages that doesn’t entirely define the state).

Furthermore, a Trajectory can

provide information about its time and last performed timestep
print a header summarizing its physical and numerical parameters together with a key to the set of relevant physical information displayed during the run
print a log at the end summarizing overall (e.g. time-averaged) physical and numerical data during the run

See also: Simulated for a full generic implementation of Trajectory together with a small tutorial

Todo:: Consider taking Trajectory by rvalue reference

Parameters

trajectory	the trajectory to run
time	end time
deltaT	time interval between two displays
sdf	number of displays between two state displays
ofn	name of the output file for displays — if empty, display to standard output; state displays into file named `ofn.state`
initialFileName	name of file containing initial condition state for the run
precision	governs the overall precision (number of digits) of outputs in displays
displayInfo	governs whether a header is displayed at the top of the output
firstStateDisplay	governs whether the state is displayed at time zero (important if state display is costly)
autoStopEpsilon	relative precision for autostopping
autoStopRepetition	number of displayed lines repeated within relative precision before autostopping – 0 means no autostopping

void run	(	Trajectory &	,
		long	nDt,
		double	deltaT,
		unsigned	sdf,
		const std::string &	ofn,
		const std::string &	initialFileName,
		int	precision,
		bool	displayInfo,
		bool	firstStateDisplay,
		double	autoStopEpsilon,
		unsigned	autoStopRepetition,
		const std::string &	parsedCommandLine
	)

Rationale: This version of run exists to avoid the eventual tiny timestep at the end of the run that might occur with the above version. This is because e.g. in the case of deltaT=0.1, time=1, adding up 0.1 ten times numerically does not result in exactly 1.

For a demonstration, compare the output of

examples/HarmonicOscillatorComplex --dc 0 --Dt 0.1 --T 1

with

examples/HarmonicOscillatorComplex --dc 0 --Dt 0.1 --NDt 10

Parameters

nDt	the end time of the trajectory will be nDt*deltaT

void run	(	Trajectory &	,
		const ParsRun &	p
	)

Runs

run(Trajectory&, long, double, unsigned, const std::string&, const std::string&, int, bool, bool) if p.NDt is nonzero and
run(Trajectory&, double, double, unsigned, const std::string&, const std::string&, int, bool, bool) otherwise

Note: This means that ParsRun::NDt takes precedence over ParsRun::T

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

utils/Trajectory.h

Public Member Functions

Related Functions

Detailed Description

Member Function Documentation

Friends And Related Function Documentation