#include <binaryoutput.h>

Base class for SMASH binary output.

Definition at line 30 of file binaryoutput.h.

Inheritance diagram for smash::BinaryOutputBase:

Protected Member Functions
	BinaryOutputBase (const std::filesystem::path &path, const std::string &mode, const std::string &name, const std::vector< std::string > &quantities)
	Create binary output base. More...

void	write (const ToBinary::type &chunk)
	Write several bytes to the binary output. 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
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...

Private Attributes
const uint16_t	format_version_ = 10
	Binary file format version number. More...

const uint16_t	format_custom_ = 2
	Format variant number associated to the custom quantities case. More...

OutputFormatter< ToBinary >	formatter_
	The output formatter. More...

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

virtual	~OutputInterface ()=0
	Pure virtual destructor to make class abstract and prevent its instantiation. More...

virtual void	at_eventstart (const Particles &, const EventLabel &, const EventInfo &)
	Output launched at event start after initialization, when particles are generated but not yet propagated. More...

virtual void	at_eventstart (const std::vector< Particles > &, int)
	Output launched at event start after initialization, when particles are generated but not yet propagated. More...

virtual void	at_eventstart (const int, const ThermodynamicQuantity, const DensityType, RectangularLattice< DensityOnLattice >)
	Output launched at event start after initialization, when particles are generated but not yet propagated. More...

virtual void	at_eventstart (const int, const ThermodynamicQuantity, const DensityType, RectangularLattice< EnergyMomentumTensor >)
	Output launched at event start after initialization, when particles are generated but not yet propagated. More...

virtual void	at_eventend (const ThermodynamicQuantity)
	Output launched at event end. More...

virtual void	at_eventend (const Particles &, const EventLabel &, const EventInfo &)
	Output launched at event end. More...

virtual void	at_eventend (const std::vector< Particles > &, const int)
	Output launched at event end. More...

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

virtual void	at_intermediate_time (const Particles &, const std::unique_ptr< Clock > &, const DensityParameters &, const EventLabel &, const EventInfo &)
	Output launched after every N'th time-step. More...

virtual void	at_intermediate_time (const std::vector< Particles > &, const std::unique_ptr< Clock > &, const DensityParameters &)
	Output launched after every N'th timestep. More...

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

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

virtual void	thermodynamics_lattice_output (RectangularLattice< DensityOnLattice > &, const double)
	Output to write thermodynamics from the lattice. More...

virtual void	thermodynamics_lattice_output (RectangularLattice< DensityOnLattice > &, const double, const std::vector< Particles > &, const DensityParameters &)
	Output to write thermodynamics from the lattice. More...

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

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

virtual void	fields_output (const std::string, const std::string, RectangularLattice< std::pair< ThreeVector, ThreeVector >> &)
	Write fields in vtk output Fields are a pair of threevectors for example electric and magnetic field. 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...

Constructor & Destructor Documentation

◆ BinaryOutputBase()

smash::BinaryOutputBase::BinaryOutputBase	(	const std::filesystem::path &	path,
		const std::string &	mode,
		const std::string &	name,
		const std::vector< std::string > &	quantities
	)

explicitprotected

Create binary output base.

Parameters

[in]	path	Output path.
[in]	mode	Is used to determine the file access mode.
[in]	name	Name of the output.
[in]	quantities	The list of quantities printed to the output.

Exceptions

std::invalid_argument if the list of quantities is empty.

Definition at line 204 of file binaryoutput.cc.

     : OutputInterface(name), file_{path, mode}, formatter_(quantities) {
   if (quantities.empty()) {
     throw std::invalid_argument(
         "Empty quantities list passed to 'BinaryOutputBase' cconstructor.");
   }
   std::fwrite("SMSH", 4, 1, file_.get());  // magic number
   write(format_version_);                  // file format version number
   std::uint16_t format_variant{};
   if (quantities == OutputDefaultQuantities::oscar2013) {
     format_variant = 0;
   } else if (quantities == OutputDefaultQuantities::oscar2013extended) {
     format_variant = 1;
   } else {
     format_variant = format_custom_;
   }
   write(format_variant);
   write(SMASH_VERSION);
 }

Member Function Documentation

◆ write() [1/11]

void smash::BinaryOutputBase::write ( const ToBinary::type & chunk )

protected

Write several bytes to the binary output.

Meant to be used by the OutputFormatter.

Parameters

[in] chunk vector of bytes to be written.

Definition at line 231 of file binaryoutput.cc.

                                                       {
   std::fwrite(chunk.data(), sizeof(char), chunk.size(), file_.get());
 }

◆ write() [2/11]

void smash::BinaryOutputBase::write ( const char c )

protected

Write byte to binary output.

Parameters

[in] c Value to be written.

Definition at line 228 of file binaryoutput.cc.

                                          {
   std::fwrite(&c, sizeof(char), 1, file_.get());
 }

◆ write() [3/11]

void smash::BinaryOutputBase::write ( const std::string & s )

protected

Write string to binary output.

Parameters

[in] s String to be written.

Definition at line 235 of file binaryoutput.cc.

                                                {
   const auto size = smash::numeric_cast<uint32_t>(s.size());
   std::fwrite(&size, sizeof(std::uint32_t), 1, file_.get());
   std::fwrite(s.c_str(), s.size(), 1, file_.get());
 }

◆ write() [4/11]

void smash::BinaryOutputBase::write ( const double x )

protected

Write double to binary output.

Parameters

[in] x Value to be written.

Definition at line 241 of file binaryoutput.cc.

                                            {
   std::fwrite(&x, sizeof(x), 1, file_.get());
 }

◆ write() [5/11]

void smash::BinaryOutputBase::write ( const FourVector & v )

protected

Write four-vector to binary output.

Parameters

[in] v Four-vector to be written.

Definition at line 245 of file binaryoutput.cc.

                                                 {
   std::fwrite(v.begin(), sizeof(*v.begin()), 4, file_.get());
 }

◆ write() [6/11]

void smash::BinaryOutputBase::write ( const std::int32_t x )

inlineprotected

Write integer (32 bit) to binary output.

Parameters

[in] x Value to be written.

Definition at line 82 of file binaryoutput.h.

                                  {
     std::fwrite(&x, sizeof(x), 1, file_.get());
   }

◆ write() [7/11]

void smash::BinaryOutputBase::write ( const std::uint32_t x )

inlineprotected

Write unsigned integer (32 bit) to binary output.

Parameters

[in] x Value to be written.

Definition at line 90 of file binaryoutput.h.

                                   {
     std::fwrite(&x, sizeof(x), 1, file_.get());
   }

◆ write() [8/11]

void smash::BinaryOutputBase::write ( const std::uint16_t x )

inlineprotected

Write unsigned integer (16 bit) to binary output.

Parameters

[in] x Value to be written.

Definition at line 98 of file binaryoutput.h.

                                   {
     std::fwrite(&x, sizeof(x), 1, file_.get());
   }

◆ write() [9/11]

void smash::BinaryOutputBase::write ( const size_t x )

inlineprotected

Write a std::size_t to binary output.

Parameters

[in] x Value to be written.

Definition at line 106 of file binaryoutput.h.

106 { write(smash::numeric_cast<uint32_t>(x)); }

◆ write() [10/11]

void smash::BinaryOutputBase::write ( const Particles & particles )

protected

Write particle data of each particle in particles to binary output.

Parameters

[in] particles List of particles, whose data is to be written.

Definition at line 249 of file binaryoutput.cc.

                                                        {
   for (const auto &p : particles) {
     write_particledata(p);
   }
 }

◆ write() [11/11]

void smash::BinaryOutputBase::write ( const ParticleList & particles )

protected

Write each particle data entry to binary output.

Parameters

[in] particles List of particles, whose data is to be written.

Definition at line 255 of file binaryoutput.cc.

                                                           {
   for (const auto &p : particles) {
     write_particledata(p);
   }
 }

◆ write_particledata()

void smash::BinaryOutputBase::write_particledata ( const ParticleData & p )

protected

Write particle data to binary output.

Parameters

[in] p Particle data to be written.

Definition at line 261 of file binaryoutput.cc.

                                                                {
   write(formatter_.binary_chunk(p));
 }

Member Data Documentation

◆ file_

RenamingFilePtr smash::BinaryOutputBase::file_

protected

Binary particles output file path.

Definition at line 127 of file binaryoutput.h.

◆ format_version_

const uint16_t smash::BinaryOutputBase::format_version_ = 10

private

Binary file format version number.

Definition at line 131 of file binaryoutput.h.

◆ format_custom_

const uint16_t smash::BinaryOutputBase::format_custom_ = 2

private

Format variant number associated to the custom quantities case.

Definition at line 133 of file binaryoutput.h.

◆ formatter_

OutputFormatter<ToBinary> smash::BinaryOutputBase::formatter_

private

The output formatter.

Definition at line 135 of file binaryoutput.h.

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

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

Protected Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ BinaryOutputBase()

Member Function Documentation

◆ write() [1/11]

◆ write() [2/11]

◆ write() [3/11]

◆ write() [4/11]

◆ write() [5/11]

◆ write() [6/11]

◆ write() [7/11]

◆ write() [8/11]

◆ write() [9/11]

◆ write() [10/11]

◆ write() [11/11]

◆ write_particledata()

Member Data Documentation

◆ file_

◆ format_version_

◆ format_custom_

◆ formatter_