$extrastylesheet
Dakota  Version 6.2
Public Member Functions
LibraryEnvironment Class Reference

Environment corresponding to execution as an embedded library. More...

Inheritance diagram for LibraryEnvironment:
Environment

List of all members.

Public Member Functions

 LibraryEnvironment ()
 default constructor
 LibraryEnvironment (ProgramOptions prog_opts, bool check_bcast_construct=true, DbCallbackFunctionPtr callback=NULL, void *callback_data=NULL)
 Primary constructor: program options typically specifies an input file or input string. Optionally specify a callback function to be invoked after parsing. Set check_bcast_construct if performing late updates and later calling done_modifying_db().
 LibraryEnvironment (MPI_Comm dakota_mpi_comm, ProgramOptions prog_opts=ProgramOptions(), bool check_bcast_construct=true, DbCallbackFunctionPtr callback=NULL, void *callback_data=NULL)
 Alternate constructor accepting communicator, same options as primary.
 ~LibraryEnvironment ()
 destructor
void insert_nodes (Dakota::DataMethod &dme, Dakota::DataModel &dmo, Dakota::DataVariables &dv, Dakota::DataInterface &di, Dakota::DataResponses &dr)
 Insert DB nodes for a {Method,Model,Variables,Interface,Responses} set.
void done_modifying_db ()
 Check database contents, broadcast, and construct iterators.
bool plugin_interface (const String &model_type, const String &interf_type, const String &an_driver, Interface *plugin_iface)
 Plug-in the passed interface into any interface matching the specified (possibly empty) model, interface, and driver strings; returns true if a plugin was performed.
InterfaceList filtered_interface_list (const String &interf_type, const String &an_driver)
 filter the available Interface instances based on matching interface type and analysis drivers (empty String matches any)
ModelList filtered_model_list (const String &model_type, const String &interf_type, const String &an_driver)
 filter the available Model instances based on matching model type, interface type, and analysis drivers (empty String matches any)

Detailed Description

Environment corresponding to execution as an embedded library.

This environment corresponds to use of Dakota as a library within another application, e.g., within library_mode.cpp. It sets up the ParallelLibrary and ProblemDescDB objects without access to command line arguments.


Constructor & Destructor Documentation

LibraryEnvironment ( ProgramOptions  prog_opts,
bool  check_bcast_construct = true,
DbCallbackFunctionPtr  callback = NULL,
void *  callback_data = NULL 
)

Primary constructor: program options typically specifies an input file or input string. Optionally specify a callback function to be invoked after parsing. Set check_bcast_construct if performing late updates and later calling done_modifying_db().

Construct library environment, optionally performing check/bcast of database and iterator construction

References Environment::construct(), OutputManager::output_startup_message(), Environment::outputManager, and Environment::parse().

LibraryEnvironment ( MPI_Comm  dakota_mpi_comm,
ProgramOptions  prog_opts = ProgramOptions(),
bool  check_bcast_construct = true,
DbCallbackFunctionPtr  callback = NULL,
void *  callback_data = NULL 
)

Alternate constructor accepting communicator, same options as primary.

Construct library environment on passed MPI Comm, optionally performing check/bcast of database and iterator construction. MPI Comm is first argument so client doesn't have to pass all args

References Environment::construct(), OutputManager::output_startup_message(), Environment::outputManager, and Environment::parse().


Member Function Documentation

InterfaceList filtered_interface_list ( const String &  interf_type,
const String &  an_driver 
)

filter the available Interface instances based on matching interface type and analysis drivers (empty String matches any)

This convenience function helps clients locate and plugin to the right Interface instance for simple cases. Pass an empty string to match any instead of a specific instance

References Interface::analysis_drivers(), Dakota::contains(), Interface::interface_type(), ProblemDescDB::model_list(), and Environment::probDescDB.

ModelList filtered_model_list ( const String &  model_type,
const String &  interf_type,
const String &  an_driver 
)

filter the available Model instances based on matching model type, interface type, and analysis drivers (empty String matches any)

This convenience function helps clients locate and plugin to the right Interface instance for cases where the parallel configuration is needed in constructing a parallel plugin. Pass an empty string to match any instead of a specific instance

References Interface::analysis_drivers(), Dakota::contains(), Interface::interface_type(), ProblemDescDB::model_list(), and Environment::probDescDB.

Referenced by parallel_interface_plugin(), LibraryEnvironment::plugin_interface(), run_dakota(), and run_dakota_mixed().


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