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

#include <IpMa57TSolverInterface.hpp>

Inheritance diagram for Ipopt::Ma57TSolverInterface:

Public Member Functions
bool	InitializeImpl (const OptionsList &options, const std::string &prefix)
	overloaded from AlgorithmStrategyObject More...

Constructor/Destructor
	Ma57TSolverInterface ()
	Constructor. More...

virtual	~Ma57TSolverInterface ()
	Destructor. More...

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. More...

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. More...

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. More...

virtual Index	NumberOfNegEVals () const
	Number of negative eigenvalues detected during last factorization. More...


virtual bool	IncreaseQuality ()
	Request to increase quality of solution for next solve. More...

virtual bool	ProvidesInertia () const
	Query whether inertia is computed by linear solver. More...

EMatrixFormat	MatrixFormat () const
	Query of requested matrix type that the linear solver understands. More...

Public Member Functions inherited from Ipopt::SparseSymLinearSolverInterface
	SparseSymLinearSolverInterface ()

virtual	~SparseSymLinearSolverInterface ()

virtual bool	ProvidesDegeneracyDetection () const
	Query whether the indices of linearly dependent rows/columns can be determined by this linear solver. More...

virtual ESymSolverStatus	DetermineDependentRows (const Index ia, const Index ja, std::list< Index > &c_deps)
	This method determines the list of row indices of the linearly dependent rows. More...

Public Member Functions inherited from Ipopt::AlgorithmStrategyObject
bool	Initialize (const Journalist &jnlst, IpoptNLP &ip_nlp, IpoptData &ip_data, IpoptCalculatedQuantities &ip_cq, const OptionsList &options, const std::string &prefix)
	This method is called every time the algorithm starts again - it is used to reset any internal state. More...

bool	ReducedInitialize (const Journalist &jnlst, const OptionsList &options, const std::string &prefix)
	Reduced version of the Initialize method, which does not require special Ipopt information. More...

	AlgorithmStrategyObject ()
	Default Constructor. More...

virtual	~AlgorithmStrategyObject ()
	Default Destructor. More...

Public Member Functions inherited from Ipopt::ReferencedObject
	ReferencedObject ()

virtual	~ReferencedObject ()

Index	ReferenceCount () const

void	AddRef (const Referencer *referencer) const

void	ReleaseRef (const Referencer *referencer) const

Static Public Member Functions

static void	RegisterOptions (SmartPtr< RegisteredOptions > roptions)
	Methods for IpoptType. More...

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. More...

void	operator= (const Ma57TSolverInterface &)
	Overloaded Equals Operator. More...

Internal functions
ESymSolverStatus	SymbolicFactorization (const Index airn, const Index ajcn)
	Call MA57AD and reserve memory for MA57 data. More...

ESymSolverStatus	Factorization (const Index airn, const Index ajcn, bool check_NegEVals, Index numberOfNegEVals)
	Call MA57BD to factorize the Matrix. More...

ESymSolverStatus	Backsolve (Index nrhs, double *rhs_vals)
	Call MA57CD to do the backsolve. More...

Private Attributes
Information about the matrix
Index	dim_
	Number of rows and columns of the matrix. More...

Index	nonzeros_
	Number of nonzeros of the matrix. More...

Information about most recent factorization/solve
Index	negevals_
	Number of negative eigenvalues. More...

Initialization flags
bool	initialized_
	Flag indicating if internal data is initialized. More...

bool	pivtol_changed_
	Flag indicating if the matrix has to be refactorized because the pivot tolerance has been changed. More...

bool	refactorize_
	Flag that is true if we just requested the values of the matrix again (SYMSOLVER_CALL_AGAIN) and have to factorize again. More...

Solver specific data/options
Number	pivtol_
	Pivol tolerance. More...

Number	pivtolmax_
	Maximal pivot tolerance. More...

Number	ma57_pre_alloc_
	Factor for estimating initial size of work arrays. More...

bool	warm_start_same_structure_
	Flag indicating whether the TNLP with identical structure has already been solved before. More...

Data for the linear solver.
Storing factorization and other solver specific data structure.
double	wd_cntl_ [5]

ma57int	wd_icntl_ [20]

ma57int	wd_info_ [40]

double	wd_rinfo_ [20]

ma57int	wd_lkeep_

ma57int *	wd_keep_

ma57int *	wd_iwork_

double *	wd_fact_

ma57int	wd_lfact_

ma57int *	wd_ifact_

ma57int	wd_lifact_

double *	a_
	factor A of matrix More...

Additional Inherited Members
Public Types inherited from Ipopt::SparseSymLinearSolverInterface
enum	EMatrixFormat { Triplet_Format, CSR_Format_0_Offset, CSR_Format_1_Offset, CSR_Full_Format_0_Offset, CSR_Full_Format_1_Offset }
	Enum to specify sparse matrix format. More...

Protected Member Functions inherited from Ipopt::AlgorithmStrategyObject
const Journalist &	Jnlst () const

IpoptNLP &	IpNLP () const

IpoptData &	IpData () const

IpoptCalculatedQuantities &	IpCq () const

bool	HaveIpData () const

Detailed Description

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

Definition at line 27 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

inlinevirtual

Query whether inertia is computed by linear solver.

Returns true, if linear solver provides inertia.

Implements Ipopt::SparseSymLinearSolverInterface.

Definition at line 96 of file IpMa57TSolverInterface.hpp.

EMatrixFormat Ipopt::Ma57TSolverInterface::MatrixFormat ( ) const

inlinevirtual

Query of requested matrix type that the linear solver understands.

Implements Ipopt::SparseSymLinearSolverInterface.

Definition at line 103 of file IpMa57TSolverInterface.hpp.

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

Call MA57BD to factorize the Matrix.

It is assumed that the first nonzeros_ element of a_ contain the values of the matrix to be factorized.

ESymSolverStatus Ipopt::Ma57TSolverInterface::Backsolve	(	Index	nrhs,
		double *	rhs_vals
	)

private

Call MA57CD to do the backsolve.

Member Data Documentation

Index Ipopt::Ma57TSolverInterface::dim_

private

Number of rows and columns of the matrix.

Definition at line 133 of file IpMa57TSolverInterface.hpp.

Index Ipopt::Ma57TSolverInterface::nonzeros_

private

Number of nonzeros of the matrix.

Definition at line 136 of file IpMa57TSolverInterface.hpp.

Index Ipopt::Ma57TSolverInterface::negevals_

private

Number of negative eigenvalues.

Definition at line 142 of file IpMa57TSolverInterface.hpp.

bool Ipopt::Ma57TSolverInterface::initialized_

private

Flag indicating if internal data is initialized.

For initialization, this object needs to have seen a matrix

Definition at line 149 of file IpMa57TSolverInterface.hpp.

bool Ipopt::Ma57TSolverInterface::pivtol_changed_

private

Flag indicating if the matrix has to be refactorized because the pivot tolerance has been changed.

Definition at line 152 of file IpMa57TSolverInterface.hpp.

bool Ipopt::Ma57TSolverInterface::refactorize_

private

Flag that is true if we just requested the values of the matrix again (SYMSOLVER_CALL_AGAIN) and have to factorize again.

Definition at line 156 of file IpMa57TSolverInterface.hpp.

Number Ipopt::Ma57TSolverInterface::pivtol_

private

Pivol tolerance.

Definition at line 162 of file IpMa57TSolverInterface.hpp.

Number Ipopt::Ma57TSolverInterface::pivtolmax_

private

Maximal pivot tolerance.

Definition at line 164 of file IpMa57TSolverInterface.hpp.

Number Ipopt::Ma57TSolverInterface::ma57_pre_alloc_

private

Factor for estimating initial size of work arrays.

Definition at line 166 of file IpMa57TSolverInterface.hpp.

bool Ipopt::Ma57TSolverInterface::warm_start_same_structure_

private

Flag indicating whether the TNLP with identical structure has already been solved before.

Definition at line 169 of file IpMa57TSolverInterface.hpp.

double Ipopt::Ma57TSolverInterface::wd_cntl_[5]

private

Definition at line 176 of file IpMa57TSolverInterface.hpp.

ma57int Ipopt::Ma57TSolverInterface::wd_icntl_[20]

private

Definition at line 177 of file IpMa57TSolverInterface.hpp.

ma57int Ipopt::Ma57TSolverInterface::wd_info_[40]

private

Definition at line 179 of file IpMa57TSolverInterface.hpp.

double Ipopt::Ma57TSolverInterface::wd_rinfo_[20]

private

Definition at line 180 of file IpMa57TSolverInterface.hpp.

ma57int Ipopt::Ma57TSolverInterface::wd_lkeep_

private

Definition at line 182 of file IpMa57TSolverInterface.hpp.

ma57int* Ipopt::Ma57TSolverInterface::wd_keep_

private

Definition at line 183 of file IpMa57TSolverInterface.hpp.

ma57int* Ipopt::Ma57TSolverInterface::wd_iwork_

private

Definition at line 185 of file IpMa57TSolverInterface.hpp.

double* Ipopt::Ma57TSolverInterface::wd_fact_

private

Definition at line 187 of file IpMa57TSolverInterface.hpp.

ma57int Ipopt::Ma57TSolverInterface::wd_lfact_

private

Definition at line 188 of file IpMa57TSolverInterface.hpp.

ma57int* Ipopt::Ma57TSolverInterface::wd_ifact_

private

Definition at line 189 of file IpMa57TSolverInterface.hpp.

ma57int Ipopt::Ma57TSolverInterface::wd_lifact_

private

Definition at line 190 of file IpMa57TSolverInterface.hpp.

double* Ipopt::Ma57TSolverInterface::a_

private

factor A of matrix

Definition at line 194 of file IpMa57TSolverInterface.hpp.

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

src/Algorithm/LinearSolvers/IpMa57TSolverInterface.hpp

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation