#include <LossDataSink.h>

Public Member Functions
	LossDataSink ()=default

	LossDataSink (const std::string &outfn, bool hdf5Save, CollectionType=CollectionType::TEMPORAL)

	LossDataSink (const LossDataSink &rsh)

	~LossDataSink () noexcept(false)

bool	inH5Mode ()

void	save (unsigned int numSets=1, OpalData::OpenMode openMode=OpalData::OpenMode::UNDEFINED)

void	addReferenceParticle (const Vector_t &x, const Vector_t &p, double time, double spos, long long globalTrackStep)

void	addParticle (const OpalParticle &, const boost::optional< std::pair< int, short int >> &turnBunchNumPair=boost::none)

size_t	size () const

std::set< SetStatistics >	computeStatistics (unsigned int numSets)

Private Member Functions
void	openASCII ()

void	openH5 (h5_int32_t mode=H5_O_WRONLY)

void	appendASCII ()

void	writeHeaderASCII ()

void	writeHeaderH5 ()

void	saveASCII ()

void	saveH5 (unsigned int setIdx)

void	closeASCII ()

bool	hasNoParticlesToDump () const

bool	hasTurnInformations () const

void	reportOnError (h5_int64_t rc, const char *file, int line)

void	splitSets (unsigned int numSets)

SetStatistics	computeSetStatistics (unsigned int setIdx)

Private Attributes
std::string	fileName_m

bool	h5hut_mode_m

std::ofstream	os_m

h5_file_t	H5file_m
	used to write out data in H5hut mode More...

std::string	outputName_m

h5_int64_t	H5call_m
	Current record, or time step, of H5 file. More...

std::vector< OpalParticle >	particles_m

std::vector< size_t >	bunchNumber_m

std::vector< size_t >	turnNumber_m

std::vector< Vector_t >	RefPartR_m

std::vector< Vector_t >	RefPartP_m

std::vector< h5_int64_t >	globalTrackStep_m

std::vector< double >	refTime_m

std::vector< double >	spos_m

std::vector< unsigned long >	startSet_m

CollectionType	collectionType_m

Detailed Description

Definition at line 80 of file LossDataSink.h.

Constructor & Destructor Documentation

LossDataSink::LossDataSink ( )

default

LossDataSink::LossDataSink	(	const std::string &	outfn,
		bool	hdf5Save,
		CollectionType	collectionType = `CollectionType::TEMPORAL`
	)

Definition at line 180 of file LossDataSink.cpp.

References OpalData::APPEND, bunchNumber_m, OpalData::checkAndAddOutputFileName(), Options::enableHDF5, OpalData::getInstance(), h5hut_mode_m, outputName_m, particles_m, OpalData::setOpenMode(), and turnNumber_m.

Here is the call graph for this function:

LossDataSink::LossDataSink ( const LossDataSink & rsh )

Definition at line 204 of file LossDataSink.cpp.

References bunchNumber_m, particles_m, and turnNumber_m.

LossDataSink::~LossDataSink ( )

noexcept

Definition at line 220 of file LossDataSink.cpp.

References CLOSE_FILE, and H5file_m.

Member Function Documentation

void LossDataSink::addParticle	(	const OpalParticle &	,
		const boost::optional< std::pair< int, short int >> &	turnBunchNumPair = `boost::none`
	)

Definition at line 314 of file LossDataSink.cpp.

References bunchNumber_m, particles_m, and turnNumber_m.

Referenced by Ring::apply().

void LossDataSink::addReferenceParticle	(	const Vector_t &	x,
		const Vector_t &	p,
		double	time,
		double	spos,
		long long	globalTrackStep
	)

Definition at line 305 of file LossDataSink.cpp.

References globalTrackStep_m, RefPartP_m, RefPartR_m, refTime_m, and spos_m.

void LossDataSink::appendASCII ( )

inlineprivate

Definition at line 114 of file LossDataSink.h.

References fileName_m, IpplInfo::myNode(), and os_m.

Referenced by save().

Here is the call graph for this function:

void LossDataSink::closeASCII ( )

inlineprivate

Definition at line 126 of file LossDataSink.h.

References IpplInfo::myNode(), and os_m.

Referenced by save().

Here is the call graph for this function:

SetStatistics LossDataSink::computeSetStatistics ( unsigned int setIdx )

private

Definition at line 704 of file LossDataSink.cpp.

References allreduce(), SetStatistics::eps2_m, SetStatistics::eps_norm_m, SetStatistics::fac_m, OpalParticle::getPx(), OpalParticle::getPy(), OpalParticle::getPz(), OpalParticle::getTime(), OpalParticle::getX(), OpalParticle::getY(), OpalParticle::getZ(), max(), SetStatistics::nTotal_m, SetStatistics::outputName_m, outputName_m, particles_m, SetStatistics::pmean_m, pow(), SetStatistics::prms_m, SetStatistics::psqsum_m, SetStatistics::RefPartP_m, RefPartP_m, SetStatistics::RefPartR_m, RefPartR_m, SetStatistics::refTime_m, refTime_m, SetStatistics::rmax_m, SetStatistics::rmean_m, SetStatistics::rmin_m, SetStatistics::rprms_m, SetStatistics::rpsum_m, SetStatistics::rrms_m, SetStatistics::rsqsum_m, SetStatistics::spos_m, spos_m, sqrt(), startSet_m, Util::KahanAccumulation::sum, SetStatistics::tmean_m, and SetStatistics::trms_m.

Referenced by computeStatistics().

Here is the call graph for this function:

std::set< SetStatistics > LossDataSink::computeStatistics ( unsigned int numSets )

inline

Definition at line 178 of file LossDataSink.h.

References computeSetStatistics(), and splitSets().

Here is the call graph for this function:

bool LossDataSink::hasNoParticlesToDump ( ) const

private

Definition at line 389 of file LossDataSink.cpp.

References particles_m, and reduce().

Referenced by save().

Here is the call graph for this function:

bool LossDataSink::hasTurnInformations ( ) const

private

Definition at line 397 of file LossDataSink.cpp.

References allreduce(), and turnNumber_m.

Referenced by saveASCII(), saveH5(), and writeHeaderASCII().

Here is the call graph for this function:

bool LossDataSink::inH5Mode ( )

inline

Definition at line 90 of file LossDataSink.h.

References h5hut_mode_m.

void LossDataSink::openASCII ( )

inlineprivate

Definition at line 107 of file LossDataSink.h.

References fileName_m, IpplInfo::myNode(), and os_m.

Referenced by save().

Here is the call graph for this function:

void LossDataSink::openH5 ( h5_int32_t mode = H5_O_WRONLY )

private

Definition at line 227 of file LossDataSink.cpp.

References fileName_m, IpplInfo::getComm(), mode, and OPEN_FILE.

Referenced by save().

Here is the call graph for this function:

void LossDataSink::reportOnError	(	h5_int64_t	rc,
		const char *	file,
		int	line
	)

private

void LossDataSink::save	(	unsigned int	numSets = `1`,
		OpalData::OpenMode	openMode = `OpalData::OpenMode::UNDEFINED`
	)

clear and return memory

Definition at line 329 of file LossDataSink.cpp.

References appendASCII(), Communicate::barrier(), bunchNumber_m, CLOSE_FILE, closeASCII(), IpplInfo::Comm, endl(), fileName_m, Hypervolume::fs, GET_NUM_STEPS, OpalData::getInstance(), OpalData::getOpenMode(), globalTrackStep_m, H5file_m, h5hut_mode_m, hasNoParticlesToDump(), level2(), openASCII(), openH5(), outputName_m, particles_m, RefPartR_m, refTime_m, saveASCII(), saveH5(), spos_m, turnNumber_m, OpalData::UNDEFINED, OpalData::WRITE, writeHeaderASCII(), and writeHeaderH5().

Referenced by Ring::finalise().

Here is the call graph for this function:

void LossDataSink::saveASCII ( )

private

Definition at line 543 of file LossDataSink.cpp.

References bunchNumber_m, IpplInfo::Comm, COMM_ANY_NODE, endl(), ERRORMSG, Message::get(), OpalParticle::getId(), IpplInfo::getNodes(), OpalParticle::getPx(), OpalParticle::getPy(), OpalParticle::getPz(), OpalParticle::getTime(), OpalParticle::getX(), OpalParticle::getY(), OpalParticle::getZ(), hasTurnInformations(), IPPL_APP_CYCLE, IPPL_APP_TAG3, TagMaker::next_tag(), os_m, particles_m, Message::put(), Communicate::receive_block(), Communicate::send(), and turnNumber_m.

Referenced by save().

Here is the call graph for this function:

void LossDataSink::saveH5 ( unsigned int setIdx )

private

Set current record/time step.

Definition at line 405 of file LossDataSink.cpp.

Referenced by save().

Here is the call graph for this function:

size_t LossDataSink::size ( ) const

inline

Definition at line 173 of file LossDataSink.h.

References particles_m.

void LossDataSink::splitSets ( unsigned int numSets )

private

In Opal-T monitors can be traversed several times. We know how many times the bunch passes because we register the passage of the reference particle. This code tries to determine to which bunch (same bunch but different times) a particle belongs. For this we could use algorithms from data science such as k-means or dbscan. But they are an overkill for this application because the bunches are well separated.

In a first step we a assign to each bunch the same number of particles and compute the mean time of passage and with it a time range. Of course this is only an approximation. So we reassign the particles to the bunches using the time ranges compute a better approximation. Two iterations should be sufficient for Opal-T where the temporal separation is large.

Parameters

numSets number of passes of the reference particle

Definition at line 645 of file LossDataSink.cpp.

References allreduce(), max(), particles_m, and startSet_m.

Referenced by computeStatistics().

Here is the call graph for this function: