OPAL (Object Oriented Parallel Accelerator Library)  2021.1.99
OPAL
Public Member Functions | Private Member Functions | Private Attributes | List of all members
LossDataSink Class Reference

#include <LossDataSink.h>

Public Member Functions

 LossDataSink ()=default
 
 LossDataSink (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< SetStatisticscomputeStatistics (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 fn_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< OpalParticleparticles_m
 
std::vector< size_t > bunchNumber_m
 
std::vector< size_t > turnNumber_m
 
std::vector< Vector_tRefPartR_m
 
std::vector< Vector_tRefPartP_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 81 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 
)

◆ LossDataSink() [3/3]

LossDataSink::LossDataSink ( const LossDataSink rsh)

Definition at line 196 of file LossDataSink.cpp.

References bunchNumber_m, particles_m, and turnNumber_m.

◆ ~LossDataSink()

LossDataSink::~LossDataSink ( )
noexcept

Definition at line 213 of file LossDataSink.cpp.

References Communicate::barrier(), CLOSE_FILE, IpplInfo::Comm, and H5file_m.

Here is the call graph for this function:

Member Function Documentation

◆ addParticle()

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

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

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

◆ appendASCII()

void LossDataSink::appendASCII ( )
inlineprivate

Definition at line 115 of file LossDataSink.h.

References fn_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 127 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

◆ computeStatistics()

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

Definition at line 179 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 376 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 385 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 91 of file LossDataSink.h.

References h5hut_mode_m.

◆ openASCII()

void LossDataSink::openASCII ( )
inlineprivate

Definition at line 108 of file LossDataSink.h.

References fn_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 221 of file LossDataSink.cpp.

References fn_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 
)

◆ saveASCII()

void LossDataSink::saveASCII ( )
private

◆ saveH5()

void LossDataSink::saveH5 ( unsigned int  setIdx)
private

◆ size()

size_t LossDataSink::size ( ) const
inline

Definition at line 174 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
numSetsnumber of passes of the reference particle

Definition at line 600 of file LossDataSink.cpp.

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

Referenced by computeStatistics().

Here is the call graph for this function:

◆ writeHeaderASCII()

void LossDataSink::writeHeaderASCII ( )
private

Definition at line 279 of file LossDataSink.cpp.

References endl(), 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 230 of file LossDataSink.cpp.

References collectionType_m, Util::getGitRevision(), OPAL_PROJECT_NAME, OPAL_PROJECT_VERSION, 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 159 of file LossDataSink.h.

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

◆ collectionType_m

CollectionType LossDataSink::collectionType_m
private

Definition at line 170 of file LossDataSink.h.

Referenced by writeHeaderH5().

◆ fn_m

std::string LossDataSink::fn_m
private

Definition at line 142 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 164 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 156 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 151 of file LossDataSink.h.

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

◆ h5hut_mode_m

bool LossDataSink::h5hut_mode_m
private

Definition at line 145 of file LossDataSink.h.

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

◆ os_m

std::ofstream LossDataSink::os_m
private

Definition at line 148 of file LossDataSink.h.

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

◆ outputName_m

std::string LossDataSink::outputName_m
private

Definition at line 153 of file LossDataSink.h.

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

◆ particles_m

std::vector<OpalParticle> LossDataSink::particles_m
private

◆ RefPartP_m

std::vector<Vector_t> LossDataSink::RefPartP_m
private

Definition at line 163 of file LossDataSink.h.

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

◆ RefPartR_m

std::vector<Vector_t> LossDataSink::RefPartR_m
private

Definition at line 162 of file LossDataSink.h.

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

◆ refTime_m

std::vector<double> LossDataSink::refTime_m
private

Definition at line 165 of file LossDataSink.h.

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

◆ spos_m

std::vector<double> LossDataSink::spos_m
private

Definition at line 166 of file LossDataSink.h.

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

◆ startSet_m

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

Definition at line 168 of file LossDataSink.h.

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

◆ turnNumber_m

std::vector<size_t> LossDataSink::turnNumber_m
private

Definition at line 160 of file LossDataSink.h.

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


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