Commit 42b38025 authored by Bryan Cazabonne's avatar Bryan Cazabonne
Browse files

Improved JavaDoc of solar radiation pressure models.

parent f052e4ba
Pipeline #1430 passed with stages
in 27 minutes and 57 seconds
......@@ -51,7 +51,15 @@ import org.orekit.utils.ParameterDriver;
* Arnold et al recommend to use <b>D2B1</b> (i.e. <i>nD</i> = 1 and <i>nB</i> = 1) and
* <b>D4B1</b> (i.e. <i>nD</i> = 2 an <i>nB</i> = 1) configurations. At the opposite, in Arnold paper, it
* is recommend to not use <b>D2B0</b> (i.e. <i>nD</i> = 1 and <i>nB</i> = 0) configuration.
* </p>
* </p> <p>
* Since Orekit 11.0, it is possible to take into account
* the eclipses generated by Moon in the solar radiation
* pressure force model using the
* {@link #addOccultingBody(ExtendedPVCoordinatesProvider, double)}
* method.<br>
* <code> ECOM2 srp =</code>
* <code> new ECOM2(1, 1, 0.0, CelestialBodyFactory.getSun(), Constants.EIGEN5C_EARTH_EQUATORIAL_RADIUS);</code><br>
* <code> srp.addOccultingBody(CelestialBodyFactory.getMoon(), Constants.MOON_EQUATORIAL_RADIUS);</code><br>
*
* @see "Arnold, Daniel, et al, CODE’s new solar radiation pressure model for GNSS orbit determination,
* Journal of geodesy 89.8 (2015): 775-791."
......
......@@ -36,6 +36,18 @@ import org.orekit.utils.ExtendedPVCoordinatesProvider;
import org.orekit.utils.ParameterDriver;
/** Solar radiation pressure force model.
* <p>
* Since Orekit 11.0, it is possible to take into account
* the eclipses generated by Moon in the solar radiation
* pressure force model using the
* {@link #addOccultingBody(ExtendedPVCoordinatesProvider, double)}
* method.
* <p>
* Example:<br>
* <code> SolarRadiationPressure srp = </code>
* <code> new SolarRadiationPressure(CelestialBodyFactory.getSun(), Constants.EIGEN5C_EARTH_EQUATORIAL_RADIUS,</code>
* <code> new IsotropicRadiationClassicalConvention(50.0, 0.5, 0.5));</code><br>
* <code> srp.addOccultingBody(CelestialBodyFactory.getMoon(), Constants.MOON_EQUATORIAL_RADIUS);</code><br>
*
* @author Fabien Maussion
* @author &Eacute;douard Delente
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment