SOFA.hpp

浏览该文件的文档.

 
 
#pragma once
 
#include "AstGlobal.h"
#include "AstCore/TimePoint.hpp"
 
AST_NAMESPACE_BEGIN
 
 
//==============================================================================
// SOFA (Standards of Fundamental Astronomy) 许可证声明
//==============================================================================
/*
 * 重要声明：本文件中的函数基于国际天文联合会(IAU)的SOFA软件库实现。
 *
 * 根据SOFA软件许可证的要求，特此声明：
 *
 * 1. 本模块的代码使用了从SOFA软件库（版本2023-10-11）获得的算法和计算例程。
 *    具体对应的SOFA函数请参考函数注释
 *
 * 2. SOFA软件由国际天文联合会(IAU) SOFA Board所有。
 *    SOFA软件许可证请参考：https://www.iausofa.org/terms-and-conditions
 *
 * 3. 根据SOFA许可证第3(c)条要求，本衍生作品的函数名不使用"iau"或"sofa"前缀。
 *    本模块使用"a"前缀表示"astronomy"天文计算。
 *
 * 4. 根据SOFA许可证第3(a)条要求，声明本软件：
 *    (i) 使用了从SOFA软件派生的计算例程；
 *    (ii) 不是由SOFA提供或认可的软件。
 *
 * 5. 本衍生作品与原始SOFA软件的主要区别：
 *    - 函数接口针对ast项目的TimePoint等自定义类型进行了适配
 *    - 函数命名遵循ast项目的命名规范
 *    - 部分实现细节根据项目需求进行了优化和调整
 *    - 不保证与原始SOFA库在边界情况和精度上完全一致
 *
 * 6. 根据SOFA许可证第3(e)条要求，必须在SOFA软件衍生作品源代码分发中完整保留SOFA软件的版权声明
 *    SOFA软件的版权声明请参阅本文件底部。
 * 
 */
 
 
 
AST_CORE_CAPI void aPrecession_IAU1976(double t, double& zeta, double& z, double& theta);
 
 
 
AST_CORE_CAPI double aMeanObliquity_IAU1980(double t);
 
 
 
 
AST_CORE_CAPI void aNutation_IERS1996(double t, double &dpsi, double &deps, double* eqecorr);
AST_CORE_CAPI void aNutation_IERS1996_Cache(double t, double &dpsi, double &deps, double* eqecorr);
 
A_ALWAYS_INLINE void aNutation_IAU1980(double t, double &dpsi, double &deps)
{
    aNutation_IERS1996(t, dpsi, deps, nullptr);
}
A_ALWAYS_INLINE void aNutation_IAU1980_Cache(double t, double &dpsi, double &deps)
{
    aNutation_IERS1996_Cache(t, dpsi, deps, nullptr);
}
 
 
 
A_ALWAYS_INLINE void aPrecession_IAU1976(const TimePoint& tp, double& zeta, double& z, double& theta){
    aPrecession_IAU1976(tp.julianCenturyFromJ2000TT(), zeta, z, theta);
}
 
 
A_ALWAYS_INLINE double aMeanObliquity_IAU1980(const TimePoint& tp){
    return aMeanObliquity_IAU1980(tp.julianCenturyFromJ2000TT());
}
 
 
typedef errc_t (*NutationFunc)(const TimePoint& tp, double &dpsi, double &deps);
 
A_ALWAYS_INLINE void aNutation_IAU1980(const TimePoint& tp, double& dpsi, double& deps)
{
    return aNutation_IAU1980(tp.julianCenturyFromJ2000TT(), dpsi, deps);
}
 
AST_CORE_CAPI NutationFunc aNutation;
 
 
 
inline void aNutationFuncSet(NutationFunc func){
    aNutation = func;
}
 
enum class ENutationMethod
{
    eIAU1980 = 0,
    eJplDe = 1,
    eUser = 2,      // 用户自定义实现
};
 
AST_CORE_CAPI errc_t aNutationMethodSet(ENutationMethod method);
 
 
AST_CORE_CAPI ENutationMethod aNutationMethodGet();
 
 
AST_CORE_CAPI double aGMST_IAU1982(const TimePoint& tp);
 
 
AST_CORE_CAPI double aGMST_UT1_IAU1982(const JulianDate& jdUT1);
 
 
AST_CORE_CAPI double aGAST_IAU1994(const TimePoint& tp);
 
 
AST_CORE_CAPI double aEquationOfEquinoxes_IAU1994(double t);
 
A_ALWAYS_INLINE double aEquationOfEquinoxes_IAU1994(const TimePoint& tp)
{
    return aEquationOfEquinoxes_IAU1994(tp.julianCenturyFromJ2000TT());
}
 
 
AST_CORE_CAPI double aEarthRotationAngle_IAU2000(const TimePoint& tp);
 
 
AST_CORE_CAPI double aEarthRotationAngleUT1_IAU2000(const JulianDate& jdUT1);
 
 
AST_NAMESPACE_END
 
 
/* ----------------------------------------------------------------------------------
 * 根据SOFA许可证第3(e)条要求，必须在SOFA软件衍生作品源代码分发中完整保留SOFA软件的版权声明
 * 下面是SOFA软件的版权声明
 * --------------------------------------------------------------------------------- */ 
 
/*----------------------------------------------------------------------
**
**  Copyright (C) 2023
**  Standards of Fundamental Astronomy Board
**  of the International Astronomical Union.
**
**  =====================
**  SOFA Software License
**  =====================
**
**  NOTICE TO USER:
**
**  BY USING THIS SOFTWARE YOU ACCEPT THE FOLLOWING SIX TERMS AND
**  CONDITIONS WHICH APPLY TO ITS USE.
**
**  1. The Software is owned by the IAU SOFA Board ("SOFA").
**
**  2. Permission is granted to anyone to use the SOFA software for any
**     purpose, including commercial applications, free of charge and
**     without payment of royalties, subject to the conditions and
**     restrictions listed below.
**
**  3. You (the user) may copy and distribute SOFA source code to others,
**     and use and adapt its code and algorithms in your own software,
**     on a world-wide, royalty-free basis.  That portion of your
**     distribution that does not consist of intact and unchanged copies
**     of SOFA source code files is a "derived work" that must comply
**     with the following requirements:
**
**     a) Your work shall be marked or carry a statement that it
**        (i) uses routines and computations derived by you from
**        software provided by SOFA under license to you; and
**        (ii) does not itself constitute software provided by and/or
**        endorsed by SOFA.
**
**     b) The source code of your derived work must contain descriptions
**        of how the derived work is based upon, contains and/or differs
**        from the original SOFA software.
**
**     c) The names of all routines in your derived work shall not
**        include the prefix "iau" or "sofa" or trivial modifications
**        thereof such as changes of case.
**
**     d) The origin of the SOFA components of your derived work must
**        not be misrepresented;  you must not claim that you wrote the
**        original software, nor file a patent application for SOFA
**        software or algorithms embedded in the SOFA software.
**
**     e) These requirements must be reproduced intact in any source
**        distribution and shall apply to anyone to whom you have
**        granted a further right to modify the source code of your
**        derived work.
**
**     Note that, as originally distributed, the SOFA software is
**     intended to be a definitive implementation of the IAU standards,
**     and consequently third-party modifications are discouraged.  All
**     variations, no matter how minor, must be explicitly marked as
**     such, as explained above.
**
**  4. You shall not cause the SOFA software to be brought into
**     disrepute, either by misuse, or use for inappropriate tasks, or
**     by inappropriate modification.
**
**  5. The SOFA software is provided "as is" and SOFA makes no warranty
**     as to its use or performance.   SOFA does not and cannot warrant
**     the performance or results which the user may obtain by using the
**     SOFA software.  SOFA makes no warranties, express or implied, as
**     to non-infringement of third party rights, merchantability, or
**     fitness for any particular purpose.  In no event will SOFA be
**     liable to the user for any consequential, incidental, or special
**     damages, including any lost profits or lost savings, even if a
**     SOFA representative has been advised of such damages, or for any
**     claim by any third party.
**
**  6. The provision of any version of the SOFA software under the terms
**     and conditions specified herein does not imply that future
**     versions will also be made available under the same terms and
**     conditions.
*
**  In any published work or commercial product which uses the SOFA
**  software directly, acknowledgement (see www.iausofa.org) is
**  appreciated.
**
**  Correspondence concerning SOFA software should be addressed as
**  follows:
**
**      By email:  sofa@ukho.gov.uk
**      By post:   IAU SOFA Center
**                 HM Nautical Almanac Office
**                 UK Hydrographic Office
**                 Admiralty Way, Taunton
**                 Somerset, TA1 2DN
**                 United Kingdom
**
**--------------------------------------------------------------------*/