#include <binaryoutput.h>

Writes the particle list at specific times to the binary file.

This class writes the current particle list at a specific time t to the binary output file. This specific time can be: event start, event end or every next time interval \(\Delta t \). Writing (or not writing) the output at these moments is controlled by different options. The time interval \(\Delta t \) is also regulated by an option. The output file is binary and has a block structure.

Details of the output format can be found on the wiki in the User Guide section, look for binary output.

Definition at line 196 of file binaryoutput.h.

Inheritance diagram for smash::BinaryOutputParticles:

[legend]

Collaboration diagram for smash::BinaryOutputParticles:

[legend]

Public Member Functions
	BinaryOutputParticles (const bf::path &path, std::string name, const OutputParameters &out_par)
	Create binary particle output. More...

void	at_eventstart (const Particles &particles, const int event_number) override
	Writes the initial particle information of an event to the binary output. More...

void	at_eventend (const Particles &particles, const int event_number, double impact_parameter, bool empty_event) override
	Writes the final particle information of an event to the binary output. More...

void	at_intermediate_time (const Particles &particles, const std::unique_ptr< Clock > &clock, const DensityParameters &dens_param) override
	Writes particles at each time interval; fixed by option OUTPUT_INTERVAL. More...

Public Member Functions inherited from smash::OutputInterface
	OutputInterface (std::string name)
	Construct output interface. More...

virtual	~OutputInterface ()=default

virtual void	at_interaction (const Action &action, const double density)
	Called whenever an action modified one or more particles. More...

virtual void	thermodynamics_output (const ThermodynamicQuantity tq, const DensityType dt, RectangularLattice< DensityOnLattice > &lattice)
	Output to write thermodynamics from the lattice. More...

virtual void	thermodynamics_output (const ThermodynamicQuantity tq, const DensityType dt, RectangularLattice< EnergyMomentumTensor > &lattice)
	Output to write energy-momentum tensor and related quantities from the lattice. More...

virtual void	thermodynamics_output (const GrandCanThermalizer &gct)
	Output to write energy-momentum tensor and related quantities from the thermalizer class. More...

bool	is_dilepton_output () const
	Get, whether this is the dilepton output? More...

bool	is_photon_output () const
	Get, whether this is the photon output? More...

bool	is_IC_output () const
	Get, whether this is the IC output? More...

const char *	to_string (const ThermodynamicQuantity tq)
	Convert thermodynamic quantities to strings. More...

const char *	to_string (const DensityType dens_type)
	Convert density types to strings. More...

Private Attributes
OutputOnlyFinal	only_final_
	Whether final- or initial-state particles should be written. More...

Additional Inherited Members
Protected Member Functions inherited from smash::BinaryOutputBase
	BinaryOutputBase (const bf::path &path, const std::string &mode, const std::string &name, bool extended_format)
	Create binary output base. More...

void	write (const char c)
	Write byte to binary output. More...

void	write (const std::string &s)
	Write string to binary output. More...

void	write (const double x)
	Write double to binary output. More...

void	write (const FourVector &v)
	Write four-vector to binary output. More...

void	write (const std::int32_t x)
	Write integer (32 bit) to binary output. More...

void	write (const std::uint32_t x)
	Write unsigned integer (32 bit) to binary output. More...

void	write (const std::uint16_t x)
	Write unsigned integer (16 bit) to binary output. More...

void	write (const size_t x)
	Write a std::size_t to binary output. More...

void	write (const Particles &particles)
	Write particle data of each particle in particles to binary output. More...

void	write (const ParticleList &particles)
	Write each particle data entry to binary output. More...

void	write_particledata (const ParticleData &p)
	Write particle data to binary output. More...

Protected Attributes inherited from smash::BinaryOutputBase
RenamingFilePtr	file_
	Binary particles output file path. More...

Protected Attributes inherited from smash::OutputInterface
const bool	is_dilepton_output_
	Is this the dilepton output? More...

const bool	is_photon_output_
	Is this the photon output? More...

const bool	is_IC_output_
	Is this the IC output? More...

Constructor & Destructor Documentation

◆ BinaryOutputParticles()

smash::BinaryOutputParticles::BinaryOutputParticles	(	const bf::path &	path,
		std::string	name,
		const OutputParameters &	out_par
	)

Create binary particle output.

Parameters

[in]	path	Output path.
[in]	name	Name of the ouput.
[in]	out_par	A structure containing the parameters of the output.

Definition at line 257 of file binaryoutput.cc.

     : BinaryOutputBase(path / "particles_binary.bin", "wb", name,
                        out_par.part_extended),
       only_final_(out_par.part_only_final) {}

Member Function Documentation

◆ at_eventstart()

void smash::BinaryOutputParticles::at_eventstart	(	const Particles &	particles,
		const int	event_number
	)

overridevirtual

Writes the initial particle information of an event to the binary output.

Parameters

[in]	particles	Current list of all particles.
[in]	event_number	Unused, needed since inherited.

Implements smash::OutputInterface.

Definition at line 264 of file binaryoutput.cc.

                                                      {
   const char pchar = 'p';
   if (only_final_ == OutputOnlyFinal::No) {
     std::fwrite(&pchar, sizeof(char), 1, file_.get());
     write(particles.size());
     write(particles);
   }
 }

Here is the call graph for this function:

◆ at_eventend()

void smash::BinaryOutputParticles::at_eventend	(	const Particles &	particles,
		const int	event_number,
		double	impact_parameter,
		bool	empty_event
	)

overridevirtual

Writes the final particle information of an event to the binary output.

Parameters

[in]	particles	Current list of particles.
[in]	event_number	Number of event.
[in]	impact_parameter	Impact parameter of this event.
[in]	empty_event	Whether there was no collision between target and projectile

Implements smash::OutputInterface.

Definition at line 274 of file binaryoutput.cc.

                                                           {
   const char pchar = 'p';
   if (!(empty_event && only_final_ == OutputOnlyFinal::IfNotEmpty)) {
     std::fwrite(&pchar, sizeof(char), 1, file_.get());
     write(particles.size());
     write(particles);
   }
  
   // Event end line
   const char fchar = 'f';
   std::fwrite(&fchar, sizeof(char), 1, file_.get());
   write(event_number);
   write(impact_parameter);
   const char empty = empty_event;
   write(empty);
  
   // Flush to disk
   std::fflush(file_.get());
 }

Here is the call graph for this function:

◆ at_intermediate_time()

void smash::BinaryOutputParticles::at_intermediate_time	(	const Particles &	particles,
		const std::unique_ptr< Clock > &	clock,
		const DensityParameters &	dens_param
	)

overridevirtual

Writes particles at each time interval; fixed by option OUTPUT_INTERVAL.

Parameters

[in]	particles	Current list of particles.
[in]	clock	Unused, needed since inherited.
[in]	dens_param	Unused, needed since inherited.

Reimplemented from smash::OutputInterface.

Definition at line 297 of file binaryoutput.cc.

                                                                             {
   const char pchar = 'p';
   if (only_final_ == OutputOnlyFinal::No) {
     std::fwrite(&pchar, sizeof(char), 1, file_.get());
     write(particles.size());
     write(particles);
   }
 }

Here is the call graph for this function:

Member Data Documentation

◆ only_final_

OutputOnlyFinal smash::BinaryOutputParticles::only_final_

private

Whether final- or initial-state particles should be written.

Definition at line 239 of file binaryoutput.h.

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

src/include/smash/binaryoutput.h
src/binaryoutput.cc

Public Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ BinaryOutputParticles()

Member Function Documentation

◆ at_eventstart()

◆ at_eventend()

◆ at_intermediate_time()

Member Data Documentation

◆ only_final_