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