MOOCHO/Thyra Adapter Software  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | List of all members
NLPInterfacePack::NLPFirstOrderThyraModelEvaluator Class Reference

Implement the NLPFirstOrder interface using a Thyra::ModelEvaluator object. More...

#include <NLPInterfacePack_NLPFirstOrderThyraModelEvaluator.hpp>

Inheritance diagram for NLPInterfacePack::NLPFirstOrderThyraModelEvaluator:
Inheritance graph
[legend]

Public Member Functions

 NLPFirstOrderThyraModelEvaluator ()
 Initialize to uninitialized. More...
 
 NLPFirstOrderThyraModelEvaluator (const Teuchos::RCP< Thyra::ModelEvaluator< value_type > > &model, const int p_idx, const int g_idx)
 Calls initialize(). More...
 
void initialize (const Teuchos::RCP< Thyra::ModelEvaluator< value_type > > &model, const int p_idx, const int g_idx)
 .Initialize given a Thyra::ModelEvaluator and a description of how to interpret it. More...
 
- Public Member Functions inherited from NLPInterfacePack::NLPThyraModelEvaluatorBase
 STANDARD_MEMBER_COMPOSITION_MEMBERS (bool, showModelEvaluatorTrace)
 Set if a trace of the model evaluations is shown or not. More...
 
void initialize (bool test_setup)
 
bool is_initialized () const
 
vec_space_ptr_t space_x () const
 
vec_space_ptr_t space_c () const
 
size_type num_bounded_x () const
 
void force_xinit_in_bounds (bool force_xinit_in_bounds)
 
bool force_xinit_in_bounds () const
 
const Vector & xinit () const
 
const Vector & xl () const
 
const Vector & xu () const
 
value_type max_var_bounds_viol () const
 
void set_f (value_type *f)
 
void set_c (VectorMutable *c)
 
void unset_quantities ()
 
void scale_f (value_type scale_f)
 
value_type scale_f () const
 
void report_final_solution (const Vector &x, const Vector *lambda, const Vector *nu, bool optimal)
 
void set_Gf (VectorMutable *Gf)
 

Overridden public members from NLP

void initialize (bool test_setup)
 
void unset_quantities ()
 

Overridden public members from NLPFirstOrder

void set_Gc (MatrixOp *Gc)
 Overridden to check the concrete type of Gc. More...
 
const NLPFirstOrder::mat_fcty_ptr_t factory_Gc () const
 
const basis_sys_ptr_t basis_sys () const
 Returns an ExampleBasisSystem. More...
 

Overridden protected members from NLPFirstOrder

void imp_calc_Gc (const Vector &x, bool newx, const FirstOrderInfo &first_order_info) const
 

Additional Inherited Members

- Protected Member Functions inherited from NLPInterfacePack::NLPThyraModelEvaluatorBase
void evalModel (const Vector &x, bool newx, const ZeroOrderInfo *zero_order_info, const ObjGradInfo *obj_grad_info) const
 
void imp_calc_f (const Vector &x, bool newx, const ZeroOrderInfo &zero_order_info) const
 
void imp_calc_c (const Vector &x, bool newx, const ZeroOrderInfo &zero_order_info) const
 
void imp_calc_Gf (const Vector &x, bool newx, const ObjGradInfo &obj_grad_info) const
 
 NLPThyraModelEvaluatorBase ()
 
void initializeBase (const Teuchos::RCP< Thyra::ModelEvaluator< value_type > > &model, const int p_idx, const int g_idx)
 Initialize given a Thyra::ModelEvaluator and a description of how to interpret it. More...
 
void updateInitialGuessAndBounds () const
 Update the initial guess and bounds . More...
 
void assert_is_initialized () const
 
void copy_from_model_x (const Thyra::VectorBase< value_type > *model_x, VectorMutable *x_D) const
 
void copy_from_model_p (const Thyra::VectorBase< value_type > *model_p, VectorMutable *x_I) const
 
void set_x (const Vector &x, Thyra::ModelEvaluatorBase::InArgs< value_type > *model_inArgs_inout) const
 
void preprocessBaseInOutArgs (const Vector &x, bool newx, const ZeroOrderInfo *zero_order_info, const ObjGradInfo *obj_grad_info, const NLPFirstOrder::FirstOrderInfo *first_order_info, Thyra::ModelEvaluatorBase::InArgs< value_type > *model_inArgs_inout, Thyra::ModelEvaluatorBase::OutArgs< value_type > *model_outArgs_inout, MatrixOp **Gc_out, VectorMutable **Gf_out, value_type **f_out, VectorMutable **c_out) const
 
void postprocessBaseOutArgs (Thyra::ModelEvaluatorBase::OutArgs< value_type > *model_outArgs_inout, VectorMutable *Gf, value_type *f, VectorMutable *c) const
 

Detailed Description

Implement the NLPFirstOrder interface using a Thyra::ModelEvaluator object.

ToDo: Finish documentation!

Definition at line 56 of file NLPInterfacePack_NLPFirstOrderThyraModelEvaluator.hpp.

Constructor & Destructor Documentation

NLPInterfacePack::NLPFirstOrderThyraModelEvaluator::NLPFirstOrderThyraModelEvaluator ( )

Initialize to uninitialized.

Definition at line 65 of file NLPInterfacePack_NLPFirstOrderThyraModelEvaluator.cpp.

NLPInterfacePack::NLPFirstOrderThyraModelEvaluator::NLPFirstOrderThyraModelEvaluator ( const Teuchos::RCP< Thyra::ModelEvaluator< value_type > > &  model,
const int  p_idx,
const int  g_idx 
)

Member Function Documentation

void NLPInterfacePack::NLPFirstOrderThyraModelEvaluator::initialize ( const Teuchos::RCP< Thyra::ModelEvaluator< value_type > > &  model,
const int  p_idx,
const int  g_idx 
)

.Initialize given a Thyra::ModelEvaluator and a description of how to interpret it.

ToDo: Finish documentation!

Todo: Add arguments for auxiliary inequalites and equalities

Definition at line 77 of file NLPInterfacePack_NLPFirstOrderThyraModelEvaluator.cpp.

void NLPInterfacePack::NLPFirstOrderThyraModelEvaluator::initialize ( bool  test_setup)
virtual
void NLPInterfacePack::NLPFirstOrderThyraModelEvaluator::unset_quantities ( )
virtual
void NLPInterfacePack::NLPFirstOrderThyraModelEvaluator::set_Gc ( MatrixOp *  Gc)
virtual

Overridden to check the concrete type of Gc.

Reimplemented from NLPInterfacePack::NLPFirstOrder.

Definition at line 105 of file NLPInterfacePack_NLPFirstOrderThyraModelEvaluator.cpp.

const NLPFirstOrder::mat_fcty_ptr_t NLPInterfacePack::NLPFirstOrderThyraModelEvaluator::factory_Gc ( ) const
virtual
const NLPFirstOrder::basis_sys_ptr_t NLPInterfacePack::NLPFirstOrderThyraModelEvaluator::basis_sys ( ) const
virtual

Returns an ExampleBasisSystem.

Reimplemented from NLPInterfacePack::NLPFirstOrder.

Definition at line 118 of file NLPInterfacePack_NLPFirstOrderThyraModelEvaluator.cpp.

void NLPInterfacePack::NLPFirstOrderThyraModelEvaluator::imp_calc_Gc ( const Vector &  x,
bool  newx,
const FirstOrderInfo first_order_info 
) const
protectedvirtual

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