CLASS  5.1
Fuel Cycle Simulator
XSModel Class Referenceabstract

Defines a mean cross section predictor. More...

#include <XSModel.hxx>

Inheritance diagram for XSModel:
CLASSObject XSM_CLOSEST XSM_MLP XSM_SFR

Public Member Functions

void ReadNFO ()
 
virtual void ReadLine (string line)
 
void ReadZAIlimits (const string &line)
 
void ReadType (const string &line)
 
void ReadRParam (const string &line)
 
virtual void LoadKeyword ()
 
void SetZAIThreshold (int Z_Threshold)
 Set the Z threshold : ZAI with Z < fZAIThreshold are not manage by CLASS. More...
 
int GetZAIThreshold ()
 Get the Z threshold. More...
 
Constructor/Desctructor
 XSModel ()
 Default constructor. More...
 
 XSModel (CLASSLogger *log)
 Logger constructor. More...
 
virtual ~XSModel ()
 Destructor. More...
 
Virtual methods : This following methods are overloaded in the derivated classes : XSM_CLOSEST & XSM_MLP & ...
virtual EvolutionData GetCrossSections (IsotopicVector IV, double t=0)=0
 Pure virtual method called to estimates mean cross sections. More...
 
virtual bool isIVInDomain (IsotopicVector IV)
 Check either the IsotopicVector IV is in the validity domain of the models. 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...
 

Protected Attributes

bool freaded
 
string fInformationFile
 file containing Reactor Type, Fuel type, HM mass, Power, time vector, and TMVA input variables names (looks the manual for format details) More...
 
double fDBPower
 Power of the data base (read from fMLPInformationFile ) More...
 
double fDBHMMass
 Heavy metal mass of the data base (read from fMLPInformationFile ) More...
 
string fDBFType
 Fuel Type (e.g MOX, UOX, ThU, ThPu ...) More...
 
string fDBRType
 Reactor Type (e.g PWR, FBR-Na, ADS..) More...
 
map< ZAI, pair< double, double > > fZAILimits
 Fresh fuel range : map<ZAI<min edge ,max edge >> More...
 
map< string, XSM_MthPtrfKeyword
 
int fZAIThreshold
 Z threshold for handling nuclei mean cross section (take only ZAI reaction of Z>= fZAIThresold) More...
 
- Protected Attributes inherited from CLASSObject
CLASSLoggerfLog
 Pointer to the Log. More...
 

Detailed Description

Defines a mean cross section predictor.

This is the mother class for methods related to XS prediction

Warning
Never instantiate XSModel in your CLASS input but it's derivated class
See also
XSM_CLOSEST
XSM_MLP
Author
BaM
BLG
Version
2

Constructor & Destructor Documentation

◆ XSModel() [1/2]

XSModel::XSModel ( )

Default constructor.

◆ XSModel() [2/2]

XSModel::XSModel ( CLASSLogger log)

Logger constructor.

◆ ~XSModel()

XSModel::~XSModel ( )
virtual

Destructor.

Member Function Documentation

◆ GetCrossSections()

virtual EvolutionData XSModel::GetCrossSections ( IsotopicVector  IV,
double  t = 0 
)
pure virtual

Pure virtual method called to estimates mean cross sections.

Estimates the mean cross sections evolution according the fresh fuel composition

Parameters
IV: Fresh fuel composition
t: deprecated parameter :
Deprecated:
t : XS update time (used in XSM_Closest)

Implemented in XSM_MLP, and XSM_CLOSEST.

◆ GetZAIThreshold()

int XSModel::GetZAIThreshold ( )
inline

Get the Z threshold.

◆ isIVInDomain()

bool XSModel::isIVInDomain ( IsotopicVector  IV)
virtual

Check either the IsotopicVector IV is in the validity domain of the models.

return true if IV is in ValidityDomain return false + a warning if IV is not in ValidityDomain

Parameters
IsotopicVectorIV, Fresh fuel composition
t: deprecated parameter :
Deprecated:
t : XS update time (used in XSM_Closest)

◆ LoadKeyword()

void XSModel::LoadKeyword ( )
virtual

Reimplemented in XSM_SFR, and XSM_MLP.

◆ ReadLine()

void XSModel::ReadLine ( string  line)
virtual

Reimplemented in XSM_SFR, and XSM_MLP.

◆ ReadNFO()

void XSModel::ReadNFO ( )

◆ ReadRParam()

void XSModel::ReadRParam ( const string &  line)

◆ ReadType()

void XSModel::ReadType ( const string &  line)

◆ ReadZAIlimits()

void XSModel::ReadZAIlimits ( const string &  line)

◆ SetZAIThreshold()

void XSModel::SetZAIThreshold ( int  Z_Threshold)
inline

Set the Z threshold : ZAI with Z < fZAIThreshold are not manage by CLASS.

Member Data Documentation

◆ fDBFType

string XSModel::fDBFType
protected

Fuel Type (e.g MOX, UOX, ThU, ThPu ...)

◆ fDBHMMass

double XSModel::fDBHMMass
protected

Heavy metal mass of the data base (read from fMLPInformationFile )

◆ fDBPower

double XSModel::fDBPower
protected

Power of the data base (read from fMLPInformationFile )

◆ fDBRType

string XSModel::fDBRType
protected

Reactor Type (e.g PWR, FBR-Na, ADS..)

◆ fInformationFile

string XSModel::fInformationFile
protected

file containing Reactor Type, Fuel type, HM mass, Power, time vector, and TMVA input variables names (looks the manual for format details)

◆ fKeyword

map<string, XSM_MthPtr> XSModel::fKeyword
protected

◆ freaded

bool XSModel::freaded
protected

◆ fZAILimits

map< ZAI, pair<double,double> > XSModel::fZAILimits
protected

Fresh fuel range : map<ZAI<min edge ,max edge >>

◆ fZAIThreshold

int XSModel::fZAIThreshold
protected

Z threshold for handling nuclei mean cross section (take only ZAI reaction of Z>= fZAIThresold)


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