G4ImportanceAlgorithm Class Reference

#include <G4ImportanceAlgorithm.hh>

Inheritance diagram for G4ImportanceAlgorithm:

Public Member Functions
virtual G4Nsplit_Weight	Calculate (G4double ipre, G4double ipost, G4double init_w) const
	G4ImportanceAlgorithm ()
virtual	~G4ImportanceAlgorithm ()

Private Member Functions
void	Error (const G4String &m) const
void	Warning (const G4String &m) const

Private Attributes
G4bool	fWarned = false

Detailed Description

Definition at line 41 of file G4ImportanceAlgorithm.hh.

Constructor & Destructor Documentation

G4ImportanceAlgorithm()

G4ImportanceAlgorithm::G4ImportanceAlgorithm

(

)

Definition at line 42 of file G4ImportanceAlgorithm.cc.

{
}

~G4ImportanceAlgorithm()

G4ImportanceAlgorithm::~G4ImportanceAlgorithm ( )

virtual

Definition at line 46 of file G4ImportanceAlgorithm.cc.

{
}

Member Function Documentation

Calculate()

G4Nsplit_Weight G4ImportanceAlgorithm::Calculate ( G4double  ipre, G4double  ipost, G4double  init_w  ) const

virtual

Implements G4VImportanceAlgorithm.

Definition at line 51 of file G4ImportanceAlgorithm.cc.

{
 
#ifdef G4MULTITHREADED
  G4MUTEXLOCK(&G4ImportanceAlgorithm::ImportanceMutex);
#endif
 
  G4Nsplit_Weight nw;
  if (ipost>0.)
  {
    if (!(ipre>0.))
    {
      Error("Calculate() - ipre==0.");
    }
    G4double ipre_over_ipost = ipre/ipost;
    if ((ipre_over_ipost<0.25 || ipre_over_ipost> 4) && !fWarned)
    {
      std::ostringstream os;
      os << "Calculate() - ipre_over_ipost ! in [0.25, 4]." << G4endl
         << "ipre_over_ipost = " << ipre_over_ipost << ".";
      Warning(os.str());
      fWarned = true;
      if (ipre_over_ipost<=0)
      {
        Error("Calculate() - ipre_over_ipost<=0.");
      }
    }
    if (init_w<=0.)
    {
      Error("Calculate() - iniitweight<= 0. found!");
    }
 
    // default geometrical splitting 
    // in integer mode 
    // for ipre_over_ipost <= 1
    G4double inv = 1./ipre_over_ipost;
    nw.fN = static_cast<G4int>(inv);
    nw.fW = init_w * ipre_over_ipost;
    
    // geometrical splitting for double mode
    if (ipre_over_ipost<1)
    {
      if ( static_cast<G4double>(nw.fN) != inv)
      {
        // double mode
        // probability p for splitting into n+1 tracks
        G4double p = inv - nw.fN;
        // get a random number out of [0,1)
        G4double r = G4UniformRand();
        if (r<p)
        {
          ++nw.fN;
        } 
      }  
    }
    else if (ipre_over_ipost>1)   // russian roulette
    {
      // probabiity for killing track
      G4double p = 1-inv;
      // get a random number out of [0,1)
      G4double r = G4UniformRand();
      if (r<p)
      {
        // kill track
        nw.fN = 0;
        nw.fW = 0;
      }
      else
      {
        nw.fN = 1;     
      }
    }
  }
#ifdef G4MULTITHREADED
  G4MUTEXUNLOCK(&G4ImportanceAlgorithm::ImportanceMutex);
#endif
  return nw;
}

References Error(), G4Nsplit_Weight::fN, G4Nsplit_Weight::fW, fWarned, G4endl, G4MUTEXLOCK, G4MUTEXUNLOCK, G4UniformRand, and Warning().

Error()

void G4ImportanceAlgorithm::Error ( const G4String &  m ) const

private

Definition at line 132 of file G4ImportanceAlgorithm.cc.

{
  G4Exception("G4ImportanceAlgorithm::Error()",
              "GeomBias0002", FatalException, msg);
}

References FatalException, and G4Exception().

Referenced by Calculate().

Warning()

void G4ImportanceAlgorithm::Warning ( const G4String &  m ) const

private

Definition at line 138 of file G4ImportanceAlgorithm.cc.

{
  G4Exception("G4ImportanceAlgorithm::Warning()",
              "GeomBias1001", JustWarning, msg);
}

References G4Exception(), and JustWarning.

Referenced by Calculate().

Field Documentation

fWarned

G4bool G4ImportanceAlgorithm::fWarned = false

mutableprivate

Definition at line 64 of file G4ImportanceAlgorithm.hh.

Referenced by Calculate().

---

The documentation for this class was generated from the following files:

• source/geometry/biasing/include/G4ImportanceAlgorithm.hh
• source/geometry/biasing/src/G4ImportanceAlgorithm.cc