G4OpticalPhysicsMessenger Class Reference

#include <G4OpticalPhysicsMessenger.hh>

Inheritance diagram for G4OpticalPhysicsMessenger:

Collaboration diagram for G4OpticalPhysicsMessenger:

Public Member Functions
	G4OpticalPhysicsMessenger (G4OpticalPhysics *)
virtual	~G4OpticalPhysicsMessenger ()
virtual void	SetNewValue (G4UIcommand *, G4String)
Public Member Functions inherited from G4UImessenger
	G4UImessenger ()
	G4UImessenger (const G4String &path, const G4String &dsc, G4bool commandsToBeBroadcasted=true)
virtual	~G4UImessenger ()
virtual G4String	GetCurrentValue (G4UIcommand *command)
G4bool	operator== (const G4UImessenger &messenger) const
G4bool	CommandsShouldBeInMaster () const

Private Member Functions
	G4OpticalPhysicsMessenger ()
	Not implemented. More...
	G4OpticalPhysicsMessenger (const G4OpticalPhysicsMessenger &right)
	Not implemented. More...
G4OpticalPhysicsMessenger &	operator= (const G4OpticalPhysicsMessenger &right)
	Not implemented. More...

Private Attributes
G4OpticalPhysics *	fOpticalPhysics
	associated class More...
G4UIdirectory *	fDir
	command directory More...
G4UIdirectory *	fDir2
G4OpticalProcessIndex	fSelectedProcessIndex
	selected optical process More...
G4UIcommand *	fActivateProcessCmd
	selectOpProcess command More...
G4UIcmdWithAnInteger *	fSetOpProcessVerboseCmd
	setProcessVerbose command More...
G4UIcmdWithAnInteger *	fSetCerenkovMaxPhotonsCmd
	setCerenkovMaxPhotons command More...
G4UIcmdWithADouble *	fSetCerenkovMaxBetaChangeCmd
	setCerenkovMaxBetaChange command More...
G4UIcmdWithADouble *	fSetScintillationYieldFactorCmd
	setScintillationYieldFactor command More...
G4UIcmdWithABool *	fSetScintillationByParticleTypeCmd
	setScintillationByParticleType command More...
G4UIcmdWithAString *	fSetWLSTimeProfileCmd
	setWLSTimeProfile command More...
G4UIcommand *	fSetTrackSecondariesFirstCmd
	setTrackSecondariesFirst command More...
G4UIcmdWithABool *	fSetFiniteRiseTimeCmd
	setFiniteRiseTime command More...

Additional Inherited Members
Protected Member Functions inherited from G4UImessenger
G4String	ItoS (G4int i)
G4String	DtoS (G4double a)
G4String	BtoS (G4bool b)
G4int	StoI (G4String s)
G4double	StoD (G4String s)
G4bool	StoB (G4String s)
void	AddUIcommand (G4UIcommand *newCommand)
void	CreateDirectory (const G4String &path, const G4String &dsc, G4bool commandsToBeBroadcasted=true)
template<typename T >
T *	CreateCommand (const G4String &cname, const G4String &dsc)
Protected Attributes inherited from G4UImessenger
G4UIdirectory *	baseDir
G4String	baseDirName
G4bool	commandsShouldBeInMaster

Detailed Description

Definition at line 73 of file G4OpticalPhysicsMessenger.hh.

Constructor & Destructor Documentation

G4OpticalPhysicsMessenger() [1/3]

G4OpticalPhysicsMessenger::G4OpticalPhysicsMessenger

(

G4OpticalPhysics *

opticalPhysics

)

Definition at line 60 of file G4OpticalPhysicsMessenger.cc.

  : G4UImessenger(),
    fOpticalPhysics(opticalPhysics),
    fSelectedProcessIndex(kNoProcess),
    fActivateProcessCmd(0),
    fSetOpProcessVerboseCmd(0),
    fSetCerenkovMaxPhotonsCmd(0),
    fSetCerenkovMaxBetaChangeCmd(0),
    fSetScintillationYieldFactorCmd(0),
    fSetScintillationByParticleTypeCmd(0),
    fSetWLSTimeProfileCmd(0),
    fSetTrackSecondariesFirstCmd(0),
    fSetFiniteRiseTimeCmd(0)
{
    G4bool toBeBroadcasted = false;
    fDir = new G4UIdirectory("/process/optical/defaults/",toBeBroadcasted);
    fDir->SetGuidance("Commands related to the optical physics simulation engine.");
    fDir2 = new G4UIdirectory("/process/optical/",toBeBroadcasted);
    fDir2->SetGuidance("Commands related to the optical physics simulation engine.");

    fActivateProcessCmd= new G4UIcommand("/process/optical/processActivation", this);
    fActivateProcessCmd->SetGuidance("Activate/deactivate the specified optical process");
    G4UIparameter* par = new G4UIparameter("proc_name",'s',false);
    G4String candidates;
    for ( G4int i=0; i<kNoProcess; i++ ) {
        candidates += G4OpticalProcessName(i);
        candidates += G4String(" ");
    }
    par->SetParameterCandidates(candidates);
    par->SetGuidance("the process name");
    fActivateProcessCmd->SetParameter(par);
    par = new G4UIparameter("flag",'b',true);
    par->SetDefaultValue(true);
    par->SetGuidance("activation flag");
    fActivateProcessCmd->SetParameter(par);
    fActivateProcessCmd->AvailableForStates(G4State_PreInit);


    fSetOpProcessVerboseCmd = new G4UIcmdWithAnInteger("/process/optical/verbose", this);
    fSetOpProcessVerboseCmd->SetGuidance("Set default verbosity level for optical processes");
    fSetOpProcessVerboseCmd->SetParameterName("ver", true);
    fSetOpProcessVerboseCmd->SetDefaultValue(1);
    fSetOpProcessVerboseCmd->SetRange("ver>=0");
    fSetOpProcessVerboseCmd->AvailableForStates(G4State_PreInit);

    
    fSetTrackSecondariesFirstCmd = new G4UIcommand("/process/optical/setTrackSecondariesFirst", this);
    fSetTrackSecondariesFirstCmd->SetGuidance("Activate/deactivate tracking of secondaries before finishing their parent track");
    par = new G4UIparameter("proc_name",'s',false);
    par->SetParameterCandidates(candidates);
    fSetTrackSecondariesFirstCmd->SetParameter(par);
    par = new G4UIparameter("flag",'b',false);
    par->SetDefaultValue(true);
    fSetTrackSecondariesFirstCmd->SetParameter(par);
    fSetTrackSecondariesFirstCmd->AvailableForStates(G4State_PreInit);

    //This are repetition of process specific ui commands needed by ATLICE and VMC
    //(UI messages needed to exist in PreInit state before actual processes are instantiated)
    fSetCerenkovMaxPhotonsCmd = new G4UIcmdWithAnInteger("/process/optical/defaults/cerenkov/setMaxPhotons", this);
    fSetCerenkovMaxPhotonsCmd->SetGuidance("Set default maximum number of photons per step");
    fSetCerenkovMaxPhotonsCmd->SetGuidance("Note this command is used to set the default value,");
    fSetCerenkovMaxPhotonsCmd->SetGuidance("if process is not active command will not have effect.");
    fSetCerenkovMaxPhotonsCmd->SetParameterName("CerenkovMaxPhotons", false);
    fSetCerenkovMaxPhotonsCmd->SetRange("CerenkovMaxPhotons>=0");
    fSetCerenkovMaxPhotonsCmd->AvailableForStates(G4State_PreInit);

    fSetCerenkovMaxBetaChangeCmd = new G4UIcmdWithADouble("/process/optical/defaults/cerenkov/setMaxBetaChange", this);
    fSetCerenkovMaxBetaChangeCmd->SetGuidance("Set default maximum change of beta of parent particle per step");
    fSetCerenkovMaxBetaChangeCmd->SetGuidance("Note this command is used to set the default value,");
    fSetCerenkovMaxBetaChangeCmd->SetGuidance("if process is not active command will not have effect.");
    fSetCerenkovMaxBetaChangeCmd->SetParameterName("CerenkovMaxBetaChange", false);
    fSetCerenkovMaxBetaChangeCmd->SetRange("CerenkovMaxBetaChange>=0");
    fSetCerenkovMaxBetaChangeCmd->AvailableForStates(G4State_PreInit);

    fSetScintillationYieldFactorCmd = new G4UIcmdWithADouble("/process/optical/defaults/scintillation/setYieldFactor", this);
    fSetScintillationYieldFactorCmd->SetGuidance("Set scintillation yield factor");
    fSetScintillationYieldFactorCmd->SetGuidance("Note this command is used to set the default value,");
    fSetScintillationYieldFactorCmd->SetGuidance("if process is not active command will not have effect.");
    fSetScintillationYieldFactorCmd->SetParameterName("ScintillationYieldFactor", false);
    fSetScintillationYieldFactorCmd->SetRange("ScintillationYieldFactor>=0");
    fSetScintillationYieldFactorCmd->AvailableForStates(G4State_PreInit, G4State_Idle);

    fSetScintillationByParticleTypeCmd = new G4UIcmdWithABool("/process/optical/defaults/scintillation/setByParticleType", this);
    fSetScintillationByParticleTypeCmd->SetGuidance("Activate/Inactivate scintillation process by particle type");
    fSetScintillationByParticleTypeCmd->SetGuidance("Note this command is used to set the default value,");
    fSetScintillationByParticleTypeCmd->SetGuidance("if process is not active command will not have effect.");
    fSetScintillationByParticleTypeCmd->SetParameterName("ScintillationByParticleTypeActivation", false);
    fSetScintillationByParticleTypeCmd->AvailableForStates(G4State_PreInit);

    fSetFiniteRiseTimeCmd = new G4UIcmdWithABool("/process/optical/defaults/scintillation/setFiniteRiseTime", this);
    fSetFiniteRiseTimeCmd->SetGuidance("Set option of a finite rise-time for G4Scintillation");
    fSetFiniteRiseTimeCmd->SetGuidance("If set, the G4Scintillation process expects the user to have set the constant material property FAST/SLOWSCINTILLATIONRISETIME");
    fSetFiniteRiseTimeCmd->SetGuidance("Note this command is used to set the default value,");
    fSetFiniteRiseTimeCmd->SetGuidance("if process is not active command will not have effect.");
    fSetFiniteRiseTimeCmd->SetParameterName("FiniteRiseTime", false);
    fSetFiniteRiseTimeCmd->AvailableForStates(G4State_PreInit);

    fSetWLSTimeProfileCmd = new G4UIcmdWithAString("/process/optical/defaults/wls/setTimeProfile", this);
    fSetWLSTimeProfileCmd->SetGuidance("Set the WLS time profile (delta or exponential)");
    fSetWLSTimeProfileCmd->SetParameterName("WLSTimeProfile", false);
    fSetWLSTimeProfileCmd->SetCandidates("delta exponential");
    fSetWLSTimeProfileCmd->AvailableForStates(G4State_PreInit);
}

Here is the call graph for this function:

~G4OpticalPhysicsMessenger()

G4OpticalPhysicsMessenger::~G4OpticalPhysicsMessenger ( )

virtual

Definition at line 165 of file G4OpticalPhysicsMessenger.cc.

{
// Destructor

  delete fDir;
  delete fDir2;
  delete fActivateProcessCmd;
  delete fSetOpProcessVerboseCmd;
  delete fSetCerenkovMaxPhotonsCmd;
  delete fSetCerenkovMaxBetaChangeCmd;
  delete fSetScintillationYieldFactorCmd;
  delete fSetScintillationByParticleTypeCmd;
  delete fSetWLSTimeProfileCmd;
  delete fSetFiniteRiseTimeCmd;
}

G4OpticalPhysicsMessenger() [2/3]

G4OpticalPhysicsMessenger::G4OpticalPhysicsMessenger ( )

private

Not implemented.

G4OpticalPhysicsMessenger() [3/3]

G4OpticalPhysicsMessenger::G4OpticalPhysicsMessenger ( const G4OpticalPhysicsMessenger &  right )

private

Not implemented.

Member Function Documentation

operator=()

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

private

Not implemented.

SetNewValue()

void G4OpticalPhysicsMessenger::SetNewValue ( G4UIcommand *  command, G4String  newValue  )

virtual

Apply command to the associated object.

Reimplemented from G4UImessenger.

Definition at line 182 of file G4OpticalPhysicsMessenger.cc.

{
  if (command == fActivateProcessCmd) {
    std::istringstream is(newValue.data());
    G4String pn;
    G4int flag;
    is >> pn >> flag;
    if  ( pn == "Cerenkov" )        {
        fSelectedProcessIndex = kCerenkov;
    } else if ( pn == "Scintillation" ) {
        fSelectedProcessIndex = kScintillation;
    } else if ( pn == "OpAbsorption" )  {
        fSelectedProcessIndex = kAbsorption;
    } else if ( pn == "OpRayleigh" )    {
        fSelectedProcessIndex = kRayleigh;
    } else if ( pn == "OpMieHG" )       {
        fSelectedProcessIndex = kMieHG;
    } else if ( pn == "OpBoundary" )    {
        fSelectedProcessIndex = kBoundary;
    } else if ( pn == "OpWLS" )         {
        fSelectedProcessIndex = kWLS;
    } else {
        G4ExceptionDescription msg;
        msg << "Not allowed process name: "<<pn<<" (UI: "<<newValue<<")";
        G4Exception("G4OpticalPhysicsMessenger::SetNewValue(...)","Optical001",FatalException,pn);
    }
    fOpticalPhysics->Configure(fSelectedProcessIndex,flag);
  }
  else if (command == fSetTrackSecondariesFirstCmd )
  {
      std::istringstream is(newValue.data());
      G4String pn;
      G4int flag;
      is >> pn >> flag;
      if ( pn == "Cerenkov" )        {
        fSelectedProcessIndex = kCerenkov;
      } else if ( pn == "Scintillation" ) {
        fSelectedProcessIndex = kScintillation;
      } else if ( pn == "OpAbsorption" )  {
        fSelectedProcessIndex = kAbsorption;
      } else if ( pn == "OpRayleigh" )    {
        fSelectedProcessIndex = kRayleigh;
      } else if ( pn == "OpMieHG" )       {
        fSelectedProcessIndex = kMieHG;
      } else if ( pn == "OpBoundary" )    {
        fSelectedProcessIndex = kBoundary;
      } else if ( pn == "OpWLS" )         {
        fSelectedProcessIndex = kWLS;
      } else {
          G4ExceptionDescription msg;
          msg << "Not allowed process name: "<<pn<<" (UI: "<<newValue<<")";
          G4Exception("G4OpticalPhysicsMessenger::SetNewValue(...)","Optical001",FatalException,pn);
      }
      fOpticalPhysics->SetTrackSecondariesFirst(fSelectedProcessIndex,flag);
  }
  else if (command == fSetOpProcessVerboseCmd) {
        fOpticalPhysics->SetVerboseLevel(fSetOpProcessVerboseCmd->GetNewIntValue(newValue));
  }
  else if (command == fSetCerenkovMaxPhotonsCmd) {
    fOpticalPhysics
      ->SetMaxNumPhotonsPerStep(
          fSetCerenkovMaxPhotonsCmd->GetNewIntValue(newValue));
  }
  else if (command == fSetCerenkovMaxBetaChangeCmd) {
    fOpticalPhysics
      ->SetMaxBetaChangePerStep(
          fSetCerenkovMaxBetaChangeCmd->GetNewDoubleValue(newValue));
  }
  else if (command == fSetScintillationYieldFactorCmd) {
    fOpticalPhysics
      ->SetScintillationYieldFactor(
          fSetScintillationYieldFactorCmd->GetNewDoubleValue(newValue));
  }
  else if (command == fSetScintillationByParticleTypeCmd) {
    fOpticalPhysics
      ->SetScintillationByParticleType(
         fSetScintillationByParticleTypeCmd->GetNewBoolValue(newValue));
  }
  else if (command == fSetFiniteRiseTimeCmd) {
    fOpticalPhysics
      ->SetFiniteRiseTime(
         fSetFiniteRiseTimeCmd->GetNewBoolValue(newValue));
  }
  else if (command == fSetWLSTimeProfileCmd) {
      fOpticalPhysics->SetWLSTimeProfile(newValue);
  }
}

Here is the call graph for this function:

Member Data Documentation

fActivateProcessCmd

G4UIcommand* G4OpticalPhysicsMessenger::fActivateProcessCmd

private

selectOpProcess command

Definition at line 105 of file G4OpticalPhysicsMessenger.hh.

fDir

G4UIdirectory* G4OpticalPhysicsMessenger::fDir

private

command directory

Definition at line 98 of file G4OpticalPhysicsMessenger.hh.

fDir2

G4UIdirectory* G4OpticalPhysicsMessenger::fDir2

private

Definition at line 99 of file G4OpticalPhysicsMessenger.hh.

fOpticalPhysics

G4OpticalPhysics* G4OpticalPhysicsMessenger::fOpticalPhysics

private

associated class

Definition at line 95 of file G4OpticalPhysicsMessenger.hh.

fSelectedProcessIndex

G4OpticalProcessIndex G4OpticalPhysicsMessenger::fSelectedProcessIndex

private

selected optical process

Definition at line 102 of file G4OpticalPhysicsMessenger.hh.

fSetCerenkovMaxBetaChangeCmd

G4UIcmdWithADouble* G4OpticalPhysicsMessenger::fSetCerenkovMaxBetaChangeCmd

private

setCerenkovMaxBetaChange command

Definition at line 115 of file G4OpticalPhysicsMessenger.hh.

fSetCerenkovMaxPhotonsCmd

G4UIcmdWithAnInteger* G4OpticalPhysicsMessenger::fSetCerenkovMaxPhotonsCmd

private

setCerenkovMaxPhotons command

Definition at line 112 of file G4OpticalPhysicsMessenger.hh.

fSetFiniteRiseTimeCmd

G4UIcmdWithABool* G4OpticalPhysicsMessenger::fSetFiniteRiseTimeCmd

private

setFiniteRiseTime command

Definition at line 133 of file G4OpticalPhysicsMessenger.hh.

fSetOpProcessVerboseCmd

G4UIcmdWithAnInteger* G4OpticalPhysicsMessenger::fSetOpProcessVerboseCmd

private

setProcessVerbose command

Definition at line 109 of file G4OpticalPhysicsMessenger.hh.

fSetScintillationByParticleTypeCmd

G4UIcmdWithABool* G4OpticalPhysicsMessenger::fSetScintillationByParticleTypeCmd

private

setScintillationByParticleType command

Definition at line 121 of file G4OpticalPhysicsMessenger.hh.

fSetScintillationYieldFactorCmd

G4UIcmdWithADouble* G4OpticalPhysicsMessenger::fSetScintillationYieldFactorCmd

private

setScintillationYieldFactor command

Definition at line 118 of file G4OpticalPhysicsMessenger.hh.

fSetTrackSecondariesFirstCmd

G4UIcommand* G4OpticalPhysicsMessenger::fSetTrackSecondariesFirstCmd

private

setTrackSecondariesFirst command

Definition at line 130 of file G4OpticalPhysicsMessenger.hh.

fSetWLSTimeProfileCmd

G4UIcmdWithAString* G4OpticalPhysicsMessenger::fSetWLSTimeProfileCmd

private

setWLSTimeProfile command

Definition at line 127 of file G4OpticalPhysicsMessenger.hh.

---

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

• G4OpticalPhysicsMessenger.hh
• G4OpticalPhysicsMessenger.cc