gorad/include/GRBiasingRegionInfo.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 //  Gorad (Geant4 Open-source Radiation Analysis and Design)
0027 //
0028 //  Author : Makoto Asai (SLAC National Accelerator Laboratory)
0029 //
0030 //  Development of Gorad is funded by NASA Johnson Space Center (JSC)
0031 //  under the contract NNJ15HK11B.
0032 //
0033 // ********************************************************************
0034 //
0035 // GRBiasingRegionInfo.hh
0036 //   Header file of Region Information class to hold parameters of
0037 //   geometry importance biasing.
0038 //
0039 // History
0040 //   September 8th, 2020 : first implementation
0041 //
0042 // ********************************************************************
0043
0044 #ifndef GRBiasingRegionInfo_h
0045 #define GRBiasingRegionInfo_h 1
0046
0047 #include "G4VUserRegionInformation.hh"
0048 #include "globals.hh"
0049
0050 class GRBiasingRegionInfo : public G4VUserRegionInformation
0051 {
0052   public:
0053     GRBiasingRegionInfo()
0054     {;}
0055     virtual ~GRBiasingRegionInfo()
0056     {;}
0057
0058   public:
0059     virtual void Print() const
0060     {
0061       G4cout << "GRBiasingRegionInfo : biasing factor " << factor
0062              << "  bias probability : " << probability << G4endl;
0063     }
0064
0065  public:
0066     void SetBiasingFactor(G4int val)
0067     {
0068       if(val>0)
0069       {
0070         factor = val;
0071         if(val>4)
0072         {
0073           G4Exception("G4GRBiasingRegionInfo::SetBiasingFactor","Gorad0005",JustWarning,
0074                       "Biasing factor maybe too large. Results should be carefully checked.");
0075         }
0076       }
0077       else
0078       { G4Exception("G4GRBiasingRegionInfo::SetBiasingFactor","Gorad0005",JustWarning,"Invalid value"); }
0079     }
0080     inline G4int GetBiasingFactor() const
0081     { return factor; }
0082     void SetProbability(G4double val)
0083     {
0084       if(val>=0.&&val<=1.)
0085       { probability = val; }
0086       else
0087       { G4Exception("G4GRBiasingRegionInfo::SetProbability","Gorad0006",JustWarning,"Invalid value"); }
0088     }
0089     inline G4double GetProbability() const
0090     { return probability; }
0091
0092  private:
0093     G4int factor = 2;
0094     G4double probability = 1.;
0095 };
0096
0097 #endif
0098