Ipopt Documentation  
 
Loading...
Searching...
No Matches
IpInexactPDTerminationTester.hpp
Go to the documentation of this file.
1// Copyright (C) 2008, 2011 International Business Machines and others.
2// All Rights Reserved.
3// This code is published under the Eclipse Public License.
4//
5// Authors: Andreas Waechter IBM 2008-09-19
6
7#ifndef __IPINEXACTPDTERMINATIONTESTER_HPP__
8#define __IPINEXACTPDTERMINATIONTESTER_HPP__
9
11
12namespace Ipopt
13{
14
19{
20public:
23
26
30
31 virtual bool InitializeImpl(
32 const OptionsList& options,
33 const std::string& prefix
34 );
35
36 static void RegisterOptions(
38 );
39
44 virtual bool InitializeSolve();
45
56 Index ndim,
57 const Number* sol,
58 const Number* resid,
59 Index iter,
60 Number norm2_rhs
61 );
62
66 virtual void Clear();
67
71 virtual Index GetSolverIterations() const
72 {
73 return last_iter_;
74 }
75
76private:
87
90 );
92
95
125
146 SmartPtr<const Vector> curr_Wv_s_; // in original space
149
155
158};
159
160} // namespace Ipopt
161
162#endif
This class implements the termination tests for the primal-dual system.
Number tt_kappa1_
kappa_1 factor in termination test 1
Number tcc_zeta_
zeta factor in the tangential component condition
Number rho_
rho constant from penalty parameter update.
virtual void Clear()
This method can be called after the Solve is over and we can delete anything that has been allocated ...
virtual Index GetSolverIterations() const
Return the number of iterative solver iteration from the most recent solve.
Number inexact_desired_pd_residual_
Desired reduction of residual.
virtual bool InitializeSolve()
Method for initializing for the next iterative solve.
bool requires_scaling_
Is set to true if the linear system is scaled via slacks.
Index last_iter_
Last iterative solver iteration counter.
InexactPDTerminationTester()
Default constructor.
virtual ~InexactPDTerminationTester()
Destructor.
Index inexact_desired_pd_residual_iter_
Number of iterations allowed for desired pd residual.
Number tcc_theta_
theta factor in the tangential component condition
Number tt_kappa2_
kappa_2 factor in termination test 2
virtual ETerminationTest TestTermination(Index ndim, const Number *sol, const Number *resid, Index iter, Number norm2_rhs)
This method checks if the current solution of the iterative linear solver is good enough (by returnin...
Number tt_eps3_
eps_3 constant in termination test 3
Number tcc_psi_
Psi factor in the tangential component condition.
Number tt_eps2_
eps_2 constant in termination test 2
virtual bool InitializeImpl(const OptionsList &options, const std::string &prefix)
Implementation of the initialization method that has to be overloaded by for each derived class.
Number tcc_theta_mu_exponent_
mu exponent when multiplied to theta in the tangential component condition
static void RegisterOptions(SmartPtr< RegisteredOptions > roptions)
InexactPDTerminationTester & operator=(const InexactPDTerminationTester &)
Overloaded Assignment Operator.
This base class is for the termination tests for the iterative linear solver in the inexact version o...
ETerminationTest
Enum to report result of termination test.
This class stores a list of user set options.
Template class for Smart Pointers.
This file contains a base class for all exceptions and a set of macros to help with exceptions.
ipindex Index
Type of all indices of vectors, matrices etc.
Definition IpTypes.hpp:20
ipnumber Number
Type of all numbers.
Definition IpTypes.hpp:17