#include <LossDataSink.h>

Collaboration diagram for LossDataSink:

Public Member Functions
	LossDataSink ()=default

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

	LossDataSink (const LossDataSink &rsh)

	~LossDataSink () noexcept(false)

bool	inH5Mode () const

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

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

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

size_t	size () const

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

Private Member Functions
void	writeFileAttribString (const char attribute, const char value)

void	writeStepAttribFloat64 (const char attribute, const h5_float64_t value, h5_int64_t size)

void	writeStepAttribInt64 (const char attribute, const h5_int64_t value, h5_int64_t size)

void	writeDataFloat64 (const char name, const h5_float64_t value)

void	writeDataInt64 (const char name, const h5_int64_t value)

void	setStep ()

void	getNumSteps ()

void	setNumParticles (h5_int64_t num)

void	openFile (const char *fname, h5_int32_t mode, h5_prop_t props)

void	closeFile ()

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	splitSets (unsigned int numSets)

SetStatistics	computeSetStatistics (unsigned int setIdx)

Private Attributes
std::string	fileName_m

bool	h5hut_mode_m = false

std::ofstream	os_m

h5_file_t	H5file_m = 0
	used to write out data in H5hut mode

std::string	outputName_m

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

std::vector< OpalParticle >	particles_m

std::vector< size_t >	bunchNumber_m

std::vector< size_t >	turnNumber_m

std::vector< Vector_t< double, 3 > >	RefPartR_m

std::vector< Vector_t< double, 3 > >	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 = CollectionType::SPATIAL

Detailed Description

Definition at line 94 of file LossDataSink.h.

Constructor & Destructor Documentation

◆ LossDataSink() [1/3]

LossDataSink::LossDataSink ( )

default

◆ LossDataSink() [2/3]

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

Definition at line 467 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() [3/3]

LossDataSink::LossDataSink ( const LossDataSink & rsh )

Definition at line 491 of file LossDataSink.cpp.

References bunchNumber_m, particles_m, and turnNumber_m.

◆ ~LossDataSink()

LossDataSink::~LossDataSink ( )

Definition at line 507 of file LossDataSink.cpp.

References closeFile(), and H5file_m.

Here is the call graph for this function:

Member Function Documentation

◆ addParticle()

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

Definition at line 606 of file LossDataSink.cpp.

References bunchNumber_m, particles_m, and turnNumber_m.

◆ addReferenceParticle()

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

Definition at line 596 of file LossDataSink.cpp.

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

◆ appendASCII()

void LossDataSink::appendASCII ( )

inlineprivate

Definition at line 141 of file LossDataSink.h.

References fileName_m, and os_m.

Referenced by save().

◆ closeASCII()

void LossDataSink::closeASCII ( )

inlineprivate

Definition at line 153 of file LossDataSink.h.

References os_m.

Referenced by save().

◆ closeFile()

void LossDataSink::closeFile ( )

private

Definition at line 133 of file LossDataSink.cpp.

References fileName_m, and H5file_m.

Referenced by save(), and ~LossDataSink().

◆ computeSetStatistics()

SetStatistics LossDataSink::computeSetStatistics ( unsigned int setIdx )

private

Definition at line 1120 of file LossDataSink.cpp.

References SetStatistics::eps2_m, SetStatistics::eps_norm_m, SetStatistics::fac_m, SetStatistics::geomEmit_m, OpalParticle::getCharge(), Util::getGamma(), Util::getKineticEnergy(), OpalParticle::getMass(), OpalParticle::getP(), OpalParticle::getPx(), OpalParticle::getPy(), OpalParticle::getPz(), OpalParticle::getTime(), OpalParticle::getX(), OpalParticle::getY(), OpalParticle::getZ(), SetStatistics::maxR_m, SetStatistics::meanGamma_m, SetStatistics::meanKineticEnergy_m, SetStatistics::nTotal_m, SetStatistics::outputName_m, outputName_m, particles_m, SetStatistics::pmean_m, 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, startSet_m, SetStatistics::stdKineticEnergy_m, Util::KahanAccumulation::sum, SetStatistics::tmean_m, SetStatistics::totalCharge_m, SetStatistics::totalMass_m, and SetStatistics::trms_m.

Referenced by computeStatistics(), and saveH5().

Here is the call graph for this function:

◆ computeStatistics()

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

inline

Definition at line 199 of file LossDataSink.h.

References computeSetStatistics(), and splitSets().

Here is the call graph for this function:

◆ getNumSteps()

void LossDataSink::getNumSteps ( )

private

Definition at line 102 of file LossDataSink.cpp.

References fileName_m, H5call_m, and H5file_m.

Referenced by save().

◆ hasNoParticlesToDump()

bool LossDataSink::hasNoParticlesToDump ( ) const

private

Definition at line 688 of file LossDataSink.cpp.

References particles_m.

Referenced by save().

◆ hasTurnInformations()

bool LossDataSink::hasTurnInformations ( ) const

private

Definition at line 697 of file LossDataSink.cpp.

References turnNumber_m.

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

◆ inH5Mode()

bool LossDataSink::inH5Mode ( ) const

inline

Definition at line 103 of file LossDataSink.h.

References h5hut_mode_m.

◆ openASCII()

void LossDataSink::openASCII ( )

inlineprivate

Definition at line 134 of file LossDataSink.h.

References fileName_m, and os_m.

Referenced by save().

◆ openFile()

void LossDataSink::openFile	(	const char *	fname,
		h5_int32_t	mode,
		h5_prop_t	props
	)

private

Definition at line 123 of file LossDataSink.cpp.

References fileName_m, and H5file_m.

Referenced by openH5().

◆ openH5()

void LossDataSink::openH5 ( h5_int32_t mode = H5_O_WRONLY )

private

Definition at line 517 of file LossDataSink.cpp.

References fileName_m, and openFile().

Referenced by save().

Here is the call graph for this function:

◆ save()

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

Definition at line 630 of file LossDataSink.cpp.

References appendASCII(), bunchNumber_m, closeASCII(), closeFile(), fileName_m, OpalData::getInstance(), getNumSteps(), OpalData::getOpenMode(), globalTrackStep_m, gmsg, h5hut_mode_m, hasNoParticlesToDump(), openASCII(), openH5(), outputName_m, particles_m, RefPartP_m, RefPartR_m, refTime_m, saveASCII(), saveH5(), splitSets(), spos_m, startSet_m, turnNumber_m, OpalData::UNDEFINED, OpalData::WRITE, writeHeaderASCII(), and writeHeaderH5().

Referenced by Ring::finalise().

Here is the call graph for this function:

◆ saveASCII()

void LossDataSink::saveASCII ( )

private

Definition at line 896 of file LossDataSink.cpp.

References bunchNumber_m, OpalParticle::getId(), OpalParticle::getPx(), OpalParticle::getPy(), OpalParticle::getPz(), OpalParticle::getTime(), OpalParticle::getX(), OpalParticle::getY(), OpalParticle::getZ(), hasTurnInformations(), os_m, particles_m, size(), and turnNumber_m.

Referenced by save().

Here is the call graph for this function:

◆ saveH5()

void LossDataSink::saveH5 ( unsigned int setIdx )

private

Set current record/time step.

Definition at line 705 of file LossDataSink.cpp.

References bunchNumber_m, Options::computePercentiles, computeSetStatistics(), SetStatistics::eps_norm_m, SetStatistics::geomEmit_m, OpalParticle::getCharge(), OpalParticle::getId(), OpalParticle::getMass(), OpalParticle::getPx(), OpalParticle::getPy(), OpalParticle::getPz(), OpalParticle::getTime(), OpalParticle::getX(), OpalParticle::getY(), OpalParticle::getZ(), globalTrackStep_m, H5call_m, hasTurnInformations(), SetStatistics::maxR_m, SetStatistics::meanKineticEnergy_m, SetStatistics::ninetyFivePercentile_m, SetStatistics::ninetyNine_NinetyNinePercentile_m, SetStatistics::ninetyNinePercentile_m, SetStatistics::normalizedEps68Percentile_m, SetStatistics::normalizedEps95Percentile_m, SetStatistics::normalizedEps99_99Percentile_m, SetStatistics::normalizedEps99Percentile_m, SetStatistics::nTotal_m, particles_m, SetStatistics::pmean_m, SetStatistics::prms_m, RefPartP_m, RefPartR_m, refTime_m, SetStatistics::rmean_m, SetStatistics::rrms_m, setNumParticles(), setStep(), SetStatistics::sixtyEightPercentile_m, spos_m, startSet_m, SetStatistics::stdKineticEnergy_m, SetStatistics::tmean_m, SetStatistics::totalCharge_m, SetStatistics::totalMass_m, SetStatistics::trms_m, turnNumber_m, writeDataFloat64(), writeDataInt64(), writeStepAttribFloat64(), and writeStepAttribInt64().

Referenced by save().

Here is the call graph for this function:

◆ setNumParticles()

void LossDataSink::setNumParticles ( h5_int64_t num )

private

Definition at line 112 of file LossDataSink.cpp.

References fileName_m, H5call_m, and H5file_m.

Referenced by saveH5().

◆ setStep()

void LossDataSink::setStep ( )

private

Definition at line 92 of file LossDataSink.cpp.

References fileName_m, H5call_m, and H5file_m.

Referenced by saveH5().

◆ size()

size_t LossDataSink::size ( ) const

inline

Definition at line 197 of file LossDataSink.h.

References particles_m.

Referenced by saveASCII(), writeStepAttribFloat64(), and writeStepAttribInt64().

◆ splitSets()

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 1045 of file LossDataSink.cpp.

References particles_m, and startSet_m.

Referenced by computeStatistics(), and save().