ptolemy.domains.algebraic.kernel

Class AlgebraicLoopDirector.SuccessiveSubstitution

java.lang.Object

ptolemy.domains.algebraic.kernel.AlgebraicLoopDirector.AlgebraicLoopSolver

ptolemy.domains.algebraic.kernel.AlgebraicLoopDirector.SuccessiveSubstitution

Enclosing class:

AlgebraicLoopDirector

class AlgebraicLoopDirector.SuccessiveSubstitution
extends AlgebraicLoopDirector.AlgebraicLoopSolver

Class for solving algebraic loops using the su method.

Author:

Michael Wetter

Field Summary

Fields inherited from class ptolemy.domains.algebraic.kernel.AlgebraicLoopDirector.AlgebraicLoopSolver

_converged, _iterationCount, _maxIterations, _tolerance, _variableNames

Constructor Summary

Constructors

Constructor and Description
SuccessiveSubstitution(java.lang.String[] variableNames, double[] tolerance, int maxIterations) Construct an algebraic loop solver.

Method Summary

Modifier and Type	Method and Description
void	solve(double[] xIni) Solve the algebraic loop using the specified array as the initial guess for the variables being solved for and replace the contents of the specified array with the solution that is found.

Methods inherited from class ptolemy.domains.algebraic.kernel.AlgebraicLoopDirector.AlgebraicLoopSolver

_didConverge, converged, getIterationCount

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SuccessiveSubstitution

public SuccessiveSubstitution(java.lang.String[] variableNames,
                              double[] tolerance,
                              int maxIterations)
                       throws IllegalActionException

Construct an algebraic loop solver.

Parameters:

variableNames - Names of each break variable.

tolerance - Tolerance for each variable.

maxIterations - Maximum number of iterations.

Throws:

IllegalActionException

Method Detail

solve

public void solve(double[] xIni)
           throws IllegalActionException

Solve the algebraic loop using the specified array as the initial guess for the variables being solved for and replace the contents of the specified array with the solution that is found.

This method iterates until a solution is found. If it does not converge within the maximum number of iterations, it throws an IllegalActionException. A method that calls solve(double[] xInitial) can then call converged() to check whether the exception is thrown because of lack of convergence.

Specified by:

solve in class AlgebraicLoopDirector.AlgebraicLoopSolver

Parameters:

xIni - Array with the initial values of the variables, to be replaced with the solution by this method.

Throws:

IllegalActionException - If the prefire() method returns false having previously returned true in the same iteration, or if the prefire() or fire() method of the actor throws it, or if evaluating the function yields a value that is not a double, or if the solver fails to find a solution.