simcore::XsecBiasingOperator Class Reference

Our specialization of the biasing operator used with Geant4. More...

#include <XsecBiasingOperator.h>

Public Member Functions
	XsecBiasingOperator (std::string name, const framework::config::Parameters &parameters)
	Constructor.
	DECLARE_FACTORY_WITH_WAREHOUSE (XsecBiasingOperator, std::shared_ptr< XsecBiasingOperator >, std::string, const framework::config::Parameters &)
	The BiasingOperator factory.
virtual	~XsecBiasingOperator ()=default
	Destructor.
virtual G4VBiasingOperation *	ProposeOccurenceBiasingOperation (const G4Track *track, const G4BiasingProcessInterface *callingProcess)=0
	Propose a biasing operation for the current track and calling process.
void	StartRun ()
	Method called at the beginning of a run.
virtual std::string	getProcessToBias () const =0
	Return the process whose cross-section will be biased.
virtual std::string	getParticleToBias () const =0
	Return the particle which should be biased.
virtual std::string	getVolumeToBias () const =0
	Return the volume which should be biased.
virtual void	RecordConfig (ldmx::RunHeader &header) const =0
	Record the configuration of this biasing operator into the run header.

Protected Member Functions
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
G4BOptnChangeCrossSection *	xsec_operation_ {nullptr}
	Cross-section biasing operation.
G4ProcessManager *	process_manager_ {nullptr}
	Process manager associated with the particle of interest.
framework::logging::logger	the_log_
	Enable logging.

Detailed Description

Our specialization of the biasing operator used with Geant4.

This specialization accomplishes three main tasks.

1. Allows any derived class to be dynamically loaded after using the declaration macro given below.
2. Interfaces with the derived class using our parameters class.
3. Pre-defines the necessary biasing operation so the derived class only needs to worry about calculating the biased xsec.

Definition at line 41 of file XsecBiasingOperator.h.

Constructor & Destructor Documentation

XsecBiasingOperator()

simcore::XsecBiasingOperator::XsecBiasingOperator	(	std::string	name,
		const framework::config::Parameters &	parameters )

Constructor.

Here, we define a unique name for this biasing operator and are given the configuration parameters loaded from the python script.

Parameters

[in]	name	unique instance name for this biasing operator
[in]	parameters	python configuration parameters

Definition at line 7 of file XsecBiasingOperator.cxx.

    : G4VBiasingOperator(name),
      the_log_{framework::logging::makeLogger(name)} {}

Member Function Documentation

BiasedXsec()

G4VBiasingOperation * simcore::XsecBiasingOperator::BiasedXsec ( double biased_xsec )

inlineprotected

Helper method for passing a biased interaction length to the Geant4 biasing framework.

Use like:

return BiasedXsec(biased_xsec);

inside of ProposeOccurenceBiasingOperation when you want to update the biased cross section.

Parameters

[in]

biased_xsec

the biased cross section

Returns

the biasing operation with the input biased cross section

Definition at line 145 of file XsecBiasingOperator.h.

                                                      {
    xsec_operation_->SetBiasedCrossSection(biased_xsec);
    xsec_operation_->Sample();
    return xsec_operation_;
  }

References xsec_operation_.

Referenced by simcore::biasoperators::DarkBrem::ProposeOccurenceBiasingOperation(), simcore::biasoperators::ElectroNuclear::ProposeOccurenceBiasingOperation(), simcore::biasoperators::GammaToMuPair::ProposeOccurenceBiasingOperation(), simcore::biasoperators::K0LongInelastic::ProposeOccurenceBiasingOperation(), simcore::biasoperators::NeutronInelastic::ProposeOccurenceBiasingOperation(), and simcore::biasoperators::PhotoNuclear::ProposeOccurenceBiasingOperation().

getParticleToBias()

virtual std::string simcore::XsecBiasingOperator::getParticleToBias ( ) const

pure virtual

Return the particle which should be biased.

We need this to be able to tell the physics list which particle to bias.

See also

RunManager::setupPhysics

Implemented in simcore::biasoperators::DarkBrem, simcore::biasoperators::ElectroNuclear, simcore::biasoperators::GammaToMuPair, simcore::biasoperators::K0LongInelastic, simcore::biasoperators::NeutronInelastic, and simcore::biasoperators::PhotoNuclear.

Referenced by StartRun().

getProcessToBias()

virtual std::string simcore::XsecBiasingOperator::getProcessToBias ( ) const

pure virtual

Return the process whose cross-section will be biased.

We need this to be able to check that the process was biased before creating the biasing operator.

Implemented in simcore::biasoperators::DarkBrem, simcore::biasoperators::ElectroNuclear, simcore::biasoperators::GammaToMuPair, simcore::biasoperators::K0LongInelastic, simcore::biasoperators::NeutronInelastic, and simcore::biasoperators::PhotoNuclear.

Referenced by StartRun().

getVolumeToBias()

virtual std::string simcore::XsecBiasingOperator::getVolumeToBias ( ) const

pure virtual

Return the volume which should be biased.

We need this to be able to tell the detector construction which volumes to attach this operator to.

Implemented in simcore::biasoperators::DarkBrem, simcore::biasoperators::ElectroNuclear, simcore::biasoperators::GammaToMuPair, simcore::biasoperators::K0LongInelastic, simcore::biasoperators::NeutronInelastic, and simcore::biasoperators::PhotoNuclear.

processIsBiased()

bool simcore::XsecBiasingOperator::processIsBiased ( std::string process )

protected

Check if the given processed is being biased.

Parameters

process

Process of interest

Returns

true if the process is being biased, false otherwise

Definition at line 39 of file XsecBiasingOperator.cxx.

                                                           {
  // Loop over all processes and check if the given process is being
  // biased.
  const G4BiasingProcessSharedData* shared_data =
      G4BiasingProcessInterface::GetSharedData(process_manager_);
  if (shared_data) {
    for (size_t iprocess = 0;
         iprocess < (shared_data->GetPhysicsBiasingProcessInterfaces()).size();
         ++iprocess) {
      const G4BiasingProcessInterface* wrapper_process =
          (shared_data->GetPhysicsBiasingProcessInterfaces())[iprocess];
 
      if (wrapper_process->GetWrappedProcess()->GetProcessName().compareTo(
              process) == 0) {
        return true;
      }
    }
  }
  return false;
}

References process_manager_.

Referenced by simcore::biasoperators::PhotoNuclear::StartRun(), and StartRun().

ProposeFinalStateBiasingOperation()

G4VBiasingOperation * simcore::XsecBiasingOperator::ProposeFinalStateBiasingOperation ( const G4Track * , const G4BiasingProcessInterface *  )

inlineprotected

Do not propose any biasing on final states.

Definition at line 168 of file XsecBiasingOperator.h.

                                                        {
    return nullptr;
  }

ProposeNonPhysicsBiasingOperation()

G4VBiasingOperation * simcore::XsecBiasingOperator::ProposeNonPhysicsBiasingOperation ( const G4Track * , const G4BiasingProcessInterface *  )

inlineprotected

Do not propose any non-physics biasing.

Definition at line 176 of file XsecBiasingOperator.h.

                                                        {
    return nullptr;
  }

ProposeOccurenceBiasingOperation()

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

pure virtual

Propose a biasing operation for the current track and calling process.

Note

Returning 0 from this function will mean that the current track and process will not be biased.

See also

BiasedXsec for a method that allows the derived class to not interact with the biasing operation itself.

Parameters

[in]	track	handle to current track that could be biased
[in]	callingProcess	handle to process asking if it should be biased

Returns

the biasing operation with the biased xsec

Implemented in simcore::biasoperators::DarkBrem, simcore::biasoperators::ElectroNuclear, simcore::biasoperators::GammaToMuPair, simcore::biasoperators::K0LongInelastic, simcore::biasoperators::NeutronInelastic, and simcore::biasoperators::PhotoNuclear.

RecordConfig()

virtual void simcore::XsecBiasingOperator::RecordConfig ( ldmx::RunHeader & header ) const

pure virtual

Record the configuration of this biasing operator into the run header.

Parameters

[in,out]

header

RunHeader to write configuration to

Implemented in simcore::biasoperators::DarkBrem, simcore::biasoperators::ElectroNuclear, simcore::biasoperators::GammaToMuPair, simcore::biasoperators::K0LongInelastic, simcore::biasoperators::NeutronInelastic, and simcore::biasoperators::PhotoNuclear.

StartRun()

void simcore::XsecBiasingOperator::StartRun

(

)

Method called at the beginning of a run.

This makes sure that the process we want to bias can be biased and constructs a corresponding biasing operation.

It can be over-written, but then the derived class should call XsecBiasingOperator::StartRun() at the beginning of their own StartRun.

Definition at line 12 of file XsecBiasingOperator.cxx.

                                   {
  if (this->getParticleToBias().compare("gamma") == 0) {
    process_manager_ = G4Gamma::GammaDefinition()->GetProcessManager();
  } else if (this->getParticleToBias().compare("e-") == 0) {
    process_manager_ = G4Electron::ElectronDefinition()->GetProcessManager();
  } else if (this->getParticleToBias().compare("neutron") == 0) {
    process_manager_ = G4Neutron::NeutronDefinition()->GetProcessManager();
  } else if (this->getParticleToBias().compare("kaon0L") == 0) {
    process_manager_ =
        G4KaonZeroLong::KaonZeroLongDefinition()->GetProcessManager();
  } else {
    EXCEPTION_RAISE("BiasSetup", "Invalid particle type '" +
                                     this->getParticleToBias() + "'.");
  }
 
  ldmx_log(info) << "Biasing particles of type " << this->getParticleToBias();
 
  if (processIsBiased(this->getProcessToBias())) {
    xsec_operation_ =
        new G4BOptnChangeCrossSection("changeXsec-" + this->getProcessToBias());
  } else {
    EXCEPTION_RAISE("BiasSetup",
                    this->getProcessToBias() +
                        " is not found in list of biased processes!");
  }
}

References getParticleToBias(), getProcessToBias(), process_manager_, processIsBiased(), and xsec_operation_.

Referenced by simcore::biasoperators::PhotoNuclear::StartRun().

Member Data Documentation

process_manager_

G4ProcessManager* simcore::XsecBiasingOperator::process_manager_ {nullptr}

protected

Process manager associated with the particle of interest.

Definition at line 163 of file XsecBiasingOperator.h.

{nullptr};

Referenced by processIsBiased(), and StartRun().

the_log_

framework::logging::logger simcore::XsecBiasingOperator::the_log_

protected

Enable logging.

Definition at line 181 of file XsecBiasingOperator.h.

xsec_operation_

G4BOptnChangeCrossSection* simcore::XsecBiasingOperator::xsec_operation_ {nullptr}

protected

Cross-section biasing operation.

Definition at line 160 of file XsecBiasingOperator.h.

{nullptr};

Referenced by BiasedXsec(), and StartRun().

---

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

• SimCore/include/SimCore/BiasOperators/XsecBiasingOperator.h
• SimCore/src/SimCore/BiasOperators/XsecBiasingOperator.cxx