G4VBiasingOperator Class Reference

#include <G4VBiasingOperator.hh>

Inheritance diagram for G4VBiasingOperator:

Public Member Functions
	G4VBiasingOperator (const G4String &name)
virtual	~G4VBiasingOperator ()=default
virtual void	Configure ()
virtual void	ConfigureForWorker ()
virtual void	StartRun ()
virtual void	StartTracking (const G4Track *)
virtual void	EndTracking ()
const G4String &	GetName () const
void	AttachTo (const G4LogicalVolume *)
G4BiasingAppliedCase	GetPreviousBiasingAppliedCase () const
G4VBiasingOperation *	GetProposedOccurenceBiasingOperation (const G4Track *track, const G4BiasingProcessInterface *callingProcess)
G4VBiasingOperation *	GetProposedFinalStateBiasingOperation (const G4Track *track, const G4BiasingProcessInterface *callingProcess)
G4VBiasingOperation *	GetProposedNonPhysicsBiasingOperation (const G4Track *track, const G4BiasingProcessInterface *callingProcess)
void	ExitingBiasing (const G4Track *track, const G4BiasingProcessInterface *callingProcess)
void	ReportOperationApplied (const G4BiasingProcessInterface *callingProcess, G4BiasingAppliedCase biasingCase, G4VBiasingOperation *operationApplied, const G4VParticleChange *particleChangeProduced)
void	ReportOperationApplied (const G4BiasingProcessInterface *callingProcess, G4BiasingAppliedCase biasingCase, G4VBiasingOperation *occurenceOperationApplied, G4double weightForOccurenceInteraction, G4VBiasingOperation *finalStateOperationApplied, const G4VParticleChange *particleChangeProduced)
const G4VBiasingOperation *	GetPreviousNonPhysicsAppliedOperation ()

Static Public Member Functions
static const std::vector< G4VBiasingOperator * > &	GetBiasingOperators ()
static G4VBiasingOperator *	GetBiasingOperator (const G4LogicalVolume *)

Protected Member Functions
virtual G4VBiasingOperation *	ProposeNonPhysicsBiasingOperation (const G4Track *track, const G4BiasingProcessInterface *callingProcess)=0
virtual G4VBiasingOperation *	ProposeOccurenceBiasingOperation (const G4Track *track, const G4BiasingProcessInterface *callingProcess)=0
virtual G4VBiasingOperation *	ProposeFinalStateBiasingOperation (const G4Track *track, const G4BiasingProcessInterface *callingProcess)=0
virtual void	OperationApplied (const G4BiasingProcessInterface *callingProcess, G4BiasingAppliedCase biasingCase, G4VBiasingOperation *operationApplied, const G4VParticleChange *particleChangeProduced)
virtual void	OperationApplied (const G4BiasingProcessInterface *callingProcess, G4BiasingAppliedCase biasingCase, G4VBiasingOperation *occurenceOperationApplied, G4double weightForOccurenceInteraction, G4VBiasingOperation *finalStateOperationApplied, const G4VParticleChange *particleChangeProduced)
virtual void	ExitBiasing (const G4Track *track, const G4BiasingProcessInterface *callingProcess)

Friends
class	G4BiasingOperatorStateNotifier

Detailed Description

Definition at line 173 of file G4VBiasingOperator.hh.

Constructor & Destructor Documentation

G4VBiasingOperator()

G4VBiasingOperator::G4VBiasingOperator

(

const G4String &

name

)

Definition at line 37 of file G4VBiasingOperator.cc.

  : fName( name )
{
  fOperators.Push_back(this);
 
  if ( fStateNotifier.Get() == nullptr )
    fStateNotifier.Put( new G4BiasingOperatorStateNotifier() );
}

Referenced by G4BOptrForceCollision::G4BOptrForceCollision(), G4BOptrForceCollision::G4BOptrForceCollision(), G4ChannelingOptrChangeCrossSection::G4ChannelingOptrChangeCrossSection(), G4ChannelingOptrMultiParticleChangeCrossSection::G4ChannelingOptrMultiParticleChangeCrossSection(), and GetBiasingOperator().

~G4VBiasingOperator()

virtual G4VBiasingOperator::~G4VBiasingOperator ( )

virtualdefault

Member Function Documentation

AttachTo()

void G4VBiasingOperator::AttachTo

(

const G4LogicalVolume *

logical

)

Definition at line 46 of file G4VBiasingOperator.cc.

{
  auto it = fLogicalToSetupMap.Find(logical);
  if ( it == fLogicalToSetupMap.End() )
  {
    fLogicalToSetupMap[logical] = this;
  }
  else if ( (*it).second != this )
  {
    G4ExceptionDescription ed;
    ed << "Biasing operator `" << GetName() 
       << "' can not be attached to Logical volume `"
       << logical->GetName() << "' which is already used by another operator !"
       << G4endl;
    G4Exception("G4VBiasingOperator::AttachTo(...)",
                "BIAS.MNG.01", JustWarning, ed);
  }
}

Configure()

virtual void G4VBiasingOperator::Configure ( )

inlinevirtual

Reimplemented in G4BOptrForceCollision.

Definition at line 190 of file G4VBiasingOperator.hh.

{}

ConfigureForWorker()

virtual void G4VBiasingOperator::ConfigureForWorker ( )

inlinevirtual

Reimplemented in G4BOptrForceCollision.

Definition at line 193 of file G4VBiasingOperator.hh.

{}

EndTracking()

virtual void G4VBiasingOperator::EndTracking ( )

inlinevirtual

Reimplemented in G4BOptrForceCollision.

Definition at line 198 of file G4VBiasingOperator.hh.

{}

ExitBiasing()

void G4VBiasingOperator::ExitBiasing ( const G4Track * track, const G4BiasingProcessInterface * callingProcess )

protectedvirtual

Reimplemented in G4BOptrForceCollision.

Definition at line 164 of file G4VBiasingOperator.cc.

{}

Referenced by ExitingBiasing().

ExitingBiasing()

void G4VBiasingOperator::ExitingBiasing	(	const G4Track *	track,
		const G4BiasingProcessInterface *	callingProcess )

Definition at line 143 of file G4VBiasingOperator.cc.

{
  ExitBiasing( track, callingProcess );
  
  // -- reset all data members:
  fOccurenceBiasingOperation                  = nullptr ;
  fFinalStateBiasingOperation                 = nullptr ;
  fNonPhysicsBiasingOperation                 = nullptr ;
  fPreviousProposedOccurenceBiasingOperation  = nullptr ;
  fPreviousProposedFinalStateBiasingOperation = nullptr ;
  fPreviousProposedNonPhysicsBiasingOperation = nullptr ;
  fPreviousAppliedOccurenceBiasingOperation   = nullptr ;
  fPreviousAppliedFinalStateBiasingOperation  = nullptr ;
  fPreviousAppliedNonPhysicsBiasingOperation  = nullptr ;
  fPreviousBiasingAppliedCase                 = BAC_None ;
}

GetBiasingOperator()

G4VBiasingOperator * G4VBiasingOperator::GetBiasingOperator ( const G4LogicalVolume * logical )

static

Definition at line 71 of file G4VBiasingOperator.cc.

{
  auto it = fLogicalToSetupMap.Find(logical);
  if ( it == fLogicalToSetupMap.End() ) { return nullptr; }
  else  { return (*it).second; }
}

Referenced by G4BiasingProcessInterface::PostStepGetPhysicalInteractionLength().

GetBiasingOperators()

const std::vector< G4VBiasingOperator * > & G4VBiasingOperator::GetBiasingOperators ( )

static

Definition at line 66 of file G4VBiasingOperator.cc.

{
  return fOperators.Get();
}

Referenced by G4BiasingProcessInterface::BuildPhysicsTable(), G4BiasingProcessInterface::BuildWorkerPhysicsTable(), G4BiasingProcessInterface::EndTracking(), and G4BiasingProcessInterface::StartTracking().

GetName()

const G4String & G4VBiasingOperator::GetName ( ) const

inline

Definition at line 204 of file G4VBiasingOperator.hh.

{ return fName; }

Referenced by AttachTo(), G4BOptrForceCollision::EndTracking(), and G4BiasingProcessInterface::PostStepGetPhysicalInteractionLength().

GetPreviousBiasingAppliedCase()

G4BiasingAppliedCase G4VBiasingOperator::GetPreviousBiasingAppliedCase ( ) const

inline

Definition at line 207 of file G4VBiasingOperator.hh.

      { return fPreviousBiasingAppliedCase; }

GetPreviousNonPhysicsAppliedOperation()

const G4VBiasingOperation * G4VBiasingOperator::GetPreviousNonPhysicsAppliedOperation ( )

inline

Definition at line 236 of file G4VBiasingOperator.hh.

      { return  fPreviousAppliedNonPhysicsBiasingOperation; }

GetProposedFinalStateBiasingOperation()

G4VBiasingOperation * G4VBiasingOperator::GetProposedFinalStateBiasingOperation	(	const G4Track *	track,
		const G4BiasingProcessInterface *	callingProcess )

Definition at line 84 of file G4VBiasingOperator.cc.

{
  fFinalStateBiasingOperation = ProposeFinalStateBiasingOperation(track, callingProcess); 
  return fFinalStateBiasingOperation;
}

GetProposedNonPhysicsBiasingOperation()

G4VBiasingOperation * G4VBiasingOperator::GetProposedNonPhysicsBiasingOperation	(	const G4Track *	track,
		const G4BiasingProcessInterface *	callingProcess )

Definition at line 90 of file G4VBiasingOperator.cc.

{
  fNonPhysicsBiasingOperation = ProposeNonPhysicsBiasingOperation(track, callingProcess);
  return fNonPhysicsBiasingOperation;
}

GetProposedOccurenceBiasingOperation()

G4VBiasingOperation * G4VBiasingOperator::GetProposedOccurenceBiasingOperation	(	const G4Track *	track,
		const G4BiasingProcessInterface *	callingProcess )

Definition at line 78 of file G4VBiasingOperator.cc.

{
  fOccurenceBiasingOperation = ProposeOccurenceBiasingOperation(track, callingProcess);
  return fOccurenceBiasingOperation;
}

OperationApplied() [1/2]

void G4VBiasingOperator::OperationApplied ( const G4BiasingProcessInterface * callingProcess, G4BiasingAppliedCase biasingCase, G4VBiasingOperation * occurenceOperationApplied, G4double weightForOccurenceInteraction, G4VBiasingOperation * finalStateOperationApplied, const G4VParticleChange * particleChangeProduced )

protectedvirtual

Reimplemented in G4BOptrForceCollision.

Definition at line 172 of file G4VBiasingOperator.cc.

{
}

OperationApplied() [2/2]

void G4VBiasingOperator::OperationApplied ( const G4BiasingProcessInterface * callingProcess, G4BiasingAppliedCase biasingCase, G4VBiasingOperation * operationApplied, const G4VParticleChange * particleChangeProduced )

protectedvirtual

Reimplemented in G4BOptrForceCollision.

Definition at line 167 of file G4VBiasingOperator.cc.

{
}

Referenced by ReportOperationApplied(), and ReportOperationApplied().

ProposeFinalStateBiasingOperation()

virtual G4VBiasingOperation * G4VBiasingOperator::ProposeFinalStateBiasingOperation ( const G4Track * track, const G4BiasingProcessInterface * callingProcess )

protectedpure virtual

Referenced by GetProposedFinalStateBiasingOperation().

ProposeNonPhysicsBiasingOperation()

virtual G4VBiasingOperation * G4VBiasingOperator::ProposeNonPhysicsBiasingOperation ( const G4Track * track, const G4BiasingProcessInterface * callingProcess )

protectedpure virtual

Referenced by GetProposedNonPhysicsBiasingOperation().

ProposeOccurenceBiasingOperation()

virtual G4VBiasingOperation * G4VBiasingOperator::ProposeOccurenceBiasingOperation ( const G4Track * track, const G4BiasingProcessInterface * callingProcess )

protectedpure virtual

Referenced by GetProposedOccurenceBiasingOperation().

ReportOperationApplied() [1/2]

void G4VBiasingOperator::ReportOperationApplied	(	const G4BiasingProcessInterface *	callingProcess,
		G4BiasingAppliedCase	biasingCase,
		G4VBiasingOperation *	occurenceOperationApplied,
		G4double	weightForOccurenceInteraction,
		G4VBiasingOperation *	finalStateOperationApplied,
		const G4VParticleChange *	particleChangeProduced )

Definition at line 129 of file G4VBiasingOperator.cc.

{
  fPreviousBiasingAppliedCase = biasingCase;
  fPreviousAppliedOccurenceBiasingOperation = occurenceOperationApplied;
  fPreviousAppliedFinalStateBiasingOperation = finalStateOperationApplied;
  OperationApplied( callingProcess, biasingCase, occurenceOperationApplied, weightForOccurenceInteraction, finalStateOperationApplied, particleChangeProduced );
}

ReportOperationApplied() [2/2]

void G4VBiasingOperator::ReportOperationApplied	(	const G4BiasingProcessInterface *	callingProcess,
		G4BiasingAppliedCase	biasingCase,
		G4VBiasingOperation *	operationApplied,
		const G4VParticleChange *	particleChangeProduced )

Definition at line 96 of file G4VBiasingOperator.cc.

{
  fPreviousBiasingAppliedCase = biasingCase;
  fPreviousAppliedOccurenceBiasingOperation  = nullptr;
  fPreviousAppliedFinalStateBiasingOperation = nullptr;
  fPreviousAppliedNonPhysicsBiasingOperation = nullptr;
  switch ( biasingCase )
  {
    case BAC_None:
      break;
    case BAC_NonPhysics:
      fPreviousAppliedNonPhysicsBiasingOperation = operationApplied ;
      break;
    case BAC_FinalState:
      fPreviousAppliedFinalStateBiasingOperation = operationApplied;
      break;
    case BAC_Occurence:
      G4Exception("G4VBiasingOperator::ReportOperationApplied(...)",
                  "BIAS.MNG.02", JustWarning,
                  "Internal logic error, please report !");
      break;
    default:
      G4Exception("G4VBiasingOperator::ReportOperationApplied(...)",
                  "BIAS.MNG.03", JustWarning,
                  "Internal logic error, please report !");
  }
  OperationApplied( callingProcess, biasingCase, operationApplied, particleChangeProduced );
}

StartRun()

virtual void G4VBiasingOperator::StartRun ( )

inlinevirtual

Reimplemented in G4BOptrForceCollision, and G4ChannelingOptrChangeCrossSection.

Definition at line 195 of file G4VBiasingOperator.hh.

{}

StartTracking()

virtual void G4VBiasingOperator::StartTracking ( const G4Track * )

inlinevirtual

Reimplemented in G4BOptrForceCollision, and G4ChannelingOptrMultiParticleChangeCrossSection.

Definition at line 197 of file G4VBiasingOperator.hh.

{}

Friends And Related Symbol Documentation

G4BiasingOperatorStateNotifier

friend class G4BiasingOperatorStateNotifier

friend

Definition at line 178 of file G4VBiasingOperator.hh.

Referenced by G4BiasingOperatorStateNotifier, and G4VBiasingOperator().

---

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

• G4VBiasingOperator.hh
• G4VBiasingOperator.cc