#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 65 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)=0
	Output launched at event start after initialization, when particles are generated but not yet propagated. More...

virtual void	at_eventend (const Particles &particles, const int event_number, const EventInfo &info)=0
	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	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...

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 71 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()

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

pure virtual

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

Implemented in smash::BinaryOutputParticles, smash::BinaryOutputCollisions, smash::RootOutput, smash::OscarOutput< Format, Contents >, smash::ThermodynamicOutput, smash::VtkOutput, smash::HepMcOutput, smash::BinaryOutputInitialConditions, and smash::ICOutput.

◆ at_eventend()

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

pure virtual

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

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

◆ 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::BinaryOutputInitialConditions, smash::ICOutput, smash::BinaryOutputCollisions, smash::RootOutput, and smash::OscarOutput< Format, Contents >.

Definition at line 104 of file outputinterface.h.

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

Here is the caller graph for this function:

◆ at_intermediate_time()

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::BinaryOutputParticles, smash::RootOutput, smash::OscarOutput< Format, Contents >, smash::ThermodynamicOutput, smash::VtkOutput, and smash::ICOutput.

Definition at line 116 of file outputinterface.h.

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

◆ 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.

Only used for vtk output. Not connected to ThermodynamicOutput.

Reimplemented in smash::VtkOutput.

Definition at line 134 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.

Only used for vtk output. Not connected to ThermodynamicOutput.

Reimplemented in smash::VtkOutput.

Definition at line 151 of file outputinterface.h.

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

◆ 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 166 of file outputinterface.h.

                                                                      {
     SMASH_UNUSED(gct);
   }

◆ is_dilepton_output()

bool smash::OutputInterface::is_dilepton_output ( ) const

inline

Get, whether this is the dilepton output?

Definition at line 171 of file outputinterface.h.

171 { 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 174 of file outputinterface.h.

174 { 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 177 of file outputinterface.h.

177 { 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 184 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 205 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 229 of file outputinterface.h.

◆ is_photon_output_

const bool smash::OutputInterface::is_photon_output_

protected

Is this the photon output?

Definition at line 232 of file outputinterface.h.

◆ is_IC_output_

const bool smash::OutputInterface::is_IC_output_

protected

Is this the IC output?

Definition at line 235 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()

◆ at_eventend()

◆ at_interaction()

◆ at_intermediate_time()

◆ thermodynamics_output() [1/3]

◆ thermodynamics_output() [2/3]

◆ thermodynamics_output() [3/3]

◆ 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_