Dakota  Version 7.0
Explore and Predict with Confidence
Public Member Functions | List of all members
ProblemDescDBRep Class Reference

A minimal letter (Rep) class to preserve the existing LO setup. More...

Inheritance diagram for ProblemDescDBRep:
ProblemDescDB

Public Member Functions

 ProblemDescDBRep (int world_size, int world_rank)
 constructor
 
 ~ProblemDescDBRep ()
 destructor
 
- Public Member Functions inherited from ProblemDescDB
 ProblemDescDB ()=default
 default constructor
 
 ProblemDescDB (int world_size, int world_rank)
 standard constructor More...
 
 ProblemDescDB (const ProblemDescDB &db)
 copy constructor More...
 
virtual ~ProblemDescDB ()
 destructor More...
 
ProblemDescDB operator= (const ProblemDescDB &db)
 assignment operator More...
 
void enable_json_input (const String &)
 Enables JSON input.
 
void enable_json_input (const nlohmann::json &)
 Enables validated JSON input from an in-memory study object.
 
void check_input (const UserModes &user_modes)
 verifies that there is at least one of each of the required keywords in the dakota input file
 
void lock ()
 Locks the database in order to prevent data access when the list nodes may not be set properly. Unlocked by a set nodes operation.
 
void unlock ()
 Explicitly unlocks the database. Use with care.
 
void lock_method_db ()
 
void unlock_method_db ()
 
void lock_model_db ()
 
void unlock_model_db ()
 
void lock_variables_db ()
 
void unlock_variables_db ()
 
void lock_interface_db ()
 
void unlock_interface_db ()
 
void lock_responses_db ()
 
void unlock_responses_db ()
 
void set_db_list_nodes (const String &method_tag)
 set method selection based on a method identifier string to activate a particular method specification in method blocks and use pointers from this method specification to set all other subordinate block selections.
 
void set_db_list_nodes (size_t method_index)
 set method selection based on an index within method blocks to activate a particular method specification and use pointers from this method specification to set all other subordinate block selections.
 
void resolve_top_method (bool set_model_nodes=true)
 For a (default) environment lacking a top method pointer, this function is used to determine which of several potential method specifications corresponds to the top method and then sets the list nodes accordingly.
 
void set_db_method_node (const String &method_tag)
 set method selection based on a method identifier string to activate a particular method specification (only).
 
void set_db_method_node (size_t method_index)
 set method selection based on an index within method blocks to activate a particular method specification (only).
 
size_t get_db_method_node ()
 return the index of the active node in method blocks
 
void set_db_model_nodes (const String &model_tag)
 set the model subordinate block selections (model selection, variables selection, interface selection, and responses selection) based on the model identifier string
 
void set_db_model_nodes (size_t model_index)
 set the model subordinate block selections (model selection, variables selection, interface selection, and responses selection) based on an index within model blocks
 
size_t get_db_model_node ()
 return the index of the active node in model blocks
 
size_t get_db_responses_node (const String &responses_tag) const
 
size_t get_db_interface_node (const String &interface_tag) const
 
size_t get_db_variables_node (const String &variables_tag) const
 
int get_active_method_index () const
 Return the active indices of each top-level specification block. These are primarily used to synchronize state with the IR runtime.
 
int get_active_model_index () const
 
int get_active_variables_index () const
 
int get_active_interface_index () const
 
int get_active_responses_index () const
 
void set_db_variables_node (const String &variables_tag)
 set variables selection based on the variables identifier string
 
void set_db_interface_node (const String &interface_tag)
 set interface selection based on the interface identifier string
 
void set_db_responses_node (const String &responses_tag)
 set responses selection based on the responses identifier string
 
std::string_view method_id () const
 return the name of the currently selected method
 
std::string_view model_id () const
 return the name of the currently selected model
 
std::string_view interface_id () const
 return the name of the currently selected interface
 
std::shared_ptr< ProblemDescDB > get_rep () const
 return the dbRep
 
template<typename T >
decltype(auto) get (const std::string &entry_name) const
 
void write_json_dump (const String &output_path) const
 write the full stored ProblemDescDB contents to a JSON file for debugging
 
int min_procs_per_ea ()
 compute minimum evaluation partition size based on lower level overrides
 
int max_procs_per_ea ()
 compute maximum evaluation partition size based on lower level overrides and concurrency levels
 
int min_procs_per_ie ()
 compute minimum iterator partition size based on lower level overrides
 
int max_procs_per_ie (int max_eval_concurrency)
 compute maximum iterator partition size based on lower level overrides and concurrency levels
 
bool method_locked () const
 return methodDBLocked
 
bool model_locked () const
 return modelDBLocked
 
bool variables_locked () const
 return variablesDBLocked
 
bool interface_locked () const
 return interfaceDBLocked
 
bool responses_locked () const
 return responsesDBLocked
 
bool is_null () const
 function to check dbRep (does this envelope contain a letter)
 
bool is_json_null () const
 function to check if IR-backed JSON input is inactive
 
bool has_ir_state () const
 function to check if validated JSON has been materialized into IR state
 
bool has_validated_json () const
 function to check if validated JSON study is available
 
const nlohmann::json & validated_json () const
 access the validated JSON study
 

Additional Inherited Members

- Static Public Member Functions inherited from ProblemDescDB
static int min_procs_per_level (int min_procs_per_server, int pps_spec, int num_serv_spec)
 compute minimum partition size for a parallel level based on lower level overrides
 
static int max_procs_per_level (int max_procs_per_server, int pps_spec, int num_serv_spec, short sched_spec, int asynch_local_conc, bool peer_dynamic_avail, int max_concurrency)
 compute maximum partition size for a parallel level based on lower level overrides
 
- Protected Member Functions inherited from ProblemDescDB
 ProblemDescDB (BaseConstructor, int world_size, int world_rank)
 constructor initializes the base class part of letter classes (BaseConstructor overloading avoids infinite recursion in the derived class constructors - Coplien, p. 139) More...
 

Detailed Description

A minimal letter (Rep) class to preserve the existing LO setup.


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