EIC code displayed by LXR master/​include/​Geant4/​G4VFastSimulationModel.hh	Source navigation Diff markup Identifier search General search
	Version: master test Revert   Change

File indexing completed on 2025-01-18 09:59:21

 //
 // ********************************************************************
 // * License and Disclaimer                                           *
 // *                                                                  *
 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
 // * conditions of the Geant4 Software License,  included in the file *
 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
 // * include a list of copyright holders.                             *
 // *                                                                  *
 // * Neither the authors of this software system, nor their employing *
 // * institutes,nor the agencies providing financial support for this *
 // * work  make  any representation or  warranty, express or implied, *
 // * regarding  this  software system or assume any liability for its *
 // * use.  Please see the license in the file  LICENSE  and URL above *
 // * for the full disclaimer and the limitation of liability.         *
 // *                                                                  *
 // * This  code  implementation is the result of  the  scientific and *
 // * technical work of the GEANT4 collaboration.                      *
 // * By using,  copying,  modifying or  distributing the software (or *
 // * any work based  on the software)  you  agree  to acknowledge its *
 // * use  in  resulting  scientific  publications,  and indicate your *
 // * acceptance of all terms of the Geant4 Software license.          *
 // ********************************************************************
 //
 //
 //
 //
 //---------------------------------------------------------------
 //
 //  G4VFastSimulationModel.hh
 //
 //  Description:
 //    Base class for fast simulation models.
 //
 //  History:
 //    Oct 97: Verderi && MoraDeFreitas - First Implementation.
 //
 //---------------------------------------------------------------
 
 #ifndef G4VFastSimulationModel_h
 #define G4VFastSimulationModel_h
 
 #include "G4FastStep.hh"
 #include "G4FastTrack.hh"
 
 //-------------------------------------------
 //
 //        G4VFastSimulationModel class
 //
 //-------------------------------------------
 
 // Class Description:
 //   This is the abstract class for the implementation of parameterisations.
 //   You have to inherit from it to implement your concrete parameterisation
 //   model.
 //
 
 class G4VFastSimulationModel
 {
   public:
     // aName identifies the parameterisation model.
     G4VFastSimulationModel(const G4String& aName);
 
     // This constructor allows you to get a quick "getting started".
     // In addition to the model name, this constructor accepts a G4LogicalVolume
     // pointer. This volume will automatically becomes the envelope, and the
     // needed G4FastSimulationManager object is constructed if necessary giving
     // it the G4LogicalVolume pointer and the boolean value. If it already
     // exists, the model is simply added to this manager. However the
     // G4VFastSimulationModel object will not keep track of the envelope given
     // in the constructor.
     // The boolean argument is there for optimization purpose: if you know that
     // the G4LogicalVolume envelope is placed only once you can turn this
     // boolean value to "true" (an automated mechanism is foreseen here.)
     G4VFastSimulationModel(const G4String& aName, G4Envelope*, G4bool IsUnique = FALSE);
 
     virtual ~G4VFastSimulationModel() = default;
 
     // In your implementation, you have to return "true" when your model is
     // applicable to the G4ParticleDefinition passed to this method. The
     // G4ParticleDefinition provides all intrisic particle informations (mass,
     // charge, spin, name ...).
     virtual G4bool IsApplicable(const G4ParticleDefinition&) = 0;
 
     // You have to return "true" when the dynamics conditions to trigger your
     // parameterisation are fulfiled. The G4FastTrack provides you access to
     // the current G4Track, gives simple access to envelope related features
     // (G4LogicalVolume, G4VSolid, G4AffineTransform references between the
     // global and the envelope local coordinates systems) and simple access to
     // the position, momentum expressed in the envelope coordinate system.
     // Using those quantities and the G4VSolid methods, you can for example
     // easily check how far you are from the envelope boundary.
     virtual G4bool ModelTrigger(const G4FastTrack&) = 0;
 
     // Your parameterisation properly said. The G4FastTrack reference provides
     // input informations. The final state of the particles after parameterisation
     // has to be returned through the G4FastStep reference. This final state is
     // described has "requests" the tracking will apply after your
     // parameterisation has been invoked.
     virtual void DoIt(const G4FastTrack&, G4FastStep&) = 0;
 
     // ---------------------------
     // -- Idem for AtRest methods:
     // ---------------------------
     // -- A default dummy implementation is provided.
 
     // You have to return "true" when the dynamics conditions to trigger your
     // parameterisation are fulfiled. The G4FastTrack provides you access to
     // the current G4Track, gives simple access to envelope related features
     // (G4LogicalVolume, G4VSolid, G4AffineTransform references between the
     // global and the envelope local coordinates systems) and simple access to
     // the position, momentum expressed in the envelope coordinate system.
     // Using those quantities and the G4VSolid methods, you can for example
     // easily check how far you are from the envelope boundary.
     virtual G4bool AtRestModelTrigger(const G4FastTrack&) { return false; }
 
     // Your parameterisation properly said. The G4FastTrack reference provides
     // input informations. The final state of the particles after parameterisation
     // has to be returned through the G4FastStep reference. This final state is
     // described has "requests" the tracking will apply after your
     // parameterisation has been invoked.
     virtual void AtRestDoIt(const G4FastTrack&, G4FastStep&) {}
 
     // Complete processing of any buffered or offloaded tracks at end of tracking
     virtual void Flush() {}
 
     // Useful public methods :
     const G4String GetName() const;
     G4bool operator==(const G4VFastSimulationModel&) const;
 
   private:
     //-------------
     // Model Name:
     //-------------
     G4String theModelName;
 };
 
 inline const G4String G4VFastSimulationModel::GetName() const
 {
   return theModelName;
 }
 
 inline G4bool G4VFastSimulationModel::operator==(const G4VFastSimulationModel& fsm) const
 {
   return this == &fsm;
 }
 #endif

This page was automatically generated by the 2.3.7 LXR engine. The LXR team