DoodsonHarmonics2PotentialCoefficients

The inputfileDoodsonHarmonics contains a Fourier series of a time variable gravitational potential at specific tidal frequencies (tides) \[ V(\M x,t) = \sum_{f} V_f^c(\M x)\cos(\theta_f(t)) + V_f^s(\M x)\sin(\theta_f(t)), \]where $V_f^c(\M x)$ and $V_f^s(\M x)$ are spherical harmonics expansions. If set the expansions are limited in the range between minDegree and maxDegree inclusivly. The coefficients are related to the reference radius R and the Earth gravitational constant GM.

The outputfilePotentialCoefficients is not a single file but a series of files. For each spherical harmonics expansion $V_f^c(\M x)$ and $V_f^s(\M x)$ a separate file is created where the variables variableLoopName, variableLoopDoodson, variableLoopCosSin are set accordingly. The file name should contain these variables, e.g. coeff.{name}.{doodson}.{cossin}.gfc.

If applyXi the Doodson-Warburg phase correction (see IERS conventions) is applied to the cos/sin potentialCoefficients before.

NameTypeAnnotation
outputfilePotentialCoefficients
filename
variableLoopName
stringvariable with darwins's name of each constituent
variableLoopDoodson
stringvariable with doodson code of each constituent
variableLoopCosSin
stringvariable with 'cos' or 'sin' of each constituent
variableLoopIndex
stringvariable with index of each constituent (starts with zero)
variableLoopCount
stringvariable with total number of constituents
inputfileDoodsonHarmonics
filename
inputfileTideGeneratingPotential
filenameto compute Xi phase correction
minDegree
uint
maxDegree
uint
GM
doubleGeocentric gravitational constant
R
doublereference radius
applyXi
booleanapply Doodson-Warburg phase correction (see IERS conventions)