CLASS  5.1
Fuel Cycle Simulator
CLASSBackEnd Class Reference

Class defining the common properties of all back end fuel cycle facilities. More...

#include <CLASSBackEnd.hxx>

Inheritance diagram for CLASSBackEnd:
CLASSFacility CLASSObject Pool SeparationPlant Storage

Public Member Functions

 CLASSBackEnd (int type=0)
 Default Constructor. More...
 
 CLASSBackEnd (CLASSLogger *log, int type=0)
 CLASSLogger Constructor. More...
 
 CLASSBackEnd (CLASSLogger *log, cSecond cycletime, int type=0)
 Cycle time Constructor. More...
 
virtual void Evolution (cSecond t)
 Performs the Evolution until time t. More...
 
void UpdateInsideIV ()
 
Get Function
std::vector< IsotopicVectorGetIVArray () const
 Return the IsotopicVector Array. More...
 
std::vector< cSecondGetIVArrayArrivalTime () const
 Vector of arrival time of each IV in the CLASSBackEnd. More...
 
int GetIVNumber () const
 Return the number of Isotopic Vector present in the CLASSBackEnd object. More...
 
bool GetStorageType () const
 Return the storageType : True if it is a Storage. More...
 
IsotopicVector GetIV (int i) const
 
DecayDataBankGetDecayDataBank ()
 Return the pointer to the decay DataBank. More...
 
CLASSBackEndGetOutBackEndFacility () const
 Return the pointer to the OUtBackEndFacility. More...
 
virtual std::map< cSecond, int > GetTheBackEndTimePath ()
 Get the full path. More...
 
Set Function
void SetIsStorageType (bool val=true)
 Set the fIsStorage bool. More...
 
virtual void SetIVArray (std::vector< IsotopicVector > const &ivarray)
 Set The isotopicVector Array. More...
 
void SetIVArrayArrivalTime (std::vector< cSecond > const &IVArrayArrivalTime)
 Set Arrival Time in Back end. More...
 
void SetDecayDataBank (DecayDataBank *decayDB)
 Set the Decay DataBank. More...
 
virtual void SetOutBackEndFacility (CLASSBackEnd *befacility)
 Set an out Facility. More...
 
BackEndFacility specific Method
virtual void ApplyZAIThreshold (int z=90)
 Put all nuclei below the threshold in -2 -2 -2 ZAI... More...
 
virtual void AddIV (IsotopicVector isotopicvector)
 Add an Isotopicvector to the IVArray. More...
 
void ClearIVArray ()
 Empty the IVArray removing all fuel stored. More...
 
- Public Member Functions inherited from CLASSFacility
 CLASSFacility (int type=0)
 Normal Constructor. More...
 
 CLASSFacility (CLASSLogger *log, int type=0)
 Special Constructor. More...
 
 CLASSFacility (CLASSLogger *log, cSecond cycletime, int type=0)
 Special Constructor. More...
 
 CLASSFacility (CLASSLogger *log, cSecond creationtime, cSecond lifetime, int type=0)
 Special Constructor. More...
 
 CLASSFacility (CLASSLogger *log, cSecond startingtime, cSecond lifetime, cSecond cycletime, int type=0)
 Special Constructor. More...
 
int GetId () const
 Return the Facility Parc'Is. More...
 
IsotopicVector GetInsideIV () const
 Return the IV contained in the Facility. More...
 
int GetFacilityType () const
 Return the Facility Type id. More...
 
cSecond GetInternalTime () const
 Return Creation Time. More...
 
cSecond GetCycleTime () const
 Return the cycle time of the Facility. More...
 
cSecond GetCreationTime () const
 Return the creation time of the Facility. More...
 
cSecond GetLifeTime () const
 Return the life time of the Facility. More...
 
ScenarioGetParc ()
 return the pointer to the Park More...
 
IsotopicVector GetCumulativeIVIn ()
 return the cumulative sum of all incoming IV More...
 
IsotopicVector GetCumulativeIVOut ()
 return the cumulative sum of all outcoming IV More...
 
void SetId (int id)
 Set The Facility Parc'Id. More...
 
void SetParc (Scenario *parc)
 Set the Pointer to the Parc. More...
 
void SetFacilityType (int type)
 
void SetInsideIV (IsotopicVector const &isotopicvector)
 Set the IV inside the Facility. More...
 
void SetCreationTime (cSecond CTtime)
 Set the creation Time. More...
 
void SetLifeTime (cSecond Ltime)
 Set the life time of the facility. More...
 
void SetShutDownTime (cSecond SDTime)
 Set the shutdown time of the facility. More...
 
void SetInCycleTime (cSecond ICtime)
 Set the In cycle time. More...
 
void SetInternalTime (cSecond INtime)
 Set the Internal Time. More...
 
virtual void SetCycleTime (cSecond Ctime)
 Set the cycle time (Cycle of the loading Plan) More...
 
void AddCumulativeIVIn (IsotopicVector const &IV)
 Add the Input IsotopicVector in the cumulative IV IN. More...
 
void AddCumulativeIVOut (IsotopicVector const &IV)
 Add the Input IsotopicVector in the cumulative IV OUT. More...
 
virtual void Dump ()
 Write Modification (IV In/Out, filling the TF...) 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 Member Functions

IsotopicVector GetDecay (IsotopicVector const &isotopicvector, cSecond t)
 Get IsotopicVector decay at time t [s]. More...
 

Protected Attributes

std::vector< IsotopicVectorfIVArray
 Vector containning all the fuel stored. More...
 
std::vector< cSecondfIVArrayArrivalTime
 Vector containning the arrival time of each fuel in [s]. More...
 
CLASSBackEndfOutBackEndFacility
 Facility getting the fuel at the end of the cycle. More...
 
- Protected Attributes inherited from CLASSFacility
bool fIsStarted
 True if Running, False Otherwise. More...
 
bool fIsShutDown
 True if the facility is stoped, False Otherwise. More...
 
bool fIsAtEndOfCycle
 True if Reaching the end of a Facility cycle. More...
 
cSecond fInternalTime
 Internal Clock [s]. More...
 
cSecond fInCycleTime
 Time spent since the beginning of the last Cycle [s]. More...
 
cSecond fCycleTime
 Cycle duration Time [s]. More...
 
IsotopicVector fInsideIV
 All IV in the Facility (fuel for reactor, total for all others...) More...
 
IsotopicVector fCumulativeIVIn
 All IV in the Facility (fuel for reactor, total for all others...) More...
 
IsotopicVector fCumulativeIVOut
 All IV in the Facility (fuel for reactor, total for all others...) More...
 
- Protected Attributes inherited from CLASSObject
CLASSLoggerfLog
 Pointer to the Log. More...
 

Detailed Description

Class defining the common properties of all back end fuel cycle facilities.

Define a CLASS Facility. The aim of these class is to gather all the commom properties of the facilities which are involve in the BackEnd Fuel cycle.

Author
BaM

Constructor & Destructor Documentation

◆ CLASSBackEnd() [1/3]

CLASSBackEnd::CLASSBackEnd ( int  type = 0)

Default Constructor.

Create an empty CLASSBackEnd

Parameters
type

◆ CLASSBackEnd() [2/3]

CLASSBackEnd::CLASSBackEnd ( CLASSLogger log,
int  type = 0 
)

CLASSLogger Constructor.

Create an empty CLASSBackEnd loading a CLASSLogger

Parameters
log: used for the log.
type

◆ CLASSBackEnd() [3/3]

CLASSBackEnd::CLASSBackEnd ( CLASSLogger log,
cSecond  cycletime,
int  type = 0 
)

Cycle time Constructor.

Create an empty CLASSBackEnd loading a CLASSLogger

Parameters
log: used for the log.
cycletimeCycle time of the CLASSBackend (e.g. Cooling time for the pool) in [s],
type-2 :SeparationPlant -1 : Storage ; 8 :Pool

Member Function Documentation

◆ AddIV()

void CLASSBackEnd::AddIV ( IsotopicVector  isotopicvector)
virtual

Add an Isotopicvector to the IVArray.

Reimplemented in Pool, Storage, and SeparationPlant.

◆ ApplyZAIThreshold()

void CLASSBackEnd::ApplyZAIThreshold ( int  z = 90)
virtual

Put all nuclei below the threshold in -2 -2 -2 ZAI...

Reimplemented from CLASSFacility.

◆ ClearIVArray()

void CLASSBackEnd::ClearIVArray ( )

Empty the IVArray removing all fuel stored.

◆ Evolution()

virtual void CLASSBackEnd::Evolution ( cSecond  t)
inlinevirtual

Performs the Evolution until time t.

Implements CLASSFacility.

Reimplemented in Pool, and Storage.

◆ GetDecay()

IsotopicVector CLASSBackEnd::GetDecay ( IsotopicVector const &  isotopicvector,
cSecond  t 
)
protected

Get IsotopicVector decay at time t [s].

◆ GetDecayDataBank()

DecayDataBank * CLASSBackEnd::GetDecayDataBank ( )
inline

Return the pointer to the decay DataBank.

◆ GetIV()

IsotopicVector CLASSBackEnd::GetIV ( int  i) const
inline

◆ GetIVArray()

std::vector< IsotopicVector > CLASSBackEnd::GetIVArray ( ) const
inline

Return the IsotopicVector Array.

◆ GetIVArrayArrivalTime()

std::vector< cSecond > CLASSBackEnd::GetIVArrayArrivalTime ( ) const
inline

Vector of arrival time of each IV in the CLASSBackEnd.

◆ GetIVNumber()

int CLASSBackEnd::GetIVNumber ( ) const
inline

Return the number of Isotopic Vector present in the CLASSBackEnd object.

◆ GetOutBackEndFacility()

CLASSBackEnd * CLASSBackEnd::GetOutBackEndFacility ( ) const
inline

Return the pointer to the OUtBackEndFacility.

◆ GetStorageType()

bool CLASSBackEnd::GetStorageType ( ) const
inline

Return the storageType : True if it is a Storage.

◆ GetTheBackEndTimePath()

std::map< cSecond, int > CLASSBackEnd::GetTheBackEndTimePath ( )
virtual

Get the full path.

Reimplemented in SeparationPlant.

◆ SetDecayDataBank()

void CLASSBackEnd::SetDecayDataBank ( DecayDataBank decayDB)
inline

Set the Decay DataBank.

◆ SetIsStorageType()

void CLASSBackEnd::SetIsStorageType ( bool  val = true)
inline

Set the fIsStorage bool.

◆ SetIVArray()

void CLASSBackEnd::SetIVArray ( std::vector< IsotopicVector > const &  ivarray)
inlinevirtual

Set The isotopicVector Array.

◆ SetIVArrayArrivalTime()

void CLASSBackEnd::SetIVArrayArrivalTime ( std::vector< cSecond > const &  IVArrayArrivalTime)
inline

Set Arrival Time in Back end.

◆ SetOutBackEndFacility()

void CLASSBackEnd::SetOutBackEndFacility ( CLASSBackEnd befacility)
inlinevirtual

Set an out Facility.

Reimplemented in Pool.

◆ UpdateInsideIV()

void CLASSBackEnd::UpdateInsideIV ( )

Member Data Documentation

◆ fIVArray

std::vector<IsotopicVector> CLASSBackEnd::fIVArray
protected

Vector containning all the fuel stored.

◆ fIVArrayArrivalTime

std::vector<cSecond> CLASSBackEnd::fIVArrayArrivalTime
protected

Vector containning the arrival time of each fuel in [s].

◆ fOutBackEndFacility

CLASSBackEnd* CLASSBackEnd::fOutBackEndFacility
protected

Facility getting the fuel at the end of the cycle.


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