trajectory::Stochastic< A, T > Class Template Reference

Represents a trajectory that has both adaptive ODE evolution and noise. More...

#include <StochasticTrajectory.h>

Inheritance diagram for trajectory::Stochastic< A, T >:

Collaboration diagram for trajectory::Stochastic< A, T >:

Protected Member Functions
std::ostream &	displayParameters_v (std::ostream &) const override
Constructors
	Stochastic (A &, typename Evolved::Derivs, double dtInit, double epsRel, double epsAbs, const A &scaleAbs, const evolved::Maker< A > &, unsigned long seed, bool noise, const randomized::Maker &)
	Straightforward constructor combining the construction of Adaptive and randomized::Randomized.
	Stochastic (A &, typename Evolved::Derivs, double dtInit, const A &scaleAbs, const ParsStochastic &, const evolved::Maker< A > &, const randomized::Maker &)
Getters
const RandomizedPtr	getRandomized () const
bool	isNoisy () const
Serialization
cpputils::iarchive &	readStateMore_v (cpputils::iarchive &iar) override
	hook into Trajectory::readState
cpputils::oarchive &	writeStateMore_v (cpputils::oarchive &oar) const override
	hook into Trajectory::writeState
Protected Member Functions inherited from trajectory::Adaptive< A >
	Adaptive (A &, typename Evolved::Derivs, double, double, double, const A &, const evolved::Maker< A > &)
	Constructor taking the same parameters as needed to operate evolved::Maker.
	Adaptive (A &, typename Evolved::Derivs, double, const ParsEvolved &, const A &, const evolved::Maker< A > &)
const std::string	trajectoryID () const
	redirected to a pure virtual, this is needed for serialization of trajectory metadata
std::ostream &	displayParameters_v (std::ostream &) const override
const ConstPtr	getEvolved () const
const Ptr	getEvolved ()
double	getDtTry () const
Protected Member Functions inherited from trajectory::AdaptiveIO< A >
const Ptr	getEvolvedIO () const
	note: not the same const-correctness as in Adaptive

Additional Inherited Members
Public Types inherited from trajectory::Adaptive< A >
typedef evolved::Evolved< A >	Evolved
Public Member Functions inherited from trajectory::Adaptive< A >
void	step (double deltaT)
	corresponding to Evolved::step, it takes a single adaptive step More...
Public Member Functions inherited from trajectory::AdaptiveIO< A >
	AdaptiveIO (Ptr)
cpputils::iarchive &	readState (cpputils::iarchive &iar)
	Read in the EvolvedIO from a cpputils::iarchive. More...
cpputils::oarchive &	writeState (cpputils::oarchive &oar) const
	Write the EvolvedIO to a cpputils::oarchive.
double	getTime () const
	Returns the time of the underlying EvolvedIO.
Public Member Functions inherited from trajectory::Trajectory
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
double	getTime () const
	actual time instant
double	getDtDid () const
	last perfomed timestep
cpputils::iarchive &	readState (cpputils::iarchive &iar)
	read from an archive
cpputils::oarchive &	writeState (cpputils::oarchive &oar) const
	write to an archive
Public Member Functions inherited from trajectory::Averageable< T >
const T	toBeAveraged () const
	returns the set of quantities condensed in a variable of type T that are “to be averaged”
Protected Types inherited from trajectory::Adaptive< A >
typedef Evolved::ConstPtr	ConstPtr
typedef Evolved::Ptr	Ptr
Protected Attributes inherited from trajectory::AdaptiveIO< A >
SerializationMetadata	meta_
Related Functions inherited from trajectory::Adaptive< A >
template<typename A >
void	run (Adaptive< A > &, double time, int dc, unsigned sdf, const std::string &ofn, const std::string &initialFileName, int precision, bool displayInfo, bool firstStateDisplay, double autoStopEpsilon, unsigned autoStopRepetition, const std::string &parsedCommandLine)
	Another version of run for running in dc-mode. More...
template<typename A >
void	run (Adaptive< A > &, const ParsRun &)
	Dispatcher. More...
Related Functions inherited from trajectory::Trajectory
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

template<typename A, typename T>
class trajectory::Stochastic< A, T >

Represents a trajectory that has both adaptive ODE evolution and noise.

In the language of the framework, this means that the class simply connects Adaptive and Averageable while storing a randomized::Randomized instant for the convenience of derived classes.

Definition at line 49 of file StochasticTrajectory.h.

Constructor & Destructor Documentation

template<typename A, typename T>

trajectory::Stochastic< A, T >::Stochastic ( A &  , typename Evolved::Derivs  , double  dtInit, const A &  scaleAbs, const ParsStochastic< A, T > &  , const evolved::Maker< A > &  , const randomized::Maker &    )

protected

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

---

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

• utils/StochasticTrajectory.h