Commit 205588b0 authored by Luc Maisonobe's avatar Luc Maisonobe

Improved javadoc for DSST short period terms customization.

parent 9689cbb6
......@@ -125,6 +125,9 @@ public class DSSTCentralBody implements DSSTForceModel {
final int maxDegreeTesseralShortPeriodics = FastMath.min(provider.getMaxDegree(), maxDegreeTesseralSP);
final int maxOrderTesseralShortPeriodics = FastMath.min(provider.getMaxOrder(), maxOrderTesseralSP);
final int maxEccPowTesseralShortPeriodics = FastMath.min(maxDegreeTesseralShortPeriodics - 1, 4);
final int maxFrequencyShortPeriodics = FastMath.min(maxDegreeTesseralShortPeriodics +
maxEccPowTesseralShortPeriodics,
12);
final int maxDegreeMdailyTesseralShortPeriodics = FastMath.min(provider.getMaxDegree(), maxDegreeMdailyTesseralSP);
final int maxOrderMdailyTesseralShortPeriodics = FastMath.min(provider.getMaxOrder(), maxOrderMdailyTesseralSP);
final int maxEccPowMdailyTesseralShortPeriodics = FastMath.min(maxDegreeMdailyTesseralShortPeriodics - 2, 4);
......@@ -133,8 +136,7 @@ public class DSSTCentralBody implements DSSTForceModel {
centralBodyRotationRate,
provider,
maxDegreeTesseralShortPeriodics, maxOrderTesseralShortPeriodics,
maxEccPowTesseralShortPeriodics,
maxDegreeTesseralShortPeriodics + maxEccPowTesseralShortPeriodics,
maxEccPowTesseralShortPeriodics, maxFrequencyShortPeriodics,
maxDegreeMdailyTesseralShortPeriodics,
maxOrderMdailyTesseralShortPeriodics,
maxEccPowMdailyTesseralShortPeriodics);
......
......@@ -245,15 +245,17 @@ public class DSSTTesseral implements DSSTForceModel {
* @param maxOrderTesseralSP maximal order to consider for short periodics tesseral harmonics potential
* (must be between 0 and {@code provider.getMaxOrder()})
* @param maxEccPowTesseralSP maximum power of the eccentricity to use in summation over s for
* short periodic tesseral harmonics (without m-daily)
* short periodic tesseral harmonics (without m-daily), should typically not exceed 4 as higher
* values will exceed computer capacity
* @param maxFrequencyShortPeriodics maximum frequency in mean longitude for short periodic computations
* (typically {@code maxDegreeTesseralSP} + {@code maxEccPowTesseralSP and no more than 12})
* @param maxDegreeMdailyTesseralSP maximal degree to consider for short periodics m-daily tesseral harmonics potential
* (must be between 2 and {@code provider.getMaxDegree()})
* @param maxOrderMdailyTesseralSP maximal order to consider for short periodics m-daily tesseral harmonics potential
* (must be between 0 and {@code provider.getMaxOrder()})
* @param maxEccPowMdailyTesseralSP maximum power of the eccentricity to use in summation over s for
* m-daily tesseral harmonics.
* (must be between 0 and {@code maxDegreeMdailyTesseralSP - 2})
* m-daily tesseral harmonics, (must be between 0 and {@code maxDegreeMdailyTesseralSP - 2},
* but should typically not exceed 4 as higher values will exceed computer capacity)
* @exception OrekitException if degrees or powers are out of range
* @since 7.2
*/
......
......@@ -193,7 +193,8 @@ public class DSSTZonal implements DSSTForceModel {
* @param maxDegreeShortPeriodics maximum degree to consider for short periodics zonal harmonics potential
* (must be between 2 and {@code provider.getMaxDegree()})
* @param maxEccPowShortPeriodics maximum power of the eccentricity to be used in short periodic computations
* (must be between 0 and {@code maxDegreeShortPeriodics - 1})
* (must be between 0 and {@code maxDegreeShortPeriodics - 1}, but should typically not exceed 4 as higher
* values will exceed computer capacity)
* @param maxFrequencyShortPeriodics maximum frequency in true longitude for short periodic computations
* (must be between 1 and {@code 2 * maxDegreeShortPeriodics + 1})
* @exception OrekitException if degrees or powers are out of range
......
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