Package pulse.problem.schemes.rte.dom

Class AdaptiveIntegrator

java.lang.Object

pulse.util.UpwardsNavigable

pulse.util.Group

pulse.util.Accessible

pulse.util.PropertyHolder

pulse.problem.schemes.rte.dom.ODEIntegrator

pulse.problem.schemes.rte.dom.AdaptiveIntegrator

All Implemented Interfaces:

Serializable, Descriptive, Reflexive

Direct Known Subclasses:

ExplicitRungeKutta, TRBDF2

public abstract class AdaptiveIntegrator
extends ODEIntegrator

An ODE integrator with an adaptive step size.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
AdaptiveIntegrator(Discretisation intensities)

Method Summary

Modifier and Type	Method	Description
void	generateGrid(int nNew)	Generates a uniform grid using the argument as the density.
NumericProperty	getAbsoluteTolerance()
NumericProperty	getGridScalingFactor()
HermiteInterpolator	getHermiteInterpolator()
NumericProperty	getRelativeTolerance()
NumericProperty	getTimeThreshold()
RTECalculationStatus	integrate()
boolean	isFirstRun()
Set<NumericPropertyKeyword>	listedKeywords()	By default, this will search the children of this PropertyHolder to collect the types of their listed numeric parameters recursively.
void	reduceStepSize()
void	set(NumericPropertyKeyword type, NumericProperty property)	An abstract method, which must be overriden to gain access over setting the values of all relevant (selected by the programmer) NumericProperties in subclasses of Accessible.
void	setAbsoluteTolerance(NumericProperty p)
void	setFirstRun(boolean firstRun)
void	setGridScalingFactor(NumericProperty p)
void	setRelativeTolerance(NumericProperty p)
void	setTimeThreshold(NumericProperty timeThreshold)
abstract Vector[]	step(int j, double sign)
String	toString()
boolean	wasRescaled()

Methods inherited from class pulse.problem.schemes.rte.dom.ODEIntegrator

derivative, derivative, emission, extract, getDescriptor, getDiscretisation, getEmissionFunction, getPhaseFunction, init, partial, partial, setDiscretisation, setEmissionFunction, setPhaseFunction, source, source, treatZeroIndex

Methods inherited from class pulse.util.PropertyHolder

addListener, areDetailsHidden, data, describe, firePropertyChanged, getListeners, getPrefix, ignoreSiblings, initListeners, isListedNumericType, isListedParameter, listedTypes, numericData, parameterListChanged, removeListeners, setPrefix, updateProperties, updateProperty

Methods inherited from class pulse.util.Accessible

accessibleChildren, genericProperties, genericProperty, numericProperties, numericProperty, property, update, update

Methods inherited from class pulse.util.Group

access, children, contents, getSimpleName, subgroups

Methods inherited from class pulse.util.UpwardsNavigable

addHierarchyListener, getHierarchyListeners, getParent, identify, removeHierarchyListener, removeHierarchyListeners, setParent, specificAncestor, tellParent

Methods inherited from class java.lang.Object

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

Constructor Detail

AdaptiveIntegrator

public AdaptiveIntegrator(Discretisation intensities)

Method Detail

integrate

public RTECalculationStatus integrate()

Specified by:

integrate in class ODEIntegrator

step

public abstract Vector[] step(int j,
                              double sign)

reduceStepSize

public void reduceStepSize()

wasRescaled

public boolean wasRescaled()

generateGrid

public void generateGrid(int nNew)

Generates a uniform grid using the argument as the density.

Parameters:

nNew - new grid density

getRelativeTolerance

public NumericProperty getRelativeTolerance()

getAbsoluteTolerance

public NumericProperty getAbsoluteTolerance()

getGridScalingFactor

public NumericProperty getGridScalingFactor()

setRelativeTolerance

public void setRelativeTolerance(NumericProperty p)

setAbsoluteTolerance

public void setAbsoluteTolerance(NumericProperty p)

setGridScalingFactor

public void setGridScalingFactor(NumericProperty p)

set

public void set(NumericPropertyKeyword type,
                NumericProperty property)

Description copied from class: Accessible

An abstract method, which must be overriden to gain access over setting the values of all relevant (selected by the programmer) NumericProperties in subclasses of Accessible. Typically this involves a switch statement that goes through the different options for the type and invokes different set(...) methods to update the matching NumericProperty with property.

Specified by:

set in class Accessible

Parameters:

type - the type, which must be equal by definition to property.getType().

property - the property, which contains new information.

listedKeywords

public Set<NumericPropertyKeyword> listedKeywords()

Description copied from class: PropertyHolder

By default, this will search the children of this PropertyHolder to collect the types of their listed numeric parameters recursively.

Overrides:

listedKeywords in class PropertyHolder

Returns:

a set of NumericPropertyKeyword instances, which have been explicitly marked as a listed parameter for this PropertyHolder.

toString

public String toString()

Overrides:

toString in class ODEIntegrator

getTimeThreshold

public NumericProperty getTimeThreshold()

setTimeThreshold

public void setTimeThreshold(NumericProperty timeThreshold)

isFirstRun

public boolean isFirstRun()

setFirstRun

public void setFirstRun(boolean firstRun)

getHermiteInterpolator

public HermiteInterpolator getHermiteInterpolator()