43 #ifndef IFPACK_HYPRE_H 44 #define IFPACK_HYPRE_H 52 #include "Epetra_CompObject.h" 53 #include "Epetra_MultiVector.h" 54 #include "Epetra_Vector.h" 55 #include "Epetra_CrsGraph.h" 56 #include "Epetra_CrsMatrix.h" 57 #include "Epetra_BlockMap.h" 58 #include "Epetra_Map.h" 59 #include "Epetra_Object.h" 60 #include "Epetra_Comm.h" 61 #include "Epetra_CrsMatrix.h" 62 #include "Epetra_Time.h" 63 #include "Teuchos_RefCountPtr.hpp" 64 #include "Teuchos_ArrayRCP.hpp" 65 #include "Epetra_MpiComm.h" 72 struct hypre_IJMatrix_struct;
73 typedef struct hypre_IJMatrix_struct *HYPRE_IJMatrix;
74 struct hypre_IJVector_struct;
75 typedef struct hypre_IJVector_struct *HYPRE_IJVector;
76 struct hypre_ParCSRMatrix_struct;
77 typedef struct hypre_ParCSRMatrix_struct* HYPRE_ParCSRMatrix;
78 struct hypre_ParVector_struct;
79 typedef struct hypre_ParVector_struct * HYPRE_ParVector;
80 struct hypre_Solver_struct;
81 typedef struct hypre_Solver_struct *HYPRE_Solver;
82 struct hypre_ParVector_struct;
83 typedef struct hypre_ParVector_struct hypre_ParVector;
87 typedef int HYPRE_Int;
89 typedef HYPRE_Int (*HYPRE_PtrToParSolverFcn)(HYPRE_Solver, HYPRE_ParCSRMatrix, HYPRE_ParVector, HYPRE_ParVector);
114 class FunctionParameter;
134 ~Ifpack_Hypre(){ Destroy();}
151 bool IsComputed()
const{
return(IsComputed_);}
194 int SetParameter(
Hypre_Chooser chooser,
int (*pt2Func)(HYPRE_Solver,
int),
int parameter);
205 int SetParameter(
Hypre_Chooser chooser,
int (*pt2Func)(HYPRE_Solver,
double),
double parameter);
217 int SetParameter(
Hypre_Chooser chooser,
int (*pt2Func)(HYPRE_Solver,
double,
int),
double parameter1,
int parameter2);
229 int SetParameter(
Hypre_Chooser chooser,
int (*pt2Func)(HYPRE_Solver,
int,
int),
int parameter1,
int parameter2);
240 int SetParameter(
Hypre_Chooser chooser,
int (*pt2Func)(HYPRE_Solver,
double*),
double* parameter);
251 int SetParameter(
Hypre_Chooser chooser,
int (*pt2Func)(HYPRE_Solver,
int*),
int* parameter);
263 int SetParameter(
Hypre_Chooser chooser,
int (*pt2Func)(HYPRE_Solver,
int**),
int** parameter);
286 int SetParameter(
bool UsePreconditioner){ UsePreconditioner_ = UsePreconditioner;
return 0;}
295 int SetParameter(
Hypre_Chooser chooser) { SolveOrPrec_ = chooser;
return 0;}
298 int SetCoordinates(Teuchos::RCP<Epetra_MultiVector> coords);
301 int SetDiscreteGradient(Teuchos::RCP<const Epetra_CrsMatrix> G);
304 int CallFunctions()
const;
316 int SetUseTranspose(
bool UseTranspose_in) {UseTranspose_ = UseTranspose_in;
return(0);};
357 const int MaxIters = 1550,
358 const double Tol = 1e-9,
362 double Condest()
const{
return(Condest_);}
368 const char*
Label()
const {
return(Label_);}
371 int SetLabel(
const char* Label_in)
373 strcpy(Label_,Label_in);
384 double NormInf()
const {
return(0.0);};
400 const HYPRE_IJMatrix& HypreMatrix()
409 virtual std::ostream&
Print(std::ostream& os)
const;
415 virtual int NumCompute()
const{
return(NumCompute_);}
424 virtual double ComputeTime()
const{
return(ComputeTime_);}
433 virtual double ComputeFlops()
const{
return(ComputeFlops_);}
444 Ifpack_Hypre(
const Ifpack_Hypre&
RHS) : Time_(
RHS.Comm()){}
447 Ifpack_Hypre& operator=(
const Ifpack_Hypre& ){
return(*
this);}
453 MPI_Comm GetMpiComm()
const 454 {
return (dynamic_cast<const Epetra_MpiComm*>(&A_->Comm()))->GetMpiComm();}
471 int NumGlobalRows()
const {
return(A_->NumGlobalRows());};
474 int NumGlobalCols()
const {
return(A_->NumGlobalCols());};
477 int NumMyRows()
const {
return(A_->NumMyRows());};
480 int NumMyCols()
const {
return(A_->NumMyCols());};
495 int CopyEpetraToHypre();
498 int AddFunToList(Teuchos::RCP<FunctionParameter> NewFun);
501 int Hypre_BoomerAMGCreate(MPI_Comm comm, HYPRE_Solver *solver);
504 int Hypre_ParaSailsCreate(MPI_Comm comm, HYPRE_Solver *solver);
507 int Hypre_EuclidCreate(MPI_Comm comm, HYPRE_Solver *solver);
510 int Hypre_AMSCreate(MPI_Comm comm, HYPRE_Solver *solver);
513 int Hypre_ParCSRHybridCreate(MPI_Comm comm, HYPRE_Solver *solver);
516 int Hypre_ParCSRPCGCreate(MPI_Comm comm, HYPRE_Solver *solver);
519 int Hypre_ParCSRGMRESCreate(MPI_Comm comm, HYPRE_Solver *solver);
522 int Hypre_ParCSRFlexGMRESCreate(MPI_Comm comm, HYPRE_Solver *solver);
525 int Hypre_ParCSRLGMRESCreate(MPI_Comm comm, HYPRE_Solver *solver);
528 int Hypre_ParCSRBiCGSTABCreate(MPI_Comm comm, HYPRE_Solver *solver);
531 Teuchos::RCP<const Epetra_Map> MakeContiguousColumnMap(Teuchos::RCP<const Epetra_RowMatrix> &Matrix)
const;
536 Teuchos::RCP<Epetra_RowMatrix> A_;
538 Teuchos::ParameterList List_;
554 mutable int NumApplyInverse_;
556 double InitializeTime_;
560 mutable double ApplyInverseTime_;
562 double ComputeFlops_;
564 mutable double ApplyInverseFlops_;
569 mutable HYPRE_IJMatrix HypreA_;
571 mutable HYPRE_ParCSRMatrix ParMatrix_;
574 Teuchos::RCP<const Epetra_CrsMatrix> G_;
576 mutable HYPRE_IJMatrix HypreG_;
578 mutable HYPRE_ParCSRMatrix ParMatrixG_;
581 mutable HYPRE_IJVector XHypre_;
583 mutable HYPRE_IJVector YHypre_;
584 mutable HYPRE_ParVector ParX_;
585 mutable HYPRE_ParVector ParY_;
586 mutable Teuchos::RCP<hypre_ParVector> XVec_;
587 mutable Teuchos::RCP<hypre_ParVector> YVec_;
589 Teuchos::RCP<Epetra_MultiVector> Coords_;
590 mutable HYPRE_IJVector xHypre_;
591 mutable HYPRE_IJVector yHypre_;
592 mutable HYPRE_IJVector zHypre_;
593 mutable HYPRE_ParVector xPar_;
594 mutable HYPRE_ParVector yPar_;
595 mutable HYPRE_ParVector zPar_;
598 mutable HYPRE_Solver Solver_;
600 mutable HYPRE_Solver Preconditioner_;
602 int (Ifpack_Hypre::*SolverCreatePtr_)(MPI_Comm, HYPRE_Solver*);
603 int (*SolverDestroyPtr_)(HYPRE_Solver);
604 int (*SolverSetupPtr_)(HYPRE_Solver, HYPRE_ParCSRMatrix, HYPRE_ParVector, HYPRE_ParVector);
605 int (*SolverSolvePtr_)(HYPRE_Solver, HYPRE_ParCSRMatrix, HYPRE_ParVector, HYPRE_ParVector);
606 int (*SolverPrecondPtr_)(HYPRE_Solver, HYPRE_PtrToParSolverFcn, HYPRE_PtrToParSolverFcn, HYPRE_Solver);
607 int (Ifpack_Hypre::*PrecondCreatePtr_)(MPI_Comm, HYPRE_Solver*);
608 int (*PrecondDestroyPtr_)(HYPRE_Solver);
609 int (*PrecondSetupPtr_)(HYPRE_Solver, HYPRE_ParCSRMatrix, HYPRE_ParVector, HYPRE_ParVector);
610 int (*PrecondSolvePtr_)(HYPRE_Solver, HYPRE_ParCSRMatrix, HYPRE_ParVector, HYPRE_ParVector);
612 bool IsSolverCreated_;
613 bool IsPrecondCreated_;
617 Teuchos::RCP<const Epetra_Map> GloballyContiguousRowMap_;
618 Teuchos::RCP<const Epetra_Map> GloballyContiguousColMap_;
619 Teuchos::RCP<const Epetra_Map> GloballyContiguousNodeRowMap_;
620 Teuchos::RCP<const Epetra_Map> GloballyContiguousNodeColMap_;
628 bool UsePreconditioner_;
630 std::vector<Teuchos::RCP<FunctionParameter> > FunsToCall_;
634 mutable Teuchos::ArrayRCP<double> VectorCache_;
virtual int NumInitialize() const =0
Returns the number of calls to Initialize().
virtual int SetUseTranspose(bool UseTranspose)=0
virtual double ComputeTime() const =0
Returns the time spent in Compute().
virtual double ComputeFlops() const =0
Returns the number of flops in the computation phase.
virtual double ApplyInverseTime() const =0
Returns the time spent in ApplyInverse().
virtual double ApplyInverseFlops() const =0
Returns the number of flops in the application of the preconditioner.
virtual const Epetra_RowMatrix & Matrix() const =0
Returns a pointer to the matrix to be preconditioned.
virtual bool IsInitialized() const =0
Returns true if the preconditioner has been successfully initialized, false otherwise.
virtual std::ostream & Print(std::ostream &os) const =0
Prints basic information on iostream. This function is used by operator<<.
virtual const Epetra_Map & OperatorDomainMap() const=0
virtual const char * Label() const=0
virtual int Initialize()=0
Computes all it is necessary to initialize the preconditioner.
virtual double InitializeTime() const =0
Returns the time spent in Initialize().
Ifpack_CondestType
Ifpack_CondestType: enum to define the type of condition number estimate.
virtual int Apply(const Epetra_MultiVector &X, Epetra_MultiVector &Y) const=0
virtual const Epetra_Map & OperatorRangeMap() const=0
virtual const Epetra_Comm & Comm() const=0
virtual int SetParameters(Teuchos::ParameterList &List)=0
Sets all parameters for the preconditioner.
virtual double Condest() const =0
Returns the computed condition number estimate, or -1.0 if not computed.
virtual bool UseTranspose() const=0
Ifpack_ScalingType enumerable type.
Ifpack_Preconditioner: basic class for preconditioning in Ifpack.
virtual int ApplyInverse(const Epetra_MultiVector &X, Epetra_MultiVector &Y) const =0
Applies the preconditioner to vector X, returns the result in Y.
virtual double InitializeFlops() const =0
Returns the number of flops in the initialization phase.
void BiCGSTAB(Epetra_CrsMatrix &A, Epetra_Vector &x, Epetra_Vector &b, Ifpack_CrsRiluk *M, int Maxiter, double Tolerance, double *residual, bool verbose)
virtual bool HasNormInf() const=0
virtual int NumCompute() const =0
Returns the number of calls to Compute().
virtual double NormInf() const=0
virtual bool IsComputed() const =0
Returns true if the preconditioner has been successfully computed, false otherwise.
virtual int Compute()=0
Computes all it is necessary to apply the preconditioner.
virtual int NumApplyInverse() const =0
Returns the number of calls to ApplyInverse().