smash::BinaryOutputCollisions Class Reference

#include <binaryoutput.h>

Saves SMASH collision history to binary file.

This class writes each collision, decay and box wall crossing to the output file. Optionally, one can also write the initial and final particle lists to the same file. 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 129 of file binaryoutput.h.

Inheritance diagram for smash::BinaryOutputCollisions:

Collaboration diagram for smash::BinaryOutputCollisions:

Public Member Functions
	BinaryOutputCollisions (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 list of an event to the binary output. More...
void	at_eventend (const Particles &particles, const int event_number, double impact_parameter) override
	Writes the final particle information list of an event to the binary output. More...
void	at_interaction (const Action &action, const double density) override
	Writes an interaction block, including information about the incoming and outgoing particles, to the binary output. More...
Public Member Functions inherited from smash::OutputInterface
	OutputInterface (std::string name)
	Construct output interface. More...
virtual	~OutputInterface ()=default
virtual void	at_intermediate_time (const Particles &particles, const Clock &clock, const DensityParameters &dens_param)
	Output launched after every N'th timestep. 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...
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
bool	print_start_end_
	Write initial and final particles additonally to collisions? 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 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...

Constructor & Destructor Documentation

BinaryOutputCollisions()

smash::BinaryOutputCollisions::BinaryOutputCollisions	(	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 output.
[in]	out_par	A structure containing parameters of the output.

Definition at line 176 of file binaryoutput.cc.

    : BinaryOutputBase(
          path / ((name == "Collisions" ? "collisions_binary" : name) + ".bin"),
          "wb", name, out_par.get_coll_extended(name)),
      print_start_end_(out_par.coll_printstartend) {}

Member Function Documentation

at_eventstart()

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

overridevirtual

Writes the initial particle information list 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 184 of file binaryoutput.cc.

                                                      {
  char pchar = 'p';
  if (print_start_end_) {
    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::BinaryOutputCollisions::at_eventend ( const Particles &  particles, const int  event_number, double  impact_parameter  )

overridevirtual

Writes the final particle information list 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.

Implements smash::OutputInterface.

Definition at line 194 of file binaryoutput.cc.

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

  // Event end line
  char fchar = 'f';
  std::fwrite(&fchar, sizeof(char), 1, file_.get());
  write(event_number);
  write(impact_parameter);

  // Flush to disk
  std::fflush(file_.get());
}

Here is the call graph for this function:

at_interaction()

void smash::BinaryOutputCollisions::at_interaction ( const Action &  action, const double  density  )

overridevirtual

Writes an interaction block, including information about the incoming and outgoing particles, to the binary output.

Parameters

[in]	action	Action that holds the information of the interaction.
[in]	density	Density at the interaction point.

Reimplemented from smash::OutputInterface.

Definition at line 214 of file binaryoutput.cc.

                                                                  {
  char ichar = 'i';
  std::fwrite(&ichar, sizeof(char), 1, file_.get());
  write(action.incoming_particles().size());
  write(action.outgoing_particles().size());
  std::fwrite(&density, sizeof(double), 1, file_.get());
  const double weight = action.get_total_weight();
  std::fwrite(&weight, sizeof(double), 1, file_.get());
  const double partial_weight = action.get_partial_weight();
  std::fwrite(&partial_weight, sizeof(double), 1, file_.get());
  const auto type = static_cast<uint32_t>(action.get_type());
  std::fwrite(&type, sizeof(uint32_t), 1, file_.get());
  write(action.incoming_particles());
  write(action.outgoing_particles());
}

Here is the call graph for this function:

Member Data Documentation

print_start_end_

bool smash::BinaryOutputCollisions::print_start_end_

private

Write initial and final particles additonally to collisions?

Definition at line 170 of file binaryoutput.h.

---

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

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