#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 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	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

std::string	outputName_m

h5_int64_t	H5call_m
	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 >	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 79 of file LossDataSink.h.

Constructor & Destructor Documentation

◆ LossDataSink() [1/3]

LossDataSink::LossDataSink ( )

default

◆ LossDataSink() [2/3]

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

Definition at line 188 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 212 of file LossDataSink.cpp.

References bunchNumber_m, particles_m, and turnNumber_m.

◆ ~LossDataSink()

LossDataSink::~LossDataSink ( )

Definition at line 228 of file LossDataSink.cpp.

References CLOSE_FILE, and H5file_m.

Member Function Documentation

◆ addParticle()

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

Definition at line 322 of file LossDataSink.cpp.

References bunchNumber_m, particles_m, and turnNumber_m.

Referenced by Ring::apply().

◆ addReferenceParticle()

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

Definition at line 313 of file LossDataSink.cpp.

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

◆ appendASCII()

void LossDataSink::appendASCII ( )

inlineprivate

Definition at line 113 of file LossDataSink.h.

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

Referenced by save().

Here is the call graph for this function:

◆ closeASCII()

void LossDataSink::closeASCII ( )

inlineprivate

Definition at line 125 of file LossDataSink.h.

References IpplInfo::myNode(), and os_m.

Referenced by save().

Here is the call graph for this function:

◆ computeSetStatistics()

SetStatistics LossDataSink::computeSetStatistics ( unsigned int setIdx )

private

Definition at line 712 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(), 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, Util::KahanAccumulation::sum, SetStatistics::tmean_m, and SetStatistics::trms_m.

Referenced by computeStatistics().

Here is the call graph for this function:

◆ computeStatistics()

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

inline

Definition at line 177 of file LossDataSink.h.

References computeSetStatistics(), and splitSets().

Here is the call graph for this function:

◆ hasNoParticlesToDump()

bool LossDataSink::hasNoParticlesToDump ( ) const

private

Definition at line 397 of file LossDataSink.cpp.

References particles_m, and reduce().

Referenced by save().

Here is the call graph for this function:

◆ hasTurnInformations()

bool LossDataSink::hasTurnInformations ( ) const

private

Definition at line 405 of file LossDataSink.cpp.

References allreduce(), and turnNumber_m.

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

Here is the call graph for this function:

◆ inH5Mode()

bool LossDataSink::inH5Mode ( )

inline

Definition at line 89 of file LossDataSink.h.

References h5hut_mode_m.

◆ openASCII()

void LossDataSink::openASCII ( )

inlineprivate

Definition at line 106 of file LossDataSink.h.

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

Referenced by save().

Here is the call graph for this function:

◆ openH5()

void LossDataSink::openH5 ( h5_int32_t mode = H5_O_WRONLY )

private

Definition at line 235 of file LossDataSink.cpp.

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

Referenced by save().

Here is the call graph for this function:

◆ reportOnError()

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

private

◆ save()

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

clear and return memory

Definition at line 337 of file LossDataSink.cpp.

References appendASCII(), Communicate::barrier(), bunchNumber_m, CLOSE_FILE, closeASCII(), IpplInfo::Comm, endl(), fileName_m, GET_NUM_STEPS, OpalData::getInstance(), OpalData::getOpenMode(), globalTrackStep_m, gmsg, 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:

◆ saveASCII()

void LossDataSink::saveASCII ( )

private

Definition at line 551 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:

◆ saveH5()

void LossDataSink::saveH5 ( unsigned int setIdx )

private

Set current record/time step.

Definition at line 413 of file LossDataSink.cpp.

Referenced by save().

Here is the call graph for this function:

◆ size()

size_t LossDataSink::size ( ) const

inline

Definition at line 172 of file LossDataSink.h.

References particles_m.

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

References allreduce(), particles_m, and startSet_m.

Referenced by computeStatistics().

Here is the call graph for this function:

◆ writeHeaderASCII()

void LossDataSink::writeHeaderASCII ( )

private

Definition at line 302 of file LossDataSink.cpp.

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

Referenced by save().

Here is the call graph for this function:

◆ writeHeaderH5()

void LossDataSink::writeHeaderH5 ( )

private

Definition at line 243 of file LossDataSink.cpp.

References collectionType_m, Options::computePercentiles, Util::getGitRevision(), TEMPORAL, and WRITE_FILEATTRIB_STRING.

Referenced by save().

Here is the call graph for this function:

Member Data Documentation

◆ bunchNumber_m

std::vector<size_t> LossDataSink::bunchNumber_m

private

Definition at line 157 of file LossDataSink.h.

Referenced by addParticle(), LossDataSink(), LossDataSink(), save(), saveASCII(), and saveH5().

◆ collectionType_m

CollectionType LossDataSink::collectionType_m

private

Definition at line 168 of file LossDataSink.h.

Referenced by writeHeaderH5().

◆ fileName_m

std::string LossDataSink::fileName_m

private

Definition at line 139 of file LossDataSink.h.

Referenced by appendASCII(), openASCII(), openH5(), and save().

◆ globalTrackStep_m

std::vector<h5_int64_t> LossDataSink::globalTrackStep_m

private

Definition at line 162 of file LossDataSink.h.

Referenced by addReferenceParticle(), save(), and saveH5().

◆ H5call_m

h5_int64_t LossDataSink::H5call_m

private

Current record, or time step, of H5 file.

Definition at line 154 of file LossDataSink.h.

Referenced by saveH5().

◆ H5file_m

h5_file_t LossDataSink::H5file_m

private

used to write out data in H5hut mode

Definition at line 148 of file LossDataSink.h.

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

◆ h5hut_mode_m

bool LossDataSink::h5hut_mode_m

private

Definition at line 142 of file LossDataSink.h.

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

◆ os_m

std::ofstream LossDataSink::os_m

private

Definition at line 145 of file LossDataSink.h.

Referenced by appendASCII(), closeASCII(), openASCII(), saveASCII(), and writeHeaderASCII().

◆ outputName_m

std::string LossDataSink::outputName_m

private

Definition at line 151 of file LossDataSink.h.

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

◆ particles_m

std::vector<OpalParticle> LossDataSink::particles_m

private

Definition at line 156 of file LossDataSink.h.

Referenced by addParticle(), computeSetStatistics(), hasNoParticlesToDump(), LossDataSink(), LossDataSink(), save(), saveASCII(), saveH5(), size(), and splitSets().

◆ RefPartP_m

std::vector<Vector_t> LossDataSink::RefPartP_m

private

Definition at line 161 of file LossDataSink.h.

Referenced by addReferenceParticle(), computeSetStatistics(), and saveH5().

◆ RefPartR_m

std::vector<Vector_t> LossDataSink::RefPartR_m

private

Definition at line 160 of file LossDataSink.h.

Referenced by addReferenceParticle(), computeSetStatistics(), save(), and saveH5().

◆ refTime_m

std::vector<double> LossDataSink::refTime_m

private

Definition at line 163 of file LossDataSink.h.

Referenced by addReferenceParticle(), computeSetStatistics(), save(), and saveH5().

◆ spos_m

std::vector<double> LossDataSink::spos_m

private

Definition at line 164 of file LossDataSink.h.

Referenced by addReferenceParticle(), computeSetStatistics(), save(), and saveH5().

◆ startSet_m

std::vector<unsigned long> LossDataSink::startSet_m

private

Definition at line 166 of file LossDataSink.h.

Referenced by computeSetStatistics(), saveH5(), and splitSets().

◆ turnNumber_m

std::vector<size_t> LossDataSink::turnNumber_m

private

Definition at line 158 of file LossDataSink.h.

Referenced by addParticle(), hasTurnInformations(), LossDataSink(), LossDataSink(), save(), saveASCII(), and saveH5().

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

src/Classic/Structure/LossDataSink.h
src/Classic/Structure/LossDataSink.cpp

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ LossDataSink() [1/3]

◆ LossDataSink() [2/3]

◆ LossDataSink() [3/3]

◆ ~LossDataSink()

Member Function Documentation

◆ addParticle()

◆ addReferenceParticle()

◆ appendASCII()

◆ closeASCII()

◆ computeSetStatistics()

◆ computeStatistics()

◆ hasNoParticlesToDump()

◆ hasTurnInformations()

◆ inH5Mode()

◆ openASCII()

◆ openH5()

◆ reportOnError()

◆ save()

◆ saveASCII()

◆ saveH5()

◆ size()

◆ splitSets()

◆ writeHeaderASCII()

◆ writeHeaderH5()

Member Data Documentation

◆ bunchNumber_m

◆ collectionType_m

◆ fileName_m

◆ globalTrackStep_m

◆ H5call_m

◆ H5file_m

◆ h5hut_mode_m

◆ os_m

◆ outputName_m

◆ particles_m

◆ RefPartP_m

◆ RefPartR_m

◆ refTime_m

◆ spos_m

◆ startSet_m

◆ turnNumber_m