smash::BinaryOutputInitialConditions Class Reference

#include <binaryoutput.h>

Writes the particles when crossing the hypersurface to the binary file.

This class writes each particle to the binary output at the time of crossing the hypersurface. This time corresponds to the proper time of the hypersruface, which is - if not specified differently in the configuration - the passing time of the two nuclei.

Details of the output format can be found on the wiki in the User Guide section, look for Output: Initial Conditions.

Definition at line 255 of file binaryoutput.h.

Inheritance diagram for smash::BinaryOutputInitialConditions:

Collaboration diagram for smash::BinaryOutputInitialConditions:

Public Member Functions
	BinaryOutputInitialConditions (const bf::path &path, std::string name, const OutputParameters &out_par)
	Create binary initial conditions particle output. More...
void	at_eventstart (const Particles &, const int) 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_interaction (const Action &action, const double) override
	Writes particles that are removed when crossing the hypersurface to the 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 std::unique_ptr< 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...
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...

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

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

Create binary initial conditions 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 304 of file binaryoutput.cc.

    : BinaryOutputBase(path / "SMASH_IC.bin", "wb", name, out_par.ic_extended) {
}

Member Function Documentation

void smash::BinaryOutputInitialConditions::at_eventstart ( const Particles &  , const int    )

overridevirtual

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

Function unused for IC output. Needed since inherited.

Implements smash::OutputInterface.

Definition at line 309 of file binaryoutput.cc.

                                                             {}

void smash::BinaryOutputInitialConditions::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 312 of file binaryoutput.cc.

                                                                  {
  const auto &log = logger<LogArea::HyperSurfaceCrossing>();

  // 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());

  // If the runtime is too short some particles might not yet have
  // reached the hypersurface. Warning is printed.
  if (particles.size() != 0) {
    log.warn(
        "End time might be too small for initial conditions output. "
        "Hypersurface has not yet been crossed by ",
        particles.size(), " particle(s).");
  }
}

Here is the call graph for this function:

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

overridevirtual

Writes particles that are removed when crossing the hypersurface to the output.

Note that the particle information is written as a particle block, not as an interaction block.

Parameters

[in]

action

Action that holds the information of the interaction.

Reimplemented from smash::OutputInterface.

Definition at line 339 of file binaryoutput.cc.

                                                                 {
  if (action.get_type() == ProcessType::HyperSurfaceCrossing) {
    const char pchar = 'p';
    std::fwrite(&pchar, sizeof(char), 1, file_.get());
    write(action.incoming_particles().size());
    write(action.incoming_particles());
  }
}

Here is the call graph for this function:

---

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

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