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 // G4ILawTruncatedExp
0027 //
0028 // Class Description:
0029 //
0030 // A G4VBiasingInteractionLaw representing a truncated exponential
0031 // law : an exponential law acting on [0,L] segment. The law is
0032 // driven by a cross-section.
0033 //
0034 // Author: Marc Verderi, November 2013.
0035 // --------------------------------------------------------------------
0036 #ifndef G4ILawTruncatedExp_hh
0037 #define G4ILawTruncatedExp_hh 1
0038
0039 #include "G4VBiasingInteractionLaw.hh"
0040
0041 class G4ILawTruncatedExp : public G4VBiasingInteractionLaw
0042 {
0043   public:
0044
0045     G4ILawTruncatedExp(const G4String& name = "expForceInteractionLaw");
0046     virtual ~G4ILawTruncatedExp();
0047
0048     virtual G4double ComputeEffectiveCrossSectionAt(G4double length) const;
0049     virtual G4double ComputeNonInteractionProbabilityAt(G4double length) const;
0050     // -- sample the distribution
0051     virtual G4double SampleInteractionLength();
0052     // -- move by true path length, this position becomes the new initial point
0053     virtual G4double UpdateInteractionLengthForStep(G4double truePathLength);
0054     virtual G4bool IsSingular() const { return fIsSingular; }
0055
0056     void SetForceCrossSection(G4double xs);
0057
0058     void SetMaximumDistance(G4double d) { fMaximumDistance = d; }
0059     G4double GetMaximumDistance() const { return fMaximumDistance; }
0060     G4double GetInteractionDistance() const { return fInteractionDistance; }
0061
0062   private:
0063
0064     G4double fMaximumDistance = 0.0;
0065     G4double fCrossSection = 0.0;
0066     G4bool fCrossSectionDefined = false;
0067     G4bool fIsSingular = false;
0068     G4double fInteractionDistance = 0.0;
0069 };
0070
0071 #endif