#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

Attention: This class provides more virtual methods than those needed in different children classes. Although this is against the inheritance "is-a" relationship, it somehow simplifies here the hierarchy, because we avoid having many more interfaces. Furthermore all base virtual methods are implemented as no-operations, i.e. empty. This implies that they can and will be called if the interface is used polymorphically but the child does not implement the called method. This happens e.g. in the Experiment class where an array of pointers to the base class is initialized with different children and then different methods are called on all array entries (some will do what has to be done, but most will just do nothing).

Note: The parameters of most methods in this base class are not documented, as irrelevant for the empty implementation. However, every child class which overrides some methods documents them in detail. Refer to them for further information.

Attention: Some methods take an EventLabel parameter and some just an integer. The former contains both the number of event and the number of ensemble while the latter is meant to be the number of the event, only. Passing the number of event only is meant to emphasise that the method will combine input from different ensembles, when multiple are used.

Definition at line 111 of file outputinterface.h.

Inheritance diagram for smash::OutputInterface:

Public Member Functions
	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...

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

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

◆ ~OutputInterface()

smash::OutputInterface::~OutputInterface ( )

inlinepure virtualdefault

Pure virtual destructor to make class abstract and prevent its instantiation.

It needs a definition which is done outside the class.

Member Function Documentation

◆ at_eventstart() [1/4]

virtual void smash::OutputInterface::at_eventstart	(	const Particles &	,
		const EventLabel &	,
		const EventInfo &
	)

inlinevirtual

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

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

Definition at line 131 of file outputinterface.h.

132 {}

◆ at_eventstart() [2/4]

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

inlinevirtual

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

Reimplemented in smash::ThermodynamicOutput.

Definition at line 138 of file outputinterface.h.

138 {}

◆ at_eventstart() [3/4]

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

inlinevirtual

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

Reimplemented in smash::ThermodynamicLatticeOutput.

Definition at line 144 of file outputinterface.h.

146 {}

◆ at_eventstart() [4/4]

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

inlinevirtual

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

Reimplemented in smash::ThermodynamicLatticeOutput.

Definition at line 152 of file outputinterface.h.

154 {}

◆ at_eventend() [1/3]

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

inlinevirtual

Output launched at event end.

Event end is determined by maximal time-step option.

Reimplemented in smash::ThermodynamicLatticeOutput.

Definition at line 160 of file outputinterface.h.

160 {}

◆ at_eventend() [2/3]

virtual void smash::OutputInterface::at_eventend	(	const Particles &	,
		const EventLabel &	,
		const EventInfo &
	)

inlinevirtual

Output launched at event end.

Event end is determined by maximal time-step option.

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

Definition at line 166 of file outputinterface.h.

167 {}

◆ at_eventend() [3/3]

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

inlinevirtual

Output launched at event end.

Event end is determined by maximal time-step option.

Reimplemented in smash::ThermodynamicOutput.

Definition at line 172 of file outputinterface.h.

172 {}

◆ at_interaction()

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

inlinevirtual

Called whenever an action modified one or more particles.

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

Definition at line 177 of file outputinterface.h.

177 {}

◆ at_intermediate_time() [1/2]

virtual void smash::OutputInterface::at_intermediate_time	(	const Particles &	,
		const std::unique_ptr< Clock > &	,
		const DensityParameters &	,
		const EventLabel &	,
		const EventInfo &
	)

inlinevirtual

Output launched after every N'th time-step.

N is controlled by an option.

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

Definition at line 182 of file outputinterface.h.

185 {}

◆ at_intermediate_time() [2/2]

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

inlinevirtual

Output launched after every N'th timestep.

N is controlled by an option.

Reimplemented in smash::ThermodynamicOutput.

Definition at line 189 of file outputinterface.h.

191 {}

◆ thermodynamics_output() [1/3]

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

inlinevirtual

Output to write thermodynamics from the lattice.

Used for vtk output.

Reimplemented in smash::VtkOutput.

Definition at line 197 of file outputinterface.h.

199 {}

◆ thermodynamics_output() [2/3]

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

inlinevirtual

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

Used for vtk output.

Reimplemented in smash::VtkOutput.

Definition at line 205 of file outputinterface.h.

207 {}

◆ thermodynamics_lattice_output() [1/3]

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

inlinevirtual

Output to write thermodynamics from the lattice.

Used for thermodynamic lattice output.

Reimplemented in smash::ThermodynamicLatticeOutput.

Definition at line 213 of file outputinterface.h.

214 {}

◆ thermodynamics_lattice_output() [2/3]

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

inlinevirtual

Output to write thermodynamics from the lattice.

Used for thermodynamic lattice output.

Reimplemented in smash::ThermodynamicLatticeOutput.

Definition at line 220 of file outputinterface.h.

222 {}

◆ thermodynamics_lattice_output() [3/3]

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

inlinevirtual

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

Used for thermodynamic lattice output.

Reimplemented in smash::ThermodynamicLatticeOutput.

Definition at line 228 of file outputinterface.h.

230 {}

◆ thermodynamics_output() [3/3]

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

inlinevirtual

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

Only used for vtk output. Not connected to ThermodynamicOutput.

Reimplemented in smash::VtkOutput.

Definition at line 237 of file outputinterface.h.

237 {}

◆ fields_output()

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

inlinevirtual

Write fields in vtk output Fields are a pair of threevectors for example electric and magnetic field.

Reimplemented in smash::VtkOutput.

Definition at line 243 of file outputinterface.h.

245 {}

◆ is_dilepton_output()

bool smash::OutputInterface::is_dilepton_output ( ) const

inline

Get, whether this is the dilepton output?

Definition at line 248 of file outputinterface.h.

248 { return is_dilepton_output_; }

◆ is_photon_output()

bool smash::OutputInterface::is_photon_output ( ) const

inline

Get, whether this is the photon output?

Definition at line 251 of file outputinterface.h.

251 { 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 254 of file outputinterface.h.

254 { 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 261 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.");
   }

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

◆ is_photon_output_

const bool smash::OutputInterface::is_photon_output_

protected

Is this the photon output?

Definition at line 309 of file outputinterface.h.

◆ is_IC_output_

const bool smash::OutputInterface::is_IC_output_

protected

Is this the IC output?

Definition at line 312 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/3]

◆ at_eventend() [2/3]

◆ at_eventend() [3/3]

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