ptolemy.domains.ct.kernel
Interface CTGeneralDirector

All Known Subinterfaces:

CTTransparentDirector

All Known Implementing Classes:

CTCaseDirector, CTDirector, CTEmbeddedDirector, CTMixedSignalDirector, CTMultiSolverDirector, HSFSMDirector, HSModalDirector

public interface CTGeneralDirector

Interface that defines the methods for lower level CT directors in hierarchy to query information from the upper level CT directors. The information includes the current step size for integration, the current execution phase, the beginning time of the current integration, and the current solver. All CT directors must implement this interface.

The CTDirector class and CTTransparentDirector interface directly implements this interface. The CTDirector class focuses on how to solve ordinary differential equations. The CTTransparentDirector interface defines the methods for upper level CT directors in hierarchy to query step size control information from the lower level CT directors.

Since:

Ptolemy II 4.1

Version:

$Id: CTGeneralDirector.java 57040 2010-01-27 20:52:32Z cxh $

Author:

Haiyang Zheng

Accepted Rating:

Green (hyzheng)

Proposed Rating:

Green (hyzheng)

Method Summary

double	getCurrentStepSize() Return the current step size used by this director.
double	getErrorTolerance() Return the error tolerance, used by state and output step size actors.
CTExecutionPhase	getExecutionPhase() Return the current execution phase.
CTGeneralDirector	getExecutiveCTGeneralDirector() Return the executive CT general director of this director, or null if this director is at the top level or the executive director is not a CT general director.
Time	getIterationBeginTime() Return the time the current iteration starts from.
java.lang.String	getODESolverClassName() Return the class name for the ODE solver.
boolean	isDiscretePhase() Return true if the current phase of execution is a discrete one.

Method Detail

getCurrentStepSize

double getCurrentStepSize()

Return the current step size used by this director.

Returns:

The current step size used by this director.

getErrorTolerance

double getErrorTolerance()

Return the error tolerance, used by state and output step size actors.

Returns:

The error tolerance.

getExecutiveCTGeneralDirector

CTGeneralDirector getExecutiveCTGeneralDirector()

Return the executive CT general director of this director, or null if this director is at the top level or the executive director is not a CT general director.

Returns:

The executive CT general director of this director, if there is any.

getExecutionPhase

CTExecutionPhase getExecutionPhase()

Return the current execution phase.

Returns:

The the current execution phase.

getIterationBeginTime

Time getIterationBeginTime()

Return the time the current iteration starts from.

Returns:

The time the current iteration starts from.

getODESolverClassName

java.lang.String getODESolverClassName()

Return the class name for the ODE solver.

Returns:

The class name for the ODE solver.

isDiscretePhase

boolean isDiscretePhase()

Return true if the current phase of execution is a discrete one.

Returns:

true if the current phase of execution is a discrete one.