fr.cnes.genopus.math

Class GPIntegrator

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GPanel

fr.cnes.genopus.math.GPIntegrator

All Implemented Interfaces:

fr.cnes.genius.main.GClear, fr.cnes.genius.main.GDisplay, fr.cnes.genius.main.GListener, fr.cnes.genius.main.GReadWrite

public class GPIntegrator
extends fr.cnes.genius.lowLevel.GPanel
implements fr.cnes.genius.main.GReadWrite, fr.cnes.genius.main.GClear, fr.cnes.genius.main.GListener

Widget for numerical integrator panel definition.

Author:

dlancien HISTORIQUE VERSION:2.1:DM:DM-635:11/10/2019:[GENOPUS] Montee de niveau GENIUS 1.9 VERSION:2.1:DM:DM-617:11/10/2019:[GENOPUS] Widget integrateur numerique FIN-HISTORIQUE

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GPIntegrator.IntegratorTypeEnum Enumeration for first order integrators types.
static class	GPIntegrator.Tolerances Tolerances definition options.

Nested classes/interfaces inherited from class fr.cnes.genius.lowLevel.GPanel

fr.cnes.genius.lowLevel.GPanel.Panel, fr.cnes.genius.lowLevel.GPanel.ScrollBarVisibility

Nested classes/interfaces inherited from class fr.cnes.genius.main.GComponent

fr.cnes.genius.main.GComponent.CopyPasteOperation, fr.cnes.genius.main.GComponent.DisplayIndicatorStatus, fr.cnes.genius.main.GComponent.ItemType, fr.cnes.genius.main.GComponent.Operation

Field Summary

Fields

Modifier and Type	Field and Description
static double	DEFAULT_ABS_MASS_TOL Default absolute mass tolerance for simplified tolerances (1E-3 kg).
static double	DEFAULT_REL_MASS_TOLERANCE Default relative mass tolerance for simplified tolerances (1E-5).
static int	THREE_DIM 3D vector length.
static int	TOL_LENGTH Tolerances length.

Fields inherited from class fr.cnes.genius.main.GComponent

NAME_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
GPIntegrator() Empty constructor.
GPIntegrator(GPIntegrator.IntegratorTypeEnum[] displayedIntegrators, GPIntegrator.IntegratorTypeEnum integratorType) Creates a new instance.
GPIntegrator(String widgetId) Creates a new instance with Dormand-Prince integrator as default displayed integrator.
GPIntegrator(String widgetId, GPIntegrator.IntegratorTypeEnum[] displayedIntegrators, GPIntegrator.IntegratorTypeEnum integratorType) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	after(fr.cnes.genius.main.GEvent e)
void	before(fr.cnes.genius.main.GEvent arg0)
void	clear()
void	display()
void	generic()
double	getAbsMassTolerance() Get the absolute mass tolerance.
double	getDOPMaxTimestep() Get the DOP max timestep.
double	getDOPMinTimestep() Get the DOP min timestep.
GPDop853	getDopPanel() Returns the DOP panel.
double[][]	getDOPTolerances(fr.cnes.sirius.patrius.orbits.Orbit initialOrbit) Get the DOP tolerances (absolutes and relative).
GPIntegrator.Tolerances	getDOPToleranceType() Get the DOP max timestep.
fr.cnes.sirius.patrius.math.ode.FirstOrderIntegrator	getFirstOrderIntegrator(fr.cnes.sirius.patrius.orbits.Orbit initialOrbit) Get the first order integrator
double	getRelMassTolerance() Get the relative mass tolerance.
double	getRKTimestep() Get the Runge-Kutta timestep.
boolean	isDOPBypassMinStep() Get the DOP bypass min step flag.
void	read()
protected void	setDefaultConstraints() Set the default constraints.
void	setDOPParameters(double minStep, double maxStep, boolean bypassMinStep, GPIntegrator.Tolerances displayedTolerance) Set DOP parameters.
void	setDOPTolerancesComplete(double[] absTol, double[] relTol) Set DOP tolerances in case of complete model.
void	setDOPTolerancesReduced(double[] absTol, double[] relTol) Set DOP tolerances in case of reduced model.
void	setDOPTolerancesSimplified(double localPositionError) Set DOP tolerance in case of simplified model.
void	setRKParameters(double timestep) Set fixed time step integrators parameters (RK4 and RK6 integrators).
void	write()

Methods inherited from class fr.cnes.genius.lowLevel.GPanel

clearConstraint, getClassConstraint, getComponent, getHorizontalScroll, getInnerDescendantClassConstraint, getJPanel, getJScrollPane, getLayoutConstraints, getStringClassConstraint, getVerticalScroll, mainClear, mainDisplay, put, setClassConstraint, setColumnConstraints, setConstraint, setHorizontalScroll, setInnerDescendantClassConstraint, setLayoutConstraints, setMargins, setPanelConstraints, setPreferredSize, setRowConstraints, setVerticalScroll

Methods inherited from class fr.cnes.genius.main.GComponent

activateConstraintsByType, attachCopyPasteMenu, attachCopyPasteMenu, beginOfElement, beginOfElement, beginOfElement, beginOfElement, clearAllInnerDescendantConstraint, clearInnerDescendantContraint, composeWidgetId, doDisplay, endOfElement, getCommentInConfigFile, getConstraint, getCurrentOperation, getDisplayIndicatorStatus, getDisplayIsModifiedIndicator, getElement, getGClassName, getGPanel, getGParent, getGUnitInConfigFile, getInnerDescendantConstraint, getName, getNameInConfigFile, getOperationSaveValue, getPathInConfigFile, getSimpleWidgetId, getStatus, getStringConstraint, getSubComponent, getWidgetId, handleCopyPasteEvent, handleCopyPasteEvent, handleProcessEventException, isCopyPasteEvent, isEnabled, isForcedStatus, isModified, launchInvalidPositionException, parseSimpleConstraint, processGEvent, setBusyCursor, setCommentInConfigFile, setCopyPasteMenuEnabled, setCurrentOperation, setDataForConstraintsByType, setDisplayIsModifiedIndicator, setElement, setEnabled, setForcedStatus, setGPanel, setGParent, setGUnitInConfigFile, setInnerDescendantConstraint, setName, setNameAndCommentInConfigFile, setNameInConfigFile, setPathInConfigFile, setStatus, setStringConstraint, setToolTipText, setWidgetId, setWidth, setWindowBusyCursor, updateIsModifiedIndicator, writeCollection, writeCollection, writeCollection, writeCollection, writeConfigItem, writeConfigItem, writeConfigItem, writeConfigItem, writeConfigItem

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ABS_MASS_TOL

public static final double DEFAULT_ABS_MASS_TOL

Default absolute mass tolerance for simplified tolerances (1E-3 kg).

See Also:

Constant Field Values

DEFAULT_REL_MASS_TOLERANCE

public static final double DEFAULT_REL_MASS_TOLERANCE

Default relative mass tolerance for simplified tolerances (1E-5).

See Also:

Constant Field Values

TOL_LENGTH

public static final int TOL_LENGTH

Tolerances length.

See Also:

Constant Field Values

THREE_DIM

public static final int THREE_DIM

3D vector length.

See Also:

Constant Field Values

Constructor Detail

GPIntegrator

public GPIntegrator()
             throws GPDateException,
                    fr.cnes.genius.exception.GArithmeticException

Empty constructor.

Throws:

GPDateException - if some error concerning date definition occurs

fr.cnes.genius.exception.GArithmeticException - if some error concerning timestep definition occurs

GPIntegrator

public GPIntegrator(String widgetId)
             throws GPDateException

Creates a new instance with Dormand-Prince integrator as default displayed integrator.

Parameters:

widgetId - widget identifier.

Throws:

GPDateException - if some error concerning date definition occurs

GPIntegrator

public GPIntegrator(GPIntegrator.IntegratorTypeEnum[] displayedIntegrators,
                    GPIntegrator.IntegratorTypeEnum integratorType)
             throws GPDateException

Creates a new instance.

Parameters:

displayedIntegrators - integrators to be displayed

integratorType - default displayed integrator type

Throws:

GPDateException - if some error concerning date definition occurs

GPIntegrator

public GPIntegrator(String widgetId,
                    GPIntegrator.IntegratorTypeEnum[] displayedIntegrators,
                    GPIntegrator.IntegratorTypeEnum integratorType)
             throws GPDateException

Creates a new instance.

Parameters:

widgetId - widget identifier.

displayedIntegrators - integrators to be displayed

integratorType - default displayed integrator type

Throws:

GPDateException - if some error concerning date definition occurs

Method Detail

setDefaultConstraints

protected final void setDefaultConstraints()

Set the default constraints.

Overrides:

setDefaultConstraints in class fr.cnes.genius.lowLevel.GPanel

generic

public void generic()
             throws fr.cnes.genius.exception.GException

Specified by:

generic in class fr.cnes.genius.lowLevel.GPanel

Throws:

fr.cnes.genius.exception.GException

read

public void read()
          throws fr.cnes.genius.exception.GException

Specified by:

read in interface fr.cnes.genius.main.GReadWrite

Throws:

fr.cnes.genius.exception.GException

write

public void write()
           throws fr.cnes.genius.exception.GException

Specified by:

write in interface fr.cnes.genius.main.GReadWrite

Throws:

fr.cnes.genius.exception.GException

display

public void display()
             throws fr.cnes.genius.exception.GException

Specified by:

display in interface fr.cnes.genius.main.GDisplay

Throws:

fr.cnes.genius.exception.GException

clear

public void clear()
           throws fr.cnes.genius.exception.GException

Specified by:

clear in interface fr.cnes.genius.main.GClear

Throws:

fr.cnes.genius.exception.GException

getRKTimestep

public double getRKTimestep()

Get the Runge-Kutta timestep.

Returns:

the value of the Runge-Kutta timestep

getDOPMinTimestep

public double getDOPMinTimestep()

Get the DOP min timestep.

Returns:

the value of the DOP min timestep

getDOPMaxTimestep

public double getDOPMaxTimestep()

Get the DOP max timestep.

Returns:

the value of the DOP min timestep

isDOPBypassMinStep

public boolean isDOPBypassMinStep()

Get the DOP bypass min step flag.

Returns:

the DOP bypass min step flag

getDOPToleranceType

public GPIntegrator.Tolerances getDOPToleranceType()

Get the DOP max timestep.

Returns:

the value of the DOP min timestep

getDOPTolerances

public double[][] getDOPTolerances(fr.cnes.sirius.patrius.orbits.Orbit initialOrbit)
                            throws fr.cnes.genius.exception.GException

Get the DOP tolerances (absolutes and relative).

Parameters:

initialOrbit - the initial orbit

Returns:

the DOP tolerances

Throws:

fr.cnes.genius.exception.GException - exception thrown if initial orbit is null

getAbsMassTolerance

public double getAbsMassTolerance()

Get the absolute mass tolerance.

Returns:

the absolute mass tolerance.

getRelMassTolerance

public double getRelMassTolerance()

Get the relative mass tolerance.

Returns:

the relative mass tolerance

setRKParameters

public void setRKParameters(double timestep)
                     throws fr.cnes.genius.exception.GArithmeticException

Set fixed time step integrators parameters (RK4 and RK6 integrators).

Parameters:

timestep - timestep

Throws:

fr.cnes.genius.exception.GArithmeticException - thrown if value is NaN

setDOPParameters

public void setDOPParameters(double minStep,
                             double maxStep,
                             boolean bypassMinStep,
                             GPIntegrator.Tolerances displayedTolerance)
                      throws fr.cnes.genius.exception.GArithmeticException

Set DOP parameters.

Parameters:

minStep - min timestep

maxStep - max timestep

bypassMinStep - true if min step bypass should be activated

displayedTolerance - tolerance type

Throws:

fr.cnes.genius.exception.GArithmeticException - thrown if one value is NaN

setDOPTolerancesComplete

public void setDOPTolerancesComplete(double[] absTol,
                                     double[] relTol)
                              throws fr.cnes.genius.exception.GArithmeticException

Set DOP tolerances in case of complete model.

Parameters:

absTol - absolute tolerances (x7: x, y, z, vx, vy, vz, mass)

relTol - relative tolerances (x7: x, y, z, vx, vy, vz, mass)

Throws:

fr.cnes.genius.exception.GArithmeticException - thrown if one value is NaN

setDOPTolerancesReduced

public void setDOPTolerancesReduced(double[] absTol,
                                    double[] relTol)
                             throws fr.cnes.genius.exception.GArithmeticException

Set DOP tolerances in case of reduced model.

Parameters:

absTol - absolute tolerances (x3: pos, vel, mass)

relTol - relative tolerances (x3: pos, vel, mass)

Throws:

fr.cnes.genius.exception.GArithmeticException - thrown if one value is NaN

setDOPTolerancesSimplified

public void setDOPTolerancesSimplified(double localPositionError)
                                throws fr.cnes.genius.exception.GArithmeticException

Set DOP tolerance in case of simplified model.

Parameters:

localPositionError - local position error

Throws:

fr.cnes.genius.exception.GArithmeticException - thrown if value is NaN

getFirstOrderIntegrator

public fr.cnes.sirius.patrius.math.ode.FirstOrderIntegrator getFirstOrderIntegrator(fr.cnes.sirius.patrius.orbits.Orbit initialOrbit)
                                                                             throws fr.cnes.genius.exception.GException

Get the first order integrator

Parameters:

initialOrbit - the initial orbit

Returns:

the first order integrator

Throws:

fr.cnes.genius.exception.GException - exception

after

public void after(fr.cnes.genius.main.GEvent e)
           throws fr.cnes.genius.exception.GException

Specified by:

after in interface fr.cnes.genius.main.GListener

Throws:

fr.cnes.genius.exception.GException

before

public void before(fr.cnes.genius.main.GEvent arg0)
            throws fr.cnes.genius.exception.GException

Specified by:

before in interface fr.cnes.genius.main.GListener

Throws:

fr.cnes.genius.exception.GException

getDopPanel

public GPDop853 getDopPanel()

Returns the DOP panel. DOP panel provides information on DOP tolerances settings.

Returns:

the DOP panel