CLASS  5.1
Fuel Cycle Simulator
IM_RK4 Class Reference

#include <IM_RK4.hxx>

Inheritance diagram for IM_RK4:
IrradiationModel DynamicalSystem CLASSObject

Public Member Functions

virtual EvolutionData GenerateEvolutionData (IsotopicVector IV, EvolutionData XSSet, double Power, double cycletime)
 virtual method called to perform the irradiation calculation using a set of cross section. More...
 
Constructor
 IM_RK4 ()
 Default constructor. More...
 
 IM_RK4 (CLASSLogger *Log)
 Logger constructor. More...
 
RK4 Method
void BuildEqns (double t, double *N, double *dNdt)
 Pre-treatment Runge-Kutta method. More...
 
void SetTheMatrixToZero ()
 Initialize the evolution Matrix. More...
 
void ResetTheMatrix ()
 
void SetTheMatrix (TMatrixT< double > BatemanMatrix)
 Set the Evolution Matrix (Bateman equations) More...
 
TMatrixT< double > GetTheMatrix ()
 return the Evolution Matrix (Bateman equations) More...
 
void SetTheNucleiVectorToZero ()
 Initialize the evolution Matrix. More...
 
void ResetTheNucleiVector ()
 
void SetTheNucleiVector (TMatrixT< double > NEvolutionMatrix)
 Set the Evolution Matrix (Bateman equations) More...
 
TMatrixT< double > GetTheNucleiVector ()
 return the Evolution Matrix (Bateman equations) More...
 
void RungeKutta (double *YStart, double t1, double t2, int EquationNumber)
 Runge Kutta calling method. More...
 
- Public Member Functions inherited from IrradiationModel
string GetDecay (string DecayModes, double &BR, int &Iso, int &StartPos)
 Returns a particular decay mode. More...
 
 IrradiationModel ()
 Default constructor. More...
 
 IrradiationModel (CLASSLogger *log)
 Logger constructor. More...
 
string GetDataFileName () const
 
string GetDataDirectoryName () const
 Path to fDataFileName. More...
 
double GetShorstestHalflife () const
 Nuclei with HL below fShorstestHalflife are cut (replaced by their daughter(s)) More...
 
void GetNuclearProcessMatrix (TMatrixT< double > &myMatrix, ZAI Mother, IsotopicVector ProductedIV, double XSValue=1)
 
void BuildReactionFiliation ()
 
string GetSpectrumType ()
 Get the type of neutron spectrum (thermal or fast) More...
 
IsotopicVector GetDecayConstant () const
 Get the decay constants. More...
 
double GetDecayConstant (const ZAI &zai) const
 Get the decay constants of ZAI. More...
 
void SetFissionEnergy (string FissionEnergyFile)
 set Fission Energy using a file More...
 
void SetFissionEnergy (ZAI zai, double E)
 set Fission Energy for a ZAI using ZAI(Z,A,I) More...
 
void SetFissionEnergy (int Z, int A, int I, double E)
 set Fission Energy for a ZAI using the Z, A, I More...
 
void SetShortestHalfLife (double halflife)
 Set the Half Life cut. More...
 
void SetZAIThreshold (double zaithreshold)
 Set the zai threshold. More...
 
void LoadFPYield (string SponfaneusYield, string ReactionYield)
 Build Fision Yields maps. More...
 
void SetSpectrumType (string type)
 Set the type of neutron spectrum (thermal or fast) More...
 
void BuildDecayMatrix ()
 Build the Decay Matrix for the futur time step. More...
 
virtual void LoadDecay ()
 Load the decay properties (HL,BR) More...
 
virtual void NuclearDataInitialization ()
 Build Decay matrices & read FpYields if any. More...
 
void Print () const
 
int GetZAIThreshold ()
 Gives the threshold (in charge number Z). The nuclei below this threshold are not managed. 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...
 

Additional Inherited Members

- Protected Member Functions inherited from IrradiationModel
TMatrixT< double > GetFissionXsMatrix (EvolutionData EvolutionDataStep, double TStep)
 Return the Fission XS Matrix at the time TStep. More...
 
TMatrixT< double > GetCaptureXsMatrix (EvolutionData EvolutionDataStep, double TStep)
 Return the capture cross section matrix at the time TStep. More...
 
TMatrixT< double > Getn2nXsMatrix (EvolutionData EvolutionDataStep, double TStep)
 Return the n2n XS matrix at the time TStep. More...
 
CLASSNucleiFiliation ReadFPYield (string Yield)
 Read a CLASSYield file and return the correpsponding map. More...
 
- Protected Attributes inherited from IrradiationModel
double fShorstestHalflife
 Limit on the half life of nuclei to take it into account. More...
 
int fZAIThreshold
 Lowest Mass deal by the evolution (default 90) More...
 
string fDataFileName
 Name of the decay list. More...
 
string fDataDirectoryName
 Path to the decay list file. More...
 
map< ZAI, double > fFissionEnergy
 Store the Energy per fission use for the flux normalisation. More...
 
map< ZAI, int > fMatrixIndex
 correspondance matrix from ZAI to the column (or line) of the different Reaction/Decay matrix More...
 
vector< ZAIfReverseMatrixIndex
 correspondance matrix from the column (or line) of the different Reaction/Decay matrix to the ZAI More...
 
TMatrixT< double > fDecayMatrix
 Matrix with half life for each nuclei. More...
 
CLASSNucleiFiliation fFastDecay
 Store the nuclei being cut (HL threshold) More...
 
CLASSNucleiFiliation fNormalDecay
 Store the uncut nuclei. More...
 
IsotopicVector fDecayConstante
 List of decay constants. More...
 
CLASSNucleiFiliation fSpontaneusYield
 Store the spontaneus fission yield. More...
 
CLASSNucleiFiliation fReactionYield
 Store the reaction fission yield. More...
 
CLASSNucleiFiliation fCaptureReaction
 Store the reaction capture Filiation. More...
 
CLASSNucleiFiliation fn2nReaction
 Store the reaction n,2n Filiation. More...
 
string fSpontaneusYieldFile
 Store the name of the spontaneus fission yield file. More...
 
string fReactionYieldFile
 Store the name of the reaction fission yield file. More...
 
string fSpectrumType
 Type of the spectrum : thermal or fast. (needed for Isomeric branching ratios) More...
 
- Protected Attributes inherited from CLASSObject
CLASSLoggerfLog
 Pointer to the Log. More...
 

Constructor & Destructor Documentation

◆ IM_RK4() [1/2]

IM_RK4::IM_RK4 ( )

Default constructor.

Make a new IM_Matrix :

◆ IM_RK4() [2/2]

IM_RK4::IM_RK4 ( CLASSLogger Log)

Logger constructor.

Make a new IM_Matrix :

Parameters
log: Use for the log

Member Function Documentation

◆ BuildEqns()

void IM_RK4::BuildEqns ( double  t,
double *  N,
double *  dNdt 
)
virtual

Pre-treatment Runge-Kutta method.

This method does initialization and then call DynamicalSystem::RungeKutta

Parameters
t1initial time
t2final time

Reimplemented from DynamicalSystem.

◆ GenerateEvolutionData()

EvolutionData IM_RK4::GenerateEvolutionData ( IsotopicVector  IV,
EvolutionData  XSSet,
double  Power,
double  cycletime 
)
virtual

virtual method called to perform the irradiation calculation using a set of cross section.

Perform the Irradiation Calcultion using the XSSet data

Parameters
IsotopicVectorIV isotopic vector to irradiate
EvolutionDataXSSet set of corss section to use to perform the evolution calculation

Need TO change with FP managment

Reimplemented from IrradiationModel.

◆ GetTheMatrix()

TMatrixT< double > IM_RK4::GetTheMatrix ( )

return the Evolution Matrix (Bateman equations)

◆ GetTheNucleiVector()

TMatrixT< double > IM_RK4::GetTheNucleiVector ( )

return the Evolution Matrix (Bateman equations)

◆ ResetTheMatrix()

void IM_RK4::ResetTheMatrix ( )

◆ ResetTheNucleiVector()

void IM_RK4::ResetTheNucleiVector ( )

◆ RungeKutta()

void DynamicalSystem::RungeKutta

Runge Kutta calling method.

Parameters
YStartinput : the initial condition Y(t1) ; output the final value Y(t2)
t1initial time
t2final time

◆ SetTheMatrix()

void IM_RK4::SetTheMatrix ( TMatrixT< double >  BatemanMatrix)

Set the Evolution Matrix (Bateman equations)

◆ SetTheMatrixToZero()

void IM_RK4::SetTheMatrixToZero ( )

Initialize the evolution Matrix.

◆ SetTheNucleiVector()

void IM_RK4::SetTheNucleiVector ( TMatrixT< double >  NEvolutionMatrix)

Set the Evolution Matrix (Bateman equations)

◆ SetTheNucleiVectorToZero()

void IM_RK4::SetTheNucleiVectorToZero ( )

Initialize the evolution Matrix.


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