Ipopt::Ma57TSolverInterface Class Reference

Interface to the symmetric linear solver MA57, derived from SparseSymLinearSolverInterface. More...

#include <IpMa57TSolverInterface.hpp>

Inheritance diagram for Ipopt::Ma57TSolverInterface:

[legend]Collaboration diagram for Ipopt::Ma57TSolverInterface:


Public Member Functions
bool	InitializeImpl (const OptionsList &options, const std::string &prefix)
	overloaded from AlgorithmStrategyObject
Constructor/Destructor
	Ma57TSolverInterface ()
	Constructor.
virtual	~Ma57TSolverInterface ()
	Destructor.
Methods for requesting solution of the linear system.
virtual ESymSolverStatus	InitializeStructure (Index dim, Index nonzeros, const Index airn, const Index ajcn)
	Method for initializing internal stuctures.
virtual double *	GetValuesArrayPtr ()
	Method returing an internal array into which the nonzero elements (in the same order as airn and ajcn) are to be stored by the calling routine before a call to MultiSolve with a new_matrix=true.
virtual ESymSolverStatus	MultiSolve (bool new_matrix, const Index airn, const Index ajcn, Index nrhs, double *rhs_vals, bool check_NegEVals, Index numberOfNegEVals)
	Solve operation for multiple right hand sides.
virtual Index	NumberOfNegEVals () const
	Number of negative eigenvalues detected during last factorization.

virtual bool	IncreaseQuality ()
	Request to increase quality of solution for next solve.
virtual bool	ProvidesInertia () const
	Query whether inertia is computed by linear solver.
EMatrixFormat	MatrixFormat () const
	Query of requested matrix type that the linear solver understands.
Static Public Member Functions

static void	RegisterOptions (SmartPtr< RegisteredOptions > roptions)
	Methods for IpoptType.
Private Member Functions
Default Compiler Generated Methods
(Hidden to avoid implicit creation/calling). These methods are not implemented and we do not want the compiler to implement them for us, so we declare them private and do not define them. This ensures that they will not be implicitly created/called.
	Ma57TSolverInterface (const Ma57TSolverInterface &)
	Copy Constructor.
void	operator= (const Ma57TSolverInterface &)
	Overloaded Equals Operator.
Internal functions
ESymSolverStatus	SymbolicFactorization (const Index airn, const Index ajcn)
	Call MA57AD and reserve memory for MA57 data.
ESymSolverStatus	Factorization (const Index airn, const Index ajcn, bool check_NegEVals, Index numberOfNegEVals)
	Call MA57BD to factorize the Matrix.
ESymSolverStatus	Backsolve (Index nrhs, double *rhs_vals)
	Call MA57CD to do the backsolve.
Private Attributes
Information about the matrix
Index	dim_
	Number of rows and columns of the matrix.
Index	nonzeros_
	Number of nonzeros of the matrix.
Information about most recent factorization/solve
Index	negevals_
	Number of negative eigenvalues.
Initialization flags
bool	initialized_
	Flag indicating if internal data is initialized.
bool	pivtol_changed_
	Flag indicating if the matrix has to be refactorized because the pivot tolerance has been changed.
bool	refactorize_
	Flag that is true if we just requested the values of the matrix again (SYMSOLVER_CALL_AGAIN) and have to factorize again.
Solver specific data/options
Number	pivtol_
	Pivol tolerance.
Number	pivtolmax_
	Maximal pivot tolerance.
Number	ma57_pre_alloc_
	Factor for estimating initial size of work arrays.
bool	warm_start_same_structure_
	Flag indicating whether the TNLP with identical structure has already been solved before.
Data for the linear solver.
Storing factorization and other solver specific data structure.
double	wd_cntl_ [5]
ipfint	wd_icntl_ [20]
ipfint	wd_info_ [40]
double	wd_rinfo_ [20]
ipfint	wd_lkeep_
ipfint *	wd_keep_
ipfint *	wd_iwork_
double *	wd_fact_
ipfint	wd_lfact_
ipfint *	wd_ifact_
ipfint	wd_lifact_
double *	a_
	factor A of matrix

Detailed Description

Interface to the symmetric linear solver MA57, derived from SparseSymLinearSolverInterface.

Definition at line 20 of file IpMa57TSolverInterface.hpp.

Constructor & Destructor Documentation

Ipopt::Ma57TSolverInterface::Ma57TSolverInterface ( )

Constructor.

virtual Ipopt::Ma57TSolverInterface::~Ma57TSolverInterface ( ) [virtual]

Destructor.

Ipopt::Ma57TSolverInterface::Ma57TSolverInterface ( const Ma57TSolverInterface & ) [private]

Copy Constructor.

Member Function Documentation

bool Ipopt::Ma57TSolverInterface::InitializeImpl	(	const OptionsList &	options,
		const std::string &	prefix
	)			`[virtual]`

overloaded from AlgorithmStrategyObject

Implements Ipopt::SparseSymLinearSolverInterface.

virtual ESymSolverStatus Ipopt::Ma57TSolverInterface::InitializeStructure	(	Index	dim,
		Index	nonzeros,
		const Index *	airn,
		const Index *	ajcn
	)			`[virtual]`

Method for initializing internal stuctures.

Here, ndim gives the number of rows and columns of the matrix, nonzeros give the number of nonzero elements, and airn and acjn give the positions of the nonzero elements.

Implements Ipopt::SparseSymLinearSolverInterface.

virtual double* Ipopt::Ma57TSolverInterface::GetValuesArrayPtr ( ) [virtual]

Method returing an internal array into which the nonzero elements (in the same order as airn and ajcn) are to be stored by the calling routine before a call to MultiSolve with a new_matrix=true.

The returned array must have space for at least nonzero elements.

Implements Ipopt::SparseSymLinearSolverInterface.

virtual ESymSolverStatus Ipopt::Ma57TSolverInterface::MultiSolve	(	bool	new_matrix,
		const Index *	airn,
		const Index *	ajcn,
		Index	nrhs,
		double *	rhs_vals,
		bool	check_NegEVals,
		Index	numberOfNegEVals
	)			`[virtual]`

Solve operation for multiple right hand sides.

Overloaded from SparseSymLinearSolverInterface.

Implements Ipopt::SparseSymLinearSolverInterface.

virtual Index Ipopt::Ma57TSolverInterface::NumberOfNegEVals ( ) const [virtual]

Number of negative eigenvalues detected during last factorization.

Returns the number of negative eigenvalues of the most recent factorized matrix. This must not be called if the linear solver does not compute this quantities (see ProvidesInertia).

Implements Ipopt::SparseSymLinearSolverInterface.

virtual bool Ipopt::Ma57TSolverInterface::IncreaseQuality ( ) [virtual]

Request to increase quality of solution for next solve.

Ask linear solver to increase quality of solution for the next solve (e.g. increase pivot tolerance). Returns false, if this is not possible (e.g. maximal pivot tolerance already used.)

Implements Ipopt::SparseSymLinearSolverInterface.

virtual bool Ipopt::Ma57TSolverInterface::ProvidesInertia ( ) const [inline, virtual]

Query whether inertia is computed by linear solver.

Returns true, if linear solver provides inertia.

Implements Ipopt::SparseSymLinearSolverInterface.

Definition at line 89 of file IpMa57TSolverInterface.hpp.

EMatrixFormat Ipopt::Ma57TSolverInterface::MatrixFormat ( ) const [inline, virtual]

Query of requested matrix type that the linear solver understands.

Implements Ipopt::SparseSymLinearSolverInterface.

Definition at line 96 of file IpMa57TSolverInterface.hpp.

References Ipopt::SparseSymLinearSolverInterface::Triplet_Format.

static void Ipopt::Ma57TSolverInterface::RegisterOptions ( SmartPtr< RegisteredOptions > roptions ) [static]

Methods for IpoptType.

void Ipopt::Ma57TSolverInterface::operator= ( const Ma57TSolverInterface & ) [private]

Overloaded Equals Operator.

ESymSolverStatus Ipopt::Ma57TSolverInterface::SymbolicFactorization	(	const Index *	airn,
		const Index *	ajcn
	)			`[private]`

Call MA57AD and reserve memory for MA57 data.

Reserve memory for iw_ and ikeep_, call MA57AD to perform symbolic manipulations, and reserve all the remaining data memory

ESymSolverStatus Ipopt::Ma57TSolverInterface::Factorization	(	const Index *	airn,
		const Index *	ajcn,
		bool	check_NegEVals,
		Index	numberOfNegEVals
	)			`[private]`