ExecutableEnvironment Class Reference

Environment corresponding to execution as a stand-alone application. More...

Inheritance diagram for ExecutableEnvironment:

Public Member Functions
	ExecutableEnvironment ()
	default constructor
	ExecutableEnvironment (int argc, char *argv[])
	constructor
	~ExecutableEnvironment () override
	destructor
void	execute () override
	the run function for the environment: invoke the iterator(s) on the model(s). Called from main.cpp.
Public Member Functions inherited from Environment
	Environment ()
	default constructor: empty envelope More...
	Environment (int argc, char *argv[])
	envelope constructor for ExecutableEnvironment letter More...
	Environment (ProgramOptions prog_opts)
	Environment (MPI_Comm dakota_mpi_comm, ProgramOptions prog_opts=ProgramOptions())
	Environment (const String &env_type)
	envelope constructor for letter type identifed by String More...
	Environment (const Environment &env)
	copy constructor More...
virtual	~Environment ()
	destructor
Environment	operator= (const Environment &env)
	assignment operator
bool	check () const
	Print status of check and return true if in a "check" mode, including version and help. Return false if proceeding to a run mode.
MPIManager &	mpi_manager ()
	return mpiManager
ProgramOptions &	program_options ()
	return programOptions
OutputManager &	output_manager ()
	return outputManager
ParallelLibrary &	parallel_library ()
	return parallelLib
ProblemDescDB &	problem_description_db ()
	return probDescDB
const Variables &	variables_results () const
	return the final environment solution (variables)
const Response &	response_results () const
	return the final environment solution (response)
void	exit_mode (const String &mode="exit")
	allow environment clients to set Dakota exit behavior (throw vs. exit) More...

Additional Inherited Members
Protected Member Functions inherited from Environment
	Environment (BaseConstructor)
	constructor initializes the base class part of default-constructed letters More...
	Environment (BaseConstructor, int argc, char *argv[])
	constructor initializes the base class part of executable letter classes More...
	Environment (BaseConstructor, ProgramOptions prog_opts, MPI_Comm dakota_mpi_comm=MPI_COMM_WORLD)
	constructor initializes the base class part of library letter classes More...
void	preprocess_inputs ()
void	parse (bool check_bcast_database=true, DbCallbackFunctionPtr callback=NULL, void *callback_data=NULL)
	parse inputs, callbacks, and optionally check and broadcast More...
void	construct ()
	Instantiate topLevelIterator.
void	destruct ()
	Deallocate parallel partitioning for topLevelIterator.
bool	assign_model_pointer () const
Protected Attributes inherited from Environment
MPIManager	mpiManager
	the MPI manager instance
ProgramOptions	programOptions
	the command line options manager
OutputManager	outputManager
	(tagged) output stream manager
ParallelLibrary	parallelLib
	the parallel library instance
ProblemDescDB	probDescDB
	the parser database instance
std::shared_ptr< Iterator >	topLevelIterator
	the top level (meta-)iterator
UsageTracker	usageTracker
	tool for Dakota usage tracking (this is a thin wrapper class)

Detailed Description

Environment corresponding to execution as a stand-alone application.

This environment corresponds to a stand-alone executable program, e.g., main.cpp. It sets up the ParallelLibrary, ProgramOptions, and ProblemDescDB objects based on access to command line arguments.

---

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

• ExecutableEnvironment.hpp
• ExecutableEnvironment.cpp