CLASS  5.1
Fuel Cycle Simulator
CLASSNucleiFiliation Class Reference

Handles connection between nuclei (decay/reaction) More...

#include <CLASSNucleiFiliation.hxx>

Inheritance diagram for CLASSNucleiFiliation:
CLASSObject

Public Member Functions

Constructor/Desctructor
 CLASSNucleiFiliation ()
 Default constructor. More...
 
 CLASSNucleiFiliation (CLASSLogger *log)
 Default constructor. More...
 
 CLASSNucleiFiliation (const CLASSNucleiFiliation &CNF)
 Copy Constructor. More...
 
 ~CLASSNucleiFiliation ()
 Normal Destructor. More...
 
Set/Get Method
map< ZAI, IsotopicVectorGetNucleiFIliation () const
 Return the full filiation list. More...
 
vector< ZAIGetZAIList () const
 Return the list of mother ZAI present in the filiation list. More...
 
int size () const
 Return the number of mother ZAI (then filiation path) More...
 
IsotopicVector GetFiliation (ZAI Mother) const
 Return the filiation isotopic vector of the ZAI mother. More...
 
ZAI GetArtificialDecay (ZAI Mother)
 Make an artificial and instantaneus decay of the ZAI, (desexcitation, or Beta decay) More...
 
void SetNucleiFIliation (map< ZAI, IsotopicVector > const &Fiiliation)
 Set the full filiation list. More...
 
Adding Method
void Add (ZAI Mother, IsotopicVector const &Daughter)
 Add A ZAI and its IsotopicVector of daughter(s) to the filiation. More...
 
- Public Member Functions inherited from CLASSObject
 CLASSObject ()
 Normal Constructor. More...
 
 CLASSObject (CLASSLogger *log)
 Log Constructor. More...
 
virtual CLASSObjectClone ()
 Correct way to copy a CLASSObject in case of derivation. More...
 
void SetLog (CLASSLogger *log)
 Set the CLASSLogger. More...
 
CLASSLoggerGetLog ()
 Return the Pointer to the Log. More...
 

Modification Method

map< ZAI, IsotopicVectorfNucleiFiliation
 
void FiliationCleanUp (map< ZAI, int > const &GoodNuclei, CLASSNucleiFiliation const &CuttedNuclei)
 Cutting all pathway until each path ends on a nuclei in the GoodList following the CuttedNuclei. If nuclei are neither in the GoodNuclei list or in CuttedNuclei, then artificial decay are performed. More...
 
void SelfFiliationCleanUp (map< ZAI, int > const &GoodNuclei)
 Cutting all the pathway ending on a nuclei not present as a mother nuclei. More...
 
void NormalizeBranchingRatio (double Value=1)
 Normalization of all the branching ratio to 1. More...
 
void NormalizeBranchingRatio (ZAI Mother, double Value)
 Normalize the branching ratio pathway of the Mother ZAI to the set value. More...
 

Additional Inherited Members

- Protected Attributes inherited from CLASSObject
CLASSLoggerfLog
 Pointer to the Log. More...
 

Detailed Description

Handles connection between nuclei (decay/reaction)

Define a nuclei as : Z A I. The aim of this class is to discribe each CLASSNucleiFiliation. It connects nuclei to their daughter nuclei through a nuclear process using the correct branching ratio. Note that this class can be used to connect nulei to their daughter through any reaction (Fission, capture...) or natural decay process...

In the case of decay process, it is possible to put (by multiplying) the decay constant to the branching ratio (ie : BR*log(2)/HalfLife, see IrradiationModel)....

Author
BaM
Version
2.0

Constructor & Destructor Documentation

◆ CLASSNucleiFiliation() [1/3]

CLASSNucleiFiliation::CLASSNucleiFiliation ( )

Default constructor.

◆ CLASSNucleiFiliation() [2/3]

CLASSNucleiFiliation::CLASSNucleiFiliation ( CLASSLogger log)

Default constructor.

Use to load a CLASSNucleiFiliation

Parameters
log: used for the log.

◆ CLASSNucleiFiliation() [3/3]

CLASSNucleiFiliation::CLASSNucleiFiliation ( const CLASSNucleiFiliation CNF)

Copy Constructor.

◆ ~CLASSNucleiFiliation()

CLASSNucleiFiliation::~CLASSNucleiFiliation ( )

Normal Destructor.

Member Function Documentation

◆ Add()

void CLASSNucleiFiliation::Add ( ZAI  Mother,
IsotopicVector const &  Daughter 
)

Add A ZAI and its IsotopicVector of daughter(s) to the filiation.

◆ FiliationCleanUp()

void CLASSNucleiFiliation::FiliationCleanUp ( map< ZAI, int > const &  GoodNuclei,
CLASSNucleiFiliation const &  CuttedNuclei 
)

Cutting all pathway until each path ends on a nuclei in the GoodList following the CuttedNuclei. If nuclei are neither in the GoodNuclei list or in CuttedNuclei, then artificial decay are performed.

◆ GetArtificialDecay()

ZAI CLASSNucleiFiliation::GetArtificialDecay ( ZAI  Mother)

Make an artificial and instantaneus decay of the ZAI, (desexcitation, or Beta decay)

◆ GetFiliation()

IsotopicVector CLASSNucleiFiliation::GetFiliation ( ZAI  Mother) const

Return the filiation isotopic vector of the ZAI mother.

◆ GetNucleiFIliation()

map<ZAI, IsotopicVector> CLASSNucleiFiliation::GetNucleiFIliation ( ) const
inline

Return the full filiation list.

◆ GetZAIList()

vector< ZAI > CLASSNucleiFiliation::GetZAIList ( ) const

Return the list of mother ZAI present in the filiation list.

◆ NormalizeBranchingRatio() [1/2]

void CLASSNucleiFiliation::NormalizeBranchingRatio ( double  Value = 1)

Normalization of all the branching ratio to 1.

◆ NormalizeBranchingRatio() [2/2]

void CLASSNucleiFiliation::NormalizeBranchingRatio ( ZAI  Mother,
double  Value 
)

Normalize the branching ratio pathway of the Mother ZAI to the set value.

◆ SelfFiliationCleanUp()

void CLASSNucleiFiliation::SelfFiliationCleanUp ( map< ZAI, int > const &  GoodNuclei)

Cutting all the pathway ending on a nuclei not present as a mother nuclei.

◆ SetNucleiFIliation()

void CLASSNucleiFiliation::SetNucleiFIliation ( map< ZAI, IsotopicVector > const &  Fiiliation)
inline

Set the full filiation list.

◆ size()

int CLASSNucleiFiliation::size ( ) const
inline

Return the number of mother ZAI (then filiation path)

Member Data Documentation

◆ fNucleiFiliation

map<ZAI, IsotopicVector> CLASSNucleiFiliation::fNucleiFiliation
protected

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