MFEM  v4.2.0
Finite element discretization library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Member Functions | Protected Attributes | List of all members
mfem::HiopNlpOptimizer Class Reference

Adapts the HiOp functionality to the MFEM OptimizationSolver interface. More...

#include <hiop.hpp>

Inheritance diagram for mfem::HiopNlpOptimizer:
[legend]
Collaboration diagram for mfem::HiopNlpOptimizer:
[legend]

Public Member Functions

 HiopNlpOptimizer ()
 
 HiopNlpOptimizer (MPI_Comm _comm)
 
virtual ~HiopNlpOptimizer ()
 
virtual void SetOptimizationProblem (const OptimizationProblem &prob)
 
virtual void Mult (const Vector &xt, Vector &x) const
 Solves the optimization problem with xt as initial guess. More...
 
- Public Member Functions inherited from mfem::OptimizationSolver
 OptimizationSolver ()
 
 OptimizationSolver (MPI_Comm _comm)
 
virtual ~OptimizationSolver ()
 
virtual void SetPreconditioner (Solver &pr)
 This should be called before SetOperator. More...
 
virtual void SetOperator (const Operator &op)
 Also calls SetOperator for the preconditioner if there is one. More...
 
- Public Member Functions inherited from mfem::IterativeSolver
 IterativeSolver ()
 
 IterativeSolver (MPI_Comm _comm)
 
void SetRelTol (double rtol)
 
void SetAbsTol (double atol)
 
void SetMaxIter (int max_it)
 
void SetPrintLevel (int print_lvl)
 
int GetNumIterations () const
 
int GetConverged () const
 
double GetFinalNorm () const
 
void SetMonitor (IterativeSolverMonitor &m)
 Set the iterative solver monitor. More...
 
MPI_Comm GetComm () const
 Return the associated MPI communicator, or MPI_COMM_NULL if no communicator is set. More...
 
- Public Member Functions inherited from mfem::Solver
 Solver (int s=0, bool iter_mode=false)
 Initialize a square Solver with size s. More...
 
 Solver (int h, int w, bool iter_mode=false)
 Initialize a Solver with height h and width w. More...
 
- Public Member Functions inherited from mfem::Operator
void InitTVectors (const Operator *Po, const Operator *Ri, const Operator *Pi, Vector &x, Vector &b, Vector &X, Vector &B) const
 Initializes memory for true vectors of linear system. More...
 
 Operator (int s=0)
 Construct a square Operator with given size s (default 0). More...
 
 Operator (int h, int w)
 Construct an Operator with the given height (output size) and width (input size). More...
 
int Height () const
 Get the height (size of output) of the Operator. Synonym with NumRows(). More...
 
int NumRows () const
 Get the number of rows (size of output) of the Operator. Synonym with Height(). More...
 
int Width () const
 Get the width (size of input) of the Operator. Synonym with NumCols(). More...
 
int NumCols () const
 Get the number of columns (size of input) of the Operator. Synonym with Width(). More...
 
virtual MemoryClass GetMemoryClass () const
 Return the MemoryClass preferred by the Operator. More...
 
virtual void MultTranspose (const Vector &x, Vector &y) const
 Action of the transpose operator: y=A^t(x). The default behavior in class Operator is to generate an error. More...
 
virtual OperatorGetGradient (const Vector &x) const
 Evaluate the gradient operator at the point x. The default behavior in class Operator is to generate an error. More...
 
virtual const OperatorGetProlongation () const
 Prolongation operator from linear algebra (linear system) vectors, to input vectors for the operator. NULL means identity. More...
 
virtual const OperatorGetRestriction () const
 Restriction operator from input vectors for the operator to linear algebra (linear system) vectors. NULL means identity. More...
 
virtual const OperatorGetOutputProlongation () const
 Prolongation operator from linear algebra (linear system) vectors, to output vectors for the operator. NULL means identity. More...
 
virtual const OperatorGetOutputRestriction () const
 Restriction operator from output vectors for the operator to linear algebra (linear system) vectors. NULL means identity. More...
 
void FormLinearSystem (const Array< int > &ess_tdof_list, Vector &x, Vector &b, Operator *&A, Vector &X, Vector &B, int copy_interior=0)
 Form a constrained linear system using a matrix-free approach. More...
 
void FormRectangularLinearSystem (const Array< int > &trial_tdof_list, const Array< int > &test_tdof_list, Vector &x, Vector &b, Operator *&A, Vector &X, Vector &B)
 Form a column-constrained linear system using a matrix-free approach. More...
 
virtual void RecoverFEMSolution (const Vector &X, const Vector &b, Vector &x)
 Reconstruct a solution vector x (e.g. a GridFunction) from the solution X of a constrained linear system obtained from Operator::FormLinearSystem() or Operator::FormRectangularLinearSystem(). More...
 
void FormSystemOperator (const Array< int > &ess_tdof_list, Operator *&A)
 Return in A a parallel (on truedofs) version of this square operator. More...
 
void FormRectangularSystemOperator (const Array< int > &trial_tdof_list, const Array< int > &test_tdof_list, Operator *&A)
 Return in A a parallel (on truedofs) version of this rectangular operator (including constraints). More...
 
void FormDiscreteOperator (Operator *&A)
 Return in A a parallel (on truedofs) version of this rectangular operator. More...
 
void PrintMatlab (std::ostream &out, int n=0, int m=0) const
 Prints operator with input size n and output size m in Matlab format. More...
 
virtual ~Operator ()
 Virtual destructor. More...
 
Type GetType () const
 Return the type ID of the Operator class. More...
 

Protected Attributes

HiopOptimizationProblemhiop_problem
 
MPI_Comm comm_
 
- Protected Attributes inherited from mfem::OptimizationSolver
const OptimizationProblemproblem
 
- Protected Attributes inherited from mfem::IterativeSolver
const Operatoroper
 
Solverprec
 
IterativeSolverMonitormonitor = nullptr
 
int max_iter
 
int print_level
 
double rel_tol
 
double abs_tol
 
int final_iter
 
int converged
 
double final_norm
 
- Protected Attributes inherited from mfem::Operator
int height
 Dimension of the output / number of rows in the matrix. More...
 
int width
 Dimension of the input / number of columns in the matrix. More...
 

Additional Inherited Members

- Public Types inherited from mfem::Operator
enum  DiagonalPolicy { DIAG_ZERO, DIAG_ONE, DIAG_KEEP }
 Defines operator diagonal policy upon elimination of rows and/or columns. More...
 
enum  Type {
  ANY_TYPE, MFEM_SPARSEMAT, Hypre_ParCSR, PETSC_MATAIJ,
  PETSC_MATIS, PETSC_MATSHELL, PETSC_MATNEST, PETSC_MATHYPRE,
  PETSC_MATGENERIC, Complex_Operator, MFEM_ComplexSparseMat, Complex_Hypre_ParCSR
}
 Enumeration defining IDs for some classes derived from Operator. More...
 
- Public Attributes inherited from mfem::Solver
bool iterative_mode
 If true, use the second argument of Mult() as an initial guess. More...
 
- Protected Member Functions inherited from mfem::IterativeSolver
double Dot (const Vector &x, const Vector &y) const
 
double Norm (const Vector &x) const
 
void Monitor (int it, double norm, const Vector &r, const Vector &x, bool final=false) const
 
- Protected Member Functions inherited from mfem::Operator
void FormConstrainedSystemOperator (const Array< int > &ess_tdof_list, ConstrainedOperator *&Aout)
 see FormSystemOperator() More...
 
void FormRectangularConstrainedSystemOperator (const Array< int > &trial_tdof_list, const Array< int > &test_tdof_list, RectangularConstrainedOperator *&Aout)
 see FormRectangularSystemOperator() More...
 
OperatorSetupRAP (const Operator *Pi, const Operator *Po)
 Returns RAP Operator of this, taking in input/output Prolongation matrices. More...
 

Detailed Description

Adapts the HiOp functionality to the MFEM OptimizationSolver interface.

Definition at line 172 of file hiop.hpp.

Constructor & Destructor Documentation

mfem::HiopNlpOptimizer::HiopNlpOptimizer ( )

Definition at line 248 of file hiop.cpp.

mfem::HiopNlpOptimizer::HiopNlpOptimizer ( MPI_Comm  _comm)

Definition at line 264 of file hiop.cpp.

mfem::HiopNlpOptimizer::~HiopNlpOptimizer ( )
virtual

Definition at line 268 of file hiop.cpp.

Member Function Documentation

void mfem::HiopNlpOptimizer::Mult ( const Vector xt,
Vector x 
) const
virtual

Solves the optimization problem with xt as initial guess.

Implements mfem::OptimizationSolver.

Definition at line 287 of file hiop.cpp.

void mfem::HiopNlpOptimizer::SetOptimizationProblem ( const OptimizationProblem prob)
virtual

This function is virtual as solvers might need to perform some initial actions (e.g. validation) with the OptimizationProblem.

Reimplemented from mfem::OptimizationSolver.

Definition at line 273 of file hiop.cpp.

Member Data Documentation

MPI_Comm mfem::HiopNlpOptimizer::comm_
protected

Definition at line 178 of file hiop.hpp.

HiopOptimizationProblem* mfem::HiopNlpOptimizer::hiop_problem
protected

Definition at line 175 of file hiop.hpp.


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