Ipopt  3.12.11
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Public Member Functions | List of all members
Ipopt::PardisoSolverInterface Class Reference

Interface to the linear solver Pardiso, derived from SparseSymLinearSolverInterface. More...

#include <IpPardisoSolverInterface.hpp>

+ Inheritance diagram for Ipopt::PardisoSolverInterface:

Public Member Functions

bool InitializeImpl (const OptionsList &options, const std::string &prefix)
 overloaded from AlgorithmStrategyObject More...
 
Constructor/Destructor
 PardisoSolverInterface ()
 Constructor. More...
 
virtual ~PardisoSolverInterface ()
 Destructor. More...
 
Methods for requesting solution of the linear system.
virtual ESymSolverStatus InitializeStructure (Index dim, Index nonzeros, const Index *ia, const Index *ja)
 Method for initializing internal stuctures. More...
 
virtual double * GetValuesArrayPtr ()
 Method returing an internal array into which the nonzero elements are to be stored. More...
 
virtual ESymSolverStatus MultiSolve (bool new_matrix, const Index *ia, const Index *ja, 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.

 PardisoSolverInterface (const PardisoSolverInterface &)
 Copy Constructor. More...
 
void operator= (const PardisoSolverInterface &)
 Overloaded Equals Operator. More...
 
Internal functions
ESymSolverStatus SymbolicFactorization (const Index *ia, const Index *ja)
 Call Pardiso to do the analysis phase. More...
 
ESymSolverStatus Factorization (const Index *ia, const Index *ja, bool check_NegEVals, Index numberOfNegEVals)
 Call Pardiso to factorize the Matrix. More...
 
ESymSolverStatus Solve (const Index *ia, const Index *ja, Index nrhs, double *rhs_vals)
 Call Pardiso to do the Solve. 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 in triplet representation. More...
 
double * a_
 Array for storing the values 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...
 
Solver specific information
void ** PT_
 Internal data address pointers. More...
 
ipfint MAXFCT_
 Maximal number of factors with identical nonzero structure. More...
 
ipfint MNUM_
 Actual matrix for the solution phase. More...
 
ipfint MTYPE_
 Matrix type; real and symmetric indefinite. More...
 
ipfintIPARM_
 Parameter and info array for Pardiso. More...
 
double * DPARM_
 Parameter and info array for Pardiso. More...
 
ipfint MSGLVL_
 Message level. More...
 
Some counters for debugging
Index debug_last_iter_
 
Index debug_cnt_
 

Solver specific options

enum  PardisoMatchingStrategy { COMPLETE, COMPLETE2x2, CONSTRAINT }
 Type for mathcing strategies. More...
 
PardisoMatchingStrategy match_strat_
 Option that controls the matching strategy. More...
 
bool have_symbolic_factorization_
 Flag indicating if symbolic factorization has already been performed. More...
 
bool pardiso_redo_symbolic_fact_only_if_inertia_wrong_
 Flag indicating whether the symbolic factorization should only be done after perturbed elements, if the inertia was wrong. More...
 
bool pardiso_repeated_perturbation_means_singular_
 Flag indicating whether repeated perturbed elements even after a new symbolic factorization should be interpreted as a singular matrix. More...
 
bool skip_inertia_check_
 Flag indicating if the interia is always assumed to be correct. More...
 
bool pardiso_iterative_
 Flag indicating whether we are using the iterative solver in Pardiso. More...
 
Index pardiso_max_droptol_corrections_
 Maximal number of decreases of drop tolerance during one solve. 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 JournalistJnlst () const
 
IpoptNLPIpNLP () const
 
IpoptDataIpData () const
 
IpoptCalculatedQuantitiesIpCq () const
 
bool HaveIpData () const
 

Detailed Description

Interface to the linear solver Pardiso, derived from SparseSymLinearSolverInterface.

For details, see description of SparseSymLinearSolverInterface base class.

Definition at line 24 of file IpPardisoSolverInterface.hpp.

Member Enumeration Documentation

Type for mathcing strategies.

Enumerator
COMPLETE 
COMPLETE2x2 
CONSTRAINT 

Definition at line 141 of file IpPardisoSolverInterface.hpp.

Constructor & Destructor Documentation

Ipopt::PardisoSolverInterface::PardisoSolverInterface ( )

Constructor.

virtual Ipopt::PardisoSolverInterface::~PardisoSolverInterface ( )
virtual

Destructor.

Ipopt::PardisoSolverInterface::PardisoSolverInterface ( const PardisoSolverInterface )
private

Copy Constructor.

Member Function Documentation

bool Ipopt::PardisoSolverInterface::InitializeImpl ( const OptionsList options,
const std::string &  prefix 
)
virtual
virtual ESymSolverStatus Ipopt::PardisoSolverInterface::InitializeStructure ( Index  dim,
Index  nonzeros,
const Index ia,
const Index ja 
)
virtual

Method for initializing internal stuctures.

Implements Ipopt::SparseSymLinearSolverInterface.

virtual double* Ipopt::PardisoSolverInterface::GetValuesArrayPtr ( )
virtual

Method returing an internal array into which the nonzero elements are to be stored.

Implements Ipopt::SparseSymLinearSolverInterface.

virtual ESymSolverStatus Ipopt::PardisoSolverInterface::MultiSolve ( bool  new_matrix,
const Index ia,
const Index ja,
Index  nrhs,
double *  rhs_vals,
bool  check_NegEVals,
Index  numberOfNegEVals 
)
virtual

Solve operation for multiple right hand sides.

Implements Ipopt::SparseSymLinearSolverInterface.

virtual Index Ipopt::PardisoSolverInterface::NumberOfNegEVals ( ) const
virtual

Number of negative eigenvalues detected during last factorization.

Implements Ipopt::SparseSymLinearSolverInterface.

virtual bool Ipopt::PardisoSolverInterface::IncreaseQuality ( )
virtual

Request to increase quality of solution for next solve.

Implements Ipopt::SparseSymLinearSolverInterface.

virtual bool Ipopt::PardisoSolverInterface::ProvidesInertia ( ) const
inlinevirtual

Query whether inertia is computed by linear solver.

Returns true, if linear solver provides inertia.

Implements Ipopt::SparseSymLinearSolverInterface.

Definition at line 76 of file IpPardisoSolverInterface.hpp.

EMatrixFormat Ipopt::PardisoSolverInterface::MatrixFormat ( ) const
inlinevirtual

Query of requested matrix type that the linear solver understands.

Implements Ipopt::SparseSymLinearSolverInterface.

Definition at line 83 of file IpPardisoSolverInterface.hpp.

static void Ipopt::PardisoSolverInterface::RegisterOptions ( SmartPtr< RegisteredOptions roptions)
static

Methods for IpoptType.

void Ipopt::PardisoSolverInterface::operator= ( const PardisoSolverInterface )
private

Overloaded Equals Operator.

ESymSolverStatus Ipopt::PardisoSolverInterface::SymbolicFactorization ( const Index ia,
const Index ja 
)
private

Call Pardiso to do the analysis phase.

ESymSolverStatus Ipopt::PardisoSolverInterface::Factorization ( const Index ia,
const Index ja,
bool  check_NegEVals,
Index  numberOfNegEVals 
)
private

Call Pardiso to factorize the Matrix.

ESymSolverStatus Ipopt::PardisoSolverInterface::Solve ( const Index ia,
const Index ja,
Index  nrhs,
double *  rhs_vals 
)
private

Call Pardiso to do the Solve.

Member Data Documentation

Index Ipopt::PardisoSolverInterface::dim_
private

Number of rows and columns of the matrix.

Definition at line 113 of file IpPardisoSolverInterface.hpp.

Index Ipopt::PardisoSolverInterface::nonzeros_
private

Number of nonzeros of the matrix in triplet representation.

Definition at line 116 of file IpPardisoSolverInterface.hpp.

double* Ipopt::PardisoSolverInterface::a_
private

Array for storing the values of the matrix.

Definition at line 119 of file IpPardisoSolverInterface.hpp.

Index Ipopt::PardisoSolverInterface::negevals_
private

Number of negative eigenvalues.

Definition at line 135 of file IpPardisoSolverInterface.hpp.

PardisoMatchingStrategy Ipopt::PardisoSolverInterface::match_strat_
private

Option that controls the matching strategy.

Definition at line 148 of file IpPardisoSolverInterface.hpp.

bool Ipopt::PardisoSolverInterface::have_symbolic_factorization_
private

Flag indicating if symbolic factorization has already been performed.

Definition at line 151 of file IpPardisoSolverInterface.hpp.

bool Ipopt::PardisoSolverInterface::pardiso_redo_symbolic_fact_only_if_inertia_wrong_
private

Flag indicating whether the symbolic factorization should only be done after perturbed elements, if the inertia was wrong.

Definition at line 154 of file IpPardisoSolverInterface.hpp.

bool Ipopt::PardisoSolverInterface::pardiso_repeated_perturbation_means_singular_
private

Flag indicating whether repeated perturbed elements even after a new symbolic factorization should be interpreted as a singular matrix.

Definition at line 158 of file IpPardisoSolverInterface.hpp.

bool Ipopt::PardisoSolverInterface::skip_inertia_check_
private

Flag indicating if the interia is always assumed to be correct.

Definition at line 161 of file IpPardisoSolverInterface.hpp.

bool Ipopt::PardisoSolverInterface::pardiso_iterative_
private

Flag indicating whether we are using the iterative solver in Pardiso.

Definition at line 164 of file IpPardisoSolverInterface.hpp.

Index Ipopt::PardisoSolverInterface::pardiso_max_droptol_corrections_
private

Maximal number of decreases of drop tolerance during one solve.

Definition at line 166 of file IpPardisoSolverInterface.hpp.

bool Ipopt::PardisoSolverInterface::initialized_
private

Flag indicating if internal data is initialized.

For initialization, this object needs to have seen a matrix

Definition at line 173 of file IpPardisoSolverInterface.hpp.

void** Ipopt::PardisoSolverInterface::PT_
private

Internal data address pointers.

Definition at line 179 of file IpPardisoSolverInterface.hpp.

ipfint Ipopt::PardisoSolverInterface::MAXFCT_
private

Maximal number of factors with identical nonzero structure.

Here, we only store one factorization. Is always 1.

Definition at line 182 of file IpPardisoSolverInterface.hpp.

ipfint Ipopt::PardisoSolverInterface::MNUM_
private

Actual matrix for the solution phase.

Is always 1.

Definition at line 184 of file IpPardisoSolverInterface.hpp.

ipfint Ipopt::PardisoSolverInterface::MTYPE_
private

Matrix type; real and symmetric indefinite.

Is always -2.

Definition at line 186 of file IpPardisoSolverInterface.hpp.

ipfint* Ipopt::PardisoSolverInterface::IPARM_
private

Parameter and info array for Pardiso.

Definition at line 188 of file IpPardisoSolverInterface.hpp.

double* Ipopt::PardisoSolverInterface::DPARM_
private

Parameter and info array for Pardiso.

Definition at line 190 of file IpPardisoSolverInterface.hpp.

ipfint Ipopt::PardisoSolverInterface::MSGLVL_
private

Message level.

Definition at line 192 of file IpPardisoSolverInterface.hpp.

Index Ipopt::PardisoSolverInterface::debug_last_iter_
private

Definition at line 197 of file IpPardisoSolverInterface.hpp.

Index Ipopt::PardisoSolverInterface::debug_cnt_
private

Definition at line 198 of file IpPardisoSolverInterface.hpp.


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