MURE
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TallyBin Class Reference

Define a general MCNP Tally Bin (cell or surface). More...

#include <Tally.hxx>

Inheritance diagram for TallyBin:
GroupBin LatticeBin SimpleBin

Public Member Functions

 TallyBin (const TallyBin &b)
 Copy constructor. More...
 
 TallyBin ()
 Normal Construcator. More...
 
virtual ~TallyBin ()
 
virtual TallyBinClone ()
 Destructor. More...
 
virtual bool IsSimpleBin ()
 if the TallyBin is a SimpleBin More...
 
virtual bool IsGroupBin ()
 if the TallyBin is a GroupBin More...
 
virtual bool IsLatticeBin ()
 
int GetCellType ()
 returns -1, 0, 1 in function of the bin type. More...
 
virtual string Print (int BeforeRparenthesis=0)
 Print the TallyBin in MCNP. More...
 
virtual string PrintVolume ()
 Print the Volume of the bin in MCNP. More...
 
virtual bool NeedVolume ()
 
vector< double > GetVolume ()
 retruns the bin volume vector. More...
 
double GetVolume (int i)
 retruns the ith bin volume vector. More...
 
double GetSurface ()
 retruns the bin surface More...
 
int GetNumberOfVolume ()
 
void SetSurface (double S, bool Inc=false)
 Set the bin surface. More...
 
void SetVolume (double V, int i=0, bool Inc=false)
 set the bin volume of ith partial bin. More...
 
virtual bool IsInBin (int num)
 whether or not the cell/suface "num" is in the tally bin More...
 
void SetBinVolume (vector< double > V)
 Set volume(s) to bin(s) More...
 

Protected Member Functions

 TallyBin (int celltype, vector< double > vol, double surf)
 used by Copy constructor of daugthers classes More...
 

Protected Attributes

int fCellType
 type of the bin (-1=unknown, 0=surface, 1=cell) More...
 
vector< double > fVolume
 bin volume vector (1 value except for LatticeBin or Universe) More...
 
double fSurface
 bin surface More...
 

Detailed Description

Define a general MCNP Tally Bin (cell or surface).

This does not include Energy, Time,.. bins.

WARNING: The surface for surface bin is not fully implemented and yet not tested.

See Also
SimpleBin
GroupBin
LatticeBin
User Guide
Author
PTO
Version
1.0

Constructor & Destructor Documentation

TallyBin::TallyBin ( int  celltype,
vector< double >  vol,
double  surf 
)
protected

used by Copy constructor of daugthers classes

TallyBin::TallyBin ( const TallyBin b)

Copy constructor.

TallyBin::TallyBin ( )

Normal Construcator.

virtual TallyBin::~TallyBin ( )
inlinevirtual

Member Function Documentation

virtual TallyBin* TallyBin::Clone ( )
inlinevirtual

Destructor.

Reimplemented in LatticeBin, GroupBin, and SimpleBin.

int TallyBin::GetCellType ( )
inline

returns -1, 0, 1 in function of the bin type.

-1 if the bin type is not known, 0 if it is a Surface bin and 1 if it is a Cell bin

int TallyBin::GetNumberOfVolume ( )
inline

returns the number of volume

double TallyBin::GetSurface ( )
inline

retruns the bin surface

vector<double> TallyBin::GetVolume ( )
inline

retruns the bin volume vector.

In general this vector contains only 1 elements (except for LatticeBin)

double TallyBin::GetVolume ( int  i)
inline

retruns the ith bin volume vector.

In general i=0 because the volume vector contains only 1 elements (except for LatticeBin)

virtual bool TallyBin::IsGroupBin ( )
inlinevirtual

if the TallyBin is a GroupBin

Reimplemented in GroupBin.

virtual bool TallyBin::IsInBin ( int  num)
inlinevirtual

whether or not the cell/suface "num" is in the tally bin

Reimplemented in LatticeBin, GroupBin, and SimpleBin.

virtual bool TallyBin::IsLatticeBin ( )
inlinevirtual

if the TallyBin is a LatticeBin

Reimplemented in LatticeBin.

virtual bool TallyBin::IsSimpleBin ( )
inlinevirtual

if the TallyBin is a SimpleBin

Reimplemented in SimpleBin.

virtual bool TallyBin::NeedVolume ( )
inlinevirtual

True if Stochastic Volume/Surface calculation are needed.

virtual string TallyBin::Print ( int  BeforeRparenthesis = 0)
inlinevirtual

Print the TallyBin in MCNP.

Reimplemented in LatticeBin, GroupBin, and SimpleBin.

string TallyBin::PrintVolume ( )
virtual

Print the Volume of the bin in MCNP.

Reimplemented in LatticeBin, and SimpleBin.

void TallyBin::SetBinVolume ( vector< double >  V)

Set volume(s) to bin(s)

void TallyBin::SetSurface ( double  S,
bool  Inc = false 
)

Set the bin surface.

If Inc=true then increment the Bin surface of S. In this case, if fSurface=-1, it is assume that no surface has been enter thus fSurface is set to S. If fSurface=-2, no incrementation is done: this means that surface for the whole bin (GroupBin) cannot be obtained.

Parameters
S: the value of the surface or of the increment depending on Inc
Inc: if false set fSurface to S, else increment fSurface of S (except if fSurface=-2)
void TallyBin::SetVolume ( double  V,
int  i = 0,
bool  Inc = false 
)

set the bin volume of ith partial bin.

If Inc=true then increment the Bin volume of V. In this case, if fVolume=-1, it is assume that no volume has been enter thus fVolume is set to V. If fVolume=-2, no incrementation is done: this means that volume for the whole bin (GroupBin) cannot be obtained.

Parameters
V: the value of the volume or of the increment depending on Inc
i: the ith partial bin for LatticeBin; i=0 for all other bin
Inc: if false set fVolume to V, else increment fVolume of V (except if fVolume=-2)set the bin volume of ith partial bin (i=0 except for LatticeBin.

Member Data Documentation

int TallyBin::fCellType
protected

type of the bin (-1=unknown, 0=surface, 1=cell)

double TallyBin::fSurface
protected

bin surface

vector<double> TallyBin::fVolume
protected

bin volume vector (1 value except for LatticeBin or Universe)


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

MURE Project, documentation generated by Doxygen 1.8.5 - Mon Nov 17 2014