Inheritance diagram for Model:
Public Member Functions | |
| Model () | |
| default constructor | |
| Model (ProblemDescDB &problem_db) | |
| standard constructor for envelope | |
| Model (const Model &model) | |
| copy constructor | |
| virtual | ~Model () |
| destructor | |
| Model | operator= (const Model &model) |
| assignment operator | |
| virtual Iterator & | subordinate_iterator () |
| return the sub-iterator in nested and surrogate models | |
| virtual Model & | subordinate_model () |
| dive through model recursions that may bypass some components. | |
| virtual Model & | surrogate_model () |
| return the approximation sub-model in surrogate models | |
| virtual Model & | truth_model () |
| return the truth sub-model in surrogate models | |
| virtual void | derived_subordinate_models (ModelList &ml, bool recurse_flag) |
| portion of subordinate_models()() specific to derived model classes | |
| virtual void | update_from_subordinate_model (bool recurse_flag=true) |
| propagate vars/labels/bounds/targets from the bottom up | |
| virtual Interface & | interface () |
| or NestedModel::optionalInterface | |
| virtual void | primary_response_fn_weights (const RealVector &wts, bool recurse_flag=true) |
| squares terms | |
| virtual void | surrogate_bypass (bool bypass_flag) |
| models contained within this model | |
| virtual void | surrogate_function_indices (const IntSet &surr_fn_indices) |
| set the (currently active) surrogate function index set | |
| virtual void | build_approximation () |
| build a new SurrogateModel approximation | |
| virtual bool | build_approximation (const Variables &vars, const Response &response) |
| response at vars | |
| virtual void | update_approximation (bool rebuild_flag) |
| based on data updates propagated elsewhere | |
| virtual void | update_approximation (const Variables &vars, const Response &response, bool rebuild_flag) |
| replace the anchor point data within an existing surrogate | |
| virtual void | update_approximation (const VariablesArray &vars_array, const ResponseArray &resp_array, bool rebuild_flag) |
| replace the data points within an existing surrogate | |
| virtual void | append_approximation (bool rebuild_flag) |
| based on data updates propagated elsewhere | |
| virtual void | append_approximation (const Variables &vars, const Response &response, bool rebuild_flag) |
| append a single point to an existing surrogate's data | |
| virtual void | append_approximation (const VariablesArray &vars_array, const ResponseArray &resp_array, bool rebuild_flag) |
| append multiple points to an existing surrogate's data | |
| virtual void | pop_approximation (bool save_sdp_set) |
| of SurrogateDataPoint set for use in restore_approximation() | |
| virtual void | restore_approximation () |
| restore a previous approximation data state within a surrogate | |
| virtual bool | restore_available () |
| query for whether a trial increment is restorable within a surrogate | |
| virtual void | finalize_approximation () |
| finalize an approximation by applying all previous trial increments | |
| virtual bool | force_rebuild () |
| based on changes in the inactive data | |
| virtual std::vector< Approximation > & | approximations () |
| retrieve the set of Approximations within a DataFitSurrModel | |
| virtual const RealVectorArray & | approximation_coefficients () |
| within a DataFitSurrModel | |
| virtual void | approximation_coefficients (const RealVectorArray &approx_coeffs) |
| a DataFitSurrModel | |
| virtual const RealVector & | approximation_variances (const RealVector &c_vars) |
| Approximation within a DataFitSurrModel. | |
| virtual const SDPList & | approximation_data (size_t index) |
| instance within a DataFitSurrModel | |
| virtual void | compute_correction (const Response &truth_response, const Response &approx_response, const RealVector &c_vars) |
| compute correction factors for use in SurrogateModels | |
| virtual void | auto_correction (bool correction_flag) |
| manages automatic application of correction factors in SurrogateModels | |
| virtual bool | auto_correction () |
| model's responses | |
| virtual void | apply_correction (Response &approx_response, const RealVector &c_vars, bool quiet_flag=false) |
| apply correction factors to approx_response (for use in SurrogateModels) | |
| virtual void | component_parallel_mode (short mode) |
| or 2 (SUB_MODEL/ACTUAL_MODEL/HF_MODEL/TRUTH_MODEL)]. | |
| virtual String | local_eval_synchronization () |
| return derived model synchronization setting | |
| virtual int | local_eval_concurrency () |
| return derived model asynchronous evaluation concurrency | |
| virtual void | serve () |
| a termination message is received from stop_servers(). | |
| virtual void | stop_servers () |
| particular model when iteration on the model is complete. | |
| virtual bool | derived_master_overload () const |
| of trying to run a multiprocessor job on the master. | |
| virtual void | inactive_view (short view, bool recurse_flag=true) |
| update the Model's inactive view based on higher level (nested) context | |
| virtual const String & | interface_id () const |
| return the interface identifier | |
| virtual int | evaluation_id () const |
| Return the current function evaluation id for the Model. | |
| virtual void | set_evaluation_reference () |
| Set the reference points for the evaluation counters within the Model. | |
| virtual void | fine_grained_evaluation_counters () |
| Request fine-grained evaluation reporting within the Model. | |
| virtual void | print_evaluation_summary (std::ostream &s, bool minimal_header=false, bool relative_count=true) const |
| Print an evaluation summary for the Model. | |
| ModelList & | subordinate_models (bool recurse_flag=true) |
| return the sub-models in nested and surrogate models | |
| void | compute_response () |
| Compute the Response at currentVariables (default ActiveSet). | |
| void | compute_response (const ActiveSet &set) |
| Compute the Response at currentVariables (specified ActiveSet). | |
| void | asynch_compute_response () |
| Response at currentVariables (default ActiveSet). | |
| void | asynch_compute_response (const ActiveSet &set) |
| Response at currentVariables (specified ActiveSet). | |
| const IntResponseMap & | synchronize () |
| complete set of results from a group of asynchronous evaluations. | |
| const IntResponseMap & | synchronize_nowait () |
| available results from a group of asynchronous evaluations. | |
| void | init_communicators (const int &max_iterator_concurrency, bool recurse_flag=true) |
| configuration in modelPCIterMap | |
| void | init_serial () |
| modify some default settings to behave properly in serial. | |
| void | set_communicators (const int &max_iterator_concurrency, bool recurse_flag=true) |
| from modelPCIterMap) | |
| void | free_communicators (const int &max_iterator_concurrency, bool recurse_flag=true) |
| deallocate communicator partitions for a model | |
| void | stop_configurations () |
| terminate serve_configurations() on other iteratorComm processors | |
| int | serve_configurations () |
| to balance init_communicators() calls on iteratorComm rank 0 | |
| void | estimate_message_lengths () |
| estimate messageLengths for a model | |
| void | assign_rep (Model *model_rep, bool ref_count_incr=true) |
| replaces existing letter with a new one | |
| size_t | tv () const |
| returns total number of vars | |
| size_t | cv () const |
| returns number of active continuous variables | |
| size_t | div () const |
| returns number of active discrete integer vars | |
| size_t | drv () const |
| returns number of active discrete real vars | |
| size_t | icv () const |
| returns number of inactive continuous variables | |
| size_t | idiv () const |
| returns number of inactive discrete integer vars | |
| size_t | idrv () const |
| returns number of inactive discrete real vars | |
| size_t | acv () const |
| returns total number of continuous variables | |
| size_t | adiv () const |
| returns total number of discrete integer vars | |
| size_t | adrv () const |
| returns total number of discrete real vars | |
| void | active_variables (const Variables &vars) |
| set the active variables in currentVariables | |
| const RealVector & | continuous_variables () const |
| return the active continuous variables from currentVariables | |
| void | continuous_variables (const RealVector &c_vars) |
| set the active continuous variables in currentVariables | |
| void | continuous_variable (const Real &c_var, const size_t &i) |
| set an active continuous variable in currentVariables | |
| const IntVector & | discrete_int_variables () const |
| return the active discrete integer variables from currentVariables | |
| void | discrete_int_variables (const IntVector &d_vars) |
| set the active discrete integer variables in currentVariables | |
| void | discrete_int_variable (const int &d_var, const size_t &i) |
| set an active discrete integer variable in currentVariables | |
| const RealVector & | discrete_real_variables () const |
| return the active discrete real variables from currentVariables | |
| void | discrete_real_variables (const RealVector &d_vars) |
| set the active discrete real variables in currentVariables | |
| void | discrete_real_variable (const Real &d_var, const size_t &i) |
| set an active discrete real variable in currentVariables | |
| UShortMultiArrayConstView | continuous_variable_types () const |
| return the active continuous variable types from currentVariables | |
| UShortMultiArrayConstView | discrete_int_variable_types () const |
| return the active discrete variable types from currentVariables | |
| UShortMultiArrayConstView | discrete_real_variable_types () const |
| return the active discrete variable types from currentVariables | |
| SizetMultiArrayConstView | continuous_variable_ids () const |
| return the active continuous variable identifiers from currentVariables | |
| const RealVector & | inactive_continuous_variables () const |
| return the inactive continuous variables in currentVariables | |
| void | inactive_continuous_variables (const RealVector &i_c_vars) |
| set the inactive continuous variables in currentVariables | |
| const IntVector & | inactive_discrete_int_variables () const |
| return the inactive discrete variables in currentVariables | |
| void | inactive_discrete_int_variables (const IntVector &i_d_vars) |
| set the inactive discrete variables in currentVariables | |
| const RealVector & | inactive_discrete_real_variables () const |
| return the inactive discrete variables in currentVariables | |
| void | inactive_discrete_real_variables (const RealVector &i_d_vars) |
| set the inactive discrete variables in currentVariables | |
| SizetMultiArrayConstView | inactive_continuous_variable_ids () const |
| return the inactive continuous variable identifiers from currentVariables | |
| const RealVector & | all_continuous_variables () const |
| return all continuous variables in currentVariables | |
| void | all_continuous_variables (const RealVector &a_c_vars) |
| set all continuous variables in currentVariables | |
| void | all_continuous_variable (const Real &a_c_var, const size_t &i) |
| set a variable within the all continuous variables in currentVariables | |
| const IntVector & | all_discrete_int_variables () const |
| return all discrete variables in currentVariables | |
| void | all_discrete_int_variables (const IntVector &a_d_vars) |
| set all discrete variables in currentVariables | |
| void | all_discrete_int_variable (const int &a_d_var, const size_t &i) |
| set a variable within the all discrete variables in currentVariables | |
| const RealVector & | all_discrete_real_variables () const |
| return all discrete variables in currentVariables | |
| void | all_discrete_real_variables (const RealVector &a_d_vars) |
| set all discrete variables in currentVariables | |
| void | all_discrete_real_variable (const Real &a_d_var, const size_t &i) |
| set a variable within the all discrete variables in currentVariables | |
| UShortMultiArrayConstView | all_continuous_variable_types () const |
| return all continuous variable types from currentVariables | |
| UShortMultiArrayConstView | all_discrete_int_variable_types () const |
| return all discrete variable types from currentVariables | |
| UShortMultiArrayConstView | all_discrete_real_variable_types () const |
| return all discrete variable types from currentVariables | |
| SizetMultiArrayConstView | all_continuous_variable_ids () const |
| return all continuous variable identifiers from currentVariables | |
| const IntSetArray & | discrete_design_set_int_values () const |
| design set integer variables | |
| void | discrete_design_set_int_values (const IntSetArray &isa) |
| design set integer variables | |
| const RealSetArray & | discrete_design_set_real_values () const |
| design set integer variables | |
| void | discrete_design_set_real_values (const RealSetArray &rsa) |
| design set integer variables | |
| Pecos::DistributionParams & | distribution_parameters () |
| return distribParams | |
| void | distribution_parameters (const Pecos::DistributionParams &dp) |
| set distribParams | |
| const IntSetArray & | discrete_state_set_int_values () const |
| state set integer variables | |
| void | discrete_state_set_int_values (const IntSetArray &isa) |
| state set integer variables | |
| const RealSetArray & | discrete_state_set_real_values () const |
| state set integer variables | |
| void | discrete_state_set_real_values (const RealSetArray &rsa) |
| state set integer variables | |
| StringMultiArrayConstView | continuous_variable_labels () const |
| return the active continuous variable labels from currentVariables | |
| void | continuous_variable_labels (StringMultiArrayConstView c_v_labels) |
| set the active continuous variable labels in currentVariables | |
| StringMultiArrayConstView | discrete_int_variable_labels () const |
| return the active discrete variable labels from currentVariables | |
| void | discrete_int_variable_labels (StringMultiArrayConstView d_v_labels) |
| set the active discrete variable labels in currentVariables | |
| StringMultiArrayConstView | discrete_real_variable_labels () const |
| return the active discrete variable labels from currentVariables | |
| void | discrete_real_variable_labels (StringMultiArrayConstView d_v_labels) |
| set the active discrete variable labels in currentVariables | |
| StringMultiArrayConstView | inactive_continuous_variable_labels () const |
| return the inactive continuous variable labels in currentVariables | |
| void | inactive_continuous_variable_labels (StringMultiArrayConstView i_c_v_labels) |
| set the inactive continuous variable labels in currentVariables | |
| StringMultiArrayConstView | inactive_discrete_int_variable_labels () const |
| return the inactive discrete variable labels in currentVariables | |
| void | inactive_discrete_int_variable_labels (StringMultiArrayConstView i_d_v_labels) |
| set the inactive discrete variable labels in currentVariables | |
| StringMultiArrayConstView | inactive_discrete_real_variable_labels () const |
| return the inactive discrete variable labels in currentVariables | |
| void | inactive_discrete_real_variable_labels (StringMultiArrayConstView i_d_v_labels) |
| set the inactive discrete variable labels in currentVariables | |
| StringMultiArrayConstView | all_continuous_variable_labels () const |
| return all continuous variable labels in currentVariables | |
| void | all_continuous_variable_labels (StringMultiArrayConstView a_c_v_labels) |
| set all continuous variable labels in currentVariables | |
| void | all_continuous_variable_label (const String &a_c_v_label, const size_t &i) |
| set a label within the all continuous labels in currentVariables | |
| StringMultiArrayConstView | all_discrete_int_variable_labels () const |
| return all discrete variable labels in currentVariables | |
| void | all_discrete_int_variable_labels (StringMultiArrayConstView a_d_v_labels) |
| set all discrete variable labels in currentVariables | |
| void | all_discrete_int_variable_label (const String &a_d_v_label, const size_t &i) |
| set a label within the all discrete labels in currentVariables | |
| StringMultiArrayConstView | all_discrete_real_variable_labels () const |
| return all discrete variable labels in currentVariables | |
| void | all_discrete_real_variable_labels (StringMultiArrayConstView a_d_v_labels) |
| set all discrete variable labels in currentVariables | |
| void | all_discrete_real_variable_label (const String &a_d_v_label, const size_t &i) |
| set a label within the all discrete labels in currentVariables | |
| const StringArray & | response_labels () const |
| return the response labels from currentResponse | |
| void | response_labels (const StringArray &resp_labels) |
| set the response labels in currentResponse | |
| const RealVector & | continuous_lower_bounds () const |
| return the active continuous lower bounds from userDefinedConstraints | |
| void | continuous_lower_bounds (const RealVector &c_l_bnds) |
| set the active continuous lower bounds in userDefinedConstraints | |
| const RealVector & | continuous_upper_bounds () const |
| return the active continuous upper bounds from userDefinedConstraints | |
| void | continuous_upper_bounds (const RealVector &c_u_bnds) |
| set the active continuous upper bounds in userDefinedConstraints | |
| const IntVector & | discrete_int_lower_bounds () const |
| return the active discrete lower bounds from userDefinedConstraints | |
| void | discrete_int_lower_bounds (const IntVector &d_l_bnds) |
| set the active discrete lower bounds in userDefinedConstraints | |
| const IntVector & | discrete_int_upper_bounds () const |
| return the active discrete upper bounds from userDefinedConstraints | |
| void | discrete_int_upper_bounds (const IntVector &d_u_bnds) |
| set the active discrete upper bounds in userDefinedConstraints | |
| const RealVector & | discrete_real_lower_bounds () const |
| return the active discrete lower bounds from userDefinedConstraints | |
| void | discrete_real_lower_bounds (const RealVector &d_l_bnds) |
| set the active discrete lower bounds in userDefinedConstraints | |
| const RealVector & | discrete_real_upper_bounds () const |
| return the active discrete upper bounds from userDefinedConstraints | |
| void | discrete_real_upper_bounds (const RealVector &d_u_bnds) |
| set the active discrete upper bounds in userDefinedConstraints | |
| const RealVector & | inactive_continuous_lower_bounds () const |
| return the inactive continuous lower bounds in userDefinedConstraints | |
| void | inactive_continuous_lower_bounds (const RealVector &i_c_l_bnds) |
| set the inactive continuous lower bounds in userDefinedConstraints | |
| const RealVector & | inactive_continuous_upper_bounds () const |
| return the inactive continuous upper bounds in userDefinedConstraints | |
| void | inactive_continuous_upper_bounds (const RealVector &i_c_u_bnds) |
| set the inactive continuous upper bounds in userDefinedConstraints | |
| const IntVector & | inactive_discrete_int_lower_bounds () const |
| return the inactive discrete lower bounds in userDefinedConstraints | |
| void | inactive_discrete_int_lower_bounds (const IntVector &i_d_l_bnds) |
| set the inactive discrete lower bounds in userDefinedConstraints | |
| const IntVector & | inactive_discrete_int_upper_bounds () const |
| return the inactive discrete upper bounds in userDefinedConstraints | |
| void | inactive_discrete_int_upper_bounds (const IntVector &i_d_u_bnds) |
| set the inactive discrete upper bounds in userDefinedConstraints | |
| const RealVector & | inactive_discrete_real_lower_bounds () const |
| return the inactive discrete lower bounds in userDefinedConstraints | |
| void | inactive_discrete_real_lower_bounds (const RealVector &i_d_l_bnds) |
| set the inactive discrete lower bounds in userDefinedConstraints | |
| const RealVector & | inactive_discrete_real_upper_bounds () const |
| return the inactive discrete upper bounds in userDefinedConstraints | |
| void | inactive_discrete_real_upper_bounds (const RealVector &i_d_u_bnds) |
| set the inactive discrete upper bounds in userDefinedConstraints | |
| const RealVector & | all_continuous_lower_bounds () const |
| return all continuous lower bounds in userDefinedConstraints | |
| void | all_continuous_lower_bounds (const RealVector &a_c_l_bnds) |
| set all continuous lower bounds in userDefinedConstraints | |
| void | all_continuous_lower_bound (const Real &a_c_l_bnd, const size_t &i) |
| userDefinedConstraints | |
| const RealVector & | all_continuous_upper_bounds () const |
| return all continuous upper bounds in userDefinedConstraints | |
| void | all_continuous_upper_bounds (const RealVector &a_c_u_bnds) |
| set all continuous upper bounds in userDefinedConstraints | |
| void | all_continuous_upper_bound (const Real &a_c_u_bnd, const size_t &i) |
| userDefinedConstraints | |
| const IntVector & | all_discrete_int_lower_bounds () const |
| return all discrete lower bounds in userDefinedConstraints | |
| void | all_discrete_int_lower_bounds (const IntVector &a_d_l_bnds) |
| set all discrete lower bounds in userDefinedConstraints | |
| void | all_discrete_int_lower_bound (const int &a_d_l_bnd, const size_t &i) |
| userDefinedConstraints | |
| const IntVector & | all_discrete_int_upper_bounds () const |
| return all discrete upper bounds in userDefinedConstraints | |
| void | all_discrete_int_upper_bounds (const IntVector &a_d_u_bnds) |
| set all discrete upper bounds in userDefinedConstraints | |
| void | all_discrete_int_upper_bound (const int &a_d_u_bnd, const size_t &i) |
| userDefinedConstraints | |
| const RealVector & | all_discrete_real_lower_bounds () const |
| return all discrete lower bounds in userDefinedConstraints | |
| void | all_discrete_real_lower_bounds (const RealVector &a_d_l_bnds) |
| set all discrete lower bounds in userDefinedConstraints | |
| void | all_discrete_real_lower_bound (const Real &a_d_l_bnd, const size_t &i) |
| userDefinedConstraints | |
| const RealVector & | all_discrete_real_upper_bounds () const |
| return all discrete upper bounds in userDefinedConstraints | |
| void | all_discrete_real_upper_bounds (const RealVector &a_d_u_bnds) |
| set all discrete upper bounds in userDefinedConstraints | |
| void | all_discrete_real_upper_bound (const Real &a_d_u_bnd, const size_t &i) |
| userDefinedConstraints | |
| size_t | num_linear_ineq_constraints () const |
| return the number of linear inequality constraints | |
| size_t | num_linear_eq_constraints () const |
| return the number of linear equality constraints | |
| const RealMatrix & | linear_ineq_constraint_coeffs () const |
| return the linear inequality constraint coefficients | |
| void | linear_ineq_constraint_coeffs (const RealMatrix &lin_ineq_coeffs) |
| set the linear inequality constraint coefficients | |
| const RealVector & | linear_ineq_constraint_lower_bounds () const |
| return the linear inequality constraint lower bounds | |
| void | linear_ineq_constraint_lower_bounds (const RealVector &lin_ineq_l_bnds) |
| set the linear inequality constraint lower bounds | |
| const RealVector & | linear_ineq_constraint_upper_bounds () const |
| return the linear inequality constraint upper bounds | |
| void | linear_ineq_constraint_upper_bounds (const RealVector &lin_ineq_u_bnds) |
| set the linear inequality constraint upper bounds | |
| const RealMatrix & | linear_eq_constraint_coeffs () const |
| return the linear equality constraint coefficients | |
| void | linear_eq_constraint_coeffs (const RealMatrix &lin_eq_coeffs) |
| set the linear equality constraint coefficients | |
| const RealVector & | linear_eq_constraint_targets () const |
| return the linear equality constraint targets | |
| void | linear_eq_constraint_targets (const RealVector &lin_eq_targets) |
| set the linear equality constraint targets | |
| size_t | num_nonlinear_ineq_constraints () const |
| return the number of nonlinear inequality constraints | |
| size_t | num_nonlinear_eq_constraints () const |
| return the number of nonlinear equality constraints | |
| const RealVector & | nonlinear_ineq_constraint_lower_bounds () const |
| return the nonlinear inequality constraint lower bounds | |
| void | nonlinear_ineq_constraint_lower_bounds (const RealVector &nln_ineq_l_bnds) |
| set the nonlinear inequality constraint lower bounds | |
| const RealVector & | nonlinear_ineq_constraint_upper_bounds () const |
| return the nonlinear inequality constraint upper bounds | |
| void | nonlinear_ineq_constraint_upper_bounds (const RealVector &nln_ineq_u_bnds) |
| set the nonlinear inequality constraint upper bounds | |
| const RealVector & | nonlinear_eq_constraint_targets () const |
| return the nonlinear equality constraint targets | |
| void | nonlinear_eq_constraint_targets (const RealVector &nln_eq_targets) |
| set the nonlinear equality constraint targets | |
| const Variables & | current_variables () const |
| return the current variables (currentVariables) | |
| const Constraints & | user_defined_constraints () const |
| return the user-defined constraints (userDefinedConstraints) | |
| const Response & | current_response () const |
| return the current response (currentResponse) | |
| ProblemDescDB & | problem_description_db () const |
| return the problem description database (probDescDB) | |
| ParallelLibrary & | parallel_library () const |
| return the parallel library (parallelLib) | |
| const String & | model_type () const |
| return the model type (modelType) | |
| const String & | model_id () const |
| return the model identifier (idModel) | |
| size_t | num_functions () const |
| return number of functions in currentResponse | |
| const String & | gradient_type () const |
| return the gradient evaluation type (gradType) | |
| const String & | method_source () const |
| return the numerical gradient evaluation method source (methodSrc) | |
| const String & | interval_type () const |
| return the numerical gradient evaluation interval type (intervalType) | |
| bool | ignore_bounds () const |
| option for ignoring bounds when numerically estimating derivatives | |
| bool | central_hess () const |
| option for using old 2nd-order scheme when computing finite-diff Hessian | |
| const RealVector & | fd_gradient_step_size () const |
| return the finite difference gradient step size (fdGradSS) | |
| const IntList & | gradient_id_analytic () const |
| return the mixed gradient analytic IDs (gradIdAnalytic) | |
| const IntList & | gradient_id_numerical () const |
| return the mixed gradient numerical IDs (gradIdNumerical) | |
| const String & | hessian_type () const |
| return the Hessian evaluation type (hessType) | |
| const String & | quasi_hessian_type () const |
| return the Hessian evaluation type (quasiHessType) | |
| const RealVector & | fd_hessian_by_grad_step_size () const |
| return gradient-based finite difference Hessian step size (fdHessByGradSS) | |
| const RealVector & | fd_hessian_by_fn_step_size () const |
| return function-based finite difference Hessian step size (fdHessByFnSS) | |
| const IntList & | hessian_id_analytic () const |
| return the mixed Hessian analytic IDs (hessIdAnalytic) | |
| const IntList & | hessian_id_numerical () const |
| return the mixed Hessian analytic IDs (hessIdNumerical) | |
| const IntList & | hessian_id_quasi () const |
| return the mixed Hessian analytic IDs (hessIdQuasi) | |
| const RealVector & | primary_response_fn_weights () const |
| squares terms. Used by ConcurrentStrategy for Pareto set optimization. | |
| void | supports_estimated_derivatives (bool sed_flag) |
| set whether this model should perform or pass on derivative estimation | |
| void | init_comms_bcast_flag (bool icb_flag) |
| set initCommsBcastFlag | |
| int | evaluation_capacity () const |
| return the evaluation capacity for use in iterator logic | |
| int | derivative_concurrency () const |
| return the gradient concurrency for use in parallel configuration logic | |
| bool | asynch_flag () const |
| return the asynchronous evaluation flag (asynchEvalFlag) | |
| void | asynch_flag (const bool flag) |
| set the asynchronous evaluation flag (asynchEvalFlag) | |
| short | output_level () const |
| return the outputLevel | |
| void | output_level (const short level) |
| set the outputLevel | |
| const IntArray & | message_lengths () const |
| return the array of MPI packed message buffer lengths (messageLengths) | |
| void | parallel_configuration_iterator (const ParConfigLIter &pc_iter) |
| set modelPCIter | |
| const ParConfigLIter & | parallel_configuration_iterator () const |
| return modelPCIter | |
| void | auto_graphics (const bool flag) |
| the model as opposed to graphics posting at the strategy level). | |
| bool | is_null () const |
| function to check modelRep (does this envelope contain a letter) | |
| Model * | model_rep () const |
| that are not mapped to the top Model level | |
| Real | FDstep1 (FDhelp *, Real h_mag, size_t i) |
| function returning finite-difference step size (affected by bounds) | |
| Real | FDstep2 (FDhelp *, Real h, size_t j) |
| by bounds) | |
Protected Member Functions | |
| Model (BaseConstructor, ProblemDescDB &problem_db) | |
| derived class constructors - Coplien, p. 139) | |
| Model (NoDBBaseConstructor, ParallelLibrary ¶llel_lib, const SharedVariablesData &svd, const ActiveSet &set) | |
| constructed on the fly | |
| Model (RecastBaseConstructor, ProblemDescDB &problem_db, ParallelLibrary ¶llel_lib) | |
| constructed on the fly | |
| virtual void | derived_compute_response (const ActiveSet &set) |
| portion of compute_response() specific to derived model classes | |
| virtual void | derived_asynch_compute_response (const ActiveSet &set) |
| portion of asynch_compute_response() specific to derived model classes | |
| virtual const IntResponseMap & | derived_synchronize () |
| portion of synchronize() specific to derived model classes | |
| virtual const IntResponseMap & | derived_synchronize_nowait () |
| portion of synchronize_nowait() specific to derived model classes | |
| virtual void | derived_init_communicators (const int &max_iterator_concurrency, bool recurse_flag=true) |
| portion of init_communicators() specific to derived model classes | |
| virtual void | derived_init_serial () |
| portion of init_serial() specific to derived model classes | |
| virtual void | derived_set_communicators (const int &max_iterator_concurrency, bool recurse_flag=true) |
| portion of set_communicators() specific to derived model classes | |
| virtual void | derived_free_communicators (const int &max_iterator_concurrency, bool recurse_flag=true) |
| portion of free_communicators() specific to derived model classes | |
Protected Attributes | |
| Variables | currentVariables |
| function evaluations | |
| size_t | numDerivVars |
| corrections where only the active continuous variables are supported) | |
| Response | currentResponse |
| function evaluations | |
| size_t | numFns |
| the number of functions in currentResponse | |
| Constraints | userDefinedConstraints |
| an iterator at startup. | |
| String | modelType |
| type of model: single, nested, or surrogate | |
| String | surrogateType |
| type of surrogate model: local_*, multipoint_*, global_*, or hierarchical | |
| String | gradType |
| grad type: none,numerical,analytic,mixed | |
| String | methodSrc |
| method source: dakota,vendor | |
| String | intervalType |
| interval type: forward,central | |
| bool | ignoreBounds |
| option to ignore bounds when computing finite differences | |
| bool | centralHess |
| option to use old 2nd-order finite diffs for Hessians | |
| RealVector | fdGradSS |
| relative step sizes for numerical gradients | |
| IntList | gradIdAnalytic |
| analytic id's for mixed gradients | |
| IntList | gradIdNumerical |
| numerical id's for mixed gradients | |
| String | hessType |
| Hess type: none,numerical,quasi,analytic,mixed. | |
| String | quasiHessType |
| quasi-Hessian type: bfgs, damped_bfgs, sr1 | |
| RealVector | fdHessByGradSS |
| relative step sizes for numerical Hessians estimated with 1st-order grad differences | |
| RealVector | fdHessByFnSS |
| relative step sizes for numerical Hessians estimated with 2nd-order fn differences | |
| IntList | hessIdAnalytic |
| analytic id's for mixed Hessians | |
| IntList | hessIdNumerical |
| numerical id's for mixed Hessians | |
| IntList | hessIdQuasi |
| quasi id's for mixed Hessians | |
| bool | supportsEstimDerivs |
| whether model should perform or forward derivative estimation | |
| IntArray | messageLengths |
| and PRPair | |
| ProblemDescDB & | probDescDB |
| class member reference to the problem description database | |
| ParallelLibrary & | parallelLib |
| class member reference to the parallel library | |
| ParConfigLIter | modelPCIter |
| the ParallelConfiguration node used by this model instance | |
| short | componentParallelMode |
| (SUB_MODEL/HF_MODEL/TRUTH_MODEL) | |
| bool | asynchEvalFlag |
| flags asynch evaluations (local or distributed) | |
| short | outputLevel |
| output verbosity level: {SILENT,QUIET,NORMAL,VERBOSE,DEBUG}_OUTPUT | |
| IntSetArray | discreteDesignSetIntValues |
| values corresponding to discrete design integer set variable | |
| RealSetArray | discreteDesignSetRealValues |
| values corresponding to discrete design real set variable | |
| Pecos::DistributionParams | distParams |
| container for random variable distribution parameters | |
| IntSetArray | discreteStateSetIntValues |
| values corresponding to discrete state integer set variable | |
| RealSetArray | discreteStateSetRealValues |
| values corresponding to discrete state real set variable | |
| RealVector | primaryRespFnWts |
| multiobjective optimization or weighted least squares) | |
Private Member Functions | |
| Model * | get_model (ProblemDescDB &problem_db) |
| Used by the envelope to instantiate the correct letter class. | |
| int | estimate_derivatives (const ShortArray &map_asv, const ShortArray &fd_grad_asv, const ShortArray &fd_hess_asv, const ShortArray &quasi_hess_asv, const ActiveSet &original_set, const bool asynch_flag) |
| method_source) in the numerical gradient specification. | |
| void | synchronize_derivatives (const Variables &vars, const IntResponseMap &fd_responses, Response &new_response, const ShortArray &fd_grad_asv, const ShortArray &fd_hess_asv, const ShortArray &quasi_hess_asv, const ActiveSet &original_set) |
| objects (fd_grad_responses) into a single response (new_response) | |
| void | update_response (const Variables &vars, Response &new_response, const ShortArray &fd_grad_asv, const ShortArray &fd_hess_asv, const ShortArray &quasi_hess_asv, const ActiveSet &original_set, Response &initial_map_response, const RealMatrix &new_fn_grads, const RealSymMatrixArray &new_fn_hessians) |
| overlay results to update a response object | |
| void | update_quasi_hessians (const Variables &vars, Response &new_response, const ActiveSet &original_set) |
| perform quasi-Newton Hessian updates | |
| bool | manage_asv (const ShortArray &asv_in, ShortArray &map_asv_out, ShortArray &fd_grad_asv_out, ShortArray &fd_hess_asv_out, ShortArray &quasi_hess_asv_out) |
| Coordinates usage of estimate_derivatives() calls based on asv_in. | |
Private Attributes | |
| String | idModel |
| model identifier string from the input file | |
| int | modelEvalId |
| evaluations are assimilated into a single higher level evaluation) | |
| bool | estDerivsFlag |
| asynch_compute_response() | |
| int | evaluationCapacity |
| capacity for concurrent evaluations supported by the Model | |
| std::map< int, ParConfigLIter > | modelPCIterMap |
| level as the lookup key | |
| bool | initCommsBcastFlag |
| init_communicators(); set from Strategy::init_iterator() | |
| bool | modelAutoGraphicsFlag |
| graphics posting at the strategy level) | |
| ModelList | modelList |
| used to collect sub-models for subordinate_models() | |
| VariablesList | varsList |
| synchronize(). | |
| std::list< ShortArray > | asvList |
| asynch_compute_response() to synchronize() | |
| std::list< ActiveSet > | setList |
| asynch_compute_response() to synchronize() | |
| BoolList | initialMapList |
| synchronize_derivatives() | |
| BoolList | dbCaptureList |
| synchronize_derivatives() | |
| ResponseList | dbResponseList |
| synchronize_derivatives() | |
| RealList | deltaList |
| transfers deltas from estimate_derivatives() to synchronize_derivatives() | |
| IntIntMap | numFDEvalsMap |
| responses into numerical gradients. | |
| IntIntMap | rawEvalIdMap |
| for rekeying responseMap. | |
| RealVectorArray | xPrev |
| previous parameter vectors used in computing s for quasi-Newton updates | |
| RealMatrix | fnGradsPrev |
| previous gradient vectors used in computing y for quasi-Newton updates | |
| RealSymMatrixArray | quasiHessians |
| quasi-Newton Hessian approximations | |
| SizetArray | numQuasiUpdates |
| number of quasi-Newton Hessian updates applied | |
| IntResponseMap | responseMap |
| concatenated form. The similar map in Interface contains raw responses. | |
| IntResponseMap | graphicsRespMap |
| to sequential input into the graphics | |
| Model * | modelRep |
| pointer to the letter (initialized only for the envelope) | |
| int | referenceCount |
| number of objects sharing modelRep | |
Classes | |
| struct | FDhelp |
| possibly adjusted for bounds More... | |
The Model class is the base class for one of the primary class hierarchies in DAKOTA. The model hierarchy contains a set of variables, an interface, and a set of responses, and an iterator operates on the model to map the variables into responses using the interface. For memory efficiency and enhanced polymorphism, the model hierarchy employs the "letter/envelope idiom" (see Coplien "Advanced C++", p. 133), for which the base class (Model) serves as the envelope and one of the derived classes (selected in Model::get_model()) serves as the letter.
| Model | ( | ) |
default constructor
The default constructor is used in vector<Model> instantiations and for initialization of Model objects contained in Iterator and derived Strategy classes. modelRep is NULL in this case (a populated problem_db is needed to build a meaningful Model object). This makes it necessary to check for NULL in the copy constructor, assignment operator, and destructor.
| Model | ( | ProblemDescDB & | problem_db | ) |
standard constructor for envelope
Used in model instantiations within strategy constructors. Envelope constructor only needs to extract enough data to properly execute get_model, since Model(BaseConstructor, problem_db) builds the actual base class data for the derived models.
copy constructor
Copy constructor manages sharing of modelRep and incrementing of referenceCount.
| ~Model | ( | ) | [virtual] |
destructor
Destructor decrements referenceCount and only deletes modelRep when referenceCount reaches zero.
| Model | ( | BaseConstructor | , | |
| ProblemDescDB & | problem_db | |||
| ) | [protected] |
derived class constructors - Coplien, p. 139)
This constructor builds the base class data for all inherited models. get_model() instantiates a derived class and the derived class selects this base class constructor in its initialization list (to avoid the recursion of the base class constructor calling get_model() again). Since the letter IS the representation, its representation pointer is set to NULL (an uninitialized pointer causes problems in ~Model).
| Model | ( | RecastBaseConstructor | , | |
| ProblemDescDB & | problem_db, | |||
| ParallelLibrary & | parallel_lib | |||
| ) | [protected] |
constructed on the fly
This constructor also builds the base class data for inherited models. However, it is used for recast models which are instantiated on the fly. Therefore it only initializes a small subset of attributes. Note that parallel_lib is managed separately from problem_db since parallel_lib is needed even in cases where problem_db is an empty envelope (i.e., use of dummy_db in Model(NoDBBaseConstructor) above.
assignment operator
Assignment operator decrements referenceCount for old modelRep, assigns new modelRep, and increments referenceCount for new modelRep.
| Iterator & subordinate_iterator | ( | ) | [virtual] |
return the sub-iterator in nested and surrogate models
return by reference requires use of dummy objects, but is important to allow use of assign_rep() since this operation must be performed on the original envelope object.
Reimplemented in DataFitSurrModel, NestedModel, and RecastModel.
| Model & subordinate_model | ( | ) | [virtual] |
dive through model recursions that may bypass some components.
return by reference requires use of dummy objects, but is important to allow use of assign_rep() since this operation must be performed on the original envelope object.
Reimplemented in NestedModel, RecastModel, and SurrogateModel.
| Model & surrogate_model | ( | ) | [virtual] |
return the approximation sub-model in surrogate models
return by reference requires use of dummy objects, but is important to allow use of assign_rep() since this operation must be performed on the original envelope object.
Reimplemented in DataFitSurrModel, HierarchSurrModel, and RecastModel.
| Model & truth_model | ( | ) | [virtual] |
return the truth sub-model in surrogate models
return by reference requires use of dummy objects, but is important to allow use of assign_rep() since this operation must be performed on the original envelope object.
Reimplemented in DataFitSurrModel, HierarchSurrModel, and RecastModel.
| void update_from_subordinate_model | ( | bool | recurse_flag = true |
) | [virtual] |
propagate vars/labels/bounds/targets from the bottom up
used only for instantiate-on-the-fly model recursions (all RecastModel instantiations and alternate DataFitSurrModel instantiations). Single, Hierarchical, and Nested Models do not redefine the function since they do not support instantiate-on-the-fly. This means that the recursion will stop as soon as it encounters a Model that was instantiated normally, which is appropriate since ProblemDescDB-constructed Models use top-down information flow and do not require bottom-up updating.
Reimplemented in DataFitSurrModel, and RecastModel.
| Interface & interface | ( | ) | [virtual] |
or NestedModel::optionalInterface
return by reference requires use of dummy objects, but is important to allow use of assign_rep() since this operation must be performed on the original envelope object.
Reimplemented in DataFitSurrModel, NestedModel, RecastModel, and SingleModel.
| String local_eval_synchronization | ( | ) | [virtual] |
return derived model synchronization setting
SingleModels and HierarchSurrModels redefine this virtual function. A default value of "synchronous" prevents asynch local operations for:
Reimplemented in RecastModel, and SingleModel.
| int local_eval_concurrency | ( | ) | [virtual] |
return derived model asynchronous evaluation concurrency
SingleModels and HierarchSurrModels redefine this virtual function.
Reimplemented in RecastModel, and SingleModel.
| const String & interface_id | ( | ) | const [virtual] |
return the interface identifier
return by reference requires use of dummy objects, but is important to allow use of assign_rep() since this operation must be performed on the original envelope object.
Reimplemented in DataFitSurrModel, NestedModel, RecastModel, and SingleModel.
| ModelList & subordinate_models | ( | bool | recurse_flag = true |
) |
return the sub-models in nested and surrogate models
since modelList is built with list insertions (using envelope copies), these models may not be used for model.assign_rep() since this operation must be performed on the original envelope object. They may, however, be used for letter-based operations (including assign_rep() on letter contents such as an interface).
| void init_communicators | ( | const int & | max_iterator_concurrency, | |
| bool | recurse_flag = true | |||
| ) |
configuration in modelPCIterMap
The init_communicators() and derived_init_communicators() functions are stuctured to avoid performing the messageLengths estimation more than once. init_communicators() (not virtual) performs the estimation and then forwards the results to derived_init_communicators (virtual) which uses the data in different contexts.
| void init_serial | ( | ) |
modify some default settings to behave properly in serial.
The init_serial() and derived_init_serial() functions are stuctured to separate base class (common) operations from derived class (specialized) operations.
| void estimate_message_lengths | ( | ) |
estimate messageLengths for a model
This functionality has been pulled out of init_communicators() and defined separately so that it may be used in those cases when messageLengths is needed but model.init_communicators() is not called, e.g., for the master processor in the self-scheduling of a concurrent iterator strategy.
| void assign_rep | ( | Model * | model_rep, | |
| bool | ref_count_incr = true | |||
| ) |
replaces existing letter with a new one
Similar to the assignment operator, the assign_rep() function decrements referenceCount for the old modelRep and assigns the new modelRep. It is different in that it is used for publishing derived class letters to existing envelopes, as opposed to sharing representations among multiple envelopes (in particular, assign_rep is passed a letter object and operator= is passed an envelope object). Letter assignment supports two models as governed by ref_count_incr:
| int derivative_concurrency | ( | ) | const |
return the gradient concurrency for use in parallel configuration logic
This function assumes derivatives with respect to the active continuous variables. Therefore, concurrency with respect to the inactive continuous variables is not captured.
| Real FDstep1 | ( | FDhelp * | fdh, | |
| Real | h_mag, | |||
| size_t | j | |||
| ) |
function returning finite-difference step size (affected by bounds)
Auxiliary function to compute forword or first central-difference step size.
| Real FDstep2 | ( | FDhelp * | fdh, | |
| Real | h, | |||
| size_t | j | |||
| ) |
by bounds)
Auxiliary function to second central-difference step size, honoring bounds.
| Model * get_model | ( | ProblemDescDB & | problem_db | ) | [private] |
Used by the envelope to instantiate the correct letter class.
Used only by the envelope constructor to initialize modelRep to the appropriate derived type, as given by the modelType attribute.
| int estimate_derivatives | ( | const ShortArray & | map_asv, | |
| const ShortArray & | fd_grad_asv, | |||
| const ShortArray & | fd_hess_asv, | |||
| const ShortArray & | quasi_hess_asv, | |||
| const ActiveSet & | original_set, | |||
| const bool | asynch_flag | |||
| ) | [private] |
method_source) in the numerical gradient specification.
Estimate derivatives by computing finite difference gradients, finite difference Hessians, and/or quasi-Newton Hessians. The total number of finite difference evaluations is returned for use by synchronize() to track response arrays, and it could be used to improve management of max_function_evaluations within the iterators.
! new logic
| void synchronize_derivatives | ( | const Variables & | vars, | |
| const IntResponseMap & | fd_responses, | |||
| Response & | new_response, | |||
| const ShortArray & | fd_grad_asv, | |||
| const ShortArray & | fd_hess_asv, | |||
| const ShortArray & | quasi_hess_asv, | |||
| const ActiveSet & | original_set | |||
| ) | [private] |
objects (fd_grad_responses) into a single response (new_response)
Merge an array of fd_responses into a single new_response. This function is used both by synchronous compute_response() for the case of asynchronous estimate_derivatives() and by synchronize() for the case where one or more asynch_compute_response() calls has employed asynchronous estimate_derivatives().
!
| void update_response | ( | const Variables & | vars, | |
| Response & | new_response, | |||
| const ShortArray & | fd_grad_asv, | |||
| const ShortArray & | fd_hess_asv, | |||
| const ShortArray & | quasi_hess_asv, | |||
| const ActiveSet & | original_set, | |||
| Response & | initial_map_response, | |||
| const RealMatrix & | new_fn_grads, | |||
| const RealSymMatrixArray & | new_fn_hessians | |||
| ) | [private] |
overlay results to update a response object
Overlay the initial_map_response with numerically estimated new_fn_grads and new_fn_hessians to populate new_response as governed by asv vectors. Quasi-Newton secant Hessian updates are also performed here, since this is where the gradient data needed for the updates is first consolidated. Convenience function used by estimate_derivatives() for the synchronous case and by synchronize_derivatives() for the asynchronous case.
| void update_quasi_hessians | ( | const Variables & | vars, | |
| Response & | new_response, | |||
| const ActiveSet & | original_set | |||
| ) | [private] |
perform quasi-Newton Hessian updates
quasi-Newton updates are performed for approximating response function Hessians using BFGS or SR1 formulations. These Hessians are supported only for the active continuous variables, and a check is performed on the DVV prior to invoking the function.
| bool manage_asv | ( | const ShortArray & | asv_in, | |
| ShortArray & | map_asv_out, | |||
| ShortArray & | fd_grad_asv_out, | |||
| ShortArray & | fd_hess_asv_out, | |||
| ShortArray & | quasi_hess_asv_out | |||
| ) | [private] |
Coordinates usage of estimate_derivatives() calls based on asv_in.
Splits asv_in total request into map_asv_out, fd_grad_asv_out, fd_hess_asv_out, and quasi_hess_asv_out as governed by the responses specification. If the returned use_est_deriv is true, then these asv outputs are used by estimate_derivatives() for the initial map, finite difference gradient evals, finite difference Hessian evals, and quasi-Hessian updates, respectively. If the returned use_est_deriv is false, then only map_asv_out is used.
1.5.1