TVirtualMCApplication.h

Go to the documentation of this file.

// -----------------------------------------------------------------------
// Copyright (C) 2019 CERN and copyright holders of VMC Project.
// This software is distributed under the terms of the GNU General Public
// License v3 (GPL Version 3), copied verbatim in the file "LICENSE".
//
// See https://github.com/vmc-project/vmc for full licensing information.
// -----------------------------------------------------------------------
 
// Author: Ivana Hrivnacova, 23/03/2002
 
/*************************************************************************
 * Copyright (C) 2006, Rene Brun and Fons Rademakers.                    *
 * Copyright (C) 2002, ALICE Experiment at CERN.                         *
 * All rights reserved.                                                  *
 *                                                                       *
 * For the licensing terms see $ROOTSYS/LICENSE.                         *
 * For the list of contributors see $ROOTSYS/README/CREDITS.             *
 *************************************************************************/
 
#ifndef ROOT_TVirtualMCApplication
#define ROOT_TVirtualMCApplication
//
// Class TVirtualMCApplication
// ---------------------------
// Interface to a user Monte Carlo application.
//
 
#include "TNamed.h"
#include "TMath.h"
 
#include "TMCtls.h"
 
class TVirtualMC;
class TMCManager;
 
class TVirtualMCApplication : public TNamed {
 
public:
   TVirtualMCApplication(const char *name, const char *title);
 
   TVirtualMCApplication();
 
   virtual ~TVirtualMCApplication();
 
   static TVirtualMCApplication *Instance();
 
   //
   // methods
   //
 
   void RequestMCManager();
 
   void Register(TVirtualMC *mc);
 
   TVirtualMC *GetMC() const;
 
   virtual void ConstructGeometry() = 0;
 
   virtual Bool_t MisalignGeometry() { return kFALSE; }
 
   virtual void ConstructOpGeometry() {}
 
   virtual void ConstructSensitiveDetectors() {}
 
   virtual void InitGeometry() = 0;
 
   virtual void AddParticles() {}
 
   virtual void AddIons() {}
 
   virtual void GeneratePrimaries() = 0;
 
   virtual void BeginEvent() = 0;
 
   virtual void BeginPrimary() = 0;
 
   virtual void PreTrack() = 0;
 
   virtual void Stepping() = 0;
 
   virtual void PostTrack() = 0;
 
   virtual void FinishPrimary() = 0;
 
   virtual void EndOfEvent() {}
 
   virtual void FinishEvent() = 0;
 
   virtual Double_t TrackingRmax() const { return DBL_MAX; }
 
   virtual Double_t TrackingZmax() const { return DBL_MAX; }
 
   virtual void Field(const Double_t *x, Double_t *b) const;
 
   virtual void GeaneStepping() { ; }
 
   // Functions for multi-threading applications
   virtual TVirtualMCApplication *CloneForWorker() const { return 0; }
 
   virtual void InitOnWorker() {}
   virtual void BeginRunOnWorker() {}
   virtual void FinishRunOnWorker() {}
   virtual void Merge(TVirtualMCApplication * /*localMCApplication*/) {}
 
protected:
   TVirtualMC *fMC;
 
   TMCManager *fMCManager;
 
private:
   // static data members
#if !defined(__CINT__)
   static TMCThreadLocal TVirtualMCApplication
      *fgInstance; 
#else
   static TVirtualMCApplication *fgInstance; 
#endif
   static Bool_t fLockMultiThreading;
 
   ClassDef(TVirtualMCApplication, 1) // Interface to MonteCarlo application
};
 
inline void TVirtualMCApplication::Field(const Double_t * /*x*/, Double_t *b) const
{
   // No magnetic field
   b[0] = 0;
   b[1] = 0;
   b[2] = 0;
}
 
#endif // ROOT_TVirtualMCApplication