integration
Interface Integrator

All Known Implementing Classes:

BS, Hermite, Hermite2

public interface Integrator

This is the abstract base class for external (i.e. outside the StellarSystem class) integrators. Classes that derive from this can be called from predictRV, fitIntegrate and integrateStable.

Method Summary

double	advance(double[][] xyzParam, double timeInterval, double tstep) Advances the system by the specified time, using xyzParam as initial (r, v).
java.lang.String	getAuthor() Returns the author's name.
java.lang.String	getDesc() Returns a description of the integrator.
java.lang.Object	getProperty(int property) Reserved for future use.
java.lang.String	getVersion() Returns the version of the integrator.
boolean	hasCloseEncounter() Specifies if a close encounter happened during the last advance().
void	setProperty(int property, java.lang.Object value) Reserved for future use.

Method Detail

advance

double advance(double[][] xyzParam,
               double timeInterval,
               double tstep)

Advances the system by the specified time, using xyzParam as initial (r, v). xyzParam is a pointer to the xyzParam field in StellarSystem, so before finishing xyzParam should be set to the new (r, v).

Parameters:

xyzParam - Input / output coordinates

timeInterval - Amount of time to evolve for.

tstep - Timestep hint.

Returns:

Last timestep used.

hasCloseEncounter

boolean hasCloseEncounter()

Specifies if a close encounter happened during the last advance().

Returns:

True if a close encounter happened.

getProperty

java.lang.Object getProperty(int property)

Reserved for future use.

Parameters:

property - Specifies which property to return.

Returns:

Value of the requested property.

setProperty

void setProperty(int property,
                 java.lang.Object value)

Reserved for future use.

Parameters:

property - Which property to set.

value - Value of the property.

getAuthor

java.lang.String getAuthor()

Returns the author's name.

Returns:

Author's name.

getVersion

java.lang.String getVersion()

Returns the version of the integrator.

Returns:

Version

getDesc

java.lang.String getDesc()

Returns a description of the integrator.

Returns:

Description.