G4GeneralCerenkov Class Reference

#include <G4GeneralCerenkov.hh>

Inheritance diagram for G4GeneralCerenkov:

Public Member Functions
	G4GeneralCerenkov (const G4String &processName="Cerenkov", G4ProcessType type=fElectromagnetic)
	~G4GeneralCerenkov () override
	G4GeneralCerenkov (const G4GeneralCerenkov &right)=delete
G4GeneralCerenkov &	operator= (const G4GeneralCerenkov &right)=delete
G4bool	IsApplicable (const G4ParticleDefinition &aParticleType) override
void	PreparePhysicsTable (const G4ParticleDefinition &part) override
void	BuildPhysicsTable (const G4ParticleDefinition &aParticleType) override
G4double	PostStepGetPhysicalInteractionLength (const G4Track &aTrack, G4double, G4ForceCondition *) override
G4VParticleChange *	PostStepDoIt (const G4Track &aTrack, const G4Step &aStep) override
void	AddModelForVolume (G4VXRayModel *, const G4String &nameLogVolume)
void	DumpInfo () const override
void	ProcessDescription (std::ostream &out) const override
G4double	GetMeanFreePath (const G4Track &, G4double, G4ForceCondition *) override
void	SetTrackSecondariesFirst (const G4bool state)
void	SetMaxBetaChangePerStep (const G4double d)
void	SetMaxNumPhotonsPerStep (const G4int NumPhotons)
void	SetStackPhotons (const G4bool)
void	SetVerboseLevel (G4int)
Public Member Functions inherited from G4VDiscreteProcess
	G4VDiscreteProcess (const G4String &aName, G4ProcessType aType=fNotDefined)
	G4VDiscreteProcess (G4VDiscreteProcess &)
virtual	~G4VDiscreteProcess ()
G4VDiscreteProcess &	operator= (const G4VDiscreteProcess &)=delete
virtual G4double	AlongStepGetPhysicalInteractionLength (const G4Track &, G4double, G4double, G4double &, G4GPILSelection *)
virtual G4double	AtRestGetPhysicalInteractionLength (const G4Track &, G4ForceCondition *)
virtual G4VParticleChange *	AtRestDoIt (const G4Track &, const G4Step &)
virtual G4VParticleChange *	AlongStepDoIt (const G4Track &, const G4Step &)
virtual G4double	GetCrossSection (const G4double, const G4MaterialCutsCouple *)
virtual G4double	MinPrimaryEnergy (const G4ParticleDefinition *, const G4Material *)
Public Member Functions inherited from G4VProcess
	G4VProcess (const G4String &aName="NoName", G4ProcessType aType=fNotDefined)
	G4VProcess (const G4VProcess &right)
virtual	~G4VProcess ()
G4VProcess &	operator= (const G4VProcess &)=delete
G4bool	operator== (const G4VProcess &right) const
G4bool	operator!= (const G4VProcess &right) const
G4double	GetCurrentInteractionLength () const
void	SetPILfactor (G4double value)
G4double	GetPILfactor () const
G4double	AlongStepGPIL (const G4Track &track, G4double previousStepSize, G4double currentMinimumStep, G4double &proposedSafety, G4GPILSelection *selection)
G4double	AtRestGPIL (const G4Track &track, G4ForceCondition *condition)
G4double	PostStepGPIL (const G4Track &track, G4double previousStepSize, G4ForceCondition *condition)
virtual G4bool	StorePhysicsTable (const G4ParticleDefinition *, const G4String &, G4bool)
virtual G4bool	RetrievePhysicsTable (const G4ParticleDefinition *, const G4String &, G4bool)
const G4String &	GetPhysicsTableFileName (const G4ParticleDefinition *, const G4String &directory, const G4String &tableName, G4bool ascii=false)
const G4String &	GetProcessName () const
G4ProcessType	GetProcessType () const
void	SetProcessType (G4ProcessType)
G4int	GetProcessSubType () const
void	SetProcessSubType (G4int)
virtual const G4VProcess *	GetCreatorProcess () const
virtual void	StartTracking (G4Track *)
virtual void	EndTracking ()
virtual void	SetProcessManager (const G4ProcessManager *)
virtual const G4ProcessManager *	GetProcessManager ()
virtual void	ResetNumberOfInteractionLengthLeft ()
G4double	GetNumberOfInteractionLengthLeft () const
G4double	GetTotalNumberOfInteractionLengthTraversed () const
G4bool	isAtRestDoItIsEnabled () const
G4bool	isAlongStepDoItIsEnabled () const
G4bool	isPostStepDoItIsEnabled () const
void	SetVerboseLevel (G4int value)
G4int	GetVerboseLevel () const
virtual void	SetMasterProcess (G4VProcess *masterP)
const G4VProcess *	GetMasterProcess () const
virtual void	BuildWorkerPhysicsTable (const G4ParticleDefinition &part)
virtual void	PrepareWorkerPhysicsTable (const G4ParticleDefinition &)

Additional Inherited Members
Static Public Member Functions inherited from G4VProcess
static const G4String &	GetProcessTypeName (G4ProcessType)
Protected Member Functions inherited from G4VProcess
void	SubtractNumberOfInteractionLengthLeft (G4double prevStepSize)
void	ClearNumberOfInteractionLengthLeft ()
Protected Attributes inherited from G4VProcess
const G4ProcessManager *	aProcessManager = nullptr
G4VParticleChange *	pParticleChange = nullptr
G4ParticleChange	aParticleChange
G4double	theNumberOfInteractionLengthLeft = -1.0
G4double	currentInteractionLength = -1.0
G4double	theInitialNumberOfInteractionLength = -1.0
G4String	theProcessName
G4String	thePhysicsTableFileName
G4ProcessType	theProcessType = fNotDefined
G4int	theProcessSubType = -1
G4double	thePILfactor = 1.0
G4int	verboseLevel = 0
G4bool	enableAtRestDoIt = true
G4bool	enableAlongStepDoIt = true
G4bool	enablePostStepDoIt = true

Detailed Description

Definition at line 58 of file G4GeneralCerenkov.hh.

Constructor & Destructor Documentation

G4GeneralCerenkov() [1/2]

G4GeneralCerenkov::G4GeneralCerenkov ( const G4String & processName = "Cerenkov", G4ProcessType type = fElectromagnetic )

explicit

Definition at line 47 of file G4GeneralCerenkov.cc.

  : G4VDiscreteProcess(nam, type)
{
  secID = G4PhysicsModelCatalog::GetModelID("model_Cerenkov");
  SetProcessSubType(fCerenkov);
  if (nullptr == fLV) {
    // initialise static data    
    fSharedModels = new std::vector<G4VXRayModel*>;
    fLV = new std::vector<std::vector<const G4LogicalVolume*>* >;
    fLVNames = new std::vector<G4String>;
 
    isInitializer = true;
  }
}

Referenced by G4GeneralCerenkov(), and operator=().

~G4GeneralCerenkov()

G4GeneralCerenkov::~G4GeneralCerenkov ( )

override

Definition at line 63 of file G4GeneralCerenkov.cc.

{
  if (isInitializer) {
    delete fSharedModels;
    fSharedModels = nullptr;
    delete fLVNames;
    for (auto const & p : *fLV) {
      delete p;
    }
    delete fLV;
    fLV = nullptr;
  }
}

G4GeneralCerenkov() [2/2]

G4GeneralCerenkov::G4GeneralCerenkov ( const G4GeneralCerenkov & right )

delete

Member Function Documentation

AddModelForVolume()

void G4GeneralCerenkov::AddModelForVolume	(	G4VXRayModel *	model,
		const G4String &	nameLogVolume )

Definition at line 84 of file G4GeneralCerenkov.cc.

{
  if (isPrepared || !isInitializer || nullptr == model) {
     G4ExceptionDescription ed;
     G4String nam;
     if (model != nullptr) { nam = model->GetName(); }
     ed << " Attempt to add Cerenkov model <" << nam << "> for LogicalVolume "
    << nameLogVolume << " is failed!\n isPrepared:" << isPrepared
    << " isInitilizer:" << isInitializer;
     G4Exception("G4GeneralCerenkov::AddModelForVolume", "em0304",
         FatalException, ed, "");
     return;
  }
  fSharedModels->push_back(model);
  fLVNames->push_back(nameLogVolume);
}

BuildPhysicsTable()

void G4GeneralCerenkov::BuildPhysicsTable ( const G4ParticleDefinition & aParticleType )

overridevirtual

Reimplemented from G4VProcess.

Definition at line 181 of file G4GeneralCerenkov.cc.

{
  // Initialisation of models is done only once
  if (isBuilt) { return; }
  isBuilt = true;
  if (nModels == 0) { return; }
 
  // worker thread
  if (!isInitializer) {
    // worker initialisation - clone master models
    fModels.reserve(nModels);
    for (G4int i=0; i<nModels; ++i) {
      auto newmod = new G4VXRayModel(*((*fSharedModels)[i]));
      fModels.push_back(newmod);
      G4double b = newmod->Initialise((*fLV)[i]);
      fBetaMin = std::min(fBetaMin, b);
    }
  } else if (verboseLevel > 0) {
    // needed for printout
    std::size_t nn = 0;
    for (G4int i=0; i<nModels; ++i) {
      G4double b = (*fSharedModels)[i]->Initialise((*fLV)[i]);
      fBetaMin = std::min(fBetaMin, b);
      nn += ((*fLV)[i])->size();
    }
    G4long pres = G4cout.precision();
    G4cout.precision(6);
    G4cout << "  " << GetProcessName() << std::setw(20) << "  fBetaMin=" << fBetaMin
       << "  fMaxBetaChange=" << fMaxBetaChange << G4endl;
    G4cout << std::setw(20) << "fMaxNphot=" << fMaxPhotons
       << "  Nlv=" << nn << "  fStackingFlag:" << fStackingFlag
       << "  fTrackSecondariesFirst:" << fTrackSecondariesFirst
       << G4endl;
    for (G4int i=0; i<nModels; ++i) {
      G4int n = (G4int)((*fLV)[i]->size());
      G4cout << std::setw(10) << (*fSharedModels)[i]->GetName()
         << std::setw(30) << "Nvolumes=" << n << "  Volumes:" << G4endl;
      G4cout << std::setw(12);
      for (G4int j=0; j<n; ++j) {
    G4cout << (*((*fLV)[i]))[j]->GetName() << " ";
    if (0 != j && (j/5)*5 == j) {
      G4cout << G4endl << std::setw(12);
    }
      }
      G4cout << G4endl;
    }
    G4cout.precision(pres);
  }
}

DumpInfo()

void G4GeneralCerenkov::DumpInfo ( ) const

inlineoverridevirtual

Reimplemented from G4VProcess.

Definition at line 86 of file G4GeneralCerenkov.hh.

{ ProcessDescription(G4cout); };

GetMeanFreePath()

G4double G4GeneralCerenkov::GetMeanFreePath ( const G4Track & , G4double , G4ForceCondition *  )

overridevirtual

Implements G4VDiscreteProcess.

Definition at line 345 of file G4GeneralCerenkov.cc.

{
  return DBL_MAX;
}

IsApplicable()

G4bool G4GeneralCerenkov::IsApplicable ( const G4ParticleDefinition & aParticleType )

overridevirtual

Reimplemented from G4VProcess.

Definition at line 78 of file G4GeneralCerenkov.cc.

{
  return true;
}

operator=()

G4GeneralCerenkov & G4GeneralCerenkov::operator= ( const G4GeneralCerenkov & right )

delete

PostStepDoIt()

G4VParticleChange * G4GeneralCerenkov::PostStepDoIt ( const G4Track & aTrack, const G4Step & aStep )

overridevirtual

Reimplemented from G4VDiscreteProcess.

Definition at line 272 of file G4GeneralCerenkov.cc.

{
  aParticleChange.Initialize(aTrack);
  if (fCurrentModel == nullptr) { return &aParticleChange; }
  fCurrentModel->SampleXRays(fSecondaries, aStep);
  if (!fSecondaries.empty()) {
 
    // X-rays
    auto touch = aStep.GetPreStepPoint()->GetTouchableHandle();
    G4int parent = aTrack.GetTrackID();
    for (auto & t : fSecondaries) {
      t->SetTouchableHandle(touch);
      t->SetParentID(parent);
      t->SetCreatorModelID(secID);
      aParticleChange.AddSecondary(t);
    }
    fSecondaries.clear();
 
    // primary track suspended
    if (fTrackSecondariesFirst && aTrack.GetTrackStatus() == fAlive) {
      aParticleChange.ProposeTrackStatus(fSuspend);
    }
  }
  return &aParticleChange;
}

PostStepGetPhysicalInteractionLength()

G4double G4GeneralCerenkov::PostStepGetPhysicalInteractionLength ( const G4Track & aTrack, G4double , G4ForceCondition * cond )

overridevirtual

Reimplemented from G4VDiscreteProcess.

Definition at line 233 of file G4GeneralCerenkov.cc.

{
  *cond = NotForced;
  G4double limit = DBL_MAX;
  auto const dp = aTrack.GetDynamicParticle();
  if (dp->GetCharge() == 0.0) { return limit; }
  fCurrentModel = nullptr;
  fPreStepBeta = dp->GetBeta();
  if (fPreStepBeta <= fBetaMin) { return limit; }
 
  auto volume = aTrack.GetVolume();
  if (nullptr == volume) { return limit; }
 
  fCurrentLV = volume->GetLogicalVolume();
  auto const MPT = fCurrentLV->GetMaterial()->GetMaterialPropertiesTable();
  if (nullptr == MPT) { return limit; }
 
  G4bool ok{false};
  for (G4int i=0; i<nModels; ++i) {
    auto const v = (*fLV)[i];
    std::size_t nn = v->size();
    for (std::size_t j = 0; j < nn; ++j) {
      if ((*v)[j] == fCurrentLV) {
    fCurrentModel = fModels[i];
    if (fCurrentModel->StepLimit(j, aTrack, fPreStepBeta, limit)) {
      *cond = StronglyForced;
    }
    ok = true;
    break;
      }
    }
    if (ok) { break; }
  }
  return limit;
}

PreparePhysicsTable()

void G4GeneralCerenkov::PreparePhysicsTable ( const G4ParticleDefinition & part )

overridevirtual

Reimplemented from G4VProcess.

Definition at line 103 of file G4GeneralCerenkov.cc.

{
  // definition of models is done only once
  if (isPrepared) { return; }
  isPrepared = true;
  
  const G4OpticalParameters* params = G4OpticalParameters::Instance();
  fMaxBetaChange = params->GetCerenkovMaxBetaChange();
  fMaxPhotons = params->GetCerenkovMaxPhotonsPerStep();
  fStackingFlag = params->GetCerenkovStackPhotons();
  fTrackSecondariesFirst = params->GetCerenkovTrackSecondariesFirst();
  verboseLevel = params->GetCerenkovVerboseLevel();
 
  auto nmod = fSharedModels->size();
  if (0 == nmod) {
    // the default model is added without association with a logical volume
    G4VXRayModel* mod = new G4StandardCerenkovModel();    
    fSharedModels->push_back(mod);
    nmod = 1;
  }
 
  fSecondaries.reserve(fMaxPhotons);
  nModels = (G4int)nmod;
 
  // fill static data structures
  if (isInitializer) {
    const G4LogicalVolumeStore* lvs = G4LogicalVolumeStore::GetInstance();
    const auto & modAndVol = params->ActiveVolumes();
 
    // preparation of logical volume vector per model
    fLV->reserve(nmod);
    for (G4int i=0; i<nModels; ++i) {
      auto v = new std::vector<const G4LogicalVolume*>;
      fLV->push_back(v);
    }
    
    for (auto const & lv : *lvs) {
      // only volumes with material property defined are considered
      auto const MPT = lv->GetMaterial()->GetMaterialPropertiesTable();
      if (nullptr == MPT) { continue; }
      
      const G4String& lvname = lv->GetName();
      G4bool ok{false};
      // search for the default model in the list
      if (!modAndVol.empty()) {
    for (auto const & it : modAndVol) {
      if (it.second == lvname) {
        if (kCerenkovDefault == it.first) {
          (*fLV)[0]->push_back(lv);
          fLVNames->push_back(lvname);
          ok = true;
          break;
        }
      }
    }
      }
      if (ok) { continue; }
 
      // search in external models
      for (G4int i=0; i<nModels; ++i) {
        if (lvname == (*fLVNames)[i]) {
      (*fLV)[i]->push_back(lv);
      ok = true;
      break;
    }
      }
      if (ok) { continue; }
 
      // temporary for backward compatibility search for a RINDEX of the volume
      if (nullptr != MPT->GetProperty(kRINDEX)) {
    (*fLV)[0]->push_back(lv);
    fLVNames->push_back(lvname);
      }
    }
  }
}

ProcessDescription()

void G4GeneralCerenkov::ProcessDescription ( std::ostream & out ) const

overridevirtual

Reimplemented from G4VProcess.

Definition at line 300 of file G4GeneralCerenkov.cc.

{
  out << "The Cerenkov effect simulates optical photons created by the\n";
  out << "passage of charged particles through matter. Materials need\n";
  out << "to have the property RINDEX (refractive index) defined." << G4endl;
}

Referenced by DumpInfo().

SetMaxBetaChangePerStep()

void G4GeneralCerenkov::SetMaxBetaChangePerStep

(

const G4double

d

)

Definition at line 316 of file G4GeneralCerenkov.cc.

{
  fMaxBetaChange = value;
  G4OpticalParameters::Instance()->SetCerenkovMaxBetaChange(value);
}

SetMaxNumPhotonsPerStep()

void G4GeneralCerenkov::SetMaxNumPhotonsPerStep

(

const G4int

NumPhotons

)

Definition at line 323 of file G4GeneralCerenkov.cc.

{
  fMaxPhotons = NumPhotons;
  G4OpticalParameters::Instance()->SetCerenkovMaxPhotonsPerStep(fMaxPhotons);
}

SetStackPhotons()

void G4GeneralCerenkov::SetStackPhotons

(

const G4bool

stackingFlag

)

Definition at line 330 of file G4GeneralCerenkov.cc.

{
  fStackingFlag = stackingFlag;
  G4OpticalParameters::Instance()->SetCerenkovStackPhotons(fStackingFlag);
}

SetTrackSecondariesFirst()

void G4GeneralCerenkov::SetTrackSecondariesFirst

(

const G4bool

state

)

Definition at line 308 of file G4GeneralCerenkov.cc.

{
  fTrackSecondariesFirst = state;
  G4OpticalParameters::Instance()->SetCerenkovTrackSecondariesFirst(
    fTrackSecondariesFirst);
}

SetVerboseLevel()

void G4GeneralCerenkov::SetVerboseLevel

(

G4int

verbose

)

Definition at line 337 of file G4GeneralCerenkov.cc.

{
  verboseLevel = verbose;
  G4OpticalParameters::Instance()->SetCerenkovVerboseLevel(verboseLevel);
}

---

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

• G4GeneralCerenkov.hh
• G4GeneralCerenkov.cc