SimulationOptions Constructor (Int32, RandomNumberGeneratorType, AbsorptionWeightingType, PhaseFunctionType, IList(DatabaseType), Boolean, Boolean, Double, Int32)

SimulationOptions Constructor (Int32, RandomNumberGeneratorType, AbsorptionWeightingType, PhaseFunctionType, IList DatabaseType , Boolean, Boolean, Double, Int32)

Virtual Photonics - VTS Library

Virtual Photonics

constructor for simulation options, a class sub to SimulationInput

Namespace: Vts.MonteCarlo
Assembly: Vts (in Vts.dll) Version: 1.0.12.0 (1.0.12)

Syntax

C++

Copy to Clipboard Print

public SimulationOptions(
	int seed,
	RandomNumberGeneratorType rngType,
	AbsorptionWeightingType absWeightingType,
	PhaseFunctionType phaseFunctionType,
	IList<DatabaseType> databases,
	bool tallySecondMoment,
	bool trackStatistics,
	double russianRouletteWeightThreshold,
	int simulationIndex
)

public SimulationOptions(
	int seed,
	RandomNumberGeneratorType rngType,
	AbsorptionWeightingType absWeightingType,
	PhaseFunctionType phaseFunctionType,
	IList<DatabaseType> databases,
	bool tallySecondMoment,
	bool trackStatistics,
	double russianRouletteWeightThreshold,
	int simulationIndex
)

Public Sub New ( 
	seed As Integer,
	rngType As RandomNumberGeneratorType,
	absWeightingType As AbsorptionWeightingType,
	phaseFunctionType As PhaseFunctionType,
	databases As IList(Of DatabaseType),
	tallySecondMoment As Boolean,
	trackStatistics As Boolean,
	russianRouletteWeightThreshold As Double,
	simulationIndex As Integer
)

Public Sub New ( 
	seed As Integer,
	rngType As RandomNumberGeneratorType,
	absWeightingType As AbsorptionWeightingType,
	phaseFunctionType As PhaseFunctionType,
	databases As IList(Of DatabaseType),
	tallySecondMoment As Boolean,
	trackStatistics As Boolean,
	russianRouletteWeightThreshold As Double,
	simulationIndex As Integer
)

public:
SimulationOptions(
	int seed, 
	RandomNumberGeneratorType rngType, 
	AbsorptionWeightingType absWeightingType, 
	PhaseFunctionType phaseFunctionType, 
	IList<DatabaseType>^ databases, 
	bool tallySecondMoment, 
	bool trackStatistics, 
	double russianRouletteWeightThreshold, 
	int simulationIndex
)

public:
SimulationOptions(
	int seed, 
	RandomNumberGeneratorType rngType, 
	AbsorptionWeightingType absWeightingType, 
	PhaseFunctionType phaseFunctionType, 
	IList<DatabaseType>^ databases, 
	bool tallySecondMoment, 
	bool trackStatistics, 
	double russianRouletteWeightThreshold, 
	int simulationIndex
)

Parameters

seed: Type: System Int32
random number generator seed (-1=randomly chosen seed, >=0 reproducible sequence)

rngType: Type: Vts RandomNumberGeneratorType
random number generator type

absWeightingType: Type: Vts AbsorptionWeightingType
absorption weighting type

phaseFunctionType: Type: Vts PhaseFunctionType
phase function type

databases: Type: System.Collections.Generic IList DatabaseType
list of DatabaseType indicating data to be written database for post-processing

tallySecondMoment: Type: System Boolean
flag indicating whether to tally second moment information for error results

trackStatistics: Type: System Boolean
flag indicating whether to track statistics about where photons end up

russianRouletteWeightThreshold: Type: System Double
weight threshold to perform RR (default=0, no RR)

simulationIndex: Type: System Int32
index of simulation