![]() |
Dakota
Version 7.0
Explore and Predict with Confidence
|
Owns runtime services and factories for a library-mode study. More...
Classes | |
| class | MethodFactory |
| Constructs methods using an owning Study's runtime services. More... | |
| class | ModelFactory |
| Constructs models using an owning Study's runtime services. More... | |
Public Member Functions | |
| Study (const StudyConfig &config=StudyConfig{}) | |
| Construct a serial study context. More... | |
| Study (MPI_Comm dakota_mpi_comm, const StudyConfig &config=StudyConfig{}) | |
| Construct a study on an application-supplied MPI communicator. More... | |
| ~Study () | |
| Release the study context after all constructed components are finished. | |
| std::shared_ptr< StudyServices > | services () const |
| Return the shared service bundle used by constructed components. | |
| std::shared_ptr< ParallelLibrary > | parallel_library () const |
| Return the parallel runtime owned by this study. | |
| std::shared_ptr< OutputManager > | output_manager () const |
| Return the output manager owned by this study. | |
| std::shared_ptr< RunOptions > | run_options () const |
| Return the configured execution-phase options. | |
| Variables | variables (const IRStore &variables_store) const |
| Construct variables from materialized input representation. More... | |
| Variables | variables (const nlohmann::json &variables_json) const |
| Validate and construct variables from a JSON block fragment. More... | |
| Response | responses (const IRStore &responses_store, const Variables &variables) const |
| Construct responses from materialized input representation. More... | |
| Response | responses (const nlohmann::json &responses_json, const Variables &variables) const |
| Validate and construct responses from a JSON block fragment. More... | |
| std::shared_ptr< Interface > | interface (const IRStore &interface_store) const |
| Construct an interface from materialized input representation. More... | |
| std::shared_ptr< Interface > | interface (const nlohmann::json &interface_json) const |
| Validate and construct an interface from a JSON block fragment. More... | |
| MethodFactory | method () const |
| Return a method factory tied to this study's runtime services. | |
| ModelFactory | model () const |
| Return a model factory tied to this study's runtime services. | |
| void | run (Iterator &iterator) const |
| Execute a top-level iterator. More... | |
| void | run (const std::shared_ptr< Iterator > &iterator) const |
| Execute a shared top-level iterator. More... | |
Private Member Functions | |
| Study (std::shared_ptr< MPIManager > mpi_manager, const StudyConfig &config) | |
Private Attributes | |
| std::shared_ptr< MPIManager > | mpiManager |
| std::shared_ptr< ProgramOptions > | programOptions |
| std::shared_ptr< OutputManager > | outputManager |
| std::shared_ptr< RunOptions > | runOptions |
| std::shared_ptr< ParallelLibrary > | parallelLibrary |
| std::shared_ptr< StudyServices > | studyServices |
| std::shared_ptr< StudyRuntime > | studyRuntime |
Owns runtime services and factories for a library-mode study.
Construct variables, responses, interfaces, models, and methods from the leaves inward, then pass the top-level Iterator to run(). The Study must outlive every component constructed from it. Components from different Study instances may have incompatible runtime services and must not be combined.
|
explicit |
Construct a serial study context.
| config | Output and execution-phase settings. |
| Study | ( | MPI_Comm | dakota_mpi_comm, |
| const StudyConfig & | config = StudyConfig{} |
||
| ) |
Construct a study on an application-supplied MPI communicator.
| dakota_mpi_comm | Communicator used by Dakota; ownership remains with the caller. |
| config | Output and execution-phase settings. |
Construct variables from materialized input representation.
| variables_store | Materialized variables block. |
Referenced by Study::ModelFactory::active_subspace(), Study::ModelFactory::adapted_basis(), Study::ModelFactory::ensemble_surrogate(), Study::ModelFactory::global_surrogate(), Study::ModelFactory::local_surrogate(), Study::ModelFactory::multipoint_surrogate(), Study::ModelFactory::nested(), Study::ModelFactory::random_field(), Study::responses(), Study::ModelFactory::single(), and Study::variables().
| Variables variables | ( | const nlohmann::json & | variables_json | ) | const |
Validate and construct variables from a JSON block fragment.
| variables_json | Children of a variables block, without a top-level wrapper. |
| std::exception | if validation or materialization fails. |
References Study::variables().
Construct responses from materialized input representation.
| responses_store | Materialized responses block. |
| variables | Variables whose active view determines response derivatives. |
References Study::variables().
Referenced by Study::responses().
Validate and construct responses from a JSON block fragment.
| responses_json | Children of a responses block, without a top-level wrapper. |
| variables | Variables whose active view determines response derivatives. |
| std::exception | if validation or materialization fails. |
References Study::responses(), and Study::variables().
Construct an interface from materialized input representation.
| interface_store | Materialized interface block. |
| std::runtime_error | if the interface type is not supported by the DI API. |
Referenced by Study::interface(), and Study::ModelFactory::single().
| std::shared_ptr< Interface > interface | ( | const nlohmann::json & | interface_json | ) | const |
Validate and construct an interface from a JSON block fragment.
| interface_json | Children of an interface block, without a top-level wrapper. |
| std::exception | if validation, materialization, or construction fails. |
References Study::interface().
| void run | ( | Iterator & | iterator | ) | const |
Execute a top-level iterator.
| iterator | Iterator constructed with compatible study services. |
Referenced by Study::run().
| void run | ( | const std::shared_ptr< Iterator > & | iterator | ) | const |
Execute a shared top-level iterator.
| iterator | Non-null iterator constructed with compatible study services. |
| std::runtime_error | if iterator is null. |
References Study::run().