include/Geant4/G4ILawTruncatedExp.hh

0001 //
0002 // ********************************************************************
0003 // * License and Disclaimer                                           *
0004 // *                                                                  *
0005 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
0006 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
0007 // * conditions of the Geant4 Software License,  included in the file *
0008 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
0009 // * include a list of copyright holders.                             *
0010 // *                                                                  *
0011 // * Neither the authors of this software system, nor their employing *
0012 // * institutes,nor the agencies providing financial support for this *
0013 // * work  make  any representation or  warranty, express or implied, *
0014 // * regarding  this  software system or assume any liability for its *
0015 // * use.  Please see the license in the file  LICENSE  and URL above *
0016 // * for the full disclaimer and the limitation of liability.         *
0017 // *                                                                  *
0018 // * This  code  implementation is the result of  the  scientific and *
0019 // * technical work of the GEANT4 collaboration.                      *
0020 // * By using,  copying,  modifying or  distributing the software (or *
0021 // * any work based  on the software)  you  agree  to acknowledge its *
0022 // * use  in  resulting  scientific  publications,  and indicate your *
0023 // * acceptance of all terms of the Geant4 Software license.          *
0024 // ********************************************************************
0025 //
0026 //
0027 //
0028 // ---------------------------------------------------------------
0029 //
0030 // G4ILawTruncatedExp
0031 //
0032 // Class Description:
0033 //     A G4VBiasingInteractionLaw representing a truncated exponential
0034 //  law : an exponential law acting on [0,L] segment. The law is
0035 //  driven by a cross-section.
0036 //
0037 // ---------------------------------------------------------------
0038 //   Initial version                         Nov. 2013 M. Verderi
0039
0040 #ifndef G4ILawTruncatedExp_hh
0041 #define G4ILawTruncatedExp_hh 1
0042
0043 #include "G4VBiasingInteractionLaw.hh"
0044
0045 class G4ILawTruncatedExp : public G4VBiasingInteractionLaw
0046 {
0047 public:
0048   G4ILawTruncatedExp(G4String name = "expForceInteractionLaw");
0049   virtual ~G4ILawTruncatedExp();
0050
0051 public:
0052   virtual G4double     ComputeEffectiveCrossSectionAt(G4double               length) const;
0053   virtual G4double ComputeNonInteractionProbabilityAt(G4double               length) const;
0054   // -- sample the distribution
0055   virtual  G4double           SampleInteractionLength();
0056   // -- move by true path length, this position becomes the new initial point
0057   virtual G4double     UpdateInteractionLengthForStep(G4double       truePathLength);
0058   virtual G4bool IsSingular() const {return fIsSingular;}
0059
0060 public:
0061   void SetForceCrossSection(G4double xs);
0062
0063 public:
0064   void         SetMaximumDistance(G4double d) { fMaximumDistance = d;}
0065   G4double     GetMaximumDistance() const     { return fMaximumDistance;}
0066   G4double GetInteractionDistance() const     { return fInteractionDistance; }
0067
0068 private:
0069   G4double     fMaximumDistance;
0070   G4double        fCrossSection;
0071   G4double fCrossSectionDefined;
0072   G4bool            fIsSingular;
0073   G4double fInteractionDistance;
0074
0075 };
0076
0077 #endif