Concrete class implementing several nonlinear CG algorithms. More...

#include <OptiPack_NonlinearCG_decl.hpp>

Inheritance diagram for OptiPack::NonlinearCG< Scalar >:

Public Types
typedef ScalarTraits< Scalar >::magnitudeType	ScalarMag

Private Attributes
RCP< const Thyra::ModelEvaluator< Scalar > >	model_

int	paramIndex_

int	responseIndex_

RCP< GlobiPack::LineSearchBase< Scalar > >	linesearch_

NonlinearCGUtils::ESolverTypes	solverType_

ScalarMag	alpha_init_

bool	alpha_reinit_

bool	and_conv_tests_

int	minIters_

int	maxIters_

ScalarMag	g_reduct_tol_

ScalarMag	g_grad_tol_

ScalarMag	g_mag_

int	numIters_

Static Private Attributes
static RCP< Teuchos::ParameterEntryValidator >	solverType_validator_ = Teuchos::null

Related Functions
(Note that these are not member functions.)
template<typename Scalar >
const RCP< NonlinearCG< Scalar > >	nonlinearCG ()
	Nonmember constructor. More...

template<typename Scalar >
const RCP< NonlinearCG< Scalar > >	nonlinearCG (const RCP< const Thyra::ModelEvaluator< Scalar > > &model, const int paramIndex, const int responseIndex, const RCP< GlobiPack::LineSearchBase< Scalar > > &linesearch)
	Nonmember constructor. More...

Constructor/Initializers/Accessors
	NonlinearCG ()
	Construct with default parameters. More...

void	initialize (const RCP< const Thyra::ModelEvaluator< Scalar > > &model, const int paramIndex, const int responseIndex, const RCP< GlobiPack::LineSearchBase< Scalar > > &linesearch)
	Initialize. More...

NonlinearCGUtils::ESolverTypes	get_solverType () const

ScalarMag	get_alpha_init () const

bool	get_alpha_reinit () const

bool	get_and_conv_tests () const

int	get_minIters () const

int	get_maxIters () const

ScalarMag	get_g_reduct_tol () const

ScalarMag	get_g_grad_tol () const

ScalarMag	get_g_mag () const

Overridden from ParameterListAcceptor (simple forwarding functions)
void	setParameterList (RCP< ParameterList > const &paramList)

RCP< const ParameterList >	getValidParameters () const

Solve.
NonlinearCGUtils::ESolveReturn	doSolve (const Ptr< Thyra::VectorBase< Scalar > > &p, const Ptr< ScalarMag > &g_opt, const Ptr< const ScalarMag > &g_reduct_tol=Teuchos::null, const Ptr< const ScalarMag > &g_grad_tol=Teuchos::null, const Ptr< const ScalarMag > &alpha_init=Teuchos::null, const Ptr< int > &numIters=Teuchos::null)
	Perform a solve. More...

Additional Inherited Members
Public Member Functions inherited from Teuchos::Describable
DescribableStreamManipulatorState	describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default)

std::ostream &	operator<< (std::ostream &os, const DescribableStreamManipulatorState &d)

virtual std::string	description () const

virtual void	describe (FancyOStream &out, const EVerbosityLevel verbLevel=verbLevel_default) const

void	describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const

virtual	~Describable ()

DescribableStreamManipulatorState	describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default)

std::ostream &	operator<< (std::ostream &os, const DescribableStreamManipulatorState &d)

virtual std::string	description () const

virtual void	describe (FancyOStream &out, const EVerbosityLevel verbLevel=verbLevel_default) const

void	describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const

virtual	~Describable ()

Public Member Functions inherited from Teuchos::LabeledObject
	LabeledObject ()

virtual	~LabeledObject ()

virtual void	setObjectLabel (const std::string &objectLabel)

virtual std::string	getObjectLabel () const

	LabeledObject ()

virtual	~LabeledObject ()

virtual void	setObjectLabel (const std::string &objectLabel)

virtual std::string	getObjectLabel () const

Public Member Functions inherited from Teuchos::VerboseObject< NonlinearCG< Scalar > >
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT RCP< const ParameterList >	getValidVerboseObjectSublist ()

TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT RCP< const ParameterList >	getValidVerboseObjectSublist ()

TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void	setupVerboseObjectSublist (ParameterList *paramList)

TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void	setupVerboseObjectSublist (ParameterList *paramList)

TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void	readVerboseObjectSublist (ParameterList paramList, RCP< FancyOStream > oStream, EVerbosityLevel *verbLevel)

void	readVerboseObjectSublist (ParameterList paramList, VerboseObject< NonlinearCG< Scalar > > verboseObject)

TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void	readVerboseObjectSublist (ParameterList paramList, RCP< FancyOStream > oStream, EVerbosityLevel *verbLevel)

void	readVerboseObjectSublist (ParameterList paramList, VerboseObject< NonlinearCG< Scalar > > verboseObject)

	VerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null)

	VerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null)

virtual const VerboseObject &	setVerbLevel (const EVerbosityLevel verbLevel) const

virtual const VerboseObject &	setVerbLevel (const EVerbosityLevel verbLevel) const

virtual const VerboseObject &	setOverridingVerbLevel (const EVerbosityLevel verbLevel) const

virtual const VerboseObject &	setOverridingVerbLevel (const EVerbosityLevel verbLevel) const

virtual EVerbosityLevel	getVerbLevel () const

virtual EVerbosityLevel	getVerbLevel () const

Public Member Functions inherited from Teuchos::VerboseObjectBase
virtual	~VerboseObjectBase ()

	VerboseObjectBase (const RCP< FancyOStream > &oStream=Teuchos::null)

virtual const VerboseObjectBase &	setOStream (const RCP< FancyOStream > &oStream) const

virtual const VerboseObjectBase &	setOverridingOStream (const RCP< FancyOStream > &oStream) const

virtual VerboseObjectBase &	setLinePrefix (const std::string &linePrefix)

virtual RCP< FancyOStream >	getOStream () const

virtual RCP< FancyOStream >	getOverridingOStream () const

virtual std::string	getLinePrefix () const

virtual OSTab	getOSTab (const int tabs=1, const std::string &linePrefix="") const

virtual	~VerboseObjectBase ()

	VerboseObjectBase (const RCP< FancyOStream > &oStream=Teuchos::null)

virtual const VerboseObjectBase &	setOStream (const RCP< FancyOStream > &oStream) const

virtual const VerboseObjectBase &	setOverridingOStream (const RCP< FancyOStream > &oStream) const

virtual VerboseObjectBase &	setLinePrefix (const std::string &linePrefix)

virtual RCP< FancyOStream >	getOStream () const

virtual RCP< FancyOStream >	getOverridingOStream () const

virtual std::string	getLinePrefix () const

virtual OSTab	getOSTab (const int tabs=1, const std::string &linePrefix="") const

Public Member Functions inherited from Teuchos::ParameterListAcceptorDefaultBase
RCP< ParameterList >	getNonconstParameterList ()

RCP< ParameterList >	unsetParameterList ()

RCP< const ParameterList >	getParameterList () const

RCP< ParameterList >	getNonconstParameterList ()

RCP< ParameterList >	unsetParameterList ()

RCP< const ParameterList >	getParameterList () const

Public Member Functions inherited from Teuchos::ParameterListAcceptor
virtual	~ParameterListAcceptor ()

virtual void	setParameterList (const RCP< ParameterList > &paramList)=0

virtual RCP< const DependencySheet >	getDependencies () const

virtual	~ParameterListAcceptor ()

virtual void	setParameterList (const RCP< ParameterList > &paramList)=0

virtual RCP< const DependencySheet >	getDependencies () const

Static Public Member Functions inherited from Teuchos::VerboseObject< NonlinearCG< Scalar > >
static void	setDefaultVerbLevel (const EVerbosityLevel defaultVerbLevel)

static void	setDefaultVerbLevel (const EVerbosityLevel defaultVerbLevel)

static EVerbosityLevel	getDefaultVerbLevel ()

static EVerbosityLevel	getDefaultVerbLevel ()

Static Public Member Functions inherited from Teuchos::VerboseObjectBase
static void	setDefaultOStream (const RCP< FancyOStream > &defaultOStream)

static RCP< FancyOStream >	getDefaultOStream ()

static void	setDefaultOStream (const RCP< FancyOStream > &defaultOStream)

static RCP< FancyOStream >	getDefaultOStream ()

Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel	verbLevel_default

Protected Member Functions inherited from Teuchos::VerboseObject< NonlinearCG< Scalar > >
void	initializeVerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null)

void	initializeVerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null)

Protected Member Functions inherited from Teuchos::VerboseObjectBase
void	initializeVerboseObjectBase (const RCP< FancyOStream > &oStream=Teuchos::null)

virtual void	informUpdatedVerbosityState () const

void	initializeVerboseObjectBase (const RCP< FancyOStream > &oStream=Teuchos::null)

virtual void	informUpdatedVerbosityState () const

Protected Member Functions inherited from Teuchos::ParameterListAcceptorDefaultBase
void	setMyParamList (const RCP< ParameterList > &paramList)

RCP< ParameterList >	getMyNonconstParamList ()

RCP< const ParameterList >	getMyParamList () const

void	setMyParamList (const RCP< ParameterList > &paramList)

RCP< ParameterList >	getMyNonconstParamList ()

RCP< const ParameterList >	getMyParamList () const

Detailed Description

template<typename Scalar>
class OptiPack::NonlinearCG< Scalar >

Concrete class implementing several nonlinear CG algorithms.

ToDo: Finish Documentation!

Definition at line 88 of file OptiPack_NonlinearCG_decl.hpp.

Member Typedef Documentation

◆ ScalarMag

template<typename Scalar>

typedef ScalarTraits<Scalar>::magnitudeType OptiPack::NonlinearCG< Scalar >::ScalarMag

Definition at line 96 of file OptiPack_NonlinearCG_decl.hpp.

Constructor & Destructor Documentation

◆ NonlinearCG()

template<typename Scalar >

OptiPack::NonlinearCG< Scalar >::NonlinearCG ( )

Construct with default parameters.

Definition at line 70 of file OptiPack_NonlinearCG_def.hpp.

Member Function Documentation

◆ initialize()

template<typename Scalar>

void OptiPack::NonlinearCG< Scalar >::initialize	(	const RCP< const Thyra::ModelEvaluator< Scalar > > &	model,
		const int	paramIndex,
		const int	responseIndex,
		const RCP< GlobiPack::LineSearchBase< Scalar > > &	linesearch
	)

Initialize.

Definition at line 87 of file OptiPack_NonlinearCG_def.hpp.

◆ get_solverType()

template<typename Scalar >

NonlinearCGUtils::ESolverTypes OptiPack::NonlinearCG< Scalar >::get_solverType ( ) const

Definition at line 103 of file OptiPack_NonlinearCG_def.hpp.

◆ get_alpha_init()

template<typename Scalar >

NonlinearCG< Scalar >::ScalarMag OptiPack::NonlinearCG< Scalar >::get_alpha_init ( ) const

Definition at line 111 of file OptiPack_NonlinearCG_def.hpp.

◆ get_alpha_reinit()

template<typename Scalar >

bool OptiPack::NonlinearCG< Scalar >::get_alpha_reinit ( ) const

Definition at line 118 of file OptiPack_NonlinearCG_def.hpp.

◆ get_and_conv_tests()

template<typename Scalar >

bool OptiPack::NonlinearCG< Scalar >::get_and_conv_tests ( ) const

Definition at line 125 of file OptiPack_NonlinearCG_def.hpp.

◆ get_minIters()

template<typename Scalar >

int OptiPack::NonlinearCG< Scalar >::get_minIters ( ) const

Definition at line 132 of file OptiPack_NonlinearCG_def.hpp.

◆ get_maxIters()

template<typename Scalar >

int OptiPack::NonlinearCG< Scalar >::get_maxIters ( ) const

Definition at line 139 of file OptiPack_NonlinearCG_def.hpp.

◆ get_g_reduct_tol()

template<typename Scalar >

NonlinearCG< Scalar >::ScalarMag OptiPack::NonlinearCG< Scalar >::get_g_reduct_tol ( ) const

Definition at line 147 of file OptiPack_NonlinearCG_def.hpp.

◆ get_g_grad_tol()

template<typename Scalar >

NonlinearCG< Scalar >::ScalarMag OptiPack::NonlinearCG< Scalar >::get_g_grad_tol ( ) const

Definition at line 155 of file OptiPack_NonlinearCG_def.hpp.

◆ get_g_mag()

template<typename Scalar >

NonlinearCG< Scalar >::ScalarMag OptiPack::NonlinearCG< Scalar >::get_g_mag ( ) const

Definition at line 163 of file OptiPack_NonlinearCG_def.hpp.

◆ setParameterList()

template<typename Scalar >

void OptiPack::NonlinearCG< Scalar >::setParameterList ( RCP< ParameterList > const & paramList )

Definition at line 173 of file OptiPack_NonlinearCG_def.hpp.

◆ getValidParameters()

template<typename Scalar >

RCP< const ParameterList > OptiPack::NonlinearCG< Scalar >::getValidParameters ( ) const

virtual

Reimplemented from Teuchos::ParameterListAcceptor.

Definition at line 203 of file OptiPack_NonlinearCG_def.hpp.

◆ doSolve()

template<typename Scalar>

NonlinearCGUtils::ESolveReturn OptiPack::NonlinearCG< Scalar >::doSolve	(	const Ptr< Thyra::VectorBase< Scalar > > &	p,
		const Ptr< ScalarMag > &	g_opt,
		const Ptr< const ScalarMag > &	g_reduct_tol = `Teuchos::null`,
		const Ptr< const ScalarMag > &	g_grad_tol = `Teuchos::null`,
		const Ptr< const ScalarMag > &	alpha_init = `Teuchos::null`,
		const Ptr< int > &	numIters = `Teuchos::null`
	)

Perform a solve.

Parameters

p	[in/out] On input `p` is the initial guess for the solution. On output, will be the final estimate for the solution.
g_opt	[out] On output, `*g_opt` will be set to the final value of the objective function.
tol	[in] If `!is_null(tol)`, then `*tol` will be the tolerance used to determine the convergence of the algorithm by comparing to `norm(g_grad)` (where `norm(...)` is the natural norm defined by the vector spaces scalar product). If `is_null(tol)`, then the tolerance will be determined in some other way.
alpha_init	[in] If `!is_null(alpha_init)`, then `*alpha_init` will be the initial line search step length on the very first nonlinear CG iteration. If `is_null(alpha_init)`, the initial step length will be determined automatically.
numIters	[out] If `nonnull(numIters)`, then on output `*numIters` gives the number of iterations taken by the algorithm.

Returns: Returns true if the solution was found. Returns false if a line search failure is encountered.

Definition at line 257 of file OptiPack_NonlinearCG_def.hpp.

Friends And Related Function Documentation

◆ nonlinearCG() [1/2]

template<typename Scalar >

const RCP< NonlinearCG< Scalar > > nonlinearCG ( )

Definition at line 218 of file OptiPack_NonlinearCG_decl.hpp.

◆ nonlinearCG() [2/2]

template<typename Scalar >

const RCP< NonlinearCG< Scalar > > nonlinearCG	(	const RCP< const Thyra::ModelEvaluator< Scalar > > &	model,
		const int	paramIndex,
		const int	responseIndex,
		const RCP< GlobiPack::LineSearchBase< Scalar > > &	linesearch
	)