Analysis Software
Documentation for sPHENIX simulation software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MpiMusic Class Reference

#include <JETSCAPE/blob/main/src/hydro/MusicWrapper.h>

+ Inheritance diagram for MpiMusic:
+ Collaboration diagram for MpiMusic:

Public Member Functions

 MpiMusic ()
 
 ~MpiMusic ()
 
void InitializeHydro (Parameter parameter_list)
 
void EvolveHydro ()
 
void GetHydroInfo (Jetscape::real t, Jetscape::real x, Jetscape::real y, Jetscape::real z, std::unique_ptr< FluidCellInfo > &fluid_cell_info_ptr)
 
void GetHydroInfo_JETSCAPE (Jetscape::real t, Jetscape::real x, Jetscape::real y, Jetscape::real z, std::unique_ptr< FluidCellInfo > &fluid_cell_info_ptr)
 
void GetHydroInfo_MUSIC (Jetscape::real t, Jetscape::real x, Jetscape::real y, Jetscape::real z, std::unique_ptr< FluidCellInfo > &fluid_cell_info_ptr)
 
void SetHydroGridInfo ()
 
void PassHydroEvolutionHistoryToFramework ()
 
void add_a_liquefier (std::shared_ptr< LiquefierBase > new_liqueifier)
 
void GetHyperSurface (Jetscape::real T_cut, SurfaceCellInfo *surface_list_ptr)
 
void collect_freeze_out_surface ()
 
- Public Member Functions inherited from Jetscape::FluidDynamics
 FluidDynamics ()
 
virtual ~FluidDynamics ()
 
virtual void Init ()
 
virtual void Exec ()
 
virtual void Clear ()
 
ParameterGetParameterList ()
 
virtual void CollectHeader (weak_ptr< JetScapeWriter > w)
 
virtual double GetEventPlaneAngle ()
 
virtual void GetTemperature (double t, double x, double y, double z, double &mT)
 
virtual void GetHydroCell (double t, double x, double y, double z, std::unique_ptr< FluidCellInfo > &fCell)
 
int GetHydroStatus () const
 
void StoreHydroEvolutionHistory (std::unique_ptr< FluidCellInfo > &fluid_cell_info_ptr)
 
void clear_up_evolution_data ()
 
void GetHydroStartTime (double &tau0)
 
Jetscape::real GetHydroEndTime () const
 
Jetscape::real GetHydroFreezeOutTemperature () const
 
void PrintFluidCellInformation (FluidCellInfo *fluid_cell_info_ptr)
 
void FindAConstantTemperatureSurface (Jetscape::real T_sw, std::vector< SurfaceCellInfo > &surface_cells)
 
virtual Jetscape::real GetEnergyDensity (Jetscape::real time, Jetscape::real x, Jetscape::real y, Jetscape::real z)
 
virtual Jetscape::real GetEntropyDensity (Jetscape::real time, Jetscape::real x, Jetscape::real y, Jetscape::real z)
 
virtual Jetscape::real GetTemperature (Jetscape::real time, Jetscape::real x, Jetscape::real y, Jetscape::real z)
 
virtual Jetscape::real GetQgpFraction (Jetscape::real time, Jetscape::real x, Jetscape::real y, Jetscape::real z)
 
void get_source_term (Jetscape::real tau, Jetscape::real x, Jetscape::real y, Jetscape::real eta, std::array< Jetscape::real, 4 > jmu) const
 
virtual void UpdateEnergyDeposit (int t, double edop)
 slots for "jet" signals (future)
 
virtual void GetEnergyDensity (int t, double &edensity)
 slots for "jet" signals (future)
 
const EvolutionHistoryget_bulk_info () const
 
- Public Member Functions inherited from Jetscape::JetScapeModuleBase
 JetScapeModuleBase ()
 
 JetScapeModuleBase (string m_name)
 
virtual ~JetScapeModuleBase ()
 
void SetXMLMainFileName (string m_name)
 
string GetXMLMainFileName ()
 
void SetXMLUserFileName (string m_name)
 
string GetXMLUserFileName ()
 
shared_ptr< std::mt19937 > GetMt19937Generator ()
 
tinyxml2::XMLElementGetXMLElement (std::initializer_list< const char * > path, bool isRequired=true)
 
std::string GetXMLElementText (std::initializer_list< const char * > path, bool isRequired=true)
 
int GetXMLElementInt (std::initializer_list< const char * > path, bool isRequired=true)
 
double GetXMLElementDouble (std::initializer_list< const char * > path, bool isRequired=true)
 
- Public Member Functions inherited from Jetscape::JetScapeTask
 JetScapeTask ()
 
virtual ~JetScapeTask ()
 
virtual void Finish ()
 
virtual void ExecuteTasks ()
 
virtual void ExecuteTask ()
 
virtual void InitTask ()
 
virtual void InitTasks ()
 
virtual void ClearTasks ()
 
virtual void ClearTask ()
 
virtual void FinishTask ()
 
virtual void FinishTasks ()
 
virtual void WriteTasks (weak_ptr< JetScapeWriter > w)
 
virtual void WriteTask (weak_ptr< JetScapeWriter > w)
 
virtual void CollectHeaders (weak_ptr< JetScapeWriter > w)
 
virtual void Add (shared_ptr< JetScapeTask > m_tasks)
 
virtual const int GetMyTaskNumber () const
 
const vector< shared_ptr
< JetScapeTask > > 
GetTaskList () const
 
shared_ptr< JetScapeTaskGetTaskAt (int i)
 
void EraseTaskLast ()
 
void EraseTaskAt (int i)
 
void ResizeTaskList (int i)
 
void ClearTaskList ()
 
int GetNumberOfTasks ()
 
const bool GetActive () const
 
void SetActive (bool m_active_exec)
 
void SetId (string m_id)
 
const string GetId () const
 
const shared_ptr
< JetScapeModuleMutex
GetMutex () const
 
void SetMutex (shared_ptr< JetScapeModuleMutex > m_mutex)
 
- Public Member Functions inherited from sigslot::has_slots< sigslot::multi_threaded_local >
 has_slots ()
 
 has_slots (const has_slots &hs)
 
void signal_connect (_signal_base< sigslot::multi_threaded_local > *sender)
 
void signal_disconnect (_signal_base< sigslot::multi_threaded_local > *sender)
 
virtual ~has_slots ()
 
void disconnect_all ()
 

Private Attributes

std::unique_ptr< MUSIC > music_hydro_ptr
 
Jetscape::real freezeout_temperature
 [GeV]
 
int doCooperFrye
 
int flag_output_evo_to_file
 
bool has_source_terms
 
std::shared_ptr
< HydroSourceJETSCAPE
hydro_source_terms_ptr
 

Static Private Attributes

static RegisterJetScapeModule
< MpiMusic
reg
 

Additional Inherited Members

- Static Public Member Functions inherited from Jetscape::JetScapeModuleBase
static int GetCurrentEvent ()
 
static void IncrementCurrentEvent ()
 
- Protected Attributes inherited from Jetscape::FluidDynamics
Jetscape::real hydro_tau_0
 
Jetscape::real hydro_tau_max
 
Jetscape::real hydro_freeze_out_temperature
 
HydroStatus hydro_status
 
std::shared_ptr< InitialStateini
 
std::shared_ptr
< PreequilibriumDynamics
pre_eq_ptr
 
double eta
 
bool boost_invariant_
 
Parameter parameter_list
 
EvolutionHistory bulk_info
 
std::weak_ptr< LiquefierBaseliquefier_ptr
 

Detailed Description

this is wrapper class for MUSIC so that it can be used as a external library for the JETSCAPE integrated framework

Definition at line 78 of file MusicWrapper.h.

View newest version in sPHENIX GitHub at line 78 of file MusicWrapper.h

Constructor & Destructor Documentation

MpiMusic::MpiMusic ( )

Definition at line 33 of file MusicWrapper.cc.

View newest version in sPHENIX GitHub at line 33 of file MusicWrapper.cc

References Jetscape::NOT_START, and SetId().

+ Here is the call graph for this function:

MpiMusic::~MpiMusic ( )

Definition at line 44 of file MusicWrapper.cc.

View newest version in sPHENIX GitHub at line 44 of file MusicWrapper.cc

Member Function Documentation

void MpiMusic::add_a_liquefier ( std::shared_ptr< LiquefierBase new_liquefier)
inlinevirtual
     @return 3-component (vx,vy,vz) fluid velocity at point (t or tau, x, y, z or eta).
Parameters
timeTime or tau coordinate.
xSpace coordinate.
ySpace coordinate.
zSpace or eta coordinate.
Returns
4-component fluid velocity at point (t or tau, x, y, zor eta).
Parameters
timeTime or tau coordinate.
xSpace coordinate.
ySpace coordinate.
zSpace or eta coordinate.
Returns
Net baryon density at point (t or tau, x, y, z or eta).
Parameters
timeTime or tau coordinate.
xSpace coordinate.
ySpace coordinate.
zSpace or eta coordinate.
Returns
Net charge density at point (t or tau, x, y, z or eta).
Parameters
timeTime or tau coordinate.
xSpace coordinate.
ySpace coordinate.
zSpace or eta coordinate.

Reimplemented from Jetscape::FluidDynamics.

Definition at line 116 of file MusicWrapper.h.

View newest version in sPHENIX GitHub at line 116 of file MusicWrapper.h

void MpiMusic::collect_freeze_out_surface ( )

Definition at line 223 of file MusicWrapper.cc.

View newest version in sPHENIX GitHub at line 223 of file MusicWrapper.cc

void MpiMusic::EvolveHydro ( )
virtual

Default function to evolve the hydrodynamics. It can be overridden by different modules.

Reimplemented from Jetscape::FluidDynamics.

Definition at line 156 of file MusicWrapper.cc.

View newest version in sPHENIX GitHub at line 156 of file MusicWrapper.cc

References dz, Jetscape::FINISHED, Jetscape::INITIALIZED, JSINFO, JSWARN, nz, and VERBOSE.

void MpiMusic::GetHydroInfo ( Jetscape::real  t,
Jetscape::real  x,
Jetscape::real  y,
Jetscape::real  z,
std::unique_ptr< FluidCellInfo > &  fluid_cell_info_ptr 
)
virtual

Retrieves the hydro information at a given space-time point. It throws a InvalidSpaceTimeRange message when (t or tau, x, y, z or eta) is out of the evolution history range.

Parameters
timeTime or tau coordinate.
xSpace coordinate.
ySpace coordinate.
zSpace or eta coordinate.
fluid_cell_info_ptrA pointer to the FluidCellInfo class.

Reimplemented from Jetscape::FluidDynamics.

Definition at line 299 of file MusicWrapper.cc.

View newest version in sPHENIX GitHub at line 299 of file MusicWrapper.cc

void MpiMusic::GetHydroInfo_JETSCAPE ( Jetscape::real  t,
Jetscape::real  x,
Jetscape::real  y,
Jetscape::real  z,
std::unique_ptr< FluidCellInfo > &  fluid_cell_info_ptr 
)

Definition at line 306 of file MusicWrapper.cc.

View newest version in sPHENIX GitHub at line 306 of file MusicWrapper.cc

void MpiMusic::GetHyperSurface ( Jetscape::real  T_cut,
SurfaceCellInfo surface_list_ptr 
)
inline

Definition at line 121 of file MusicWrapper.h.

View newest version in sPHENIX GitHub at line 121 of file MusicWrapper.h

void MpiMusic::InitializeHydro ( Parameter  parameter_list)
virtual

Default function to initialize the hydrodynamics. It can be overridden by different modules.

Parameters
parameter_listAn object of the class Parameter.

Reimplemented from Jetscape::FluidDynamics.

Definition at line 46 of file MusicWrapper.cc.

View newest version in sPHENIX GitHub at line 46 of file MusicWrapper.cc

References Acts::UnitConstants::e, perf_headwind::input_file, JSINFO, JSWARN, and VERBOSE.

void MpiMusic::SetHydroGridInfo ( )

Definition at line 246 of file MusicWrapper.cc.

View newest version in sPHENIX GitHub at line 246 of file MusicWrapper.cc

Member Data Documentation

int MpiMusic::doCooperFrye
private

flag to run Cooper-Frye freeze-out for soft particles

Definition at line 84 of file MusicWrapper.h.

View newest version in sPHENIX GitHub at line 84 of file MusicWrapper.h

int MpiMusic::flag_output_evo_to_file
private

Definition at line 86 of file MusicWrapper.h.

View newest version in sPHENIX GitHub at line 86 of file MusicWrapper.h

Jetscape::real MpiMusic::freezeout_temperature
private

[GeV]

Definition at line 83 of file MusicWrapper.h.

View newest version in sPHENIX GitHub at line 83 of file MusicWrapper.h

bool MpiMusic::has_source_terms
private

Definition at line 87 of file MusicWrapper.h.

View newest version in sPHENIX GitHub at line 87 of file MusicWrapper.h

std::shared_ptr<HydroSourceJETSCAPE> MpiMusic::hydro_source_terms_ptr
private

Definition at line 88 of file MusicWrapper.h.

View newest version in sPHENIX GitHub at line 88 of file MusicWrapper.h

std::unique_ptr<MUSIC> MpiMusic::music_hydro_ptr
private

Definition at line 81 of file MusicWrapper.h.

View newest version in sPHENIX GitHub at line 81 of file MusicWrapper.h

RegisterJetScapeModule< MpiMusic > MpiMusic::reg
staticprivate

Definition at line 92 of file MusicWrapper.h.

View newest version in sPHENIX GitHub at line 92 of file MusicWrapper.h


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