smash::VtkOutput Class Reference

#include <vtkoutput.h>

SMASH output in a paraview format, intended for simple visualization.

Definition at line 28 of file vtkoutput.h.

Inheritance diagram for smash::VtkOutput:

Collaboration diagram for smash::VtkOutput:

Public Member Functions
	VtkOutput (const bf::path &path, const std::string &name, const OutputParameters &out_par)
	Create a new VTK output. More...
	~VtkOutput ()
void	at_eventstart (const Particles &particles, const int event_number) override
	Writes the initial particle information list of an event to the VTK output. More...
void	at_eventend (const Particles &particles, const int event_number, double impact_parameter, bool empty_event) override
	Writes the final particle information list of an event to the VTK output. More...
void	at_intermediate_time (const Particles &particles, const std::unique_ptr< Clock > &clock, const DensityParameters &dens_param) override
	Writes out all current particles. More...
void	thermodynamics_output (const ThermodynamicQuantity tq, const DensityType dt, RectangularLattice< DensityOnLattice > &lattice) override
	Prints the density lattice in VTK format on a grid. More...
void	thermodynamics_output (const ThermodynamicQuantity tq, const DensityType dt, RectangularLattice< EnergyMomentumTensor > &lattice) override
	Prints the energy-momentum-tensor lattice in VTK format on a grid. More...
void	thermodynamics_output (const GrandCanThermalizer &gct) override
	Printout of all thermodynamic quantities from the thermalizer class. More...
Public Member Functions inherited from smash::OutputInterface
	OutputInterface (std::string name)
	Construct output interface. More...
virtual	~OutputInterface ()=default
virtual void	at_interaction (const Action &action, const double density)
	Called whenever an action modified one or more particles. 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...

Private Member Functions
void	write (const Particles &particles)
	Write the given particles to the output. More...
std::string	make_filename (const std::string &description, int counter)
	Make a file name given a description and a counter. More...
std::string	make_varname (const ThermodynamicQuantity tq, const DensityType dens_type)
	Make a variable name given quantity and density type. More...
template<typename T >
void	write_vtk_header (std::ofstream &file, RectangularLattice< T > &lat, const std::string &description)
	Write the VTK header. More...
template<typename T , typename F >
void	write_vtk_scalar (std::ofstream &file, RectangularLattice< T > &lat, const std::string &varname, F &&function)
	Write a VTK scalar. More...
template<typename T , typename F >
void	write_vtk_vector (std::ofstream &file, RectangularLattice< T > &lat, const std::string &varname, F &&function)
	Write a VTK vector. More...

Private Attributes
const bf::path	base_path_
	filesystem path for output More...
int	current_event_ = 0
	Event number. More...
int	vtk_output_counter_ = 0
	Number of vtk output in current event. More...
int	vtk_density_output_counter_ = 0
	Number of density lattice vtk output in current event. More...
int	vtk_tmn_output_counter_ = 0
	Number of energy-momentum tensor lattice vtk output in current event. More...
int	vtk_tmn_landau_output_counter_ = 0
	Number of Landau frame energy-momentum tensor vtk output in current event. More...
int	vtk_v_landau_output_counter_ = 0
	Number of Landau rest frame velocity vtk output in current event. More...
int	vtk_fluidization_counter_ = 0
	Number of fluidization output. More...
bool	is_thermodynamics_output_
	Is the VTK output a thermodynamics output. More...

Additional Inherited Members
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

VtkOutput()

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

Create a new VTK output.

Parameters

path	Path to the output file.
name	Name of the output.
out_par	Additional information on the configured output.

Definition at line 23 of file vtkoutput.cc.

    : OutputInterface(name),
      base_path_(std::move(path)),
      is_thermodynamics_output_(name == "Thermodynamics") {
  if (out_par.part_extended) {
    logg[LOutput].warn()
        << "Creating VTK output: There is no extended VTK format.";
  }
}

~VtkOutput()

smash::VtkOutput::~VtkOutput

(

)

Definition at line 34 of file vtkoutput.cc.

{}

Member Function Documentation

at_eventstart()

void smash::VtkOutput::at_eventstart ( const Particles &  particles, const int  event_number  )

overridevirtual

Writes the initial particle information list of an event to the VTK output.

Parameters

particles	Current list of all particles.
event_number	Number of the current event.

Implements smash::OutputInterface.

Definition at line 60 of file vtkoutput.cc.

                                                      {
  vtk_output_counter_ = 0;
  vtk_density_output_counter_ = 0;
  vtk_tmn_output_counter_ = 0;
  vtk_tmn_landau_output_counter_ = 0;
  vtk_v_landau_output_counter_ = 0;
  vtk_fluidization_counter_ = 0;
 
  current_event_ = event_number;
  if (!is_thermodynamics_output_) {
    write(particles);
    vtk_output_counter_++;
  }
}

Here is the call graph for this function:

at_eventend()

void smash::VtkOutput::at_eventend ( const Particles &  particles, const int  event_number, double  impact_parameter, bool  empty_event  )

overridevirtual

Writes the final particle information list of an event to the VTK output.

This currently does not do anything, because it is not required for the VTK output.

Parameters

particles	Unused. Current list of particles.
event_number	Unused. Number of event.
impact_parameter	Unused. Impact parameter of this event.
empty_event	Unused. Whether the projectile and target did not collide.

Implements smash::OutputInterface.

Definition at line 76 of file vtkoutput.cc.

                                              {
}

at_intermediate_time()

void smash::VtkOutput::at_intermediate_time ( const Particles &  particles, const std::unique_ptr< Clock > &  clock, const DensityParameters &  dens_param  )

overridevirtual

Writes out all current particles.

Parameters

particles	Current list of particles.
clock	Unused, needed since inherited.
dens_param	Unused, needed since inherited.

Reimplemented from smash::OutputInterface.

Definition at line 81 of file vtkoutput.cc.

                                                                {
  if (!is_thermodynamics_output_) {
    write(particles);
    vtk_output_counter_++;
  }
}

Here is the call graph for this function:

thermodynamics_output() [1/3]

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

overridevirtual

Prints the density lattice in VTK format on a grid.

Parameters

tq	The quantity whose density should be written, see ThermodynamicQuantity.
dt	The type of the density, see DensityType.
lattice	The lattice from which the quantity is taken.

Reimplemented from smash::OutputInterface.

Definition at line 239 of file vtkoutput.cc.

                                                   {
  if (!is_thermodynamics_output_) {
    return;
  }
  std::ofstream file;
  const std::string varname = make_varname(tq, dens_type);
  file.open(make_filename(varname, vtk_density_output_counter_), std::ios::out);
  write_vtk_header(file, lattice, varname);
  write_vtk_scalar(file, lattice, varname,
                   [&](DensityOnLattice &node) { return node.density(); });
  vtk_density_output_counter_++;
}

Here is the call graph for this function:

thermodynamics_output() [2/3]

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

overridevirtual

Prints the energy-momentum-tensor lattice in VTK format on a grid.

Parameters

tq	The quantity whose density should be written, see ThermodynamicQuantity.
dt	The type of the density, see DensityType
lattice	The lattice from which the quantity is taken.

Reimplemented from smash::OutputInterface.

Definition at line 270 of file vtkoutput.cc.

                                                           {
  if (!is_thermodynamics_output_) {
    return;
  }
  std::ofstream file;
  const std::string varname = make_varname(tq, dens_type);
 
  if (tq == ThermodynamicQuantity::Tmn) {
    file.open(make_filename(varname, vtk_tmn_output_counter_++), std::ios::out);
    write_vtk_header(file, Tmn_lattice, varname);
    for (int i = 0; i < 4; i++) {
      for (int j = i; j < 4; j++) {
        write_vtk_scalar(file, Tmn_lattice,
                         varname + std::to_string(i) + std::to_string(j),
                         [&](EnergyMomentumTensor &node) {
                           return node[EnergyMomentumTensor::tmn_index(i, j)];
                         });
      }
    }
  } else if (tq == ThermodynamicQuantity::TmnLandau) {
    file.open(make_filename(varname, vtk_tmn_landau_output_counter_++),
              std::ios::out);
    write_vtk_header(file, Tmn_lattice, varname);
    for (int i = 0; i < 4; i++) {
      for (int j = i; j < 4; j++) {
        write_vtk_scalar(file, Tmn_lattice,
                         varname + std::to_string(i) + std::to_string(j),
                         [&](EnergyMomentumTensor &node) {
                           const FourVector u = node.landau_frame_4velocity();
                           const EnergyMomentumTensor Tmn_L = node.boosted(u);
                           return Tmn_L[EnergyMomentumTensor::tmn_index(i, j)];
                         });
      }
    }
  } else {
    file.open(make_filename(varname, vtk_v_landau_output_counter_++),
              std::ios::out);
    write_vtk_header(file, Tmn_lattice, varname);
    write_vtk_vector(file, Tmn_lattice, varname,
                     [&](EnergyMomentumTensor &node) {
                       const FourVector u = node.landau_frame_4velocity();
                       return -u.velocity();
                     });
  }
}

Here is the call graph for this function:

thermodynamics_output() [3/3]

void smash::VtkOutput::thermodynamics_output ( const GrandCanThermalizer &  gct )

overridevirtual

Printout of all thermodynamic quantities from the thermalizer class.

Parameters

gct	Grand-canonical thermalizer from which the quantities are taken.

Reimplemented from smash::OutputInterface.

Definition at line 318 of file vtkoutput.cc.

                                                                    {
  if (!is_thermodynamics_output_) {
    return;
  }
  std::ofstream file;
  file.open(make_filename("fluidization_td", vtk_fluidization_counter_++),
            std::ios::out);
  write_vtk_header(file, gct.lattice(), "fluidization_td");
  write_vtk_scalar(file, gct.lattice(), "e",
                   [&](ThermLatticeNode &node) { return node.e(); });
  write_vtk_scalar(file, gct.lattice(), "p",
                   [&](ThermLatticeNode &node) { return node.p(); });
  write_vtk_vector(file, gct.lattice(), "v",
                   [&](ThermLatticeNode &node) { return node.v(); });
  write_vtk_scalar(file, gct.lattice(), "T",
                   [&](ThermLatticeNode &node) { return node.T(); });
  write_vtk_scalar(file, gct.lattice(), "mub",
                   [&](ThermLatticeNode &node) { return node.mub(); });
  write_vtk_scalar(file, gct.lattice(), "mus",
                   [&](ThermLatticeNode &node) { return node.mus(); });
}

Here is the call graph for this function:

write()

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

private

Write the given particles to the output.

Parameters

particles

The particles.

Definition at line 90 of file vtkoutput.cc.

                                                {
  char filename[32];
  snprintf(filename, sizeof(filename), "pos_ev%05i_tstep%05i.vtk",
           current_event_, vtk_output_counter_);
  FilePtr file_{std::fopen((base_path_ / filename).native().c_str(), "w")};
 
  /* Legacy VTK file format */
  std::fprintf(file_.get(), "# vtk DataFile Version 2.0\n");
  std::fprintf(file_.get(), "Generated from molecular-offset data %s\n",
               VERSION_MAJOR);
  std::fprintf(file_.get(), "ASCII\n");
 
  /* Unstructured data sets are composed of points, lines, polygons, .. */
  std::fprintf(file_.get(), "DATASET UNSTRUCTURED_GRID\n");
  std::fprintf(file_.get(), "POINTS %zu double\n", particles.size());
  for (const auto &p : particles) {
    std::fprintf(file_.get(), "%g %g %g\n", p.position().x1(),
                 p.position().x2(), p.position().x3());
  }
  std::fprintf(file_.get(), "CELLS %zu %zu\n", particles.size(),
               particles.size() * 2);
  for (size_t point_index = 0; point_index < particles.size(); point_index++) {
    std::fprintf(file_.get(), "1 %zu\n", point_index);
  }
  std::fprintf(file_.get(), "CELL_TYPES %zu\n", particles.size());
  for (size_t point_index = 0; point_index < particles.size(); point_index++) {
    std::fprintf(file_.get(), "1\n");
  }
  std::fprintf(file_.get(), "POINT_DATA %zu\n", particles.size());
  std::fprintf(file_.get(), "SCALARS pdg_codes int 1\n");
  std::fprintf(file_.get(), "LOOKUP_TABLE default\n");
  for (const auto &p : particles) {
    std::fprintf(file_.get(), "%s\n", p.pdgcode().string().c_str());
  }
  std::fprintf(file_.get(), "SCALARS is_formed int 1\n");
  std::fprintf(file_.get(), "LOOKUP_TABLE default\n");
  double current_time = particles.time();
  for (const auto &p : particles) {
    std::fprintf(file_.get(), "%s\n",
                 (p.formation_time() > current_time) ? "0" : "1");
  }
  std::fprintf(file_.get(), "SCALARS cross_section_scaling_factor double 1\n");
  std::fprintf(file_.get(), "LOOKUP_TABLE default\n");
  for (const auto &p : particles) {
    std::fprintf(file_.get(), "%g\n", p.xsec_scaling_factor());
  }
  std::fprintf(file_.get(), "SCALARS mass double 1\n");
  std::fprintf(file_.get(), "LOOKUP_TABLE default\n");
  for (const auto &p : particles) {
    std::fprintf(file_.get(), "%g\n", p.effective_mass());
  }
  std::fprintf(file_.get(), "SCALARS N_coll int 1\n");
  std::fprintf(file_.get(), "LOOKUP_TABLE default\n");
  for (const auto &p : particles) {
    std::fprintf(file_.get(), "%i\n", p.get_history().collisions_per_particle);
  }
  std::fprintf(file_.get(), "SCALARS particle_ID int 1\n");
  std::fprintf(file_.get(), "LOOKUP_TABLE default\n");
  for (const auto &p : particles) {
    std::fprintf(file_.get(), "%i\n", p.id());
  }
  std::fprintf(file_.get(), "SCALARS baryon_number int 1\n");
  std::fprintf(file_.get(), "LOOKUP_TABLE default\n");
  for (const auto &p : particles) {
    std::fprintf(file_.get(), "%i\n", p.pdgcode().baryon_number());
  }
  std::fprintf(file_.get(), "SCALARS strangeness int 1\n");
  std::fprintf(file_.get(), "LOOKUP_TABLE default\n");
  for (const auto &p : particles) {
    std::fprintf(file_.get(), "%i\n", p.pdgcode().strangeness());
  }
  std::fprintf(file_.get(), "VECTORS momentum double\n");
  for (const auto &p : particles) {
    std::fprintf(file_.get(), "%g %g %g\n", p.momentum().x1(),
                 p.momentum().x2(), p.momentum().x3());
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

make_filename()

std::string smash::VtkOutput::make_filename ( const std::string &  description, int  counter  )

private

Make a file name given a description and a counter.

Parameters

description	The description.
counter	The counter enumerating the outputs.

Definition at line 226 of file vtkoutput.cc.

                                                                      {
  char suffix[22];
  snprintf(suffix, sizeof(suffix), "_%05i_tstep%05i.vtk", current_event_,
           counter);
  return base_path_.string() + std::string("/") + descr + std::string(suffix);
}

Here is the caller graph for this function:

make_varname()

std::string smash::VtkOutput::make_varname ( const ThermodynamicQuantity  tq, const DensityType  dens_type  )

private

Make a variable name given quantity and density type.

Parameters

tq	The quantity.
dens_type	The density type.

Definition at line 233 of file vtkoutput.cc.

                                                                 {
  return std::string(to_string(dens_type)) + std::string("_") +
         std::string(to_string(tq));
}

Here is the call graph for this function:

Here is the caller graph for this function:

write_vtk_header()

template<typename T >

void smash::VtkOutput::write_vtk_header ( std::ofstream &  file, RectangularLattice< T > &  lat, const std::string &  description  )

private

Write the VTK header.

Parameters

file	Output file.
lat	Lattice corresponding to output.
description	Description of the output.

Definition at line 178 of file vtkoutput.cc.

                                                               {
  const auto dim = lattice.dimensions();
  const auto cs = lattice.cell_sizes();
  const auto orig = lattice.origin();
  file << "# vtk DataFile Version 2.0\n"
       << description << "\n"
       << "ASCII\n"
       << "DATASET STRUCTURED_POINTS\n"
       << "DIMENSIONS " << dim[0] << " " << dim[1] << " " << dim[2] << "\n"
       << "SPACING " << cs[0] << " " << cs[1] << " " << cs[2] << "\n"
       << "ORIGIN " << orig[0] << " " << orig[1] << " " << orig[2] << "\n"
       << "POINT_DATA " << lattice.size() << "\n";
}

Here is the call graph for this function:

Here is the caller graph for this function:

write_vtk_scalar()

template<typename T , typename F >

void smash::VtkOutput::write_vtk_scalar ( std::ofstream &  file, RectangularLattice< T > &  lat, const std::string &  varname, F &&  function  )

private

Write a VTK scalar.

Parameters

file	Output file.
lat	Lattice corresponding to output.
varname	Name of the output variable.
function	Function that gets the scalar given a lattice node.

Definition at line 195 of file vtkoutput.cc.

                                                                             {
  file << "SCALARS " << varname << " double 1\n"
       << "LOOKUP_TABLE default\n";
  file << std::setprecision(3);
  file << std::fixed;
  const auto dim = lattice.dimensions();
  lattice.iterate_sublattice({0, 0, 0}, dim, [&](T &node, int ix, int, int) {
    const double f_from_node = get_quantity(node);
    file << f_from_node << " ";
    if (ix == dim[0] - 1) {
      file << "\n";
    }
  });
}

Here is the call graph for this function:

Here is the caller graph for this function:

write_vtk_vector()

template<typename T , typename F >

void smash::VtkOutput::write_vtk_vector ( std::ofstream &  file, RectangularLattice< T > &  lat, const std::string &  varname, F &&  function  )

private

Write a VTK vector.

Parameters

file	Output file.
lat	Lattice corresponding to output.
varname	Name of the output variable.
function	Function that gets the vector given a lattice node.

Definition at line 213 of file vtkoutput.cc.

                                                                             {
  file << "VECTORS " << varname << " double\n";
  file << std::setprecision(3);
  file << std::fixed;
  const auto dim = lattice.dimensions();
  lattice.iterate_sublattice({0, 0, 0}, dim, [&](T &node, int, int, int) {
    const ThreeVector v = get_quantity(node);
    file << v.x1() << " " << v.x2() << " " << v.x3() << "\n";
  });
}

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

base_path_

const bf::path smash::VtkOutput::base_path_

private

filesystem path for output

Definition at line 169 of file vtkoutput.h.

current_event_

int smash::VtkOutput::current_event_ = 0

private

Event number.

Definition at line 172 of file vtkoutput.h.

vtk_output_counter_

int smash::VtkOutput::vtk_output_counter_ = 0

private

Number of vtk output in current event.

Definition at line 174 of file vtkoutput.h.

vtk_density_output_counter_

int smash::VtkOutput::vtk_density_output_counter_ = 0

private

Number of density lattice vtk output in current event.

Definition at line 177 of file vtkoutput.h.

vtk_tmn_output_counter_

int smash::VtkOutput::vtk_tmn_output_counter_ = 0

private

Number of energy-momentum tensor lattice vtk output in current event.

Definition at line 179 of file vtkoutput.h.

vtk_tmn_landau_output_counter_

int smash::VtkOutput::vtk_tmn_landau_output_counter_ = 0

private

Number of Landau frame energy-momentum tensor vtk output in current event.

Definition at line 181 of file vtkoutput.h.

vtk_v_landau_output_counter_

int smash::VtkOutput::vtk_v_landau_output_counter_ = 0

private

Number of Landau rest frame velocity vtk output in current event.

Definition at line 183 of file vtkoutput.h.

vtk_fluidization_counter_

int smash::VtkOutput::vtk_fluidization_counter_ = 0

private

Number of fluidization output.

Definition at line 185 of file vtkoutput.h.

is_thermodynamics_output_

bool smash::VtkOutput::is_thermodynamics_output_

private

Is the VTK output a thermodynamics output.

Definition at line 187 of file vtkoutput.h.

---

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

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