G4FissionFragmentGenerator Class Reference

#include <G4FissionFragmentGenerator.hh>

Collaboration diagram for G4FissionFragmentGenerator:

Public Member Functions
	G4FissionFragmentGenerator (void)
	G4FissionFragmentGenerator (G4int Verbosity)
G4DynamicParticleVector *	G4GenerateFission (void)
G4DynamicParticleVector *	G4GenerateFission (const G4HadProjectile &Projectile)
const std::vector < G4DynamicParticleVector * >	G4GenerateFission (G4long NumberOfFissions, const G4HadProjectile &Projectile)
G4Ions *	G4GenerateFissionProduct (void)
G4double	G4GetAlphaProduction (void)
G4double	G4GetTernaryProbability (void)
G4FFGEnumerations::FissionCause	G4GetCause (void)
G4double	G4GetIncidentEnergy (void)
G4int	G4GetIsotope (void)
G4FFGEnumerations::MetaState	G4GetMetaState (void)
G4FFGEnumerations::FissionSamplingScheme	G4GetSamplingScheme (void)
G4FFGEnumerations::YieldType	G4GetYieldType (void)
bool	InitializeFissionProductYieldClass (std::istringstream &dataFile)
void	G4SetAlphaProduction (G4double WhatAlphaProduction)
void	G4SetTernaryProbability (G4double WhatTernaryProbability)
void	G4SetCause (G4FFGEnumerations::FissionCause WhichCause)
void	G4SetIncidentEnergy (G4double WhatIncidentEnergy)
void	G4SetIsotope (G4int WhichIsotope)
void	G4SetMetaState (G4FFGEnumerations::MetaState WhichMetaState)
void	G4SetSamplingScheme (G4FFGEnumerations::FissionSamplingScheme NewScheme)
void	G4SetYieldType (G4FFGEnumerations::YieldType WhichYieldType)
void	G4SetVerbosity (G4int WhatVerbosity)
	~G4FissionFragmentGenerator ()

Static Public Member Functions
static G4int	G4MakeIsotopeCode (G4int Z, G4int A, G4int M)

Protected Member Functions
void	Initialize (void)

Protected Attributes
G4int	Isotope_
G4FFGEnumerations::MetaState	MetaState_
G4FFGEnumerations::FissionCause	Cause_
G4double	IncidentEnergy_
G4FFGEnumerations::YieldType	YieldType_
G4double	TernaryProbability_
G4double	AlphaProduction_
G4bool	IsReconstructionNeeded_
G4int	Verbosity_
G4FFGEnumerations::FissionSamplingScheme	SamplingScheme_
G4FissionProductYieldDist *	YieldData_

Detailed Description

G4FissionFragmentGenerator is the front end class to be used by the user for handling all fission event generation.

This class is intended to be instantiated for one type of fission event for as specific isotope/isomer, fission type, and incident neutron energy. For this reason no functions exist to change or modify these values once the class in constructed. A new class must be created by the user for each type of fission event, if such functionality is desired.

Definition at line 54 of file G4FissionFragmentGenerator.hh.

Constructor & Destructor Documentation

G4FissionFragmentGenerator::G4FissionFragmentGenerator

(

void

)

Default constructor

• Usage: No arguments required
• Notes:
  • There are methods that should be called to set operating parameters before generating any fission events with G4FissionFragmentGenerator. These are:
    • G4SetIsotope()
    • G4SetMetaState()
    • G4SetCause()
    • G4SetIncidentEnergy()
    • G4SetYieldType()
    • G4SetAlphaProduction()
    • G4SetAlphaProductionProbability()
    • G4SetSamplingScheme()
  • If any or all of these parameters are not set by the user, then default values will be used.
    • Isotope: 92238
    • Metastable state: GROUND_STATE
    • Cause: SPONTANEOUS
    • Incident energy: 0.025 eV
    • Yield type: INDEPENDENT
    • Alpha production: 0
    • Alpha production probability: 0
    • Sampling scheme: NORMAL

Definition at line 50 of file G4FissionFragmentGenerator.cc.

Here is the call graph for this function:

G4FissionFragmentGenerator::G4FissionFragmentGenerator

(

G4int

Verbosity

)

Overloaded constructor

• Usage:
  • Verbosity: Verbosity level
• Notes:
  • Refer to the documentation for the default constructor for setting up the operating parameters.

Definition at line 60 of file G4FissionFragmentGenerator.cc.

Here is the call graph for this function:

G4FissionFragmentGenerator::~G4FissionFragmentGenerator

(

)

Default deconstructor

Definition at line 755 of file G4FissionFragmentGenerator.cc.

Member Function Documentation

G4DynamicParticleVector * G4FissionFragmentGenerator::G4GenerateFission

(

void

)

Generates a single fission event

• Usage: No arguments required
• Notes:
  • Generates a single fission event by calling the overloaded function and passing an argument of '1'

Definition at line 93 of file G4FissionFragmentGenerator.cc.

Here is the call graph for this function:

G4DynamicParticleVector * G4FissionFragmentGenerator::G4GenerateFission

(

const G4HadProjectile &

Projectile

)

Generates a single fission event

• Usage: -Projectile: G4HadProjectile of the fission-inducing particle
• Notes:
  • Generates a single fission event by calling the overloaded function and passing an argument of '1'

Definition at line 110 of file G4FissionFragmentGenerator.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

const std::vector< G4DynamicParticleVector * > G4FissionFragmentGenerator::G4GenerateFission	(	G4long	NumberOfFissions,
		const G4HadProjectile &	Projectile
	)

Generates NumberOfFissions fission events

• Usage: -NumberOfFissions: The number of fission events to generate
• Notes:
  • Generates NumberOfFissions fission events

Definition at line 123 of file G4FissionFragmentGenerator.cc.

Here is the call graph for this function:

G4Ions * G4FissionFragmentGenerator::G4GenerateFissionProduct

(

void

)

Returns a randomly sampled fission product

Definition at line 157 of file G4FissionFragmentGenerator.cc.

Here is the call graph for this function:

G4double G4FissionFragmentGenerator::G4GetAlphaProduction

(

void

)

Returns the production rate of alpha particles for fission events

Definition at line 174 of file G4FissionFragmentGenerator.cc.

G4FFGEnumerations::FissionCause G4FissionFragmentGenerator::G4GetCause

(

void

)

Returns the FissionCause of the fission event.

Definition at line 192 of file G4FissionFragmentGenerator.cc.

G4double G4FissionFragmentGenerator::G4GetIncidentEnergy

(

void

)

Returns the energy of the fission inducing particle.

Definition at line 201 of file G4FissionFragmentGenerator.cc.

G4int G4FissionFragmentGenerator::G4GetIsotope

(

void

)

Returns the code of the fission isotope in ZZZAAA format.

Definition at line 210 of file G4FissionFragmentGenerator.cc.

G4FFGEnumerations::MetaState G4FissionFragmentGenerator::G4GetMetaState

(

void

)

Returns the MetaState of the fission isotope.

Definition at line 219 of file G4FissionFragmentGenerator.cc.

G4FFGEnumerations::FissionSamplingScheme G4FissionFragmentGenerator::G4GetSamplingScheme

(

void

)

Returns the FissionSamplingScheme that is currently in use.

Definition at line 228 of file G4FissionFragmentGenerator.cc.

G4double G4FissionFragmentGenerator::G4GetTernaryProbability

(

void

)

Returns the probability of ternary fission

Definition at line 183 of file G4FissionFragmentGenerator.cc.

G4FFGEnumerations::YieldType G4FissionFragmentGenerator::G4GetYieldType

(

void

)

Returns the yield type that is currently in use

Definition at line 237 of file G4FissionFragmentGenerator.cc.

G4int G4FissionFragmentGenerator::G4MakeIsotopeCode ( G4int  Z, G4int  A, G4int  M  )

static

Converts the Z, A and M of an isotope into an integer representation

Definition at line 246 of file G4FissionFragmentGenerator.cc.

Here is the caller graph for this function:

void G4FissionFragmentGenerator::G4SetAlphaProduction

(

G4double

WhatAlphaProduction

)

Sets the number of alpha particles produced in fission.

• Usage:
  • if AlphaProduction is negative then alpha particles are sampled on a Gaussian with a mean of abs(AlphaProduction).
• Notes:
  • The maximum number of alpha particles that may be created is physically limited by the nucleons present in the parent nucleus. Setting the AlphaProduction too high will have unpredictable results on the sampling of the fission products.

Definition at line 257 of file G4FissionFragmentGenerator.cc.

Here is the call graph for this function:

void G4FissionFragmentGenerator::G4SetCause

(

G4FFGEnumerations::FissionCause

WhichCause

)

Sets the cause of fission event.

• Usage:
  • WhichCause: SPONTANEOUS, N_INDUCED, P_INDUCED, or G_INDUCED
• Notes:

Definition at line 301 of file G4FissionFragmentGenerator.cc.

Here is the caller graph for this function:

void G4FissionFragmentGenerator::G4SetIncidentEnergy

(

G4double

WhatIncidentEnergy

)

Sets the incident energy, if any, of the particle that cause fission.

• Usage:
  • WhatIncidentEnergy: Kinetic energy of the particle with units applied;
• Notes:

Definition at line 372 of file G4FissionFragmentGenerator.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

void G4FissionFragmentGenerator::G4SetIsotope

(

G4int

WhichIsotope

)

Sets the fission isotope

• Usage:
  • WhichIsotope: Code of the isotope in ZZZAAA format
• Notes:

Definition at line 435 of file G4FissionFragmentGenerator.cc.

Here is the caller graph for this function:

void G4FissionFragmentGenerator::G4SetMetaState

(

G4FFGEnumerations::MetaState

WhichMetaState

)

Sets the metastable state of the fission isotope.

• Usage:
  • WhichMetaState: GROUND_STATE, META_1, or META_2
• Notes:

Definition at line 479 of file G4FissionFragmentGenerator.cc.

Here is the caller graph for this function:

void G4FissionFragmentGenerator::G4SetSamplingScheme

(

G4FFGEnumerations::FissionSamplingScheme

NewScheme

)

Set the sampling scheme.

• Usage:
  • NewScheme: The G4FissionSamplingScheme value for the sampling scheme to use.
• Notes:
  • NORMAL: Sets the parameters of this class to sample fission events without any biasing.
  • LIGHT_FRAGMENT: Sets the parameters of this class to bias the fragment generation by always selecting a light fragment (A < 115) first.
  • WENDT: Sets the parameters of this class to sample fission events according to the Wendt sampling scheme. Please refer to the code documentation for G4FPYWendtSamplingDist for a more detailed explanation.

Definition at line 546 of file G4FissionFragmentGenerator.cc.

Here is the caller graph for this function:

void G4FissionFragmentGenerator::G4SetTernaryProbability

(

G4double

WhatTernaryProbability

)

Sets the probability of ternary fission

• Usage:
  • WhatAlphaProductionProbability: Probability of generating alpha particles for a fission event. 1 = 100% chance of alpha production
• Notes:

Definition at line 279 of file G4FissionFragmentGenerator.cc.

Here is the call graph for this function:

void G4FissionFragmentGenerator::G4SetVerbosity

(

G4int

WhatVerbosity

)

Sets the verbosity levels

• Usage:
  • WhichVerbosity: Combination of levels
• Notes:
  • SILENT: All verbose output is repressed
  • UPDATES: Only high-level internal changes are reported
  • DAUGHTER_INFO: Displays information about daughter product sampling
  • NEUTRON_INFO: Displays information about neutron sampling
  • GAMMA_INFO: Displays information about gamma sampling
  • ALPHA_INFO: Displays information about alpha sampling
  • MOMENTUM_INFO: Displays information about momentum balancing
  • EXTRAPOLATION_INTERPOLATION_INFO: Displays information about any data extrapolation or interpolation that occurs
  • DEBUG: Reports program flow as it steps through functions
  • PRINT_ALL: Displays any and all output

Definition at line 678 of file G4FissionFragmentGenerator.cc.

Here is the call graph for this function:

void G4FissionFragmentGenerator::G4SetYieldType

(

G4FFGEnumerations::YieldType

WhichYieldType

)

Sets the ENDF yield type to be used for the data

• Usage:
  • WhichYieldType: INDEPENDENT or COMULATIVE
• Notes:

Definition at line 612 of file G4FissionFragmentGenerator.cc.

Here is the caller graph for this function:

void G4FissionFragmentGenerator::Initialize ( void  )

protected

Initialize is a common function called by all constructors.

Definition at line 70 of file G4FissionFragmentGenerator.cc.

Here is the caller graph for this function:

bool G4FissionFragmentGenerator::InitializeFissionProductYieldClass

(

std::istringstream &

dataFile

)

Initializes a new G4FPY...Dist class based on the class descriptor variables of G4FissionFragmentGenerator.

Definition at line 693 of file G4FissionFragmentGenerator.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

G4double G4FissionFragmentGenerator::AlphaProduction_

protected

Controls whether alpha particles are emitted, and how many

Definition at line 261 of file G4FissionFragmentGenerator.hh.

G4FFGEnumerations::FissionCause G4FissionFragmentGenerator::Cause_

protected

The cause of fission: SPONTANEOUS or N_INDUCED.

Definition at line 253 of file G4FissionFragmentGenerator.hh.

G4double G4FissionFragmentGenerator::IncidentEnergy_

protected

Kinetic energy, if any, of the incident particle in GeV.

Definition at line 255 of file G4FissionFragmentGenerator.hh.

G4int G4FissionFragmentGenerator::Isotope_

protected

Number in ZZZAAA format of the isotope that G4FissionFragmentGenerator references

Definition at line 246 of file G4FissionFragmentGenerator.hh.

G4bool G4FissionFragmentGenerator::IsReconstructionNeeded_

protected

If Isotope_, MetaState_, Cause_, or IncidentEnergy_ are changed in the middle of a run then the class pointed at by YieldData_ will need to be reconstructed

Definition at line 266 of file G4FissionFragmentGenerator.hh.

G4FFGEnumerations::MetaState G4FissionFragmentGenerator::MetaState_

protected

MetaState information of the isotope that G4FissionFragmentGenerator references
A value of 0 refers to the ground state

Definition at line 251 of file G4FissionFragmentGenerator.hh.

G4FFGEnumerations::FissionSamplingScheme G4FissionFragmentGenerator::SamplingScheme_

protected

The sampling scheme that is used: NORMAL, LIGHT_FRAGMENT, or WENDT.

Definition at line 274 of file G4FissionFragmentGenerator.hh.

G4double G4FissionFragmentGenerator::TernaryProbability_

protected

Sets the ternary fission probability. Valid ranges are [0, 1]

Definition at line 259 of file G4FissionFragmentGenerator.hh.

G4int G4FissionFragmentGenerator::Verbosity_

protected

Verbosity level

Definition at line 268 of file G4FissionFragmentGenerator.hh.

G4FissionProductYieldDist* G4FissionFragmentGenerator::YieldData_

protected

Pointer to G4FissionProductYieldDist class that holds all the probabilistic yield data

Definition at line 278 of file G4FissionFragmentGenerator.hh.

G4FFGEnumerations::YieldType G4FissionFragmentGenerator::YieldType_

protected

The type of yield to be used: INDEPENDET or CUMULATIVE

Definition at line 257 of file G4FissionFragmentGenerator.hh.

---

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

• source/source/processes/hadronic/models/neutron_hp/include/G4FissionFragmentGenerator.hh
• source/source/processes/hadronic/models/neutron_hp/src/G4FissionFragmentGenerator.cc