CLASS  5.1
Fuel Cycle Simulator
CLASSFacility Class Referenceabstract

Defines the common properties of all facilities. More...

#include <CLASSFacility.hxx>

Inheritance diagram for CLASSFacility:
CLASSObject CLASSBackEnd FabricationPlant Reactor Pool SeparationPlant Storage

Public Member Functions

Constructor/Desctructor
 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...
 
Get Function
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...
 
Set Function
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...
 
Evolution Method
virtual void ApplyZAIThreshold (int z=90)
 Put all nuclei below the threshold in -2 -2 -2 ZAI... 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 Evolution (cSecond t)=0
 Performs the Evolution to time t. 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 Attributes

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

Defines the common properties of all facilities.

Define a CLASS Facility. The aim of these class is to gather all the commom properties of the facilities.

Author
BaM

Constructor & Destructor Documentation

◆ CLASSFacility() [1/5]

CLASSFacility::CLASSFacility ( int  type = 0)

Normal Constructor.

Make a new Facility

Parameters
typeidentification type of the facility :

◆ CLASSFacility() [2/5]

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

Special Constructor.

Make a new Facility

Parameters
log: used for the log.
typeidentification type of the facility :

◆ CLASSFacility() [3/5]

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

Special Constructor.

Make a new Facility

Parameters
log: used for the log.
cycletimeduration of the cycle [s],
typeidentification type of the facility :

◆ CLASSFacility() [4/5]

CLASSFacility::CLASSFacility ( CLASSLogger log,
cSecond  creationtime,
cSecond  lifetime,
int  type = 0 
)

Special Constructor.

Make a new Facility

Parameters
log: used for the log.
creationtimecreation date of the Facility [s],
lifetimeoperating duration [s],
typeidentification type of the facility :

◆ CLASSFacility() [5/5]

CLASSFacility::CLASSFacility ( CLASSLogger log,
cSecond  startingtime,
cSecond  lifetime,
cSecond  cycletime,
int  type = 0 
)

Special Constructor.

Make a new Facility

Parameters
log: used for the log.
creationtimecreation date of the Facility [s],
lifetimeoperating duration [s],
cycletimeduration of the cycle [s],
typeidentification type of the facility :

Member Function Documentation

◆ AddCumulativeIVIn()

void CLASSFacility::AddCumulativeIVIn ( IsotopicVector const &  IV)
inline

Add the Input IsotopicVector in the cumulative IV IN.

◆ AddCumulativeIVOut()

void CLASSFacility::AddCumulativeIVOut ( IsotopicVector const &  IV)
inline

Add the Input IsotopicVector in the cumulative IV OUT.

◆ ApplyZAIThreshold()

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

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

Reimplemented in CLASSBackEnd.

◆ Dump()

virtual void CLASSFacility::Dump ( )
inlinevirtual

Write Modification (IV In/Out, filling the TF...)

Reimplemented in Reactor, and Pool.

◆ Evolution()

virtual void CLASSFacility::Evolution ( cSecond  t)
pure virtual

Performs the Evolution to time t.

Implemented in Reactor, FabricationPlant, Pool, Storage, and CLASSBackEnd.

◆ GetCreationTime()

cSecond CLASSFacility::GetCreationTime ( ) const
inline

Return the creation time of the Facility.

◆ GetCumulativeIVIn()

IsotopicVector CLASSFacility::GetCumulativeIVIn ( )
inline

return the cumulative sum of all incoming IV

◆ GetCumulativeIVOut()

IsotopicVector CLASSFacility::GetCumulativeIVOut ( )
inline

return the cumulative sum of all outcoming IV

◆ GetCycleTime()

cSecond CLASSFacility::GetCycleTime ( ) const
inline

Return the cycle time of the Facility.

◆ GetFacilityType()

int CLASSFacility::GetFacilityType ( ) const
inline

Return the Facility Type id.

◆ GetId()

int CLASSFacility::GetId ( ) const
inline

Return the Facility Parc'Is.

◆ GetInsideIV()

IsotopicVector CLASSFacility::GetInsideIV ( ) const
inline

Return the IV contained in the Facility.

◆ GetInternalTime()

cSecond CLASSFacility::GetInternalTime ( ) const
inline

Return Creation Time.

◆ GetLifeTime()

cSecond CLASSFacility::GetLifeTime ( ) const
inline

Return the life time of the Facility.

◆ GetParc()

Scenario* CLASSFacility::GetParc ( )
inline

return the pointer to the Park

◆ SetCreationTime()

void CLASSFacility::SetCreationTime ( cSecond  CTtime)
inline

Set the creation Time.

◆ SetCycleTime()

virtual void CLASSFacility::SetCycleTime ( cSecond  Ctime)
inlinevirtual

Set the cycle time (Cycle of the loading Plan)

◆ SetFacilityType()

void CLASSFacility::SetFacilityType ( int  type)
inline

Set the facility type :

◆ SetId()

void CLASSFacility::SetId ( int  id)
inline

Set The Facility Parc'Id.

◆ SetInCycleTime()

void CLASSFacility::SetInCycleTime ( cSecond  ICtime)
inline

Set the In cycle time.

◆ SetInsideIV()

void CLASSFacility::SetInsideIV ( IsotopicVector const &  isotopicvector)
inline

Set the IV inside the Facility.

◆ SetInternalTime()

void CLASSFacility::SetInternalTime ( cSecond  INtime)
inline

Set the Internal Time.

◆ SetLifeTime()

void CLASSFacility::SetLifeTime ( cSecond  Ltime)
inline

Set the life time of the facility.

◆ SetParc()

void CLASSFacility::SetParc ( Scenario parc)
inline

Set the Pointer to the Parc.

◆ SetShutDownTime()

void CLASSFacility::SetShutDownTime ( cSecond  SDTime)
inline

Set the shutdown time of the facility.

Member Data Documentation

◆ fCumulativeIVIn

IsotopicVector CLASSFacility::fCumulativeIVIn
protected

All IV in the Facility (fuel for reactor, total for all others...)

◆ fCumulativeIVOut

IsotopicVector CLASSFacility::fCumulativeIVOut
protected

All IV in the Facility (fuel for reactor, total for all others...)

◆ fCycleTime

cSecond CLASSFacility::fCycleTime
protected

Cycle duration Time [s].

◆ fInCycleTime

cSecond CLASSFacility::fInCycleTime
protected

Time spent since the beginning of the last Cycle [s].

◆ fInsideIV

IsotopicVector CLASSFacility::fInsideIV
protected

All IV in the Facility (fuel for reactor, total for all others...)

◆ fInternalTime

cSecond CLASSFacility::fInternalTime
protected

Internal Clock [s].

◆ fIsAtEndOfCycle

bool CLASSFacility::fIsAtEndOfCycle
protected

True if Reaching the end of a Facility cycle.

◆ fIsShutDown

bool CLASSFacility::fIsShutDown
protected

True if the facility is stoped, False Otherwise.

◆ fIsStarted

bool CLASSFacility::fIsStarted
protected

True if Running, False Otherwise.


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