MoochoPack : Framework for Large-Scale Optimization Algorithms Version of the Day
Classes | Public Types | Public Member Functions
MoochoPack::DecompositionSystemStateStepBuilderStd Class Reference

Standard builder object for creating DecompositionSystem, EvalNewPoint Step and other objects and setting up some of the state object. More...

#include <MoochoPack_DecompositionSystemStateStepBuilderStd.hpp>

List of all members.

Classes

struct  SOptionValues
  More...

Public Types

typedef Teuchos::RCP< const
OptionsFromStreamPack::OptionsFromStream
options_ptr_t
 

Public Member Functions

 DecompositionSystemStateStepBuilderStd ()
 
void set_options (const options_ptr_t &options)
 Set the options that will be used to configure the algorithmic objects.
const options_ptr_tget_options () const
 
void process_nlp_and_options (std::ostream *trase_out, NLP &nlp, NLPFirstOrder **nlp_foi, NLPSecondOrder **nlp_soi, NLPDirect **nlp_fod, bool *tailored_approach)
 Process the NLP and process the options passed in from set_options(). Postconditions:
void create_decomp_sys (std::ostream *trase_out, NLP &nlp, NLPFirstOrder *nlp_foi, NLPSecondOrder *nlp_soi, NLPDirect *nlp_fod, bool tailored_approach, Teuchos::RCP< DecompositionSystem > *decomp_sys)
 Create the decomposition system object.
void add_iter_quantities (std::ostream *trase_out, NLP &nlp, NLPFirstOrder *nlp_foi, NLPSecondOrder *nlp_soi, NLPDirect *nlp_fod, bool tailored_approach, const Teuchos::RCP< DecompositionSystem > &decomp_sys, const Teuchos::RCP< NLPAlgoState > &state)
 Add the common iteration quantities to the state object.
void create_eval_new_point (std::ostream *trase_out, NLP &nlp, NLPFirstOrder *nlp_foi, NLPSecondOrder *nlp_soi, NLPDirect *nlp_fod, bool tailored_approach, const Teuchos::RCP< DecompositionSystem > &decomp_sys, Teuchos::RCP< IterationPack::AlgorithmStep > *eval_new_point_step, Teuchos::RCP< CalcFiniteDiffProd > *calc_fd_prod, Teuchos::RCP< VariableBoundsTester > *bounds_tester, Teuchos::RCP< NewDecompositionSelection_Strategy > *new_decomp_selection_strategy)
 Create the EvalNewPoint step object and allocated objects.
SOptionValuescurrent_option_values ()
 Return the current option values being used.

Enums for variaous options categories

enum  ENullSpaceMatrixType
  More...
enum  ERangeSpaceMatrixType
  More...

Detailed Description

Standard builder object for creating DecompositionSystem, EvalNewPoint Step and other objects and setting up some of the state object.

This class is designed to be used by NLPAlgoConfig subclasses based on SQP and performs many different tasks that are common to all of these algorithms.

ToDo: Finish documentation!

Definition at line 65 of file MoochoPack_DecompositionSystemStateStepBuilderStd.hpp.


Member Typedef Documentation


Member Enumeration Documentation


Constructor & Destructor Documentation

MoochoPack::DecompositionSystemStateStepBuilderStd::DecompositionSystemStateStepBuilderStd ( )

Member Function Documentation

void MoochoPack::DecompositionSystemStateStepBuilderStd::set_options ( const options_ptr_t options)

Set the options that will be used to configure the algorithmic objects.

Parameters:
options[in] If NULL then no options will be set. If !=NULL then this is the OptionsFromStream object that will be used to extract the options to use for the algorithm. The state of this object must be maintained by the client until this object is no longer needed.

Definition at line 117 of file MoochoPack_DecompositionSystemStateStepBuilderStd.cpp.

const DecompositionSystemStateStepBuilderStd::options_ptr_t & MoochoPack::DecompositionSystemStateStepBuilderStd::get_options ( ) const
void MoochoPack::DecompositionSystemStateStepBuilderStd::process_nlp_and_options ( std::ostream *  trase_out,
NLP &  nlp,
NLPFirstOrder **  nlp_foi,
NLPSecondOrder **  nlp_soi,
NLPDirect **  nlp_fod,
bool *  tailored_approach 
)

Process the NLP and process the options passed in from set_options(). Postconditions:

ToDo: Finish documentation!

Definition at line 128 of file MoochoPack_DecompositionSystemStateStepBuilderStd.cpp.

void MoochoPack::DecompositionSystemStateStepBuilderStd::create_decomp_sys ( std::ostream *  trase_out,
NLP &  nlp,
NLPFirstOrder *  nlp_foi,
NLPSecondOrder *  nlp_soi,
NLPDirect nlp_fod,
bool  tailored_approach,
Teuchos::RCP< DecompositionSystem > *  decomp_sys 
)

Create the decomposition system object.

ToDo: Finish documentation!

Definition at line 226 of file MoochoPack_DecompositionSystemStateStepBuilderStd.cpp.

void MoochoPack::DecompositionSystemStateStepBuilderStd::add_iter_quantities ( std::ostream *  trase_out,
NLP &  nlp,
NLPFirstOrder *  nlp_foi,
NLPSecondOrder *  nlp_soi,
NLPDirect nlp_fod,
bool  tailored_approach,
const Teuchos::RCP< DecompositionSystem > &  decomp_sys,
const Teuchos::RCP< NLPAlgoState > &  state 
)

Add the common iteration quantities to the state object.

ToDo: Finish documentation!

Definition at line 348 of file MoochoPack_DecompositionSystemStateStepBuilderStd.cpp.

void MoochoPack::DecompositionSystemStateStepBuilderStd::create_eval_new_point ( std::ostream *  trase_out,
NLP &  nlp,
NLPFirstOrder *  nlp_foi,
NLPSecondOrder *  nlp_soi,
NLPDirect nlp_fod,
bool  tailored_approach,
const Teuchos::RCP< DecompositionSystem > &  decomp_sys,
Teuchos::RCP< IterationPack::AlgorithmStep > *  eval_new_point_step,
Teuchos::RCP< CalcFiniteDiffProd > *  calc_fd_prod,
Teuchos::RCP< VariableBoundsTester > *  bounds_tester,
Teuchos::RCP< NewDecompositionSelection_Strategy > *  new_decomp_selection_strategy 
)

Create the EvalNewPoint step object and allocated objects.

ToDo: Finish documentation!

Definition at line 530 of file MoochoPack_DecompositionSystemStateStepBuilderStd.cpp.

DecompositionSystemStateStepBuilderStd::SOptionValues & MoochoPack::DecompositionSystemStateStepBuilderStd::current_option_values ( ) [inline]

Return the current option values being used.

Definition at line 220 of file MoochoPack_DecompositionSystemStateStepBuilderStd.hpp.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends