openstudio::analysis::PSUADEDaceAlgorithmOptions Class Reference

#include <PSUADEDaceAlgorithmOptions.hpp>

Inheritance diagram for openstudio::analysis::PSUADEDaceAlgorithmOptions:

Public Member Functions
Constructors and Destructors
	PSUADEDaceAlgorithmOptions ()
	PSUADEDaceAlgorithmOptions (const std::vector< Attribute > &options)
	Constructor provided for deserialization; not for general use. More...
virtual	~PSUADEDaceAlgorithmOptions ()
Getters and Queries
boost::optional< int >	seed () const
	Returns the explicit pseudo-random number generator seed if it exists, evaluates to false otherwise. More...
boost::optional< int >	samples () const
	Returns the user-specified number of samples to be used if it exists, evaluates to false otherwise. More...
boost::optional< int >	partitions () const
	Returns the user-specified number of partitions to be used if it exists, evaluates to false otherwise. More...
Setters
bool	setSeed (int value)
	Seed value must be greater than zero. More...
void	clearSeed ()
bool	setSamples (int value)
	The number of samples must be greater than zero. More...
void	clearSamples ()
bool	setPartitions (int value)
	The number of partitions must be greater than zero. More...
void	clearPartitions ()
Public Member Functions inherited from openstudio::analysis::DakotaAlgorithmOptions
virtual	~DakotaAlgorithmOptions ()
Public Member Functions inherited from openstudio::analysis::AlgorithmOptions
	AlgorithmOptions ()
	By default, maxIter and maxSims are set to boost::none (no restriction). More...
virtual	~AlgorithmOptions ()
AlgorithmOptions	clone () const
boost::optional< int >	maxIter () const
boost::optional< int >	maxSims () const
std::vector< Attribute >	options () const
	Getter provided for serialization; not for general use. More...
void	setMaxIter (int maxIter)
void	setMaxSims (int maxSims)
void	clearMaxIter ()
void	clearMaxSims ()
template<typename T >
T	cast () const
	Cast to type T. More...
template<typename T >
boost::optional< T >	optionalCast () const
	Cast to boost::optional<T>. More...

Related Functions
(Note that these are not member functions.)
typedef boost::optional < PSUADEDaceAlgorithmOptions >	OptionalPSUADEDaceAlgorithmOptions
typedef std::vector < PSUADEDaceAlgorithmOptions >	PSUADEDaceAlgorithmOptionsVector
Related Functions inherited from openstudio::analysis::DakotaAlgorithmOptions
typedef std::vector < DakotaAlgorithmOptions >	DakotaAlgorithmOptionsVector
typedef boost::optional < DakotaAlgorithmOptions >	OptionalDakotaAlgorithmOptions
Related Functions inherited from openstudio::analysis::AlgorithmOptions
typedef std::vector < AlgorithmOptions >	AlgorithmOptionsVector
typedef boost::optional < AlgorithmOptions >	OptionalAlgorithmOptions

Additional Inherited Members
Protected Member Functions inherited from openstudio::analysis::AlgorithmOptions
void	setAlgorithm (const Algorithm &algorithm)
QVariant	toVariant () const

Detailed Description

PSUADEDaceAlgorithmOptions is a DakotaAlgorithmOptions that defines options specific to PSUADEDaceAlgorithm.

Constructor & Destructor Documentation

openstudio::analysis::PSUADEDaceAlgorithmOptions::PSUADEDaceAlgorithmOptions

(

)

openstudio::analysis::PSUADEDaceAlgorithmOptions::PSUADEDaceAlgorithmOptions ( const std::vector< Attribute > &  options )

explicit

Constructor provided for deserialization; not for general use.

virtual openstudio::analysis::PSUADEDaceAlgorithmOptions::~PSUADEDaceAlgorithmOptions ( )

inlinevirtual

Member Function Documentation

void openstudio::analysis::PSUADEDaceAlgorithmOptions::clearPartitions

(

)

void openstudio::analysis::PSUADEDaceAlgorithmOptions::clearSamples

(

)

void openstudio::analysis::PSUADEDaceAlgorithmOptions::clearSeed

(

)

boost::optional<int> openstudio::analysis::PSUADEDaceAlgorithmOptions::partitions

(

)

const

Returns the user-specified number of partitions to be used if it exists, evaluates to false otherwise.

boost::optional<int> openstudio::analysis::PSUADEDaceAlgorithmOptions::samples

(

)

const

Returns the user-specified number of samples to be used if it exists, evaluates to false otherwise.

boost::optional<int> openstudio::analysis::PSUADEDaceAlgorithmOptions::seed

(

)

const

Returns the explicit pseudo-random number generator seed if it exists, evaluates to false otherwise.

bool openstudio::analysis::PSUADEDaceAlgorithmOptions::setPartitions

(

int

value

)

The number of partitions must be greater than zero.

This value should be odd, though Dakota will automatically correct the value if it is not odd.

bool openstudio::analysis::PSUADEDaceAlgorithmOptions::setSamples

(

int

value

)

The number of samples must be greater than zero.

This value should be an integer multiple of (number of continuous design variables + 1), but if will be automatically adjusted by Dakota if misspecified.

bool openstudio::analysis::PSUADEDaceAlgorithmOptions::setSeed

(

int

value

)

Seed value must be greater than zero.

Friends And Related Function Documentation

typedef boost::optional<PSUADEDaceAlgorithmOptions> OptionalPSUADEDaceAlgorithmOptions

related

typedef std::vector<PSUADEDaceAlgorithmOptions> PSUADEDaceAlgorithmOptionsVector

related