Model Class Reference

Base class for the model class hierarchy. More...

Inheritance diagram for Model:

NestedModel RecastModel SingleModel SurrogateModel DataFitSurrModel HierarchSurrModel List of all members.

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 Iteratorsubordinate_iterator ()
 return the sub-iterator in nested and surrogate models
virtual Modelsurrogate_model ()
 return the approximation sub-model in surrogate models
virtual Modeltruth_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 Interfaceinterface ()
 or NestedModel::optionalInterface
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 (const Variables &vars, const Response &response, bool rebuild_flag)
 update an existing surrogate model with a new anchor
virtual void update_approximation (const VariablesArray &vars_array, const ResponseArray &resp_array, bool rebuild_flag)
 update an existing surrogate model with new data points
virtual void append_approximation (const Variables &vars, const Response &response, bool rebuild_flag)
 append a single point to an existing surrogate model's data
virtual void append_approximation (const VariablesArray &vars_array, const ResponseArray &resp_array, bool rebuild_flag)
 append multiple points to an existing surrogate model's data
virtual Array< Approximation > & approximations ()
 retrieve the set of Approximations within a DataFitSurrModel
virtual const RealVectorArrayapproximation_coefficients ()
 within a DataFitSurrModel
virtual void approximation_coefficients (const RealVectorArray &approx_coeffs)
 a DataFitSurrModel
virtual void print_coefficients (ostream &s, size_t index) const
 within a DataFitSurrModel
virtual const RealVectorapproximation_variances (const RealVector &c_vars)
 Approximation within a DataFitSurrModel.
virtual const List< SurrogateDataPoint > & 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 const Stringinterface_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 (ostream &s, bool minimal_header=false, bool relative_count=true) const
 Print an evaluation summary for the Model.
ModelListsubordinate_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 ResponseArraysynchronize ()
 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
 return total number of vars
size_t cv () const
 return number of active continuous variables
size_t dv () const
 return number of active discrete variables
size_t icv () const
 return number of inactive continuous variables
size_t idv () const
 return number of inactive discrete variables
size_t acv () const
 return total number of continuous variables
size_t adv () const
 return total number of discrete variables
void active_variables (const Variables &vars)
 set the active variables in currentVariables
const RealVectorcontinuous_variables () const
 return the active continuous variables from currentVariables
void continuous_variables (const RealVector &c_vars)
 set the active continuous variables in currentVariables
const IntVectordiscrete_variables () const
 return the active discrete variables from currentVariables
void discrete_variables (const IntVector &d_vars)
 set the active discrete variables in currentVariables
const StringArraycontinuous_variable_types () const
 return the active continuous variable types from currentVariables
const StringArraydiscrete_variable_types () const
 return the active discrete variable types from currentVariables
const UIntArraycontinuous_variable_ids () const
 return the active continuous variable identifiers from currentVariables
const RealVectorinactive_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 IntVectorinactive_discrete_variables () const
 return the inactive discrete variables in currentVariables
void inactive_discrete_variables (const IntVector &i_d_vars)
 set the inactive discrete variables in currentVariables
const UIntArrayinactive_continuous_variable_ids () const
 return the inactive continuous variable identifiers from currentVariables
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
IntVector all_discrete_variables () const
 return all discrete variables in currentVariables
void all_discrete_variables (const IntVector &a_d_vars)
 set all discrete variables in currentVariables
const StringArrayall_continuous_variable_types () const
 return all continuous variable types from currentVariables
const StringArrayall_discrete_variable_types () const
 return all discrete variable types from currentVariables
const UIntArrayall_continuous_variable_ids () const
 return all continuous variable identifiers from currentVariables
const RealDenseVector & normal_means () const
 return the normal uncertain variable means
void normal_means (const RealDenseVector &n_means)
 set the normal uncertain variable means
const RealDenseVector & normal_std_deviations () const
 return the normal uncertain variable standard deviations
void normal_std_deviations (const RealDenseVector &n_std_devs)
 set the normal uncertain variable standard deviations
const RealDenseVector & normal_lower_bounds () const
 return the normal uncertain variable lower bounds
void normal_lower_bounds (const RealDenseVector &n_lower_bnds)
 set the normal uncertain variable lower bounds
const RealDenseVector & normal_upper_bounds () const
 return the normal uncertain variable upper bounds
void normal_upper_bounds (const RealDenseVector &n_upper_bnds)
 set the normal uncertain variable upper bounds
const RealDenseVector & lognormal_means () const
 return the lognormal uncertain variable means
void lognormal_means (const RealDenseVector &ln_means)
 set the lognormal uncertain variable means
const RealDenseVector & lognormal_std_deviations () const
 return the lognormal uncertain variable standard deviations
void lognormal_std_deviations (const RealDenseVector &ln_std_devs)
 set the lognormal uncertain variable standard deviations
const RealDenseVector & lognormal_error_factors () const
 return the lognormal uncertain variable error factors
void lognormal_error_factors (const RealDenseVector &ln_err_facts)
 set the lognormal uncertain variable error factors
const RealDenseVector & lognormal_lower_bounds () const
 return the lognormal uncertain variable lower bounds
void lognormal_lower_bounds (const RealDenseVector &ln_lower_bnds)
 set the lognormal uncertain variable lower bounds
const RealDenseVector & lognormal_upper_bounds () const
 return the lognormal uncertain variable upper bounds
void lognormal_upper_bounds (const RealDenseVector &ln_upper_bnds)
 set the lognormal uncertain variable upper bounds
const RealDenseVector & uniform_lower_bounds () const
 return the uniform uncertain variable lower bounds
void uniform_lower_bounds (const RealDenseVector &u_lower_bnds)
 set the uniform uncertain variable lower bounds
const RealDenseVector & uniform_upper_bounds () const
 return the uniform uncertain variable upper bounds
void uniform_upper_bounds (const RealDenseVector &u_upper_bnds)
 set the uniform uncertain variable upper bounds
const RealDenseVector & loguniform_lower_bounds () const
 return the loguniform uncertain variable lower bounds
void loguniform_lower_bounds (const RealDenseVector &lu_lower_bnds)
 set the loguniform uncertain variable lower bounds
const RealDenseVector & loguniform_upper_bounds () const
 return the loguniform uncertain variable upper bounds
void loguniform_upper_bounds (const RealDenseVector &lu_upper_bnds)
 set the loguniform uncertain variable upper bounds
const RealDenseVector & triangular_modes () const
 return the triangular uncertain variable modes
void triangular_modes (const RealDenseVector &t_modes)
 set the triangular uncertain variable modes
const RealDenseVector & triangular_lower_bounds () const
 return the triangular uncertain variable lower bounds
void triangular_lower_bounds (const RealDenseVector &t_lower_bnds)
 set the triangular uncertain variable lower bounds
const RealDenseVector & triangular_upper_bounds () const
 return the triangular uncertain variable upper bounds
void triangular_upper_bounds (const RealDenseVector &t_upper_bnds)
 set the triangular uncertain variable upper bounds
const RealDenseVector & exponential_betas () const
 return the exponential uncertain variable beta parameters
void exponential_betas (const RealDenseVector &e_betas)
 set the exponential uncertain variable beta parameters
const RealDenseVector & beta_alphas () const
 return the beta uncertain variable alphas
void beta_alphas (const RealDenseVector &b_alphas)
 set the beta uncertain variable alphas
const RealDenseVector & beta_betas () const
 return the beta uncertain variable betas
void beta_betas (const RealDenseVector &b_betas)
 set the beta uncertain variable betas
const RealDenseVector & beta_lower_bounds () const
 return the beta uncertain variable lower bounds
void beta_lower_bounds (const RealDenseVector &b_lower_bnds)
 set the beta uncertain variable lower bounds
const RealDenseVector & beta_upper_bounds () const
 return the beta uncertain variable upper bounds
void beta_upper_bounds (const RealDenseVector &b_upper_bnds)
 set the beta uncertain variable upper bounds
const RealDenseVector & gamma_alphas () const
 return the gamma uncertain variable alpha parameters
void gamma_alphas (const RealDenseVector &ga_alphas)
 set the gamma uncertain variable alpha parameters
const RealDenseVector & gamma_betas () const
 return the gamma uncertain variable beta parameters
void gamma_betas (const RealDenseVector &ga_betas)
 set the gamma uncertain variable beta parameters
const RealDenseVector & gumbel_alphas () const
 return the gumbel uncertain variable alphas
void gumbel_alphas (const RealDenseVector &gu_alphas)
 set the gumbel uncertain variable alphas
const RealDenseVector & gumbel_betas () const
 return the gumbel uncertain variable betas
void gumbel_betas (const RealDenseVector &gu_betas)
 set the gumbel uncertain variable betas
const RealDenseVector & frechet_alphas () const
 return the frechet uncertain variable alpha parameters
void frechet_alphas (const RealDenseVector &f_alphas)
 set the frechet uncertain variable alpha parameters
const RealDenseVector & frechet_betas () const
 return the frechet uncertain variable beta parameters
void frechet_betas (const RealDenseVector &f_betas)
 set the frechet uncertain variable beta parameters
const RealDenseVector & weibull_alphas () const
 return the weibull uncertain variable alpha parameters
void weibull_alphas (const RealDenseVector &w_alphas)
 set the weibull uncertain variable alpha parameters
const RealDenseVector & weibull_betas () const
 return the weibull uncertain variable beta parameters
void weibull_betas (const RealDenseVector &w_betas)
 set the weibull uncertain variable beta parameters
const RealDenseVectorArrayhistogram_bin_pairs () const
 return the histogram uncertain bin pairs
void histogram_bin_pairs (const RealDenseVectorArray &h_bin_pairs)
 set the histogram uncertain bin pairs
const RealDenseVectorArrayhistogram_point_pairs () const
 return the histogram uncertain point pairs
void histogram_point_pairs (const RealDenseVectorArray &h_pt_pairs)
 set the histogram uncertain point pairs
const RealDenseVectorArrayinterval_probabilities () const
 return the interval basic probability values
void interval_probabilities (const RealDenseVectorArray &int_probs)
 set the interval basic probability values
const RealDenseVectorArrayinterval_bounds () const
 return the interval bounds
void interval_bounds (const RealDenseVectorArray &int_bounds)
 set the interval bounds
const RealSymDenseMatrix & uncertain_correlations () const
 return the uncertain variable correlations
void uncertain_correlations (const RealSymDenseMatrix &uncertain_corr)
 set the uncertain variable correlations
const StringArraycontinuous_variable_labels () const
 return the active continuous variable labels from currentVariables
void continuous_variable_labels (const StringArray &c_v_labels)
 set the active continuous variable labels in currentVariables
const StringArraydiscrete_variable_labels () const
 return the active discrete variable labels from currentVariables
void discrete_variable_labels (const StringArray &d_v_labels)
 set the active discrete variable labels in currentVariables
const StringArrayinactive_continuous_variable_labels () const
 return the inactive continuous variable labels in currentVariables
void inactive_continuous_variable_labels (const StringArray &i_c_v_labels)
 set the inactive continuous variable labels in currentVariables
const StringArrayinactive_discrete_variable_labels () const
 return the inactive discrete variable labels in currentVariables
void inactive_discrete_variable_labels (const StringArray &i_d_v_labels)
 set the inactive discrete variable labels in currentVariables
StringArray all_continuous_variable_labels () const
 return all continuous variable labels in currentVariables
void all_continuous_variable_labels (const StringArray &a_c_v_labels)
 set all continuous variable labels in currentVariables
StringArray all_discrete_variable_labels () const
 return all discrete variable labels in currentVariables
void all_discrete_variable_labels (const StringArray &a_d_v_labels)
 set all discrete variable labels in currentVariables
const StringArrayresponse_labels () const
 return the response labels from currentResponse
void response_labels (const StringArray &resp_labels)
 set the response labels in currentResponse
const RealVectorcontinuous_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 RealVectorcontinuous_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 IntVectordiscrete_lower_bounds () const
 return the active discrete lower bounds from userDefinedConstraints
void discrete_lower_bounds (const IntVector &d_l_bnds)
 set the active discrete lower bounds in userDefinedConstraints
const IntVectordiscrete_upper_bounds () const
 return the active discrete upper bounds from userDefinedConstraints
void discrete_upper_bounds (const IntVector &d_u_bnds)
 set the active discrete upper bounds in userDefinedConstraints
const RealVectorinactive_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 RealVectorinactive_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 IntVectorinactive_discrete_lower_bounds () const
 return the inactive discrete lower bounds in userDefinedConstraints
void inactive_discrete_lower_bounds (const IntVector &i_d_l_bnds)
 set the inactive discrete lower bounds in userDefinedConstraints
const IntVectorinactive_discrete_upper_bounds () const
 return the inactive discrete upper bounds in userDefinedConstraints
void inactive_discrete_upper_bounds (const IntVector &i_d_u_bnds)
 set the inactive discrete upper bounds in userDefinedConstraints
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
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
IntVector all_discrete_lower_bounds () const
 return all discrete lower bounds in userDefinedConstraints
void all_discrete_lower_bounds (const IntVector &a_d_l_bnds)
 set all discrete lower bounds in userDefinedConstraints
IntVector all_discrete_upper_bounds () const
 return all discrete upper bounds in userDefinedConstraints
void all_discrete_upper_bounds (const IntVector &a_d_u_bnds)
 set all discrete upper bounds in 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 RealMatrixlinear_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 RealVectorlinear_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 RealVectorlinear_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 RealMatrixlinear_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 RealVectorlinear_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 RealVectornonlinear_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 RealVectornonlinear_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 RealVectornonlinear_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 UIntArraymerged_discrete_ids