Solver Options


\begin{classdesc}{SolverOptions}{}
This class defines the solver options for a l...
...e option also supports the handling of diagnostic informations.
\end{classdesc}


\begin{methoddesc}[SolverOptions]{getSummary}{}
Returns a string reporting the current settings
\end{methoddesc}


\begin{methoddesc}[SolverOptions]{getName}{key}
Returns the name as a string of a given key
\end{methoddesc}


\begin{methoddesc}
% latex2html id marker 6789
[SolverOptions]{setSolverMethod}{...
...S 1} for the solvers supported by \module{esys.finley}\xspace .
\end{methoddesc}


\begin{methoddesc}[SolverOptions]{getSolverMethod}{}
Returns key of the solver method to be used.
\end{methoddesc}


\begin{methoddesc}
% latex2html id marker 6820
[SolverOptions]{setPreconditioner...
...S 2} for the solvers supported by \module{esys.finley}\xspace .
\end{methoddesc}


\begin{methoddesc}[SolverOptions]{getPreconditioner}{}
Returns key of the preconditioner to be used.
\end{methoddesc}


\begin{methoddesc}[SolverOptions]{setPackage}{\optional{package=SolverOptions.DE...
... \member{SolverOptions.MKL} and \member{SolverOptions.UMFPACK}.
\end{methoddesc}


\begin{methoddesc}[SolverOptions]{getPackage}{}
Returns the solver package key
\end{methoddesc}


\begin{methoddesc}[SolverOptions]{resetDiagnostics}{\optional{all=False}}
resets...
...pace all diagnostics including accumulative counters are reset.
\end{methoddesc}


\begin{methoddesc}[SolverOptions]{getDiagnostics}{\optional{ name}}
Returns the ...
...ual
\item ''converged'': return self.__converged
\end{itemize}\end{methoddesc}


\begin{methoddesc}[SolverOptions]{hasConverged}{}
Returns \constant{True}\xspace...
...been thrown by the solver the status of this flag is undefined.
\end{methoddesc}


\begin{methoddesc}[SolverOptions]{setCoarsening}{\optional{method=SolverOptions....
..._COARSENING}, or \member{SolverOptions.AGGREGATION_COARSENING}.
\end{methoddesc}


\begin{methoddesc}[SolverOptions]{getCoarsening}{}
Returns the key of the coarse...
...ndex{linear solver!AMG}\index{algebraic Multi-grid}\index{AMG}.
\end{methoddesc}


\begin{methoddesc}[SolverOptions]{setReordering}{\optional{ordering=SolverOption...
...STED_DISSECTION}, or \member{SolverOptions.DEFAULT_REORDERING}.
\end{methoddesc}


\begin{methoddesc}[SolverOptions]{getReordering}{}
Returns the key of the reordering method to be applied if supported by the solver.
\end{methoddesc}


\begin{methoddesc}[SolverOptions]{setRestart}{\optional{restart=None}}
Sets the ...
...f \var{restart} is equal to \var{None} no restart is performed.
\end{methoddesc}


\begin{methoddesc}[SolverOptions]{getRestart}{}
Returns the number of iterations...
...index{linear solver!GMRES}\index{GMRES}is performing a restart.
\end{methoddesc}


\begin{methoddesc}[SolverOptions]{setTruncation}{\optional{truncation=20}}
Sets ...
...ES}\xspace\index{linear solver!GMRES}\index{GMRES}converged but
\end{methoddesc}


\begin{methoddesc}[SolverOptions]{getTruncation}{}
Returns the number of residua...
...ar solver!GMRES}\index{GMRES}to be stored for orthogonalization
\end{methoddesc}


\begin{methoddesc}[SolverOptions]{setIterMax}{\optional{iter_max=10000}}
Sets the maximum number of iteration steps
\end{methoddesc}


\begin{methoddesc}[SolverOptions]{getIterMax}{}
Returns maximum number of iteration steps
\end{methoddesc}


\begin{methoddesc}[SolverOptions]{setLevelMax}{\optional{level_max=10}}
Sets the...
...index{algebraic Multi-grid}\index{AMG}solver or preconditioner.
\end{methoddesc}


\begin{methoddesc}[SolverOptions]{getLevelMax}{}
Returns the maximum number of c...
...to be used in an algebraic multi level solver or preconditioner
\end{methoddesc}


\begin{methoddesc}[SolverOptions]{setCoarseningThreshold}{\optional{theta=0.05}}...
...\index{algebraic Multi-grid}\index{AMG}solver or preconditioner
\end{methoddesc}


\begin{methoddesc}[SolverOptions]{getCoarseningThreshold}{}
Returns the threshol...
...\index{algebraic Multi-grid}\index{AMG}solver or preconditioner
\end{methoddesc}


\begin{methoddesc}[SolverOptions]{setMinCoarseMatrixSize}{\optional{size=500}}
Sets the minumum size of the coarsest level matrix in AMG.
\end{methoddesc}


\begin{methoddesc}[SolverOptions]{getMinCoarseMatrixSize}{}
Returns the minumum size of the coarsest level matrix in AMG.
\end{methoddesc}


\begin{methoddesc}[SolverOptions]{setNumSweeps}{\optional{sweeps=2}}
Sets the nu...
...itioner!Gauss-Seidel}\index{Gauss-Seidel Scheme}preconditioner.
\end{methoddesc}


\begin{methoddesc}[SolverOptions]{getNumSweeps}{}
Returns the number of sweeps i...
...itioner!Gauss-Seidel}\index{Gauss-Seidel Scheme}preconditioner.
\end{methoddesc}


\begin{methoddesc}[SolverOptions]{setNumPreSweeps}{\optional{sweeps=2}}
Sets the...
...index{linear solver!AMG}\index{algebraic Multi-grid}\index{AMG}
\end{methoddesc}


\begin{methoddesc}[SolverOptions]{getNumPreSweeps}{}
Returns the number of sweep...
...index{linear solver!AMG}\index{algebraic Multi-grid}\index{AMG}
\end{methoddesc}


\begin{methoddesc}[SolverOptions]{setNumPostSweeps}{\optional{sweeps=2}}
Sets th...
...index{linear solver!AMG}\index{algebraic Multi-grid}\index{AMG}
\end{methoddesc}


\begin{methoddesc}[SolverOptions]{getNumPostSweeps}{}
Returns he number of sweep...
...index{linear solver!AMG}\index{algebraic Multi-grid}\index{AMG}
\end{methoddesc}


\begin{methoddesc}[SolverOptions]{setTolerance}{\optional{rtol=1.e-8}}
Sets the ...
...iscrete problem but will
not consider any discretization error.
\end{methoddesc}


\begin{methoddesc}[SolverOptions]{getTolerance}{}
Returns the relative tolerance for the solver
\end{methoddesc}


\begin{methoddesc}[SolverOptions]{setAbsoluteTolerance}{\optional{atol=0.}}
Sets...
...iscrete problem but will
not consider any discretization error.
\end{methoddesc}


\begin{methoddesc}[SolverOptions]{getAbsoluteTolerance}{}
Returns the absolute tolerance for the solver
\end{methoddesc}


\begin{methoddesc}[SolverOptions]{setInnerTolerance}{\optional{rtol=0.9}}
Sets t...
...eme for instance
on the coarsest level in a multi-level scheme.
\end{methoddesc}


\begin{methoddesc}[SolverOptions]{getInnerTolerance}{}
Returns the relative tolerance for an inner iteration scheme
\end{methoddesc}


\begin{methoddesc}[SolverOptions]{setDropTolerance}{\optional{drop_tol=0.01}}
Sets the relative drop tolerance in ILUT
\end{methoddesc}


\begin{methoddesc}[SolverOptions]{getDropTolerance}{}
Returns the relative drop ...
...lverOptions.ILUT}\xspace\index{preconditioner!ILUT}\index{ILUT}
\end{methoddesc}


\begin{methoddesc}[SolverOptions]{setDropStorage}{\optional{storage=2.}}
Sets th...
...UT}\xspace\index{preconditioner!ILUT}\index{ILUT}factorization.
\end{methoddesc}


\begin{methoddesc}[SolverOptions]{getDropStorage}{}
Returns the maximum allowed ...
...lverOptions.ILUT}\xspace\index{preconditioner!ILUT}\index{ILUT}
\end{methoddesc}


\begin{methoddesc}[SolverOptions]{setRelaxationFactor}{\optional{factor=0.3}}
Se...
...ace\index{preconditioner!RILU}\index{RILU}to the main diagonal.
\end{methoddesc}


\begin{methoddesc}[SolverOptions]{getRelaxationFactor}{}
Returns the relaxation factor used to add dropped elements in RILU to the main diagonal.
\end{methoddesc}


\begin{methoddesc}[SolverOptions]{isSymmetric}{}
Returns \constant{True}\xspace is the descrete system is indicated as symmetric.
\end{methoddesc}


\begin{methoddesc}[SolverOptions]{setSymmetryOn}{}
Sets the symmetry flag to indicate that the coefficient matrix is symmetric.
\end{methoddesc}


\begin{methoddesc}[SolverOptions]{setSymmetryOff}{}
Clears the symmetry flag for the coefficient matrix.
\end{methoddesc}


\begin{methoddesc}[SolverOptions]{isVerbose}{}
Returns \constant{True}\xspace if the solver is expected to be verbose.
\end{methoddesc}


\begin{methoddesc}[SolverOptions]{setVerbosityOn}{}
Switches the verbosity of the solver on.
\end{methoddesc}


\begin{methoddesc}[SolverOptions]{setVerbosityOff}{}
Switches the verbosity of the solver off.
\end{methoddesc}


\begin{methoddesc}[SolverOptions]{adaptInnerTolerance}{}
Returns \constant{True}...
... the inner tolerance set by \member{setInnerTolerance} is used.
\end{methoddesc}


\begin{methoddesc}[SolverOptions]{setInnerToleranceAdaptionOn}{}
Switches the automatic selection of inner tolerance on
\end{methoddesc}


\begin{methoddesc}[SolverOptions]{setInnerToleranceAdaptionOff}{}
Switches the automatic selection of inner tolerance off.
\end{methoddesc}


\begin{methoddesc}[SolverOptions]{setInnerIterMax}{\optional{iter_max=10}}
Sets the maximum number of iteration steps for the inner iteration.
\end{methoddesc}


\begin{methoddesc}[SolverOptions]{getInnerIterMax}{}
Returns maximum number of inner iteration steps.
\end{methoddesc}


\begin{methoddesc}[SolverOptions]{acceptConvergenceFailure}{}
Returns \constant{...
... method to check if the
last call to the solver was successful.
\end{methoddesc}


\begin{methoddesc}[SolverOptions]{setAcceptanceConvergenceFailureOn}{}
Switches the acceptance of a failure of convergence on.
\end{methoddesc}


\begin{methoddesc}[SolverOptions]{setAcceptanceConvergenceFailureOff}{}
Switches the acceptance of a failure of convergence off.
\end{methoddesc}


\begin{memberdesc}[SolverOptions]{DEFAULT}
default method, preconditioner or pac...
...opriate method should be
chosen by the used PDE solver library.
\end{memberdesc}


\begin{memberdesc}[SolverOptions]{MKL}
the \texttt{MKL}\xspace\index{packages!MKL}\index{MKL}library by Intel,~Reference~\cite{MKL}\footnotemark .
\end{memberdesc}


\begin{memberdesc}[SolverOptions]{UMFPACK}
the \texttt{UMFPACK}\xspace\index{pac...
...pace\index{packages!UMFPACK}\index{UMFPACK}is not parallelized.
\end{memberdesc}


\begin{memberdesc}
% latex2html id marker 7093
[SolverOptions]{PASO}
\texttt{PAS...
...dule{esys.finley}\xspace , see Section~\ref{CHAPTER ON FINLEY}.
\end{memberdesc}


\begin{memberdesc}[SolverOptions]{ITERATIVE}
the default iterative method and pr...
...space\index{preconditioner!Jacobi}\index{Jacobi}preconditioner.
\end{memberdesc}


\begin{memberdesc}[SolverOptions]{DIRECT}
the default direct linear solver.
\end{memberdesc}


\begin{memberdesc}[SolverOptions]{CHOLEVSKY}
direct solver based on Cholevsky fa...
...Reference~\cite{Saad}. The solver will require a symmetric PDE.
\end{memberdesc}


\begin{memberdesc}[SolverOptions]{PCG}
preconditioned conjugate gradient method,...
...olver!PCG}\index{PCG}. The solver will require a symmetric PDE.
\end{memberdesc}


\begin{memberdesc}[SolverOptions]{TFQMR}
transpose-free quasi-minimal residual m...
...Reference~\cite{WEISS}\index{linear solver!TFQMR}\index{TFQMR}. \end{memberdesc}


\begin{memberdesc}[SolverOptions]{GMRES}
the GMRES method, see~Reference~\cite{W...
...ers
\var{truncation} and \var{restart} of \method{getSolution}.
\end{memberdesc}


\begin{memberdesc}[SolverOptions]{MINRES}
minimal residual method method, \index{linear solver!MINRES}\index{MINRES} \end{memberdesc}


\begin{memberdesc}[SolverOptions]{LUMPING}
uses lumping to solve the system of l...
...s finer.
Lumping does not use the linear system solver library.
\end{memberdesc}


\begin{memberdesc}[SolverOptions]{PRES20}
the GMRES method with truncation after...
...siduals and
restart after 20 steps, see~Reference~\cite{WEISS}.
\end{memberdesc}


\begin{memberdesc}[SolverOptions]{CGS}
conjugate gradient squared method, see~Reference~\cite{WEISS}.
\end{memberdesc}


\begin{memberdesc}[SolverOptions]{BICGSTAB}
stabilized bi-conjugate gradients methods, see~Reference~\cite{WEISS}.
\end{memberdesc}


\begin{memberdesc}[SolverOptions]{SSOR}
symmetric successive over-relaxation met...
...oner but some linear solver libraries support
this as a solver.
\end{memberdesc}


\begin{memberdesc}[SolverOptions]{ILU0}
the incomplete LU factorization preconditioner with no fill-in, see~Reference~\cite{Saad}.
\end{memberdesc}


\begin{memberdesc}[SolverOptions]{ILUT}
the incomplete LU factorization precondi...
...{getDropStorage} are both set in the
\method{getSolution} call.
\end{memberdesc}


\begin{memberdesc}[SolverOptions]{JACOBI}
the Jacobi preconditioner, see~Reference~\cite{Saad}.
\end{memberdesc}


\begin{memberdesc}[SolverOptions]{AMG}
the algebraic--multi grid method, see~Ref...
...solver method but is more robust when used
in a preconditioner.
\end{memberdesc}


\begin{memberdesc}[SolverOptions]{GAUSS_SEIDEL}
the symmetric Gauss-Seidel preco...
...te{Saad}.
\member{getNumSweeps()} is the number of sweeps used.
\end{memberdesc}


\begin{memberdesc}[SolverOptions]{RILU}
relaxed incomplete LU factorization prec...
...agonal
with the relaxation factor \member{getRelaxationFactor}
\end{memberdesc}


\begin{memberdesc}[SolverOptions]{REC_ILU}
recursive incomplete LU factorization...
...}\index{ILU0}0 but applies reordering during the factorization.
\end{memberdesc}


\begin{memberdesc}[SolverOptions]{NO_REORDERING}
no ordering is used during factorization.
\end{memberdesc}


\begin{memberdesc}[SolverOptions]{DEFAULT_REORDERING}
the default reordering method during factorization.
\end{memberdesc}


\begin{memberdesc}[SolverOptions]{MINIMUM_FILL_IN}
applies reordering before fac...
... advisable to apply reordering on the mesh to minimize fill-in.
\end{memberdesc}


\begin{memberdesc}[SolverOptions]{NESTED_DISSECTION}
applies reordering before f...
... advisable to apply reordering on the mesh to minimize fill-in.
\end{memberdesc}


\begin{memberdesc}[SolverOptions]{TRILINOS}
the Trilinos library is used as a solver~Reference~\cite{TRILINOS}
\end{memberdesc}


\begin{memberdesc}[SolverOptions]{SUPER_LU}
the SuperLU library is used as a solver~Reference~\cite{SuperLU}
\end{memberdesc}


\begin{memberdesc}[SolverOptions]{PASTIX}
the Pastix library is used as a solver~Reference~\cite{PASTIX}
\end{memberdesc}


\begin{memberdesc}[SolverOptions]{YAIR_SHAPIRA_COARSENING}
\member{SolverOptions...
...gebraic Multi-grid}\index{AMG}coarsening method by Yair-Shapira
\end{memberdesc}


\begin{memberdesc}[SolverOptions]{RUGE_STUEBEN_COARSENING} \member{SolverOptions...
...aic Multi-grid}\index{AMG}coarsening method by Ruge and Stueben
\end{memberdesc}


\begin{memberdesc}[SolverOptions]{AGGREGATION_COARSENING} \member{SolverOptions....
...Multi-grid}\index{AMG}coarsening using (symmetric) aggregation
\end{memberdesc}


\begin{memberdesc}[SolverOptions]{NO_PRECONDITIONER}
no preconditioner is applied.
\end{memberdesc}

esys@esscc.uq.edu.au