Package org.orekit.forces.radiation
Class AbstractSolarLightFluxModel
- java.lang.Object
-
- org.orekit.forces.radiation.AbstractLightFluxModel
-
- org.orekit.forces.radiation.AbstractSolarLightFluxModel
-
- All Implemented Interfaces:
LightFluxModel
- Direct Known Subclasses:
ConicallyShadowedLightFluxModel
,CylindricallyShadowedLightFluxModel
public abstract class AbstractSolarLightFluxModel extends AbstractLightFluxModel
Abstract class for the definition of the solar flux model with a single occulting body of spherical shape.- Since:
- 12.2
- Author:
- Romain Serra
- See Also:
LightFluxModel
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
AbstractSolarLightFluxModel(double kRef, ExtendedPositionProvider occultedBody, double occultingBodyRadius, EventDetectionSettings eventDetectionSettings)
Constructor.protected
AbstractSolarLightFluxModel(ExtendedPositionProvider occultedBody, double occultingBodyRadius, EventDetectionSettings eventDetectionSettings)
Constructor with default value for reference flux.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description EventDetectionSettings
getEventDetectionSettings()
Getter for eclipse event detection settings used for eclipses.double
getOccultingBodyRadius()
Getter for occulting body radius.protected <T extends CalculusFieldElement<T>>
FieldVector3D<T>getUnoccultedFluxVector(FieldVector3D<T> relativePosition)
Get the light flux vector, not considering any shadowing effect.protected Vector3D
getUnoccultedFluxVector(Vector3D relativePosition)
Get the light flux vector, not considering any shadowing effect.-
Methods inherited from class org.orekit.forces.radiation.AbstractLightFluxModel
getLightFluxVector, getLightFluxVector, getLightingRatio, getLightingRatio, getLightingRatio, getLightingRatio, getOccultedBody, getOccultedBodyPosition, getOccultedBodyPosition
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.orekit.forces.radiation.LightFluxModel
getEclipseConditionsDetector, getFieldEclipseConditionsDetector, init, init
-
-
-
-
Constructor Detail
-
AbstractSolarLightFluxModel
protected AbstractSolarLightFluxModel(double kRef, ExtendedPositionProvider occultedBody, double occultingBodyRadius, EventDetectionSettings eventDetectionSettings)
Constructor.- Parameters:
kRef
- reference fluxoccultedBody
- position provider for light sourceoccultingBodyRadius
- radius of central, occulting bodyeventDetectionSettings
- user-defined detection settings for eclipses (if ill-tuned, events might be missed or performance might drop)
-
AbstractSolarLightFluxModel
protected AbstractSolarLightFluxModel(ExtendedPositionProvider occultedBody, double occultingBodyRadius, EventDetectionSettings eventDetectionSettings)
Constructor with default value for reference flux.- Parameters:
occultedBody
- position provider for light sourceoccultingBodyRadius
- radius of central, occulting bodyeventDetectionSettings
- user-defined detection settings for eclipses (if ill-tuned, events might be missed or performance might drop)
-
-
Method Detail
-
getOccultingBodyRadius
public double getOccultingBodyRadius()
Getter for occulting body radius.- Returns:
- radius
-
getEventDetectionSettings
public EventDetectionSettings getEventDetectionSettings()
Getter for eclipse event detection settings used for eclipses.- Returns:
- event detection settings
-
getUnoccultedFluxVector
protected Vector3D getUnoccultedFluxVector(Vector3D relativePosition)
Get the light flux vector, not considering any shadowing effect.- Specified by:
getUnoccultedFluxVector
in classAbstractLightFluxModel
- Parameters:
relativePosition
- relative position w.r.t. light source- Returns:
- unocculted flux
-
getUnoccultedFluxVector
protected <T extends CalculusFieldElement<T>> FieldVector3D<T> getUnoccultedFluxVector(FieldVector3D<T> relativePosition)
Get the light flux vector, not considering any shadowing effect. Field version.- Specified by:
getUnoccultedFluxVector
in classAbstractLightFluxModel
- Type Parameters:
T
- field type- Parameters:
relativePosition
- relative position w.r.t. light source- Returns:
- unocculted flux
-
-