diff --git a/source/classes/earthRotation/earthRotation.h b/source/classes/earthRotation/earthRotation.h index c39625c2..84ced772 100644 --- a/source/classes/earthRotation/earthRotation.h +++ b/source/classes/earthRotation/earthRotation.h @@ -42,7 +42,7 @@ typedef std::shared_ptr EarthRotationPtr; /***** CLASS ***********************************/ /** @brief Transformation between CRF and TRF. -* An Instance of this class can be created by @ref readConfig. */ +* An Instance of this class can be created by calling the function @ref readConfig(). */ class EarthRotation { public: @@ -78,17 +78,17 @@ class EarthRotation * @param[out] S CIO locator [rad]. */ virtual void earthOrientationParameter(const Time &timeGPS, Double &xp, Double &yp, Double &sp, Double &deltaUT, Double &LOD, Double &X, Double &Y, Double &S) const; - /** @brief creates an derived instance of this class. */ + /** @brief Creates a derived instance of this class. */ static EarthRotationPtr create(Config &config, const std::string &name); }; /***** FUNCTIONS *******************************/ /** @brief Creates an instance of the class EarthRotation. -* Search for a node with @a name in the Config node. -* if @a name is not found the function returns FALSE and @a earthRotation is untouched. -* @param config The config node which includes the node with the options for this class -* @param name Tag name in the config. +* Search for a node with @a name in the configuration node @a config. +* If @a name is not found, the function returns FALSE and @a earthRotation is untouched. +* @param config The configuration node which includes the node @a name with the options for this class +* @param name Tag name in the configuration node. * @param[out] earthRotation Created class. * @param mustSet If is MUSTSET and @a name is not found, this function throws an exception instead of returning with FALSE. * @param defaultValue Ignored at the moment. diff --git a/source/classes/earthRotation/earthRotationFile.h b/source/classes/earthRotation/earthRotationFile.h index 2c4fe6e7..f7fa4141 100755 --- a/source/classes/earthRotation/earthRotationFile.h +++ b/source/classes/earthRotation/earthRotationFile.h @@ -2,7 +2,7 @@ /** * @file earthRotationFile.h * -* @brief Interpolated values from file. +* @brief Interpolates EOPs from input file. * @see EarthRotation * * @author Torsten Mayer-Guerr @@ -30,7 +30,7 @@ This file can be created with \program{EarthOrientationParameterTimeSeries}. /***** CLASS ***********************************/ -/** @brief According to IERS2010 conventions. +/** @brief Interpolates EOPs from input file. * @ingroup earthRotationGroup * @see EarthRotation */ class EarthRotationFile : public EarthRotation diff --git a/source/classes/earthRotation/earthRotationIers2003.h b/source/classes/earthRotation/earthRotationIers2003.h index f50ebb05..88a2b93d 100755 --- a/source/classes/earthRotation/earthRotationIers2003.h +++ b/source/classes/earthRotation/earthRotationIers2003.h @@ -48,6 +48,14 @@ from \url{ftp://maia.usno.navy.mil/conv2000/chapter8/} /***** CLASS ***********************************/ /** @brief According to IERS2003 conventions. + * In addtion to those interpolated values from the input file, + * - diurnal and semi-diurnal variations from ocean tides are considered by the IERS routine \c ORTHO_EOP.F for + * x-pole, y-pole and dUT1 + * - librations are considered by the routine \c PMSDNUT2.F for x-pole and y-pole + * - librations are considered by the routine \c UTLIBR.F for dUT1 and LOD + * + * sp is calculated with the ERFA function \c eraSp00. X,Y, and S are calculated by the + * precession & nutation model with the ERFA function \c eraXys00a. * @ingroup earthRotationGroup * @see EarthRotation */ class EarthRotationIers2003 : public EarthRotation diff --git a/source/classes/earthRotation/earthRotationIers2010.h b/source/classes/earthRotation/earthRotationIers2010.h index cb66657a..a2eb0088 100755 --- a/source/classes/earthRotation/earthRotationIers2010.h +++ b/source/classes/earthRotation/earthRotationIers2010.h @@ -32,6 +32,15 @@ A file with the earth orientation parameter is needed (\configFile{inputfileEOP} /***** CLASS ***********************************/ /** @brief According to IERS2010 conventions. + * In addtion to those interpolated values from the input file, + * - diurnal and semi-diurnal variations from ocean tides are considered by the IERS routine \c ORTHO_EOP.F for + * x-pole, y-pole and dUT1 + * - librations are considered by the routine \c PMSDNUT2.F for x-pole and y-pole + * - librations are considered by the routine \c UTLIBR.F for dUT1 and LOD + * + * sp is calculated with the ERFA function \c eraSp00. X,Y, and S are calculated either by the truncated + * precession & nutation model with the ERFA function \c eraXys00b or by the untruncated + * precession & nutation model with the ERFA functions \c eraXy06 and \c eraS06. * @ingroup earthRotationGroup * @see EarthRotation */ class EarthRotationIers2010 : public EarthRotation diff --git a/source/classes/earthRotation/earthRotationIers2010b.cpp b/source/classes/earthRotation/earthRotationIers2010b.cpp index 69f51f81..40158e78 100644 --- a/source/classes/earthRotation/earthRotationIers2010b.cpp +++ b/source/classes/earthRotation/earthRotationIers2010b.cpp @@ -105,7 +105,7 @@ void EarthRotationIers2010b::earthOrientationParameter(const Time &timeGPS, Doub // Models // ------ - // diurnal and semidiurnal variations in EOP (x,y,UT1) from ocean tides + // diurnal and semidiurnal variations in EOP (x,y,UT1) and LOD from ocean tides if(doodsonEop.doodson.size()) { const Vector thetaf = doodsonMatrix * Doodson::arguments(timeGPS); diff --git a/source/classes/earthRotation/earthRotationIers2010b.h b/source/classes/earthRotation/earthRotationIers2010b.h index 80437c3e..6d952df7 100644 --- a/source/classes/earthRotation/earthRotationIers2010b.h +++ b/source/classes/earthRotation/earthRotationIers2010b.h @@ -34,6 +34,15 @@ Includes additional high-frequency EOP models (\configFile{inputfileDoodsonEOP}{ /***** CLASS ***********************************/ /** @brief According to IERS2010 conventions. + * In addtion to those interpolated values from the input file, + * - diurnal, semi-diurnal and even higher frequency variations from ocean tides are considered by the + * input DoodsonEOP file which contains cofficients of corrections for different tidal consituents for + * x-pole, y-pole, dUT1 and LOD + * - librations are considered by the routine \c PMSDNUT2.F for x-pole and y-pole + * - librations are considered by the routine \c UTLIBR.F for dUT1 and LOD + * + * sp is calculated with the ERFA function \c eraSp00. X,Y, and S are calculated by the untruncated + * precession & nutation model with the ERFA functions \c eraXy06 and \c eraS06. * @ingroup earthRotationGroup * @see EarthRotation */ class EarthRotationIers2010b : public EarthRotation diff --git a/source/classes/earthRotation/earthRotationZAxis.h b/source/classes/earthRotation/earthRotationZAxis.h index 6560cc26..5f1b6265 100755 --- a/source/classes/earthRotation/earthRotationZAxis.h +++ b/source/classes/earthRotation/earthRotationZAxis.h @@ -53,7 +53,7 @@ inline EarthRotationZAxis::EarthRotationZAxis(Config &config) { readConfig(config, "initialAngle", angle0, Config::MUSTSET, "5.133658456", "Angle at time0 [rad]"); readConfig(config, "angularVelocity", angleVelocity, Config::MUSTSET, "7.29211585531e-5", "[rad/s]"); - readConfig(config, "time0", time0, Config::MUSTSET, "51740.5", ""); + readConfig(config, "time0", time0, Config::MUSTSET, "51740.5", "Time of the initial angle"); if(isCreateSchema(config)) return; } diff --git a/source/classes/timeSeries/timeSeries.h b/source/classes/timeSeries/timeSeries.h index 38fb0e14..f5cace7f 100644 --- a/source/classes/timeSeries/timeSeries.h +++ b/source/classes/timeSeries/timeSeries.h @@ -45,7 +45,7 @@ typedef std::shared_ptr TimeSeriesPtr; /***** CLASS ***********************************/ /** @brief Generates time series. -* An instance of this class can be created with @ref readConfig. */ +* An instance of this class can be created with the function @ref readConfig(). */ class TimeSeries { std::vector base; @@ -60,17 +60,17 @@ class TimeSeries /** @brief Time series with increasing order. */ std::vector