JetScape.h

Go to the documentation of this file. Or view the newest version in sPHENIX GitHub for file JetScape.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 JETSCAPE_H
#define JETSCAPE_H

#include "JetScapeLogger.h"
#include "JetScapeTaskSupport.h"
#include "JetScapeModuleBase.h"
#include "CausalLiquefier.h"

namespace Jetscape {

class JetScape : public JetScapeModuleBase {

public:
  JetScape();

  virtual ~JetScape();

  void Init();

  void Exec();

  void Finish();

  void SetNumberOfEvents(int m_n_events) { n_events = m_n_events; }

  int GetNumberOfEvents() { return n_events; }

  inline void SetReuseHydro(const bool reuse_hydro) {
    reuse_hydro_ = reuse_hydro;
  }
  inline bool GetReuseHydro() const { return reuse_hydro_; }

  inline void SetNReuseHydro(const unsigned int n_reuse_hydro) {
    if (!GetReuseHydro()) {
      JSWARN << "Number of hydro reusals set, but reusal not turned on.";
      JSWARN << "Try jetscape->SetReuseHydro (true);";
    }
    n_reuse_hydro_ = n_reuse_hydro;
  }
  inline unsigned int GetNReuseHydro() const { return n_reuse_hydro_; }

protected:
  void CompareElementsFromXML();
  void recurseToBuild(std::vector<std::string> &elems, tinyxml2::XMLElement *mElement);
  void recurseToSearch(std::vector<std::string> &elems, tinyxml2::XMLElement *uElement);
  void ReadGeneralParametersFromXML();
  void DetermineTaskListFromXML();
  void DetermineWritersFromXML();
  void CheckForWriterFromXML(const char *writerName,
                             std::string outputFilename);
  void SetModuleId(tinyxml2::XMLElement *moduleElement,
                   shared_ptr<JetScapeModuleBase> module);

  void SetPointers();

  void Show();
  int n_events;
  int n_events_printout;

  bool reuse_hydro_;
  unsigned int n_reuse_hydro_;

  std::shared_ptr<CausalLiquefier> liquefier;

  bool
      fEnableAutomaticTaskListDetermination; // Option to automatically determine the task list from the XML file,
      // rather than manually calling JetScapeTask::Add() in the run macro.
};

} // end namespace Jetscape

#endif