EGSnrc C++ class library  Report PIRS-898 (2021)
Iwan Kawrakow, Ernesto Mainegra-Hing, Frederic Tessier, Reid Townson and Blake Walters
Public Types | Public Member Functions | Protected Attributes | List of all members
EGS_RadiativeSplitting Class Reference

A radiative splitting object: header. More...

#include <egs_radiative_splitting.h>

Inheritance diagram for EGS_RadiativeSplitting:
EGS_AusgabObject EGS_Object

Public Types

enum  Type { URS, DRS, DRSf }
 

Public Member Functions

 EGS_RadiativeSplitting (const string &Name="", EGS_ObjectFactory *f=0)
 
void setApplication (EGS_Application *App)
 
void setSplitting (const int &n_s)
 
int processEvent (EGS_Application::AusgabCall iarg)
 
int processEvent (EGS_Application::AusgabCall iarg, int ir)
 
- Public Member Functions inherited from EGS_AusgabObject
 EGS_AusgabObject (const string &Name="", EGS_ObjectFactory *f=0)
 Construct an ausgab object named Name.
 
 EGS_AusgabObject (EGS_Input *input, EGS_ObjectFactory *f=0)
 Construct an ausgab object from the input pointed to by inp. More...
 
virtual bool needsCall (EGS_Application::AusgabCall iarg) const
 Is the ausgab call iarg relevant for this object? More...
 
virtual void setCurrentCase (EGS_I64 ncase)
 Set the current event.
 
const char * getObjectDescription () const
 Get a short description of this ausgab object. More...
 
virtual bool storeState (ostream &data_out) const
 Store the source state into the stream data_out. More...
 
virtual bool setState (istream &data_in)
 Set the ausgab object state based on data from the stream data_in. More...
 
virtual bool addState (istream &data_in)
 Add data from the stream data_in to the ausgab object state. More...
 
virtual void resetCounter ()
 Reset the ausgab object state. More...
 
virtual void reportResults ()
 Report results. More...
 
- Public Member Functions inherited from EGS_Object
 EGS_Object (const string &Name="", EGS_ObjectFactory *f=0)
 Create an EGS_Object named Name belonging to the object factory f. More...
 
 EGS_Object (EGS_Input *inp, EGS_ObjectFactory *f=0)
 Create an EGS_Object from the information pointed to by inp that belongs to object factory f. More...
 
const string & getObjectName () const
 Get the object name.
 
void setObjectName (const string &Name)
 Set the object name to Name.
 
const string & getObjectType () const
 Get the object type.
 
virtual EGS_ObjectcreateObject (EGS_Input *inp)
 Create an object from the infromation pointed to by inp. More...
 
void setName (EGS_Input *inp)
 Set the name of the object from the information provided by inp. More...
 
int ref ()
 Increase the reference count to this object.
 
int deref ()
 Decrease the reference count to this object.
 
void setFactory (EGS_ObjectFactory *f)
 Set the factory to which the object belongs. More...
 

Protected Attributes

int nsplit
 
- Protected Attributes inherited from EGS_AusgabObject
string description
 A short ausgab object description. More...
 
EGS_Applicationapp
 The application this object belongs to.
 
- Protected Attributes inherited from EGS_Object
string name
 The object name.
 
string otype
 The object type.
 
int nref
 Number of references to the object.
 
EGS_ObjectFactoryfactory
 The factory this object belongs to.
 

Additional Inherited Members

- Static Public Member Functions inherited from EGS_AusgabObject
static void createAusgabObjects (EGS_Input *)
 Create ausgab objects from the information pointed to by input. More...
 
static EGS_AusgabObjectgetAusgabObject (const string &Name)
 Get a pointer to the ausgab object named Name. More...
 
static void addKnownAusgabObject (EGS_AusgabObject *o)
 Add a known ausgab object to the ausgab object factory. More...
 
static void addKnownTypeId (const char *name)
 Add a known ausgab object typeid to the ausgab object factory. More...
 
static int nObjects ()
 Returns the number of ausgab objects in the internal list.
 
static EGS_AusgabObjectgetObject (int j)
 Returns the j'th ausgab object in the internal list.
 
- Static Public Member Functions inherited from EGS_Object
static string getUniqueName (const EGS_Object *o=0)
 Create and return a unique object name. More...
 
static void deleteObject (EGS_Object *o)
 Delete an object. More...
 

Detailed Description

A radiative splitting object: header.

This ausgab object can be used to increase the efficiency of radiative events. This ausgab object is specified via:

:start ausgab object:
    library   = egs_radiative_splitting
    name      = some_name
    splitting = n_split
:stop ausgab object:

TODO:

Definition at line 93 of file egs_radiative_splitting.h.

Member Enumeration Documentation

Splitting algortihm type

Definition at line 98 of file egs_radiative_splitting.h.


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