ptolemy.domains.ct.kernel.solver
Class FixedStepSolver

java.lang.Object
  extended byptolemy.kernel.util.NamedObj
      extended byptolemy.domains.ct.kernel.ODESolver
          extended byptolemy.domains.ct.kernel.solver.FixedStepSolver
All Implemented Interfaces:
Changeable, java.lang.Cloneable, Debuggable, DebugListener, Derivable, ModelErrorHandler, MoMLExportable, Nameable, java.io.Serializable
Direct Known Subclasses:
BackwardEulerSolver, ForwardEulerSolver

public abstract class FixedStepSolver
extends ODESolver

Abstract base class for fixed step size (no error control) ODE solvers. It provide base implementation for some methods that are shared by all fixed-step-size solvers.

Since:
Ptolemy II 0.2
Version:
$Id: FixedStepSolver.java,v 1.35 2004/04/13 03:26:56 cxh Exp $
Author:
Jie Liu
See Also:
Serialized Form
Accepted Rating:
Yellow (liuxj)
Proposed Rating:
Yellow (liuj)

Nested Class Summary
 
Nested classes inherited from class ptolemy.kernel.util.NamedObj
NamedObj.ContainedObjectsIterator
 
Field Summary
 
Fields inherited from class ptolemy.kernel.util.NamedObj
_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _elementName, _isPersistent, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS
 
Constructor Summary
FixedStepSolver()
          Construct a solver in the default workspace with an empty string as name.
FixedStepSolver(Workspace workspace)
          Construct a solver in the given workspace with a null string name.
 
Method Summary
 boolean integratorIsAccurate(CTBaseIntegrator integrator)
          Return true always, since no error control is performed.
 double integratorPredictedStepSize(CTBaseIntegrator integrator)
          Return the current step size of the director, since no step size control is performed.
 
Methods inherited from class ptolemy.domains.ct.kernel.ODESolver
_makeSolverOf, _prefireIfNecessary, getContainer, getHistoryCapacityRequirement, getIntegratorAuxVariableCount, getRound, incrementRound, integratorFire, resetRound, resolveStates
 
Methods inherited from class ptolemy.kernel.util.NamedObj
_addAttribute, _attachText, _cloneFixAttributeFields, _debug, _debug, _debug, _debug, _debug, _description, _exportMoMLContents, _getContainedObject, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _propagateExistence, _propagateValue, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, attributeChanged, attributeList, attributeList, attributeTypeChanged, clone, clone, containedObjectsIterator, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, exportMoML, exportMoML, exportMoML, exportMoML, exportMoML, getAttribute, getAttribute, getAttributes, getChangeListeners, getClassName, getDerivedLevel, getDerivedList, getElementName, getFullName, getModelErrorHandler, getName, getName, getPrototypeList, getSource, handleModelError, isDeferringChangeRequests, isOverridden, isPersistent, message, propagateExistence, propagateValue, propagateValues, removeChangeListener, removeDebugListener, requestChange, setClassName, setDeferringChangeRequests, setDerivedLevel, setModelErrorHandler, setName, setPersistent, setSource, toplevel, toString, uniqueName, validateSettables, workspace
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

FixedStepSolver

public FixedStepSolver()
Construct a solver in the default workspace with an empty string as name. The solver is added to the list of objects in the workspace. Increment the version number of the workspace.


FixedStepSolver

public FixedStepSolver(Workspace workspace)
Construct a solver in the given workspace with a null string name. If the workspace argument is null, use the default workspace. The director is added to the list of objects in the workspace. Increment the version number of the workspace.

Parameters:
workspace - Object for synchronization and version tracking
Method Detail

integratorIsAccurate

public final boolean integratorIsAccurate(CTBaseIntegrator integrator)
Return true always, since no error control is performed.

Specified by:
integratorIsAccurate in class ODESolver
Parameters:
integrator - The integrator that wants to do the test.
Returns:
True always.
See Also:
CTStepSizeControlActor.isThisStepAccurate()

integratorPredictedStepSize

public final double integratorPredictedStepSize(CTBaseIntegrator integrator)
Return the current step size of the director, since no step size control is performed.

Specified by:
integratorPredictedStepSize in class ODESolver
Parameters:
integrator - The integrator that want to predict the step size.
Returns:
The current step size of the director.
See Also:
CTStepSizeControlActor.predictedStepSize()