NLPInterfacePack::NLPDirectThyraModelEvaluator Class Reference

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

#include <NLPInterfacePack_NLPDirectThyraModelEvaluator.hpp>

Inheritance diagram for NLPInterfacePack::NLPDirectThyraModelEvaluator:

List of all members.

Public Member Functions
	STANDARD_COMPOSITION_MEMBERS (Thyra::DirectionalFiniteDiffCalculator< value_type >, objDirecFiniteDiffCalculator)
	Utility object that computes directional finite differences for objective.
	STANDARD_COMPOSITION_MEMBERS (Thyra::DirectionalFiniteDiffCalculator< value_type >, conDirecFiniteDiffCalculator)
	Utility object that computes directional finite differences for constraints.
	STANDARD_MEMBER_COMPOSITION_MEMBERS (bool, DfDp_is_const)
	Set if model.DfDp is constant or not.
	NLPDirectThyraModelEvaluator ()
	Initialize to uninitialized.
	NLPDirectThyraModelEvaluator (const Teuchos::RCP< Thyra::ModelEvaluator< value_type > > &model, const int p_idx, const int g_idx, const objDirecFiniteDiffCalculator_ptr_t objDirecFiniteDiffCalculator=Teuchos::null, const conDirecFiniteDiffCalculator_ptr_t conDirecFiniteDiffCalculator=Teuchos::null)
	Calls initialize().
void	initialize (const Teuchos::RCP< Thyra::ModelEvaluator< value_type > > &model, const int p_idx, const int g_idx, const objDirecFiniteDiffCalculator_ptr_t objDirecFiniteDiffCalculator=Teuchos::null, const conDirecFiniteDiffCalculator_ptr_t conDirecFiniteDiffCalculator=Teuchos::null)
	.Initialize given a Thyra::ModelEvaluator and a description of how to interpret it.
Overridden public members from NLP
void	initialize (bool test_setup)
void	unset_quantities ()
Overridden public members from NLPObjGrad
bool	supports_Gf () const
bool	supports_Gf_prod () const
value_type	calc_Gf_prod (const Vector &x, const Vector &d, bool newx) const
Overridden public members from NLPDirect
Range1D	var_dep () const
Range1D	var_indep () const
const mat_fcty_ptr_t	factory_D () const
const mat_sym_nonsing_fcty_ptr_t	factory_S () const
void	calc_point (const Vector &x, value_type *f, VectorMutable *c, bool recalc_c, VectorMutable *Gf, VectorMutable *py, VectorMutable *rGf, MatrixOp *GcU, MatrixOp *D, MatrixOp *Uz) const
void	calc_semi_newton_step (const Vector &x, VectorMutable *c, bool recalc_c, VectorMutable *py) const

---

Detailed Description

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

ToDo: Finish documentation!

Definition at line 58 of file NLPInterfacePack_NLPDirectThyraModelEvaluator.hpp.

---

Constructor & Destructor Documentation

NLPInterfacePack::NLPDirectThyraModelEvaluator::NLPDirectThyraModelEvaluator

(

)

Initialize to uninitialized.

Definition at line 65 of file NLPInterfacePack_NLPDirectThyraModelEvaluator.cpp.

NLPInterfacePack::NLPDirectThyraModelEvaluator::NLPDirectThyraModelEvaluator	(	const Teuchos::RCP< Thyra::ModelEvaluator< value_type > > &	model,
		const int	p_idx,
		const int	g_idx,
		const objDirecFiniteDiffCalculator_ptr_t	objDirecFiniteDiffCalculator = Teuchos::null,
		const conDirecFiniteDiffCalculator_ptr_t	conDirecFiniteDiffCalculator = Teuchos::null
	)

Calls initialize().

Definition at line 69 of file NLPInterfacePack_NLPDirectThyraModelEvaluator.cpp.

---

Member Function Documentation

NLPInterfacePack::NLPDirectThyraModelEvaluator::STANDARD_COMPOSITION_MEMBERS	(	Thyra::DirectionalFiniteDiffCalculator< value_type >	,
		objDirecFiniteDiffCalculator
	)

Utility object that computes directional finite differences for objective.

NLPInterfacePack::NLPDirectThyraModelEvaluator::STANDARD_COMPOSITION_MEMBERS	(	Thyra::DirectionalFiniteDiffCalculator< value_type >	,
		conDirecFiniteDiffCalculator
	)

Utility object that computes directional finite differences for constraints.

NLPInterfacePack::NLPDirectThyraModelEvaluator::STANDARD_MEMBER_COMPOSITION_MEMBERS	(	bool	,
		DfDp_is_const
	)

Set if model.DfDp is constant or not.

void NLPInterfacePack::NLPDirectThyraModelEvaluator::initialize	(	const Teuchos::RCP< Thyra::ModelEvaluator< value_type > > &	model,
		const int	p_idx,
		const int	g_idx,
		const objDirecFiniteDiffCalculator_ptr_t	objDirecFiniteDiffCalculator = Teuchos::null,
		const conDirecFiniteDiffCalculator_ptr_t	conDirecFiniteDiffCalculator = Teuchos::null
	)

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

ToDo: Finish documentation!

Definition at line 84 of file NLPInterfacePack_NLPDirectThyraModelEvaluator.cpp.

void NLPInterfacePack::NLPDirectThyraModelEvaluator::initialize

(

bool

test_setup

)

[virtual]

Reimplemented from NLPInterfacePack::NLPDirect.

Definition at line 113 of file NLPInterfacePack_NLPDirectThyraModelEvaluator.cpp.

void NLPInterfacePack::NLPDirectThyraModelEvaluator::unset_quantities

(

)

[virtual]

Reimplemented from NLPInterfacePack::NLPThyraModelEvaluatorBase.

Definition at line 123 of file NLPInterfacePack_NLPDirectThyraModelEvaluator.cpp.

bool NLPInterfacePack::NLPDirectThyraModelEvaluator::supports_Gf

(

)

const [virtual]

Reimplemented from NLPInterfacePack::NLPObjGrad.

Definition at line 130 of file NLPInterfacePack_NLPDirectThyraModelEvaluator.cpp.

bool NLPInterfacePack::NLPDirectThyraModelEvaluator::supports_Gf_prod

(

)

const [virtual]

Reimplemented from NLPInterfacePack::NLPObjGrad.

Definition at line 139 of file NLPInterfacePack_NLPDirectThyraModelEvaluator.cpp.

value_type NLPInterfacePack::NLPDirectThyraModelEvaluator::calc_Gf_prod	(	const Vector &	x,
		const Vector &	d,
		bool	newx
	)		const [virtual]

Reimplemented from NLPInterfacePack::NLPObjGrad.

Definition at line 144 of file NLPInterfacePack_NLPDirectThyraModelEvaluator.cpp.

Range1D NLPInterfacePack::NLPDirectThyraModelEvaluator::var_dep

(

)

const [virtual]

Reimplemented from NLPInterfacePack::NLPDirect.

Definition at line 165 of file NLPInterfacePack_NLPDirectThyraModelEvaluator.cpp.

Range1D NLPInterfacePack::NLPDirectThyraModelEvaluator::var_indep

(

)

const [virtual]

Reimplemented from NLPInterfacePack::NLPDirect.

Definition at line 170 of file NLPInterfacePack_NLPDirectThyraModelEvaluator.cpp.

const NLPDirect::mat_fcty_ptr_t NLPInterfacePack::NLPDirectThyraModelEvaluator::factory_D

(

)

const [virtual]

Implements NLPInterfacePack::NLPDirect.

Definition at line 176 of file NLPInterfacePack_NLPDirectThyraModelEvaluator.cpp.

const NLPDirect::mat_sym_nonsing_fcty_ptr_t NLPInterfacePack::NLPDirectThyraModelEvaluator::factory_S

(

)

const [virtual]

Reimplemented from NLPInterfacePack::NLPDirect.

Definition at line 182 of file NLPInterfacePack_NLPDirectThyraModelEvaluator.cpp.

void NLPInterfacePack::NLPDirectThyraModelEvaluator::calc_point	(	const Vector &	x,
		value_type *	f,
		VectorMutable *	c,
		bool	recalc_c,
		VectorMutable *	Gf,
		VectorMutable *	py,
		VectorMutable *	rGf,
		MatrixOp *	GcU,
		MatrixOp *	D,
		MatrixOp *	Uz
	)		const [virtual]

Implements NLPInterfacePack::NLPDirect.

Definition at line 187 of file NLPInterfacePack_NLPDirectThyraModelEvaluator.cpp.

void NLPInterfacePack::NLPDirectThyraModelEvaluator::calc_semi_newton_step	(	const Vector &	x,
		VectorMutable *	c,
		bool	recalc_c,
		VectorMutable *	py
	)		const [virtual]

Implements NLPInterfacePack::NLPDirect.

Definition at line 451 of file NLPInterfacePack_NLPDirectThyraModelEvaluator.cpp.

---

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

• NLPInterfacePack_NLPDirectThyraModelEvaluator.hpp
• NLPInterfacePack_NLPDirectThyraModelEvaluator.cpp