Package cnuphys.adaptiveSwim

Class AdaptivePlaneStopper

java.lang.Object

cnuphys.adaptiveSwim.AAdaptiveStopper

cnuphys.adaptiveSwim.AdaptivePlaneStopper

All Implemented Interfaces:

IAdaptiveStopper

public class AdaptivePlaneStopper
extends AAdaptiveStopper

Stopper for swimming to a plane

Author:

heddle

Field Summary

Fields inherited from class cnuphys.adaptiveSwim.AAdaptiveStopper

_accuracy, _dim, _hLast, _s, _sf, _THEMAXSTEP, _trajectory, _u

Constructor Summary

Constructors

Constructor	Description
AdaptivePlaneStopper(double[] u0, double sf, Plane targetPlane, double accuracy, SwimTrajectory trajectory)	Rho stopper (does check max path length)

Method Summary

Modifier and Type	Method	Description
boolean	stopIntegration(double snew, double[] unew)	Given the current state of the integration, should we stop?

Methods inherited from class cnuphys.adaptiveSwim.AAdaptiveStopper

accept, copy, getMaxStepSize, getS, getSmax, getU, setMaxStep

Methods inherited from class java.lang.Object

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

Constructor Details

AdaptivePlaneStopper

public AdaptivePlaneStopper(double[] u0,
 double sf,
 Plane targetPlane,
 double accuracy,
 SwimTrajectory trajectory)

Rho stopper (does check max path length)

Parameters:

u0 - initial state vector

sf - the maximum value of the path length in meters

targetPlane - the target plane

accuracy - the accuracy in meters

trajectory - optional swim trajectory (can be null)

Method Details

stopIntegration

public boolean stopIntegration(double snew,
 double[] unew)

Description copied from interface: IAdaptiveStopper

Given the current state of the integration, should we stop? This allows the integration to stop, for example, if some distance from the origin has been exceeded or if the independent variable passes some threshold. It won't be precise, because the check may not happen on every step, but it should be close.

Returns:

true if we should stop now.