include/Geant4/G4ILawCommonTruncatedExp.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 // G4ILawCommonTruncatedExp
0031 //
0032 // Class Description:
0033 //     A G4VBiasingInteractionLaw representing a truncated exponential
0034 //  law : an exponential law acting on [0,L] segment. This law is
0035 //  Common as it collects several process cross-sections, which sum
0036 //  is used to drive the law.
0037 //
0038 // ---------------------------------------------------------------
0039 //   Refactored version                      Oct. 2014 M. Verderi
0040 //   Initial version                         Nov. 2013 M. Verderi
0041
0042
0043 #ifndef G4ILawCommonTruncatedExp_hh
0044 #define G4ILawCommonTruncatedExp_hh 1
0045
0046 #include "G4VBiasingInteractionLaw.hh"
0047 #include "G4ILawTruncatedExp.hh"
0048 #include "G4ThreeVector.hh"
0049
0050 class G4ILawCommonTruncatedExp : public G4VBiasingInteractionLaw
0051 {
0052 public:
0053   G4ILawCommonTruncatedExp(G4String name = "expSharedForceInteractionLaw");
0054   virtual ~G4ILawCommonTruncatedExp();
0055
0056 public:
0057   virtual G4bool                             IsSingular() const
0058   {return fExpInteractionLaw.IsSingular();}
0059   virtual G4bool        IsEffectiveCrossSectionInfinite() const
0060   {return fExpInteractionLaw.IsEffectiveCrossSectionInfinite();}
0061 private:
0062   // -- sample the distribution:
0063   virtual G4double              SampleInteractionLength();
0064   // -- move by true path length, this position becomes the new initial point
0065   // -- in this case, cheat by returning DBL_MAX, to let operation proposing the
0066   // -- step length in the alongGPIL
0067   virtual G4double       UpdateInteractionLengthForStep(G4double       truePathLength);
0068 public:
0069   virtual G4double       ComputeEffectiveCrossSectionAt(G4double               length) const;
0070   virtual G4double   ComputeNonInteractionProbabilityAt(G4double               length) const;
0071
0072 public:
0073   void             SetForceCrossSection( G4double xs )    {        fExpInteractionLaw.SetForceCrossSection( xs ); }
0074   void     SetSelectedProcessXSfraction( G4double fXS )   {        fSelectedProcessXSfraction = fXS;              }
0075   G4double  SetSelectedProcessXSfraction() const          { return fSelectedProcessXSfraction;                    }
0076   void               SetMaximumDistance(G4double d)       {        fExpInteractionLaw.SetMaximumDistance(d);      }
0077   G4double           GetMaximumDistance() const           { return fExpInteractionLaw.GetMaximumDistance();       }
0078   G4double       GetInteractionDistance() const           { return fExpInteractionLaw.GetInteractionDistance();   }
0079
0080 private:
0081   G4ILawTruncatedExp         fExpInteractionLaw;
0082   G4double           fSelectedProcessXSfraction;
0083   G4double                 fInteractionDistance;
0084 };
0085
0086 #endif