StRoot  1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
StarUrQMD Class Reference
Inheritance diagram for StarUrQMD:
StarGenerator StMaker TDataSet

Public Member Functions

 StarUrQMD (const Char_t *name="UrQMD3_3_1")
Int_t Init ()
Int_t Generate ()
void Clear (const Option_t *opts="")
ENERGIES_tenergies ()
SYS_tsys ()
RSYS_trsys ()
CUTS_tcuts ()
SPDATA_tspdata ()
ISYS_tisys ()
COOR_tcoor ()
FRAG_tfrag ()
AIOS_taios ()
POTS_tpots ()
SCOOR_tscoor ()
SISYS_tsisys ()
SSYS_tssys ()
RTDELAY_trtdelay ()
ITDELAY_titdelay ()
SVINFO_tsvinfo ()
FFERMI_tffermi ()
PEQ_tpeq ()
- Public Member Functions inherited from StarGenerator
 StarGenerator (const Char_t *name="")
Int_t InitRun (Int_t runnumber)
 Developer may not provide run initialization.
virtual Int_t PreGenerate ()
 Developers may provide a pre-generate method which will execute before Generate().
virtual Int_t PostGenerate ()
 Developers may provide a post-generate method which will execute after Generate().
virtual void FillEA (StarGenEvent *event)
 (Optional) Method to fill a eA event
virtual void FillUser (StarGenEvent *event)
 (Optional) Method to fill a user-defined event
Int_t PreGenerateHook ()
Int_t PostGenerateHook ()
Int_t Make ()
 If called, make simply aliases to the Generate() function.
void Clear (const Option_t *opts="")
 Clear the event.
Int_t Finalize ()
void SetBlue (const Char_t *b)
 Sets the particle species for the blue beam.
void SetYell (const Char_t *y)
 Sets the particle species for the yellow beam.
void SetFrame (const Char_t *frame, const Double_t val)
void SetFrame (const Char_t *frame, const Double_t *pblue, const Double_t *pyell)
void SetImpact (Double_t bmin, Double_t bmax)
 Set the minimum and maximum impact parameters for the collision (HI generators)
Int_t GetNumberOfParticles ()
 Returns the number of particles in the event.
void SetPileup (Bool_t p, Double_t prob=0.10)
Bool_t IsPileup ()
 Returns true if this is a pileup generator.
Double_t GetPileup ()
 Returns the pileup probability.
void SetOutputTree (TTree *tree)
void SetInputTree (TTree *tree, const Char_t *bname=0)
void SetInputFile (const Char_t *name, const Char_t *treename="genevents", const Char_t *bname=0)
Int_t IOmode ()
 Returns the ID of this event generator.
StarGenEventEvent ()
 Retrieves the event record.
virtual StarGenStats Stats ()
 Create and retrieve end-of-run statistics.
virtual const char * GetCVS () const
- Public Member Functions inherited from StMaker
 StMaker (const char *name="", const char *dummy=0)
 Constructor & Destructor.
virtual Int_t IsChain () const
virtual void Clear (Option_t *option="")
 User defined functions.
virtual void StartMaker ()
virtual Int_t IMake (Int_t number)
virtual void EndMaker (Int_t ierr)
virtual Int_t Finish ()
virtual Int_t FinishRun (Int_t oldrunumber)
virtual void FatalErr (Int_t Ierr, const char *Com)
virtual void PrintInfo ()
virtual void NotifyMe (const char *, const void *)
virtual void AddMaker (StMaker *mk)
virtual void MakeDoc (const TString &, const TString &, Bool_t)
virtual void AddData (TDataSet *data, const char *dir=".data")
 User methods.
virtual TDataSetAddObj (TObject *obj, const char *dir, int owner=1)
virtual TDataSetToWhiteBoard (const char *name, void *dat)
virtual TDataSetToWhiteBoard (const char *name, void *dat, void *del)
virtual TDataSetToWhiteBoard (const char *name, TObject *dat, Int_t owner)
virtual TDataSetToWhiteConst (const char *name, TObject *dat)
virtual TDataSetToWhiteConst (const char *name, void *dat)
virtual TDataSetWhiteBoard (const char *name, void *v=0) const
virtual Int_t Skip (Int_t nskip)
virtual void AddConst (TDataSet *data=0)
virtual void AddHist (TH1 *h, const char *dir=0)
virtual void AddGarb (TDataSet *data=0)
virtual void AddRunco (TDataSet *data=0)
virtual void AddRunco (Double_t par, const char *name, const char *comment)
void AddRunCont (TDataSet *data=0)
virtual TList * GetHistList () const
virtual TH1 * GetHist (const char *histName) const
virtual StMakercd ()
virtual StMakerCd ()
virtual Int_t GetNumber () const
 STAR methods.
virtual void SetNumber (Int_t number)
virtual StMakerGetParentChain () const
virtual Int_t GetIventNumber () const
 Returns the current event number.
virtual void SetIventNumber (Int_t iv)
virtual Int_t GetEventNumber () const
virtual Int_t GetRunNumber () const
 Returns the current RunNumber.
virtual const TDatime & GetDateTime () const
virtual const TDatime & GetDBTime () const
virtual void SetDateTime (Int_t idat, Int_t itim)
virtual StEvtHddrGetEvtHddr () const
virtual Int_t GetDate () const
virtual Int_t GetTime () const
virtual const char * GetEventType () const
virtual TDataSetGetData (const char *name, const char *dir=".data") const
virtual TDataSetGetData () const
virtual TDataSetGetConst () const
virtual TDataSetGetDataSet (const char *logInput) const
virtual TDataSetDataSet (const char *logInput) const
virtual TDataSetGetInputDS (const char *logInput) const
virtual TDataSetGetDataBase (const char *logInput, const TDatime *td=0)
virtual TDataSetGetInputDB (const char *logInput)
virtual Int_t GetDebug () const
virtual Int_t Debug () const
virtual Int_t GetMakeReturn () const
virtual TList * Histograms () const
virtual TString GetAlias (const char *log, const char *dir=".aliases") const
virtual TString GetInput (const char *log) const
virtual TString GetOutput (const char *log) const
virtual TList * GetMakeList () const
virtual StMakerGetParentMaker () const
virtual StMakerGetMaker (const char *mkname)
virtual StMakerGetMakerInheritsFrom (const char *mktype) const
virtual Bool_t IsActive ()
virtual StMakerMaker (const char *mkname)
virtual void SetBIT (EMakerStatus k)
 Maker Status Bits.
virtual void ResetBIT (EMakerStatus k)
virtual Bool_t TestBIT (EMakerStatus k)
virtual void SetActive (Bool_t k=kTRUE)
 Setters for flags and switches.
virtual void SetDebug (Int_t l=1)
virtual void SetDEBUG (Int_t l=1)
virtual void SetFlavor (const char *flav, const char *tabname)
virtual void SetMakeReturn (Int_t ret)
virtual void SetAlias (const char *log, const char *act, const char *dir=".aliases")
virtual void AddAlias (const char *log, const char *act, const char *dir=".aliases")
virtual void SetInput (const char *log, const char *act)
virtual void SetOutput (const char *log, const char *act)
virtual void SetOutput (const char *log, TDataSet *ds)
virtual void SetOutput (TDataSet *ds)
virtual void SetOutputAll (TDataSet *ds, Int_t level=1)
virtual void SetMode (Int_t mode=0)
virtual void SetNotify (const char *about, StMaker *mk)
virtual Int_t GetMode ()
virtual Int_t GetDebug ()
virtual const StChainOptGetChainOpt () const
virtual TFile * GetTFile () const
virtual void NotifyEm (const char *about, const void *ptr)
virtual Double_t RealTime ()
virtual Double_t CpuTime ()
virtual void StartTimer (Bool_t reset=kFALSE)
virtual void StopTimer ()
virtual void PrintTimer (Option_t *option="")
virtual void PrintTotalTime ()
virtual const char * GetName () const
 special overload
TObject * GetDirObj (const char *dir) const
void SetDirObj (TObject *obj, const char *dir)
Int_t SetAttr (const char *key, const char *val, const char *to=".")
Int_t SetAttr (const char *key, Int_t val, const char *to=".")
Int_t SetAttr (const char *key, UInt_t val, const char *to=".")
Int_t SetAttr (const char *key, Double_t val, const char *to=".")
Int_t SetAttr (const StMaker *mk)
Int_t RemAttr (const char *key, const char *to=".")
const TAttrGetAttr () const
Int_t IAttr (const char *key) const
UInt_t UAttr (const char *key) const
Double_t DAttr (const char *key) const
const char * SAttr (const char *key) const
void PrintAttr () const
- Public Member Functions inherited from TDataSet
 TDataSet (const char *name="", TDataSet *parent=0, Bool_t arrayFlag=kFALSE)
 TDataSet (const TDataSet &src, EDataSetPass iopt=kAll)
 TDataSet (TNode &src)
 This copy ctor has been depricated (left for thwe sake of the backweard compatibility)
virtual ~TDataSet ()
 std::cout << "Default destructor for " << GetName() << " - " << GetTitle() << std::endl;
virtual void Add (TDataSet *dataset)
virtual void AddAt (TDataSet *dataset, Int_t idx=0)
virtual void AddAtAndExpand (TDataSet *dataset, Int_t idx=0)
virtual void AddFirst (TDataSet *dataset)
 Add TDataSet object at the beginning of the dataset list of this dataset.
virtual void AddLast (TDataSet *dataset)
 Add TDataSet object at the end of the dataset list of this dataset.
TDataSetAt (Int_t idx) const
virtual void Browse (TBrowser *b)
 Browse this dataset (called by TBrowser).
virtual TObject * Clone (const char *newname="") const
 the custom implementation fo the TObject::Clone
virtual void Delete (Option_t *opt="")
virtual TDataSetFind (const char *path) const
virtual TDataSetFindByName (const char *name, const char *path="", Option_t *opt="") const
virtual TDataSetFindByPath (const char *path) const
 Aliase for TDataSet::Find(const Char_t *path) method.
virtual TDataSetFindByTitle (const char *title, const char *path="", Option_t *opt="") const
TObject * FindObject (const char *name) const
TObject * FindObject (const TObject *o) const
virtual TDataSetFirst () const
 Return the first object in the list. Returns 0 when list is empty.
TObjArray * GetObjArray () const
virtual TSeqCollection * GetCollection () const
TList * GetList () const
virtual Int_t GetListSize () const
TObject * GetMother () const
virtual TObject * GetObject () const
 The depricated method (left here for the sake of the backward compatibility)
virtual TDataSetGetParent () const
virtual Long_t HasData () const
virtual TDataSetInstance () const
virtual TString Path () const
 return the full path of this data set
virtual EDataSetPass Pass (EDataSetPass(*callback)(TDataSet *), Int_t depth=0)
virtual EDataSetPass Pass (EDataSetPass(*callback)(TDataSet *, void *), void *user, Int_t depth=0)
virtual void PrintContents (Option_t *opt="") const
virtual Int_t Purge (Option_t *opt="")
virtual void Remove (TDataSet *set)
 Remiove the "set" from this TDataSet.
virtual TDataSetRemoveAt (Int_t idx)
virtual void SetMother (TDataSet *parent=0)
virtual void SetObject (TObject *obj)
 The depricated method (left here for the sake of the backward compatibility)
virtual void SetParent (TDataSet *parent=0)
virtual void SetWrite ()
virtual void Shunt (TDataSet *newParent=0)
virtual void Sort ()
 Sort recursively all members of the TDataSet with TList::Sort method.
virtual Bool_t IsEmpty () const
 return kTRUE if the "internal" collection has no member
virtual Bool_t IsFolder () const
virtual Bool_t IsMarked () const
virtual Bool_t IsThisDir (const char *dirname, int len=-1, int ignorecase=0) const
virtual TDataSetLast () const
 Return the last object in the list. Returns 0 when list is empty.
virtual void ls (Option_t *option="") const
virtual void ls (Int_t depth) const
void Mark ()
void UnMark ()
void MarkAll ()
 Mark all members of this dataset.
void UnMarkAll ()
 UnMark all members of this dataset.
void InvertAllMarks ()
 Invert mark bit for all members of this dataset.
void Mark (UInt_t flag, EBitOpt reset=kSet)
virtual TDataSetNext () const
virtual TDataSetPrev () const
virtual void Update ()
virtual void Update (TDataSet *set, UInt_t opt=0)
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const

Protected Member Functions

void InitializeUrQMD ()
void GenerateEvent ()
 ClassDef (StarUrQMD, 1)
void FillPP (StarGenEvent *event)
 JFN 11/18/12 13:24 - I think having a clear function is optional, and UrQMD doesn't have any explicit cleanup. Although, we could toss the un-needed output files here.
void FillEP (StarGenEvent *event)
 (Optional) Method to fill a DIS event More...
void FillAA (StarGenEvent *event)
 (Optional) Method to fill a AA event
- Protected Member Functions inherited from StarGenerator
 ClassDef (StarGenerator, 1)
- Protected Member Functions inherited from StMaker
StMessMgrGetLogger () const
virtual TDataSetFindDataSet (const char *logInput, const StMaker *uppMk=0, const StMaker *dowMk=0) const
- Protected Member Functions inherited from TDataSet
virtual void SetMother (TObject *mother)
 TDataSet (const char *name, const char *title)
void AddMain (TDataSet *set)
 add data set to main data set
TDataSetGetRealParent ()
 return real parent
void MakeCollection ()
 Create the internal container at once if any.

Protected Attributes

map< TString, Int_t > InputParametersInt
map< TString, Double_t > InputParametersDouble
map< TString, TString > InputParametersString
map< Int_t, Int_t > mStatusCode
std::vector< std::string > StableParticles
- Protected Attributes inherited from StarGenerator
const Double_t mm
 If an event generator measures distances in mm, then multiply by mm.
const Double_t cm
 If an event generator measures distances in cm, then multiply by cm.
Int_t mNumberOfParticles
 Generated event.
TString mBlue
 Name of the blue beam particle (+z)
TString mYell
 Name of the yellow beam particle (-z)
TString mFrame
 Frame of the collision, i.e. CMS, FIXT, 3MOM, 4MOM, 5MOM.
Double_t mRootS
 CMS energy or incident beam momentum for fixed target collisions.
Double_t mDirect
 Direction (+1 = W, -1 = E) of the beam in fixted target mode.
Double_t mImpactMin
 Minimum impact parameter in a HI collision.
Double_t mImpactMax
 Maximum impact parameter in a HI collision.
TLorentzVector mBlueMomentum
 4-Momentum of the blue beam
TLorentzVector mYellMomentum
 4-Momentum of the yellow beam
Double_t mBlueMass
 Mass of the blue beam.
Double_t mYellMass
 Mass of the yellow beam.
Double_t mVertex [3]
 Position of the interaction vertex.
Double_t mSpread [3]
 Width of the interaction vertex.
Int_t mIOMode
 IO flag. 0=no IO, 1=write, 2=read.
TTree * mInputTree
 Pointer to the tree for reading in events.
TTree * mOutputTree
 Pointer to the tree for writing out events.
Bool_t mIsPileup
 Flag which indicates whether this is a pileup simulation.
Double_t mPileup
 Indicates the probability that this generator should be run in pileup mode.
 Database for particle information (based on TDatabasePDG)
TString mLibrary
 Concrete event generator library.
- Protected Attributes inherited from StMaker
 list of logInput:ActualInput
 list of logOuput:ActualOuput
TList * m_Histograms
 Run Control parameters.
Int_t fTallyMaker [kStFatal+1]
Int_t m_Mode
Int_t m_Number
 Integer mode of maker.
Int_t m_LastRun
 Serial event number.
Int_t m_DebugLevel
 Last Run number.
Int_t m_MakeReturn
 Debug level.
TStopwatch m_Timer
 Make() return flag.
 Timer object.
 StMemStat for Make.
Int_t fStatus
 StMemStat for Clear.
 Maker status.
- Protected Attributes inherited from TDataSet
TSeqCollection * fList

Additional Inherited Members

- Public Types inherited from StMaker
enum  EDebugLevel { kNormal, kDebug }
enum  EMakerStatus {
  kInitBeg = 1, kInitEnd = 2, kMakeBeg = 3, kCleaBeg = 4,
  kFiniBeg = 5, kFiniEnd = 6, kActive = 7
- Public Types inherited from TDataSet
enum  EDataSetPass {
  kContinue, kPrune, kStop, kUp,
  kStruct, kAll, kRefs, kMarked
enum  ESetBits { kMark = BIT(22), kArray = BIT(20) }
enum  EBitOpt { kSet = kTRUE, kReset = kFALSE }
- Static Public Member Functions inherited from StMaker
static StMakerNew (const char *classname, const char *name="", void *title=0)
static StMakerGetTopChain ()
static StMakerGetChain ()
static StMakerGetFailedMaker ()
static StMakerGetMaker (const TDataSet *ds)
 Static functions.
static EDataSetPass ClearDS (TDataSet *ds, void *user)
static const char * RetCodeAsString (Int_t kode)
static Int_t AliasDate (const char *alias)
static Int_t AliasTime (const char *alias)
static const char * AliasGeometry (const char *alias)
static const DbAlias_tGetDbAliases ()
static void SetTestMaker (StTestMaker *mk)
static Int_t Cleanup (TDataSet *&ds)
static void lsMakers (const StMaker *top)
- Static Public Member Functions inherited from TDataSet
static TDataSetGetMainSet ()
 return pointer to the main dataset
static TDataSetinstance ()
- Public Attributes inherited from StMaker
enum StMaker:: { ... }  EModule_return_Status
- Static Protected Member Functions inherited from TDataSet
static EDataSetPass SortIt (TDataSet *ds)
static EDataSetPass SortIt (TDataSet *ds, void *user)
- Static Protected Attributes inherited from StMaker
static StMakerfgTopChain = 0
 list of Histograms
static StMakerfgStChain = 0
 pointer to top StChain
static StMakerfgFailedMaker = 0
 current pointer to StChain
static StTestMakerfgTestMaker = 0
 current pointer to failed maker
static Int_t fgTallyMaker [kStFatal+1] = {0,0,0,0,0}
- Static Protected Attributes inherited from TDataSet
static TDataSetfgMainSet = &mainSet

Detailed Description

Definition at line 10 of file StarUrQMD.h.

Constructor & Destructor Documentation

StarUrQMD::StarUrQMD ( const Char_t *  name = "UrQMD3_3_1")

Setting up a map between UrQMD's status codes and the HepMC status codes used in StarEvent

Definition at line 25 of file StarUrQMD.cxx.

References StarGenParticle::kFinal.

Member Function Documentation

ENERGIES_t& StarUrQMD::energies ( )

Refernces for Common Blocks: Ex: Name_t funcname(){ return *address_of_block(); }

Definition at line 22 of file StarUrQMD.h.

void StarUrQMD::FillEP ( StarGenEvent event)

(Optional) Method to fill a DIS event

JFN 11/25/12 12:31pm- when FillPP is done, just copy the contents in here.

Reimplemented from StarGenerator.

Definition at line 237 of file StarUrQMD.cxx.

Referenced by Generate().

Int_t StarUrQMD::Generate ( )

Developers must provide a generate method. In this method, the event generation machinery should be called. It is expected that the event record is filled in the Generate method, so that particles and event characteristics are available to subsequent generators and the primary generator maker. The primary maker is responsible for pushing particles out to the concrete simulation package.

Generate an event

Implements StarGenerator.

Definition at line 148 of file StarUrQMD.cxx.

References FillEP(), FillPP(), StarGenParticle::kFinal, kStOK, StarGenerator::mBlue, StarGenerator::mEvent, and StarGenerator::mYell.

Int_t StarUrQMD::Init ( )

Developer must provide initialization routine. This method should call any functions, subroutines and/or methods on the concrete event generator necessary for its initialization.

Remapt the ROOT names to UrQMD names

Ex: particle["ROOT name"]="UrQMD name";

Set up frames

JFN 11/21/12 4:11pm- I believe this calculation of mRootS from the momentum is correct, but I wouldn't stake my life on it. Additionally, I think mRootS should be something that should be calculated by the StarGenerator framework (ie, I shouldn't have to do it)

Set particles to not decay JFN 11/20/12 12:36pm- I have figured out how to set particles to not decay; they must be listed in the input file in the form "stb [itpy#]". I need to figure out the convention for ityp id numbers. JFN 11/20/12 12:46pm- See the UrQMD manual, page 12, tables 2 and 3 for particle IDs JFN 11/25/12 1:17pm- ityp doesn't seem to be completely specific for defingin particle type. Also, "antibaryons carry a negative sign", so some of these may need to be negative.

Initialize UrQMD:

Implements StarGenerator.

Definition at line 47 of file StarUrQMD.cxx.

References InitializeUrQMD(), StarGenerator::mBlue, StarGenerator::mBlueMomentum, StarGenerator::mEvent, StarGenerator::mFrame, StarGenerator::mImpactMax, StarGenerator::mImpactMin, StarGenerator::mRootS, StarGenerator::mYell, and StarGenerator::mYellMomentum.

void StarUrQMD::InitializeUrQMD ( )

JFN 11/19/12 7:54am- to initialize UrQMD we first have to create input files for UrQMD to read and set enviormental variables, then we call UrQMD's init function JFN 11/19/12 7:37pm- In hindsight, I think I might rather have these functions defined in StarUrQMD.cxx.... maybe JFN 11/20/12 12:09pm- I have moved these two function (InitializeUrQMD and GenerateEvent) to StarUrQMD.cxx

Set the enviormental variables JFN 11/19/12 7:55am- Honestly, it pains me to set enviormental variables just to run this. I need to check if there is a way I can just set common block variables JFN 11/19/12 7:38pm- I would like to be able to just define the name on the input output files.... JFN 11/21/12 5:19pm- I have found where the enviormental variables are loaded for UrQMD: line 359 of input.F. I see no easy way to spoof this behavior without modifying the source code, which I am trying to keep to an absolute minimum,

Print the input file

Set particles to not decay

Define calculation time: total time span, interval at which output is written (both in fm/c)

This supresses the output files

This sets the number of events for UrQMD to run (but we aren't using this, so it doens't matter)

This sets the random number generator seed (but we aren't using UrQMD's random number generator, so this doens't matter)

This marks the end of the input file

Initialize UrQMD

Definition at line 247 of file StarUrQMD.cxx.

Referenced by Init().

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