CML2Convergence Class Reference

#include <ML2Convergence.hh>

Collaboration diagram for CML2Convergence:

Public Member Functions
	CML2Convergence ()
	CML2Convergence (G4int seed, G4int saving_in_Selected_Voxels_every_events, G4String FileExperimentalData, G4String FileExperimentalDataOut, G4bool bCompareExp, G4int maxNumberOfEvents, G4int nRecycling, G4int nMaxLoops)
	~CML2Convergence (void)
void	add (const G4Step *aStep)
G4bool	stopRun ()
void	setMaxNumberOfEvents (G4int val)
G4double	getMaxNumberOfEvents ()
CML2ExpVoxels *	getExpVoxels ()
void	saveResults ()
void	setNewGeometry ()
int	getNMaxLoops ()

Private Member Functions
G4bool	convergenceCriteria ()

Private Attributes
std::vector< Svoxel >	voxels
CML2ExpVoxels *	ML2ExpVoxels
G4String	fileExperimentalData
G4bool	bCompareExp
G4int	maxNumberOfEvents
G4int	nGeometry
G4int	nAccumulatedEvents
int	nMaxLoops
int	idCurrentLoop

Detailed Description

Definition at line 52 of file ML2Convergence.hh.

Constructor & Destructor Documentation

CML2Convergence() [1/2]

CML2Convergence::CML2Convergence

(

void

)

Definition at line 46 of file ML2Convergence.cc.

{}

CML2Convergence() [2/2]

CML2Convergence::CML2Convergence	(	G4int	seed,
		G4int	saving_in_Selected_Voxels_every_events,
		G4String	FileExperimentalData,
		G4String	FileExperimentalDataOut,
		G4bool	bCompareExp,
		G4int	maxNumberOfEvents,
		G4int	nRecycling,
		G4int	nMaxLoops
	)

Definition at line 49 of file ML2Convergence.cc.

    :ML2ExpVoxels(0)
{
    nGeometry=0;
    nMaxLoops=maxLoops;
    idCurrentLoop=nMaxLoops;
    bCompareExp=bComp;
    nAccumulatedEvents=0;
    if (bCompareExp){nMaxLoops=-1;};
    fileExperimentalData=FileExperimentalData;

    // if the flag compareExp if true and the experimental data is given create the class CML2ExpVoxels
    if (bCompareExp && fileExperimentalData!="")
    {
        ML2ExpVoxels=new CML2ExpVoxels(bCompareExp, saveEvents, seed, FileExperimentalData, FileExperimentalDataOut);
        if (!ML2ExpVoxels->loadData())
        {
            ML2ExpVoxels=0;
            std::cout <<"I don't have any convergence criteria set, I'll do " << nMaxLoops << " loop(s) for each rotation"<< G4endl;
        }
        else
        {
            ML2ExpVoxels->setRecycling(nRecycling);
        }
    }
    maxNumberOfEvents=maxNumEvents;
}

Here is the call graph for this function:

~CML2Convergence()

CML2Convergence::~CML2Convergence

(

void

)

Definition at line 79 of file ML2Convergence.cc.

{
    if (ML2ExpVoxels!=0)
    {delete ML2ExpVoxels;}

}

Member Function Documentation

add()

void CML2Convergence::add

(

const G4Step *

aStep

)

Definition at line 85 of file ML2Convergence.cc.

{
    // accumulate events in the CML2ExpVoxels class (if created)
    if (ML2ExpVoxels!=0)
    {
        if (aStep->GetTotalEnergyDeposit()>0.)
        {ML2ExpVoxels->add(aStep);}
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

convergenceCriteria()

G4bool CML2Convergence::convergenceCriteria ( )

private

Definition at line 112 of file ML2Convergence.cc.

{
    G4bool bStopRun=true;
    G4int nEventsAccumulated=0;
    if (bCompareExp)
    {
        nEventsAccumulated=ML2ExpVoxels->getMaxNumberOfEvents();
        // It checks if the maximum number of events is reached at least in one voxel. Having more rotations the limits is incremented each rotation
        if (ML2ExpVoxels->getMaxNumberOfEvents()>= maxNumberOfEvents)
        {bStopRun = true; ML2ExpVoxels->resetNEventsInVoxels();}
        else
        {bStopRun = false;}
    }
    std::cout <<"\n ++++++++++++++++++++ \n";
    std::cout <<"current geometry: " << nGeometry;
    std::cout << "\nNumber of events accumulated in the current geometry:"<<
                 nEventsAccumulated<<"\nNumber of events to be accumulated:" <<
                maxNumberOfEvents<< "\n -------------------------\n";
    return bStopRun;
}

Here is the call graph for this function:

Here is the caller graph for this function:

getExpVoxels()

CML2ExpVoxels* CML2Convergence::getExpVoxels ( )

inline

Definition at line 62 of file ML2Convergence.hh.

{return ML2ExpVoxels;}

getMaxNumberOfEvents()

G4double CML2Convergence::getMaxNumberOfEvents ( )

inline

Definition at line 61 of file ML2Convergence.hh.

{return maxNumberOfEvents;};

getNMaxLoops()

int CML2Convergence::getNMaxLoops ( )

inline

Definition at line 65 of file ML2Convergence.hh.

{return nMaxLoops;}

Here is the call graph for this function:

Here is the caller graph for this function:

saveResults()

void CML2Convergence::saveResults ( )

inline

Definition at line 63 of file ML2Convergence.hh.

{if (ML2ExpVoxels!=0){ML2ExpVoxels->saveResults();}}

Here is the call graph for this function:

Here is the caller graph for this function:

setMaxNumberOfEvents()

void CML2Convergence::setMaxNumberOfEvents ( G4int  val )

inline

Definition at line 60 of file ML2Convergence.hh.

{maxNumberOfEvents=val;}

setNewGeometry()

void CML2Convergence::setNewGeometry ( )

inline

Definition at line 64 of file ML2Convergence.hh.

{nGeometry++;   idCurrentLoop=nMaxLoops;}

Here is the caller graph for this function:

stopRun()

G4bool CML2Convergence::stopRun

(

)

Definition at line 94 of file ML2Convergence.cc.

{
    G4bool bStopRun=false;
    if (ML2ExpVoxels!=0) // true if the experimental data file exists and is used to check the convergence
    {
        bStopRun=convergenceCriteria();
        return bStopRun;
    }
    else // true if no experiemental data file is used. In this case it runs "nMaxLoops" loops.
    {
        idCurrentLoop--;
        if (idCurrentLoop==0)
        {
            bStopRun=true;
        }
    }
    return bStopRun;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

bCompareExp

G4bool CML2Convergence::bCompareExp

private

Definition at line 74 of file ML2Convergence.hh.

fileExperimentalData

G4String CML2Convergence::fileExperimentalData

private

Definition at line 72 of file ML2Convergence.hh.

idCurrentLoop

int CML2Convergence::idCurrentLoop

private

Definition at line 76 of file ML2Convergence.hh.

maxNumberOfEvents

G4int CML2Convergence::maxNumberOfEvents

private

Definition at line 75 of file ML2Convergence.hh.

ML2ExpVoxels

CML2ExpVoxels* CML2Convergence::ML2ExpVoxels

private

Definition at line 70 of file ML2Convergence.hh.

nAccumulatedEvents

G4int CML2Convergence::nAccumulatedEvents

private

Definition at line 75 of file ML2Convergence.hh.

nGeometry

G4int CML2Convergence::nGeometry

private

Definition at line 75 of file ML2Convergence.hh.

nMaxLoops

int CML2Convergence::nMaxLoops

private

Definition at line 76 of file ML2Convergence.hh.

voxels

std::vector<Svoxel> CML2Convergence::voxels

private

Definition at line 69 of file ML2Convergence.hh.

---

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

• ML2Convergence.hh
• ML2Convergence.cc