CLASS  5.1
Fuel Cycle Simulator
IsotopicVector Class Reference

Allows to store & operate on radioactive sample. More...

#include <IsotopicVector.hxx>

Inheritance diagram for IsotopicVector:

Public Types

typedef std::map< ZAI, double >::const_iterator const_iterator
 
typedef std::map< ZAI, double >::iterator iterator
 

Public Member Functions

Constructor/Desctructor
 IsotopicVector ()
 Normal Constructor. More...
 
 IsotopicVector (IsotopicVector const &IVa)
 Copy Constructor. More...
 
 ~IsotopicVector ()
 Normal Destructor. More...
 
Internal Operator
IsotopicVectoroperator+= (IsotopicVector const &IVb)
 Operator += definition. More...
 
IsotopicVectoroperator-= (IsotopicVector const &IVb)
 Operator -= definition. More...
 
IsotopicVectoroperator*= (IsotopicVector const &IVb)
 Operator *= definition. More...
 
IsotopicVectoroperator*= (double const &factor)
 Operator *= definition (scalar) More...
 
bool operator< (const IsotopicVector &isotopicvector) const
 IsotopicVector Comparator. More...
 
Get Method
map< ZAI, double > GetIsotopicQuantity () const
 Return the IsotopicVector as a map. More...
 
map< ZAI, double > GetIsotopicQuantityNeeded () const
 Return the needed IsotopicVector as a map. More...
 
IsotopicVector GetSpeciesComposition (int z) const
 Return the Species composition of the "z" atom. More...
 
IsotopicVector GetThisComposition (IsotopicVector IV) const
 Return the composition according the IV list... More...
 
IsotopicVector GetThisChemicalComposition (IsotopicVector IV) const
 Return the composition according the IV list... More...
 
vector< ZAIGetZAIList () const
 Return the list of ZAI present in the IV. More...
 
IsotopicVector GetActinidesComposition () const
 Return the Actinides composition (Z >= 89) More...
 
double GetZAIIsotopicQuantity (const ZAI &zai) const
 Return the quantity of the ZAI. More...
 
double GetZAIIsotopicQuantity (const int z, const int a, const int i) const
 Return the quantity of the ZAI. More...
 
double GetQuantity (const int z, const int a, const int i) const
 
double GetQuantity (const ZAI &zai) const
 
void Initiatlize (double val)
 
double GetTotalMass () const
 Return the mass (in tons) of the isotopic vector. More...
 
double GetMeanMolarMass () const
 
vector< int > GetChemicalSpecies () const
 Return the list of chemichal species contained. More...
 
int GetZAIQuantity () const
 Return the number of different ZAI in the IsotopicVector. More...
 
double GetSumOfAll () const
 Return the Sum of nuclei in the IsotopicVector. More...
 
iterator begin ()
 Return an iterator on the begin of fIsotopicQuantity. More...
 
const_iterator begin () const
 Return a constant iterator on the begin of fIsotopicQuantity. More...
 
iterator end ()
 Return an iterator on the end of fIsotopicQuantity. More...
 
const_iterator end () const
 Return a constant iterator on the end of fIsotopicQuantity. More...
 
iterator find (const ZAI &zai)
 
const_iterator find (const ZAI &zai) const
 
Internal Operation Method
void Clear ()
 Empty all the IV. More...
 
void ClearNeed ()
 Empty Need componant of the IV. More...
 
void Add (const ZAI &zai, double quantity)
 Add Quantity gramme of the ZAI Element. More...
 
void Add (const IsotopicVector &isotopicvector)
 Add IsotopicVector to the existing IsotopicVector. More...
 
void Add (const map< ZAI, double > &quantity)
 Add IsotopicVector to the existing IsotopicVector. More...
 
void Add (int Z, int A, int I, double quantity)
 Add Quantity gramme of the ZAI Element. More...
 
void Add (const pair< ZAI, double > &zaiQ)
 
void Need (const ZAI &zai, double quantity)
 Fill the fIsotopicQuantityNeeded. More...
 
void Need (const IsotopicVector &isotopicvector)
 Fill the fIsotopicQuantityNeeded. More...
 
void Need (const map< ZAI, double > &quantityneeded)
 Fill the fIsotopicQuantityNeeded. More...
 
void Remove (const ZAI &zai, double quantity)
 Remove Quantity gramme of the ZAI Element. More...
 
void Remove (const IsotopicVector &isotopicvector)
 Remove IsotopicVector to the existing IsotopicVector. More...
 
void Remove (const pair< ZAI, double > &zaiQ)
 
void Multiply (double factor)
 Multiply the IV by a Factor. More...
 
void ApplyZAIThreshold (int z=90)
 Put all nuclei below the threshold in -2 -2 -2 ZAI... More...
 
In/Out Method
void Write (string filename, cSecond time=-1) const
 Write the Content of the IV in the filename file. More...
 
void Print (string o=" ") const
 Print the composition of the IV in terminal. More...
 
string sPrint () const
 Print the composition of the IV in a string. More...
 
void PrintList (string o=" ") const
 Print the composition of the IV. More...
 

Protected Member Functions

 ClassDef (IsotopicVector, 1)
 

Protected Attributes

map< ZAI,double > fIsotopicQuantity
 Isotopic vector composition in atomes Number. More...
 
map< ZAI,double > fIsotopicQuantityNeeded
 map where negative value are saved More...
 

Detailed Description

Allows to store & operate on radioactive sample.

Defines an Isotopicvector. An isotopicVector is a map of ZAI and double (e.g number of atoms). Its aim is to define a radioactive sample.

Author
BaM
BLG
Marc
Version
2.0

Member Typedef Documentation

◆ const_iterator

◆ iterator

typedef std::map<ZAI,double>::iterator IsotopicVector::iterator

Constructor & Destructor Documentation

◆ IsotopicVector() [1/2]

IsotopicVector::IsotopicVector ( )

Normal Constructor.

◆ IsotopicVector() [2/2]

IsotopicVector::IsotopicVector ( IsotopicVector const &  IVa)

Copy Constructor.

◆ ~IsotopicVector()

IsotopicVector::~IsotopicVector ( )

Normal Destructor.

Member Function Documentation

◆ Add() [1/5]

void IsotopicVector::Add ( const ZAI zai,
double  quantity 
)

Add Quantity gramme of the ZAI Element.

◆ Add() [2/5]

void IsotopicVector::Add ( const IsotopicVector isotopicvector)

Add IsotopicVector to the existing IsotopicVector.

◆ Add() [3/5]

void IsotopicVector::Add ( const map< ZAI, double > &  quantity)

Add IsotopicVector to the existing IsotopicVector.

◆ Add() [4/5]

void IsotopicVector::Add ( int  Z,
int  A,
int  I,
double  quantity 
)
inline

Add Quantity gramme of the ZAI Element.

◆ Add() [5/5]

void IsotopicVector::Add ( const pair< ZAI, double > &  zaiQ)
inline

◆ ApplyZAIThreshold()

void IsotopicVector::ApplyZAIThreshold ( int  z = 90)

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

◆ begin() [1/2]

iterator IsotopicVector::begin ( )
inline

Return an iterator on the begin of fIsotopicQuantity.

◆ begin() [2/2]

const_iterator IsotopicVector::begin ( ) const
inline

Return a constant iterator on the begin of fIsotopicQuantity.

◆ ClassDef()

IsotopicVector::ClassDef ( IsotopicVector  ,
 
)
protected

◆ Clear()

void IsotopicVector::Clear ( )

Empty all the IV.

◆ ClearNeed()

void IsotopicVector::ClearNeed ( )

Empty Need componant of the IV.

◆ end() [1/2]

iterator IsotopicVector::end ( )
inline

Return an iterator on the end of fIsotopicQuantity.

◆ end() [2/2]

const_iterator IsotopicVector::end ( ) const
inline

Return a constant iterator on the end of fIsotopicQuantity.

◆ find() [1/2]

iterator IsotopicVector::find ( const ZAI zai)
inline

◆ find() [2/2]

const_iterator IsotopicVector::find ( const ZAI zai) const
inline

◆ GetActinidesComposition()

IsotopicVector IsotopicVector::GetActinidesComposition ( ) const

Return the Actinides composition (Z >= 89)

◆ GetChemicalSpecies()

vector< int > IsotopicVector::GetChemicalSpecies ( ) const

Return the list of chemichal species contained.

◆ GetIsotopicQuantity()

map<ZAI,double> IsotopicVector::GetIsotopicQuantity ( ) const
inline

Return the IsotopicVector as a map.

◆ GetIsotopicQuantityNeeded()

map<ZAI,double> IsotopicVector::GetIsotopicQuantityNeeded ( ) const
inline

Return the needed IsotopicVector as a map.

◆ GetMeanMolarMass()

double IsotopicVector::GetMeanMolarMass ( ) const

◆ GetQuantity() [1/2]

double IsotopicVector::GetQuantity ( const int  z,
const int  a,
const int  i 
) const
inline

◆ GetQuantity() [2/2]

double IsotopicVector::GetQuantity ( const ZAI zai) const
inline

◆ GetSpeciesComposition()

IsotopicVector IsotopicVector::GetSpeciesComposition ( int  z) const

Return the Species composition of the "z" atom.

◆ GetSumOfAll()

double IsotopicVector::GetSumOfAll ( ) const

Return the Sum of nuclei in the IsotopicVector.

◆ GetThisChemicalComposition()

IsotopicVector IsotopicVector::GetThisChemicalComposition ( IsotopicVector  IV) const

Return the composition according the IV list...

◆ GetThisComposition()

IsotopicVector IsotopicVector::GetThisComposition ( IsotopicVector  IV) const

Return the composition according the IV list...

◆ GetTotalMass()

double IsotopicVector::GetTotalMass ( ) const

Return the mass (in tons) of the isotopic vector.

◆ GetZAIIsotopicQuantity() [1/2]

double IsotopicVector::GetZAIIsotopicQuantity ( const ZAI zai) const

Return the quantity of the ZAI.

◆ GetZAIIsotopicQuantity() [2/2]

double IsotopicVector::GetZAIIsotopicQuantity ( const int  z,
const int  a,
const int  i 
) const

Return the quantity of the ZAI.

◆ GetZAIList()

vector< ZAI > IsotopicVector::GetZAIList ( ) const

Return the list of ZAI present in the IV.

◆ GetZAIQuantity()

int IsotopicVector::GetZAIQuantity ( ) const
inline

Return the number of different ZAI in the IsotopicVector.

◆ Initiatlize()

void IsotopicVector::Initiatlize ( double  val)

◆ Multiply()

void IsotopicVector::Multiply ( double  factor)

Multiply the IV by a Factor.

◆ Need() [1/3]

void IsotopicVector::Need ( const ZAI zai,
double  quantity 
)

Fill the fIsotopicQuantityNeeded.

◆ Need() [2/3]

void IsotopicVector::Need ( const IsotopicVector isotopicvector)

Fill the fIsotopicQuantityNeeded.

◆ Need() [3/3]

void IsotopicVector::Need ( const map< ZAI, double > &  quantityneeded)
inline

Fill the fIsotopicQuantityNeeded.

◆ operator*=() [1/2]

IsotopicVector & IsotopicVector::operator*= ( IsotopicVector const &  IVb)

Operator *= definition.

◆ operator*=() [2/2]

IsotopicVector & IsotopicVector::operator*= ( double const &  factor)

Operator *= definition (scalar)

◆ operator+=()

IsotopicVector & IsotopicVector::operator+= ( IsotopicVector const &  IVb)

Operator += definition.

◆ operator-=()

IsotopicVector & IsotopicVector::operator-= ( IsotopicVector const &  IVb)

Operator -= definition.

◆ operator<()

bool IsotopicVector::operator< ( const IsotopicVector isotopicvector) const

IsotopicVector Comparator.

◆ Print()

void IsotopicVector::Print ( string  o = " ") const

Print the composition of the IV in terminal.

◆ PrintList()

void IsotopicVector::PrintList ( string  o = " ") const

Print the composition of the IV.

◆ Remove() [1/3]

void IsotopicVector::Remove ( const ZAI zai,
double  quantity 
)

Remove Quantity gramme of the ZAI Element.

◆ Remove() [2/3]

void IsotopicVector::Remove ( const IsotopicVector isotopicvector)

Remove IsotopicVector to the existing IsotopicVector.

◆ Remove() [3/3]

void IsotopicVector::Remove ( const pair< ZAI, double > &  zaiQ)
inline

◆ sPrint()

string IsotopicVector::sPrint ( ) const

Print the composition of the IV in a string.

◆ Write()

void IsotopicVector::Write ( string  filename,
cSecond  time = -1 
) const

Write the Content of the IV in the filename file.

Member Data Documentation

◆ fIsotopicQuantity

map<ZAI ,double> IsotopicVector::fIsotopicQuantity
protected

Isotopic vector composition in atomes Number.

◆ fIsotopicQuantityNeeded

map<ZAI ,double> IsotopicVector::fIsotopicQuantityNeeded
protected

map where negative value are saved


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