CLASS  5.1
Fuel Cycle Simulator
XSM_CLOSEST Class Reference

Defines a XSModel getting mean cross sections from the closest EvolutionData. More...

#include <XSM_CLOSEST.hxx>

Inheritance diagram for XSM_CLOSEST:
XSModel CLASSObject

Public Member Functions

void SetDistanceType (int DistanceType)
 Choose the way to calculate the distance between two isotopic vectors. More...
 
Constructor/Desctructor
 XSM_CLOSEST (string DB_index_file, bool oldreadmethod=false)
 normal constructor More...
 
 XSM_CLOSEST (CLASSLogger *Log, string DB_index_file, bool oldreadmethod=false)
 Logger constructor. More...
 
 ~XSM_CLOSEST ()
 
Get Method
virtual EvolutionData GetCrossSections (IsotopicVector isotopicvector, double t=0)
 Reason to live of this CLASS : Return the closest Evolutiondata. More...
 
vector< EvolutionDataGetFuelDataBank () const
 Return the FuelDataBank. More...
 
string GetDataBaseIndex () const
 Return the index Name. More...
 
string GetFuelType () const
 Return the fuel type of the DB. More...
 
vector< double > GetFuelParameter () const
 Return the Fuel parameters of the DB. More...
 
pair< double, double > GetBurnUpRange () const
 Return the Burnup range of the DB. More...
 
bool IsDefine (IsotopicVector IV) const
 True if the key is define, false instead. More...
 
map< double, int > GetDistancesTo (IsotopicVector isotopicvector, double t=0)
 
Set Method

Return a map containing the distance of each EvolutionData in the DataBase to the set IV at the time t

void SetFuelDataBank (vector< EvolutionData > mymap)
 Set the FuelDataBank map. More...
 
void SetDataBaseIndex (string database)
 Set the Name of the database index. More...
 
void SetOldReadMethod (bool val)
 use the old reading method More...
 
void SetWeightedDistanceCalculation (bool val=true)
 Set weighted distance calculation. More...
 
void SetInventoryEvolutionInterpolation (bool val=true)
 
void SetDistanceParameter (IsotopicVector DistanceParameter)
 Define mannually the weight for each ZAI in the distance calculation. More...
 
Other Method
void ReadDataBase ()
 read the index file and fill the evolutionData map More...
 
void CalculateDistanceParameter ()
 Calcul of the weight for each ZAI in the distance calculation from the mean XS of the FuelDataBank. More...
 
- Public Member Functions inherited from XSModel
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...
 
 XSModel ()
 Default constructor. More...
 
 XSModel (CLASSLogger *log)
 Logger constructor. More...
 
virtual ~XSModel ()
 Destructor. 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...
 

Additional Inherited Members

- Protected Attributes inherited from XSModel
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 XSModel getting mean cross sections from the closest EvolutionData.

Define a XSM_CLOSEST. Class to get cross sections from a set of pre-calculation (with MURE,or other depletion code). With this class, cross sections needed to solves Bateman equation come from an already performed depletion calculation contained in a set of many depletion calculations. The way to pick up these or these depletion calculation is related to a distance : The depletion calculation (or EvolutionData) the closest from the new fresh fuel composition is selected. Different distances are defined :

  • Standard euclidean distance (weights : 1) IS THE DEFAULT
  • Euclidean distance with weights assigned according mean cross section values
  • Euclidean distance with weights assigned by user
Authors
BaM,BLG
Version
1.0

Constructor & Destructor Documentation

◆ XSM_CLOSEST() [1/2]

XSM_CLOSEST::XSM_CLOSEST ( string  DB_index_file,
bool  oldreadmethod = false 
)

normal constructor

Make a new XSM_CLOSEST

Parameters
DB_index_file: File listing the path of all depletion calculations (in EvolutionData format (.dat file) )
oldreadmethod:

◆ XSM_CLOSEST() [2/2]

XSM_CLOSEST::XSM_CLOSEST ( CLASSLogger Log,
string  DB_index_file,
bool  oldreadmethod = false 
)

Logger constructor.

Make a new XSM_CLOSEST

Parameters
log: Use for the log
DB_index_file: File listing the path of all depletion calculations (in EvolutionData format (.dat file) )
oldreadmethod:

◆ ~XSM_CLOSEST()

XSM_CLOSEST::~XSM_CLOSEST ( )

Member Function Documentation

◆ CalculateDistanceParameter()

void XSM_CLOSEST::CalculateDistanceParameter ( )

Calcul of the weight for each ZAI in the distance calculation from the mean XS of the FuelDataBank.

◆ GetBurnUpRange()

pair<double,double> XSM_CLOSEST::GetBurnUpRange ( ) const
inline

Return the Burnup range of the DB.

◆ GetCrossSections()

EvolutionData XSM_CLOSEST::GetCrossSections ( IsotopicVector  isotopicvector,
double  t = 0 
)
virtual

Reason to live of this CLASS : Return the closest Evolutiondata.

Implements XSModel.

◆ GetDataBaseIndex()

string XSM_CLOSEST::GetDataBaseIndex ( ) const
inline

Return the index Name.

◆ GetDistancesTo()

map< double, int > XSM_CLOSEST::GetDistancesTo ( IsotopicVector  isotopicvector,
double  t = 0 
)

◆ GetFuelDataBank()

vector< EvolutionData > XSM_CLOSEST::GetFuelDataBank ( ) const
inline

Return the FuelDataBank.

◆ GetFuelParameter()

vector<double> XSM_CLOSEST::GetFuelParameter ( ) const
inline

Return the Fuel parameters of the DB.

◆ GetFuelType()

string XSM_CLOSEST::GetFuelType ( ) const
inline

Return the fuel type of the DB.

◆ IsDefine()

bool XSM_CLOSEST::IsDefine ( IsotopicVector  IV) const

True if the key is define, false instead.

◆ ReadDataBase()

void XSM_CLOSEST::ReadDataBase ( )

read the index file and fill the evolutionData map

◆ SetDataBaseIndex()

void XSM_CLOSEST::SetDataBaseIndex ( string  database)
inline

Set the Name of the database index.

◆ SetDistanceParameter()

void XSM_CLOSEST::SetDistanceParameter ( IsotopicVector  DistanceParameter)

Define mannually the weight for each ZAI in the distance calculation.

◆ SetDistanceType()

void XSM_CLOSEST::SetDistanceType ( int  DistanceType)

Choose the way to calculate the distance between two isotopic vectors.

The different algorythms are:

  • 0 is for the standard norme,
  • 1 for each ZAI weighted with its XS,
  • 2 for each ZAI weighted with coefficient given by the user.

◆ SetFuelDataBank()

void XSM_CLOSEST::SetFuelDataBank ( vector< EvolutionData mymap)
inline

Set the FuelDataBank map.

◆ SetInventoryEvolutionInterpolation()

void XSM_CLOSEST::SetInventoryEvolutionInterpolation ( bool  val = true)
inline
Deprecated:
The 64 closest EvolutionData (ED) are used to build a new ED. The cross section from each ED are weighted according to their distance

◆ SetOldReadMethod()

void XSM_CLOSEST::SetOldReadMethod ( bool  val)
inline

use the old reading method

◆ SetWeightedDistanceCalculation()

void XSM_CLOSEST::SetWeightedDistanceCalculation ( bool  val = true)
inline

Set weighted distance calculation.


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