#include <outputinterface.h>

Abstraction of generic output.

Any output should inherit this class. It provides virtual methods that will be called at predefined moments: 1) At event start and event end: at_eventstart, at_eventend 2) After every fixed time period: at_intermediate_time, thermodynamics_output 3) At each interaction: at_interaction

Definition at line 72 of file outputinterface.h.

Inheritance diagram for smash::OutputInterface:

[legend]

Collaboration diagram for smash::OutputInterface:

[legend]

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

virtual	~OutputInterface ()=default

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

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

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

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

virtual void	at_eventend (const int event_number, const ThermodynamicQuantity tq, const DensityType dens_type)
	Output launched at event end. More...

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

virtual void	at_eventend (const Particles &particles, const int event_number, const EventInfo &info)
	Output launched at event end. More...

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

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

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

virtual void	at_intermediate_time (const std::vector< Particles > &ensembles, 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_lattice_output (RectangularLattice< DensityOnLattice > &lattice, const double current_time)
	Output to write thermodynamics from the lattice. More...

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

virtual void	thermodynamics_lattice_output (const ThermodynamicQuantity tq, RectangularLattice< EnergyMomentumTensor > &lattice, const double current_time)
	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...

virtual void	fields_output (const std::string name1, const std::string name2, RectangularLattice< std::pair< ThreeVector, ThreeVector >> &lat)
	Write fields in vtk output. 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...

Protected Attributes
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

◆ OutputInterface()

smash::OutputInterface::OutputInterface ( std::string name )

inlineexplicit

Construct output interface.

Parameters

[in] name (File)name of output.

Definition at line 78 of file outputinterface.h.

       : is_dilepton_output_(name == "Dileptons"),
         is_photon_output_(name == "Photons"),
         is_IC_output_(name == "SMASH_IC") {}

◆ ~OutputInterface()

virtual smash::OutputInterface::~OutputInterface ( )

virtualdefault

Member Function Documentation

◆ at_eventstart() [1/4]

virtual void smash::OutputInterface::at_eventstart	(	const Particles &	particles,
		const int	event_number,
		const EventInfo &	info
	)

inlinevirtual

Output launched at event start after initialization, when particles are generated but not yet propagated.

Parameters

	particles	List of particles.
	event_number	Number of the current event.
[in]	info	Event info, see event_info

Reimplemented in smash::ICOutput, smash::BinaryOutputInitialConditions, smash::BinaryOutputCollisions, smash::BinaryOutputParticles, smash::HepMcInterface, smash::OscarOutput< Format, Contents >, smash::RootOutput, and smash::VtkOutput.

Definition at line 91 of file outputinterface.h.

                                                     {
     SMASH_UNUSED(particles);
     SMASH_UNUSED(event_number);
     SMASH_UNUSED(info);
   }

◆ at_eventstart() [2/4]

virtual void smash::OutputInterface::at_eventstart	(	const std::vector< Particles > &	ensembles,
		int	event_number
	)

inlinevirtual

Output launched at event start after initialization, when particles are generated but not yet propagated.

Parameters

	ensembles	List of particles.
[in]	event_number	Number of the current event.

Reimplemented in smash::ThermodynamicOutput.

Definition at line 103 of file outputinterface.h.

                                                {
     SMASH_UNUSED(ensembles);
     SMASH_UNUSED(event_number);
   }

◆ at_eventstart() [3/4]

virtual void smash::OutputInterface::at_eventstart	(	const int	event_number,
		const ThermodynamicQuantity	tq,
		const DensityType	dens_type,
		RectangularLattice< DensityOnLattice >	lattice
	)

inlinevirtual

Output launched at event start after initialization, when particles are generated but not yet propagated.

Parameters

[in]	event_number	Number of the current event.
[in]	tq	Thermodynamic quantity to deal with.
[in]	dens_type	Density type for the reference frame.
[in]	lattice	Lattice of tabulated values.

Reimplemented in smash::ThermodynamicLatticeOutput.

Definition at line 117 of file outputinterface.h.

                                                                            {
     SMASH_UNUSED(event_number);
     SMASH_UNUSED(tq);
     SMASH_UNUSED(dens_type);
     SMASH_UNUSED(lattice);
   }

◆ at_eventstart() [4/4]

virtual void smash::OutputInterface::at_eventstart	(	const int	event_number,
		const ThermodynamicQuantity	tq,
		const DensityType	dens_type,
		RectangularLattice< EnergyMomentumTensor >	lattice
	)

inlinevirtual

Output launched atevent start after initialization, when particles are generated but not yet propagated.

Parameters

[in]	event_number	Number of the current event.
[in]	tq	Thermodynamic quantity to deal with.
[in]	dens_type	Density type for the reference frame.
[in]	lattice	Lattice of tabulated values.

Reimplemented in smash::ThermodynamicLatticeOutput.

Definition at line 135 of file outputinterface.h.

                                                                                {
     SMASH_UNUSED(event_number);
     SMASH_UNUSED(tq);
     SMASH_UNUSED(dens_type);
     SMASH_UNUSED(lattice);
   }

◆ at_eventend() [1/4]

virtual void smash::OutputInterface::at_eventend	(	const int	event_number,
		const ThermodynamicQuantity	tq,
		const DensityType	dens_type
	)

inlinevirtual

Output launched at event end.

Event end is determined by maximal timestep option.

Parameters

[in]	event_number	Number of the current event.
[in]	tq	Thermodynamic quantity to deal with
[in]	dens_type	Density type for the evaluation of thermodynamic quantities

Definition at line 153 of file outputinterface.h.

                                                         {
     SMASH_UNUSED(event_number);
     SMASH_UNUSED(tq);
     SMASH_UNUSED(dens_type);
   }

◆ at_eventend() [2/4]

virtual void smash::OutputInterface::at_eventend ( const ThermodynamicQuantity tq )

inlinevirtual

Output launched at event end.

Event end is determined by maximal timestep option.

Parameters

[in] tq Thermodynamic quantity to deal with.

Reimplemented in smash::ThermodynamicLatticeOutput.

Definition at line 166 of file outputinterface.h.

166 { SMASH_UNUSED(tq); }

◆ at_eventend() [3/4]

virtual void smash::OutputInterface::at_eventend	(	const Particles &	particles,
		const int	event_number,
		const EventInfo &	info
	)

inlinevirtual

Output launched at event end.

Event end is determined by maximal timestep option.

Parameters

	particles	List of particles.
	event_number	Number of the current event.
[in]	info	Event info, see event_info

Reimplemented in smash::OscarOutput< Format, Contents >, smash::BinaryOutputParticles, smash::BinaryOutputInitialConditions, smash::ICOutput, smash::RootOutput, and smash::VtkOutput.

Definition at line 175 of file outputinterface.h.

                                                   {
     SMASH_UNUSED(particles);
     SMASH_UNUSED(event_number);
     SMASH_UNUSED(info);
   }

◆ at_eventend() [4/4]

virtual void smash::OutputInterface::at_eventend	(	const std::vector< Particles > &	ensembles,
		const int	event_number
	)

inlinevirtual

Output launched at event end.

Event end is determined by maximal timestep option.

Parameters

ensembles	List of particles.
event_number	Number of the current event.

Reimplemented in smash::ThermodynamicOutput.

Definition at line 187 of file outputinterface.h.

                                                    {
     SMASH_UNUSED(ensembles);
     SMASH_UNUSED(event_number);
   }

◆ at_interaction()

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

inlinevirtual

Called whenever an action modified one or more particles.

Parameters

action	The action object, containing the initial and final state etc.
density	The density at the interaction point.

Reimplemented in smash::BinaryOutputCollisions, smash::HepMcInterface, smash::OscarOutput< Format, Contents >, smash::RootOutput, smash::BinaryOutputInitialConditions, and smash::ICOutput.

Definition at line 200 of file outputinterface.h.

                                                                           {
     SMASH_UNUSED(action);
     SMASH_UNUSED(density);
   }

Here is the caller graph for this function:

◆ at_intermediate_time() [1/2]

virtual void smash::OutputInterface::at_intermediate_time	(	const Particles &	particles,
		const std::unique_ptr< Clock > &	clock,
		const DensityParameters &	dens_param,
		const EventInfo &	info
	)

inlinevirtual

Output launched after every N'th timestep.

N is controlled by an option.

Parameters

	particles	List of particles.
	clock	System clock.
	dens_param	Parameters for density calculation.
[in]	info	Event info, see event_info

Reimplemented in smash::ICOutput, smash::BinaryOutputParticles, smash::OscarOutput< Format, Contents >, smash::RootOutput, and smash::VtkOutput.

Definition at line 212 of file outputinterface.h.

                                                            {
     SMASH_UNUSED(particles);
     SMASH_UNUSED(clock);
     SMASH_UNUSED(dens_param);
     SMASH_UNUSED(info);
   }

◆ at_intermediate_time() [2/2]

virtual void smash::OutputInterface::at_intermediate_time	(	const std::vector< Particles > &	ensembles,
		const std::unique_ptr< Clock > &	clock,
		const DensityParameters &	dens_param
	)

inlinevirtual

Output launched after every N'th timestep.

N is controlled by an option.

Parameters

ensembles	List of particles.
clock	System clock.
dens_param	Parameters for density calculation.

Reimplemented in smash::ThermodynamicOutput.

Definition at line 227 of file outputinterface.h.

                                                                          {
     SMASH_UNUSED(ensembles);
     SMASH_UNUSED(clock);
     SMASH_UNUSED(dens_param);
   }

◆ thermodynamics_output() [1/3]

virtual void smash::OutputInterface::thermodynamics_output	(	const ThermodynamicQuantity	tq,
		const DensityType	dt,
		RectangularLattice< DensityOnLattice > &	lattice
	)

inlinevirtual

Output to write thermodynamics from the lattice.

Parameters

tq	Thermodynamic quantity to be written, used for file name etc.
dt	Type of density, i.e. which particles to take into account.
lattice	Lattice of tabulated values.

Used for vtk output.

Reimplemented in smash::VtkOutput.

Definition at line 243 of file outputinterface.h.

                                                      {
     SMASH_UNUSED(tq);
     SMASH_UNUSED(dt);
     SMASH_UNUSED(lattice);
   }

◆ thermodynamics_output() [2/3]

virtual void smash::OutputInterface::thermodynamics_output	(	const ThermodynamicQuantity	tq,
		const DensityType	dt,
		RectangularLattice< EnergyMomentumTensor > &	lattice
	)

inlinevirtual

Output to write energy-momentum tensor and related quantities from the lattice.

Parameters

tq	Thermodynamic quantity to be written: Tmn, Tmn_Landau, v_Landau.
dt	Type of density, i.e. which particles to take into account.
lattice	Lattice of tabulated values.

Used for vtk output.

Reimplemented in smash::VtkOutput.

Definition at line 260 of file outputinterface.h.

                                                          {
     SMASH_UNUSED(tq);
     SMASH_UNUSED(dt);
     SMASH_UNUSED(lattice);
   }

◆ thermodynamics_lattice_output() [1/3]

virtual void smash::OutputInterface::thermodynamics_lattice_output	(	RectangularLattice< DensityOnLattice > &	lattice,
		const double	current_time
	)

inlinevirtual

Output to write thermodynamics from the lattice.

Parameters

[in]	lattice	Lattice type DensityOnLattice of tabulated values.
[in]	current_time	Time of the simulation in the computational frame.

Used for thermodynamic lattice output.

Reimplemented in smash::ThermodynamicLatticeOutput.

Definition at line 275 of file outputinterface.h.

                                  {
     SMASH_UNUSED(lattice);
     SMASH_UNUSED(current_time);
   }

◆ thermodynamics_lattice_output() [2/3]

virtual void smash::OutputInterface::thermodynamics_lattice_output	(	RectangularLattice< DensityOnLattice > &	lattice,
		const double	current_time,
		const std::vector< Particles > &	ensembles,
		const DensityParameters &	dens_param
	)

inlinevirtual

Output to write thermodynamics from the lattice.

Parameters

[in]	lattice	Lattice type FourVector of tabulated values.
[in]	current_time	Time of the simulation in the computational frame.
[in]	ensembles	Particles, from which the 4-currents j_{Q,B,S} are computed
[in]	dens_param	set of parameters, defining smearing. For more info about smearing see ASCII Thermodynamics Output.

Used for thermodynamic lattice output.

Reimplemented in smash::ThermodynamicLatticeOutput.

Definition at line 294 of file outputinterface.h.

                                            {
     SMASH_UNUSED(lattice);
     SMASH_UNUSED(current_time);
     SMASH_UNUSED(ensembles);
     SMASH_UNUSED(dens_param);
   }

◆ thermodynamics_lattice_output() [3/3]

virtual void smash::OutputInterface::thermodynamics_lattice_output	(	const ThermodynamicQuantity	tq,
		RectangularLattice< EnergyMomentumTensor > &	lattice,
		const double	current_time
	)

inlinevirtual

Output to write energy-momentum tensor and related quantities from the lattice.

Parameters

[in]	tq	Thermodynamic quantity to be written, used for file name etc.
[in]	lattice	Lattice type EnergyMomentumTensor of tabulated values.
[in]	current_time	Time of the simulation in the computational frame.

Used for thermodynamic lattice output.

Reimplemented in smash::ThermodynamicLatticeOutput.

Definition at line 313 of file outputinterface.h.

                                  {
     SMASH_UNUSED(tq);
     SMASH_UNUSED(lattice);
     SMASH_UNUSED(current_time);
   }

◆ thermodynamics_output() [3/3]

virtual void smash::OutputInterface::thermodynamics_output ( const GrandCanThermalizer & gct )

inlinevirtual

Output to write energy-momentum tensor and related quantities from the thermalizer class.

Parameters

gct	Pointer to thermalizer

Only used for vtk output. Not connected to ThermodynamicOutput.

Reimplemented in smash::VtkOutput.

Definition at line 329 of file outputinterface.h.

                                                                      {
     SMASH_UNUSED(gct);
   }

◆ fields_output()

virtual void smash::OutputInterface::fields_output	(	const std::string	name1,
		const std::string	name2,
		RectangularLattice< std::pair< ThreeVector, ThreeVector >> &	lat
	)

inlinevirtual

Write fields in vtk output.

Fields are a pair of threevectors for example electric and magnetic field

Parameters

[in]	name1	Name of the first field
[in]	name2	Name of the second field
[in]	lat	Lattice storing both fields

Reimplemented in smash::VtkOutput.

Definition at line 342 of file outputinterface.h.

                                                                   {
     SMASH_UNUSED(name1);
     SMASH_UNUSED(name2);
     SMASH_UNUSED(lat);
   }

◆ is_dilepton_output()

bool smash::OutputInterface::is_dilepton_output ( ) const

inline

Get, whether this is the dilepton output?

Definition at line 351 of file outputinterface.h.

351 { return is_dilepton_output_; }

Here is the caller graph for this function:

◆ is_photon_output()

bool smash::OutputInterface::is_photon_output ( ) const

inline

Get, whether this is the photon output?

Definition at line 354 of file outputinterface.h.

354 { return is_photon_output_; }

◆ is_IC_output()

bool smash::OutputInterface::is_IC_output ( ) const

inline

Get, whether this is the IC output?

Definition at line 357 of file outputinterface.h.

357 { return is_IC_output_; }

◆ to_string() [1/2]

const char* smash::OutputInterface::to_string ( const ThermodynamicQuantity tq )

inline

Convert thermodynamic quantities to strings.

Parameters

[in] tq Enum value of the thermodynamic quantity.

Returns: String description of the enumerator.

Definition at line 364 of file outputinterface.h.

                                                         {
     switch (tq) {
       case ThermodynamicQuantity::EckartDensity:
         return "rho_eckart";
       case ThermodynamicQuantity::Tmn:
         return "tmn";
       case ThermodynamicQuantity::TmnLandau:
         return "tmn_landau";
       case ThermodynamicQuantity::LandauVelocity:
         return "v_landau";
       case ThermodynamicQuantity::j_QBS:
         return "j_QBS";
     }
     throw std::invalid_argument("Unknown thermodynamic quantity.");
   }

Here is the caller graph for this function:

◆ to_string() [2/2]

const char* smash::OutputInterface::to_string ( const DensityType dens_type )

inline

Convert density types to strings.

Parameters

[in] dens_type enum value of the density type

Returns: String description of the enumerator.

Definition at line 385 of file outputinterface.h.

                                                      {
     switch (dens_type) {
       case DensityType::Hadron:
         return "hadron";
       case DensityType::Baryon:
         return "net_baryon";
       case DensityType::BaryonicIsospin:
         return "net_baryonI3";
       case DensityType::Pion:
         return "pion";
       case DensityType::Isospin3_tot:
         return "tot_isospin3";
       case DensityType::Charge:
         return "charge";
       case DensityType::Strangeness:
         return "strangeness";
       case DensityType::None:
         return "none";
     }
     throw std::invalid_argument("Unknown density type.");
   }

Member Data Documentation

◆ is_dilepton_output_

const bool smash::OutputInterface::is_dilepton_output_

protected

Is this the dilepton output?

Definition at line 409 of file outputinterface.h.

◆ is_photon_output_

const bool smash::OutputInterface::is_photon_output_

protected

Is this the photon output?

Definition at line 412 of file outputinterface.h.

◆ is_IC_output_

const bool smash::OutputInterface::is_IC_output_

protected

Is this the IC output?

Definition at line 415 of file outputinterface.h.

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

src/include/smash/outputinterface.h

Public Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ OutputInterface()

◆ ~OutputInterface()

Member Function Documentation

◆ at_eventstart() [1/4]

◆ at_eventstart() [2/4]

◆ at_eventstart() [3/4]

◆ at_eventstart() [4/4]

◆ at_eventend() [1/4]

◆ at_eventend() [2/4]

◆ at_eventend() [3/4]

◆ at_eventend() [4/4]

◆ at_interaction()

◆ at_intermediate_time() [1/2]

◆ at_intermediate_time() [2/2]

◆ thermodynamics_output() [1/3]

◆ thermodynamics_output() [2/3]

◆ thermodynamics_lattice_output() [1/3]

◆ thermodynamics_lattice_output() [2/3]

◆ thermodynamics_lattice_output() [3/3]

◆ thermodynamics_output() [3/3]

◆ fields_output()

◆ is_dilepton_output()

◆ is_photon_output()

◆ is_IC_output()

◆ to_string() [1/2]

◆ to_string() [2/2]

Member Data Documentation

◆ is_dilepton_output_

◆ is_photon_output_

◆ is_IC_output_