Bias the neutron inelastic collsions. More...

#include <NeutronInelastic.h>

Public Member Functions
	NeutronInelastic (std::string name, const framework::config::Parameters &p)
	Constructor.

virtual	~NeutronInelastic ()=default
	Destructor.

G4VBiasingOperation *	ProposeOccurenceBiasingOperation (const G4Track track, const G4BiasingProcessInterface callingProcess) override

std::string	getProcessToBias () const override
	Return the process to bias.

std::string	getParticleToBias () const override
	Return the particle to bias.

std::string	getVolumeToBias () const override
	Return the volume to bias in.

void	RecordConfig (ldmx::RunHeader &header) const override
	Record the configuration to the run header.

Public Member Functions inherited from simcore::XsecBiasingOperator
	XsecBiasingOperator (std::string name, const framework::config::Parameters &parameters)
	Constructor.

virtual	~XsecBiasingOperator ()=default
	Destructor.

void	StartRun ()
	Method called at the beginning of a run.

Private Attributes
std::string	volume_
	The volume to bias in.

double	factor_
	The biasing factor.

double	threshold_
	Minimum kinetic energy [MeV] to allow a track to be biased.

Additional Inherited Members
Public Types inherited from simcore::XsecBiasingOperator
using	Factory = ::simcore::Factory< XsecBiasingOperator, std::shared_ptr< XsecBiasingOperator >, std::string, const framework::config::Parameters & >
	The BiasingOperator factory.

Protected Member Functions inherited from simcore::XsecBiasingOperator
G4VBiasingOperation *	BiasedXsec (double biased_xsec)
	Helper method for passing a biased interaction length to the Geant4 biasing framework.

bool	processIsBiased (std::string process)
	Check if the given processed is being biased.

G4VBiasingOperation *	ProposeFinalStateBiasingOperation (const G4Track , const G4BiasingProcessInterface )
	Do not propose any biasing on final states.

G4VBiasingOperation *	ProposeNonPhysicsBiasingOperation (const G4Track , const G4BiasingProcessInterface )
	Do not propose any non-physics biasing.

Protected Attributes inherited from simcore::XsecBiasingOperator
G4BOptnChangeCrossSection *	xsecOperation_ {nullptr}
	Cross-section biasing operation.

G4ProcessManager *	processManager_ {nullptr}
	Process manager associated with the particle of interest.

Detailed Description

Bias the neutron inelastic collsions.

Definition at line 12 of file NeutronInelastic.h.

Constructor & Destructor Documentation

◆ NeutronInelastic()

simcore::biasoperators::NeutronInelastic::NeutronInelastic	(	std::string	name,
		const framework::config::Parameters &	p
	)

Constructor.

Calls parent constructor and allows accesss to configuration parameters.

Definition at line 7 of file NeutronInelastic.cxx.

    : XsecBiasingOperator(name, p) {
  volume_ = p.getParameter<std::string>("volume");
  factor_ = p.getParameter<double>("factor");
  threshold_ = p.getParameter<double>("threshold");
}

References factor_, framework::config::Parameters::getParameter(), threshold_, and volume_.

Member Function Documentation

◆ getParticleToBias()

std::string simcore::biasoperators::NeutronInelastic::getParticleToBias ( ) const

inlineoverridevirtual

Return the particle to bias.

Implements simcore::XsecBiasingOperator.

Definition at line 37 of file NeutronInelastic.h.

37{ return "neutron"; }

◆ getProcessToBias()

std::string simcore::biasoperators::NeutronInelastic::getProcessToBias ( ) const

inlineoverridevirtual

Return the process to bias.

Implements simcore::XsecBiasingOperator.

Definition at line 34 of file NeutronInelastic.h.

34{ return "neutronInelastic"; }

◆ getVolumeToBias()

std::string simcore::biasoperators::NeutronInelastic::getVolumeToBias ( ) const

inlineoverridevirtual

Return the volume to bias in.

Implements simcore::XsecBiasingOperator.

Definition at line 40 of file NeutronInelastic.h.

40{ return volume_; }

References volume_.

◆ ProposeOccurenceBiasingOperation()

G4VBiasingOperation * simcore::biasoperators::NeutronInelastic::ProposeOccurenceBiasingOperation	(	const G4Track *	track,
		const G4BiasingProcessInterface *	callingProcess
	)

overridevirtual

Returns: Method that returns the biasing operation that will be used to bias the neutron inelactic hadronic interactions.

Implements simcore::XsecBiasingOperator.

Definition at line 15 of file NeutronInelastic.cxx.

                                                                           {
  if (track->GetKineticEnergy() < threshold_) {
    return nullptr;
  }
 
  std::string currentProcess =
      callingProcess->GetWrappedProcess()->GetProcessName();
  if (currentProcess.compare(this->getProcessToBias()) == 0) {
    G4double interactionLength =
        callingProcess->GetWrappedProcess()->GetCurrentInteractionLength();
 
    double neutInXsecUnbiased = 1. / interactionLength;
 
    double neutInXsecBiased = neutInXsecUnbiased * factor_;
 
    return BiasedXsec(neutInXsecBiased);
  }
  return nullptr;
}

References simcore::XsecBiasingOperator::BiasedXsec(), factor_, and threshold_.

◆ RecordConfig()

void simcore::biasoperators::NeutronInelastic::RecordConfig ( ldmx::RunHeader & header ) const

inlineoverridevirtual

Record the configuration to the run header.

Parameters

[in,out] header RunHeader to record to

Implements simcore::XsecBiasingOperator.

Definition at line 47 of file NeutronInelastic.h.

                                                          {
    header.setStringParameter("BiasOperator::NeutronInelastic::Volume",
                              volume_);
    header.setFloatParameter("BiasOperator::NeutronInelastic::Factor", factor_);
    header.setFloatParameter("BiasOperator::NeutronInelastic::Threshold",
                             threshold_);
  }

References factor_, ldmx::RunHeader::setFloatParameter(), ldmx::RunHeader::setStringParameter(), threshold_, and volume_.

Member Data Documentation

◆ factor_

double simcore::biasoperators::NeutronInelastic::factor_

private

The biasing factor.

Definition at line 60 of file NeutronInelastic.h.

Referenced by NeutronInelastic(), ProposeOccurenceBiasingOperation(), and RecordConfig().

◆ threshold_

double simcore::biasoperators::NeutronInelastic::threshold_

private

Minimum kinetic energy [MeV] to allow a track to be biased.

Definition at line 63 of file NeutronInelastic.h.

Referenced by NeutronInelastic(), ProposeOccurenceBiasingOperation(), and RecordConfig().

◆ volume_

std::string simcore::biasoperators::NeutronInelastic::volume_

private

The volume to bias in.

Definition at line 57 of file NeutronInelastic.h.

Referenced by getVolumeToBias(), NeutronInelastic(), and RecordConfig().

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

SimCore/include/SimCore/BiasOperators/NeutronInelastic.h
SimCore/src/SimCore/BiasOperators/NeutronInelastic.cxx

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ NeutronInelastic()

Member Function Documentation

◆ getParticleToBias()

◆ getProcessToBias()

◆ getVolumeToBias()

◆ ProposeOccurenceBiasingOperation()

◆ RecordConfig()

Member Data Documentation

◆ factor_

◆ threshold_

◆ volume_