SimulationOptions Class Reference

Description

Collect the different options for simulation.

SimulationOptions.

Definition at line 27 of file SimulationOptions.h.

Collaboration diagram for SimulationOptions:

Public Member Functions
	SimulationOptions ()
unsigned	getCurrentBatch () const
unsigned	getHardwareConcurrency () const
size_t	getMcPoints () const
unsigned	getNumberOfBatches () const
unsigned	getNumberOfThreads () const
bool	includeSpecular () const
bool	isIntegrate () const
void	setIncludeSpecular (bool include_specular)
void	setMonteCarloIntegration (bool flag=true, size_t mc_points=50)
	Enables/disables MonetCarlo integration. More...
void	setNumberOfBatches (int nbatches)
	Sets number of batches to split. More...
void	setNumberOfThreads (int nthreads)
	Sets number of threads to use during the simulation (0 - take the default value from the hardware) More...
void	setThreadInfo (const ThreadInfo &thread_info)
	Sets the batch and thread information to be used. More...
void	setUseAvgMaterials (bool use_avg_materials)
bool	useAvgMaterials () const

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

Constructor & Destructor Documentation

SimulationOptions()

SimulationOptions::SimulationOptions

(

)

Definition at line 22 of file SimulationOptions.cpp.

    : m_mc_integration(false)
    , m_include_specular(false)
    , m_use_avg_materials(false)
    , m_mc_points(1)
{
    if (const char* env_p = std::getenv("BA_NTHREADS")) {
        m_thread_info.n_threads = std::stoi(env_p);
        if (m_thread_info.n_threads > 0)
            return;
    }
    m_thread_info.n_threads = getHardwareConcurrency();
}

References BaseUtils::System::getenv(), getHardwareConcurrency(), m_thread_info, and ThreadInfo::n_threads.

Here is the call graph for this function:

Member Function Documentation

getCurrentBatch()

unsigned SimulationOptions::getCurrentBatch

(

)

const

Definition at line 75 of file SimulationOptions.cpp.

{
    unsigned result = m_thread_info.current_batch;
    ASSERT(result < m_thread_info.n_batches);
    return result;
}

References ASSERT, ThreadInfo::current_batch, m_thread_info, and ThreadInfo::n_batches.

getHardwareConcurrency()

unsigned SimulationOptions::getHardwareConcurrency

(

)

const

Definition at line 82 of file SimulationOptions.cpp.

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

Referenced by SimulationOptions(), and setNumberOfThreads().

getMcPoints()

size_t SimulationOptions::getMcPoints ( ) const

inline

Definition at line 32 of file SimulationOptions.h.

{ return m_mc_points; }

References m_mc_points.

Referenced by IInterparticleStrategy::MCIntegratedEvaluate().

getNumberOfBatches()

unsigned SimulationOptions::getNumberOfBatches

(

)

const

Definition at line 69 of file SimulationOptions.cpp.

{
    ASSERT(m_thread_info.n_batches > 0);
    return m_thread_info.n_batches;
}

References ASSERT, m_thread_info, and ThreadInfo::n_batches.

getNumberOfThreads()

unsigned SimulationOptions::getNumberOfThreads

(

)

const

Definition at line 57 of file SimulationOptions.cpp.

{
    ASSERT(m_thread_info.n_threads > 0);
    return m_thread_info.n_threads;
}

References ASSERT, m_thread_info, and ThreadInfo::n_threads.

includeSpecular()

bool SimulationOptions::includeSpecular ( ) const

inline

Definition at line 59 of file SimulationOptions.h.

{ return m_include_specular; }

References m_include_specular.

isIntegrate()

bool SimulationOptions::isIntegrate

(

)

const

Definition at line 36 of file SimulationOptions.cpp.

{
    return m_mc_integration && m_mc_points > 1;
}

References m_mc_integration, and m_mc_points.

Referenced by IInterparticleStrategy::evaluate().

setIncludeSpecular()

void SimulationOptions::setIncludeSpecular ( bool  include_specular )

inline

Definition at line 57 of file SimulationOptions.h.

{ m_include_specular = include_specular; }

References m_include_specular.

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 41 of file SimulationOptions.cpp.

{
    m_mc_integration = flag;
    m_mc_points = mc_points;
}

References m_mc_integration, and m_mc_points.

setNumberOfBatches()

void SimulationOptions::setNumberOfBatches

(

int

nbatches

)

Sets number of batches to split.

Definition at line 63 of file SimulationOptions.cpp.

{
    ASSERT(nbatches > 0);
    m_thread_info.n_batches = nbatches;
}

References ASSERT, m_thread_info, and ThreadInfo::n_batches.

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 47 of file SimulationOptions.cpp.

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

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

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 53 of file SimulationOptions.h.

{ m_thread_info = thread_info; }

References m_thread_info.

setUseAvgMaterials()

void SimulationOptions::setUseAvgMaterials ( bool  use_avg_materials )

inline

Definition at line 61 of file SimulationOptions.h.

{ m_use_avg_materials = use_avg_materials; }

References m_use_avg_materials.

Referenced by swigAPI::defaultMaterialProfileLimits(), and swigAPI::materialProfileSLD().

useAvgMaterials()

bool SimulationOptions::useAvgMaterials ( ) const

inline

Definition at line 63 of file SimulationOptions.h.

{ return m_use_avg_materials; }

References m_use_avg_materials.

Referenced by reSample::make().

Member Data Documentation

m_include_specular

bool SimulationOptions::m_include_specular

private

Definition at line 67 of file SimulationOptions.h.

Referenced by includeSpecular(), and setIncludeSpecular().

m_mc_integration

bool SimulationOptions::m_mc_integration

private

Definition at line 66 of file SimulationOptions.h.

Referenced by isIntegrate(), and setMonteCarloIntegration().

m_mc_points

size_t SimulationOptions::m_mc_points

private

Definition at line 69 of file SimulationOptions.h.

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

m_thread_info

ThreadInfo SimulationOptions::m_thread_info

private

Definition at line 70 of file SimulationOptions.h.

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

m_use_avg_materials

bool SimulationOptions::m_use_avg_materials

private

Definition at line 68 of file SimulationOptions.h.

Referenced by setUseAvgMaterials(), and useAvgMaterials().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Resample/Options/SimulationOptions.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Resample/Options/SimulationOptions.cpp