Package no.uib.cipr.matrix.sparse
Interface IterationMonitor
- All Known Implementing Classes:
AbstractIterationMonitor,DefaultIterationMonitor,MatrixIterationMonitor
public interface IterationMonitor
Monitors the iterative solution process for convergence and divergence. Can
also report the current progress.
-
Method Summary
Modifier and TypeMethodDescriptionbooleanconverged(double r) Checks for convergencebooleanChecks for convergencebooleanChecks for convergencebooleanChecks for convergenceReturns current iteration reporterReturns the vector-norm in usebooleanisFirst()Returns true for the first iterationintNumber of iterations performedvoidnext()Increases iteration counterdoubleresidual()Returns current residualvoidsetFirst()Resets the iterationvoidsetIterationReporter(IterationReporter monitor) Sets new iteration reportervoidsetNormType(Vector.Norm normType) Sets the vector-norm to calculate with
-
Method Details
-
setFirst
void setFirst()Resets the iteration -
isFirst
boolean isFirst()Returns true for the first iteration -
next
void next()Increases iteration counter -
iterations
int iterations()Number of iterations performed -
residual
double residual()Returns current residual -
converged
Checks for convergence- Parameters:
r- Residual-vectorx- State-vector- Returns:
- True if converged
- Throws:
IterativeSolverNotConvergedException
-
converged
Checks for convergence- Parameters:
r- Residual-normx- State-vector- Returns:
- True if converged
- Throws:
IterativeSolverNotConvergedException
-
converged
Checks for convergence- Parameters:
r- Residual-norm- Returns:
- True if converged
- Throws:
IterativeSolverNotConvergedException
-
converged
Checks for convergence- Parameters:
r- Residual-vector- Returns:
- True if converged
- Throws:
IterativeSolverNotConvergedException
-
setIterationReporter
Sets new iteration reporter -
getIterationReporter
IterationReporter getIterationReporter()Returns current iteration reporter -
setNormType
Sets the vector-norm to calculate with -
getNormType
Vector.Norm getNormType()Returns the vector-norm in use
-