SimulationOptions Class Reference

Collaboration diagram for SimulationOptions:

Public Member Functions
	SimulationOptions ()
bool	isIntegrate () const
size_t	getMcPoints () const
void	setMonteCarloIntegration (bool flag=true, size_t mc_points=50)
void	setNumberOfThreads (int nthreads)
unsigned	getNumberOfThreads () const
void	setNumberOfBatches (int nbatches)
unsigned	getNumberOfBatches () const
unsigned	getCurrentBatch () const
void	setThreadInfo (const ThreadInfo &thread_info)
unsigned	getHardwareConcurrency () const
void	setIncludeSpecular (bool include_specular)
bool	includeSpecular () const
void	setUseAvgMaterials (bool use_avg_materials)
bool	useAvgMaterials () const

Private Attributes
bool	m_mc_integration
bool	m_include_specular
bool	m_use_avg_materials
size_t	m_mc_points
ThreadInfo	m_thread_info

Detailed Description

Collect the different options for simulation.

SimulationOptions

Definition at line 27 of file SimulationOptions.h.

Constructor & Destructor Documentation

SimulationOptions()

SimulationOptions::SimulationOptions

(

)

Definition at line 19 of file SimulationOptions.cpp.

    : m_mc_integration(false), m_include_specular(false), m_use_avg_materials(false), m_mc_points(1)
{
    m_thread_info.n_threads = getHardwareConcurrency();
}

References getHardwareConcurrency(), m_thread_info, and ThreadInfo::n_threads.

Here is the call graph for this function:

Member Function Documentation

isIntegrate()

bool SimulationOptions::isIntegrate

(

)

const

Definition at line 25 of file SimulationOptions.cpp.

{
    return m_mc_integration && m_mc_points > 1;
}

References m_mc_integration, and m_mc_points.

Referenced by anonymous_namespace{ProcessedSample.cpp}::CreateFresnelMap(), SimulationToPython::defineSimulationOptions(), and IInterferenceFunctionStrategy::evaluate().

getMcPoints()

size_t SimulationOptions::getMcPoints ( ) const

inline

Definition at line 33 of file SimulationOptions.h.

{ return m_mc_points; }

References m_mc_points.

Referenced by SimulationToPython::defineSimulationOptions(), and IInterferenceFunctionStrategy::MCIntegratedEvaluate().

setMonteCarloIntegration()

void SimulationOptions::setMonteCarloIntegration	(	bool	flag = true,
		size_t	mc_points = 50
	)

Enables/disables MonetCarlo integration.

Parameters

flag	If true, MonteCarlo integration will be used, otherwise analytical calculations
mc_points	Number of points for MonteCarlo integrator

Definition at line 30 of file SimulationOptions.cpp.

{
    m_mc_integration = flag;
    m_mc_points = mc_points;
}

References m_mc_integration, and m_mc_points.

Referenced by StandardSimulations::MiniGISASMonteCarlo().

setNumberOfThreads()

void SimulationOptions::setNumberOfThreads

(

int

nthreads

)

Sets number of threads to use during the simulation (0 - take the default value from the hardware)

Definition at line 36 of file SimulationOptions.cpp.

{
    if (nthreads == 0)
        m_thread_info.n_threads = getHardwareConcurrency();
    else if (nthreads > 0)
        m_thread_info.n_threads = nthreads;
    else
        m_thread_info.n_threads = 1;
}

References getHardwareConcurrency(), m_thread_info, and ThreadInfo::n_threads.

Here is the call graph for this function:

getNumberOfThreads()

unsigned SimulationOptions::getNumberOfThreads

(

)

const

Definition at line 46 of file SimulationOptions.cpp.

{
    if (m_thread_info.n_threads < 1)
        throw std::runtime_error("Error in SimulationOptions::getNumberOfThreads: Number of "
                                 "threads must be positive");
    return m_thread_info.n_threads;
}

References m_thread_info, and ThreadInfo::n_threads.

Referenced by SimulationToPython::defineSimulationOptions(), and Simulation::runSingleSimulation().

setNumberOfBatches()

void SimulationOptions::setNumberOfBatches

(

int

nbatches

)

Sets number of batches to split.

Definition at line 54 of file SimulationOptions.cpp.

{
    if (nbatches < 1)
        throw std::runtime_error("Error in SimulationOptions::setNumberOfBatches: Number of "
                                 "batches must be positive");
    m_thread_info.n_batches = nbatches;
}

References m_thread_info, and ThreadInfo::n_batches.

getNumberOfBatches()

unsigned SimulationOptions::getNumberOfBatches

(

)

const

Definition at line 62 of file SimulationOptions.cpp.

{
    if (m_thread_info.n_batches < 1)
        throw std::runtime_error("Error in SimulationOptions::getNumberOfBatches: Number of "
                                 "batches must be positive");
    return m_thread_info.n_batches;
}

References m_thread_info, and ThreadInfo::n_batches.

Referenced by getCurrentBatch(), and Simulation::runSimulation().

getCurrentBatch()

unsigned SimulationOptions::getCurrentBatch

(

)

const

Definition at line 70 of file SimulationOptions.cpp.

{
    if (m_thread_info.current_batch >= getNumberOfBatches())
        throw std::runtime_error(
            "Error in SimulationOptions::getCurrentBatch: current batch is out of range");
    return m_thread_info.current_batch;
}

References ThreadInfo::current_batch, getNumberOfBatches(), and m_thread_info.

Referenced by Simulation::runSimulation().

Here is the call graph for this function:

setThreadInfo()

void SimulationOptions::setThreadInfo ( const ThreadInfo &  thread_info )

inline

Sets the batch and thread information to be used.

Definition at line 54 of file SimulationOptions.h.

{ m_thread_info = thread_info; }

References m_thread_info.

getHardwareConcurrency()

unsigned SimulationOptions::getHardwareConcurrency

(

)

const

Definition at line 78 of file SimulationOptions.cpp.

{
    return std::thread::hardware_concurrency();
}

Referenced by SimulationToPython::defineSimulationOptions(), setNumberOfThreads(), and SimulationOptions().

setIncludeSpecular()

void SimulationOptions::setIncludeSpecular ( bool  include_specular )

inline

Definition at line 58 of file SimulationOptions.h.

{ m_include_specular = include_specular; }

References m_include_specular.

Referenced by StandardSimulations::MiniGISASSpecularPeak().

includeSpecular()

bool SimulationOptions::includeSpecular ( ) const

inline

Definition at line 60 of file SimulationOptions.h.

{ return m_include_specular; }

References m_include_specular.

Referenced by SimulationToPython::defineSimulationOptions(), and DWBAComputation::DWBAComputation().

setUseAvgMaterials()

void SimulationOptions::setUseAvgMaterials ( bool  use_avg_materials )

inline

Definition at line 62 of file SimulationOptions.h.

{ m_use_avg_materials = use_avg_materials; }

References m_use_avg_materials.

Referenced by DefaultMaterialProfileLimits(), and MaterialProfile().

useAvgMaterials()

bool SimulationOptions::useAvgMaterials ( ) const

inline

Definition at line 64 of file SimulationOptions.h.

{ return m_use_avg_materials; }

References m_use_avg_materials.

Referenced by SimulationToPython::defineSimulationOptions(), ProcessedSample::initFresnelMap(), and ProcessedSample::initSlices().

Member Data Documentation

m_mc_integration

bool SimulationOptions::m_mc_integration

private

Definition at line 67 of file SimulationOptions.h.

Referenced by isIntegrate(), and setMonteCarloIntegration().

m_include_specular

bool SimulationOptions::m_include_specular

private

Definition at line 68 of file SimulationOptions.h.

Referenced by includeSpecular(), and setIncludeSpecular().

m_use_avg_materials

bool SimulationOptions::m_use_avg_materials

private

Definition at line 69 of file SimulationOptions.h.

Referenced by setUseAvgMaterials(), and useAvgMaterials().

m_mc_points

size_t SimulationOptions::m_mc_points

private

Definition at line 70 of file SimulationOptions.h.

Referenced by getMcPoints(), isIntegrate(), and setMonteCarloIntegration().

m_thread_info

ThreadInfo SimulationOptions::m_thread_info

private

Definition at line 71 of file SimulationOptions.h.

Referenced by getCurrentBatch(), getNumberOfBatches(), getNumberOfThreads(), setNumberOfBatches(), setNumberOfThreads(), setThreadInfo(), and SimulationOptions().

---

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

• /home/www/ba/Sample/RT/SimulationOptions.h
• /home/www/ba/Sample/RT/SimulationOptions.cpp