JetScapeEventHeader.h

Go to the documentation of this file. Or view the newest version in sPHENIX GitHub for file JetScapeEventHeader.h

/*******************************************************************************
 * Copyright (c) The JETSCAPE Collaboration, 2018
 *
 * Modular, task-based framework for simulating all aspects of heavy-ion collisions
 * 
 * For the list of contributors see AUTHORS.
 *
 * Report issues at https://github.com/JETSCAPE/JETSCAPE/issues
 *
 * or via email to bugs.jetscape@gmail.com
 *
 * Distributed under the GNU General Public License 3.0 (GPLv3 or later).
 * See COPYING for details.
 ******************************************************************************/

#ifndef JETSCAPEEVENTHEADER_H
#define JETSCAPEEVENTHEADER_H

namespace Jetscape {

class JetScapeEventHeader {

public:
  JetScapeEventHeader(){};
  // ~JetScapeEventHeader(){};
  // JetScapeEventHeader(const JetScapeEventHeader &c); //copy constructor

  /* const Parton& getParton(int idx) const; */
  /* const vector<Parton>& getPartonCollection() const; */
  /* void addParton(Parton &p); */
  /* void addPartonShower(shared_ptr<PartonShower> ps); */
  /* void deleteParton(int idx); */

  // ============================ Initial Hard Process =================================
  double GetSigmaGen() { return SigmaGen; };
  void SetSigmaGen(double d) { SigmaGen = d; };

  double GetSigmaErr() { return SigmaErr; };
  void SetSigmaErr(double d) { SigmaErr = d; };

  double GetPtHat() { return PtHat; };
  void SetPtHat(double d) { PtHat = d; };

  double GetEventWeight() { return EventWeight; };
  void SetEventWeight(double d) { EventWeight = d; };

  // ============================ Initial State =================================
  double GetNpart() { return Npart; };
  void SetNpart(double d) { Npart = d; };

  double GetNcoll() { return Ncoll; };
  void SetNcoll(double d) { Ncoll = d; };

  double GetTotalEntropy() { return TotalEntropy; };
  void SetTotalEntropy(double d) { TotalEntropy = d; };

  // ============================ Hydro =================================
  double GetEventPlaneAngle() { return EventPlaneAngle; };
  void SetEventPlaneAngle(double d) { EventPlaneAngle = d; };

private:
  // ============================ Initial Hard Process =================================
  double SigmaGen = -1;
  double SigmaErr = -1;
  double PtHat = -1;
  double EventWeight = 1;

  // ============================ Initial State =================================
  double Npart = -1; // could be int, but using double to allow averaged values
  double Ncoll = -1; // could be int, but using double to allow averaged values
  double TotalEntropy = -1;

  // ============================ Hydro =================================
  double EventPlaneAngle = -999;

  // ============================ Other possible options =================================
  // IS:
  // double Eccentricity;
  // double ImpactParameter;

  // Hydro:
  // angles, eccentricities

  // Eloss:
  // Switching criteria

  // Potential for consistency checks:
  // TotalEntropy from Free Streaming and from Hydro

  // Potential file-wide parameters (should be implemented in a different class)

  // IS:
  // string NuclearDensity; // (Woods-Saxon?)
  // string SaturationModel; // (IP-SAT, MCKLN, ...)

  // Inital Hard Process:
  // ptHat_min, ptHat_max
  // generator name, npdf,

  // Hydro:
  // EOS

  // Free Streaming:
  // Name, version

  // Hadronization:
  // type (colorless/colored, reco, ...)
};

} // end namespace Jetscape

#endif // JETSCAPEEVENTHEADER_H