TidalPy.RadialSolver.matrix_types package
Submodules
TidalPy.RadialSolver.matrix_types.solid_matrix module
Fundamental Matrix and its inverse as defined in Sabadini, Vermeerson, & Cambiotti (2016) (Hereafter cited as SVC16)
Two versions are defined, one for a generic order-l and one for order-l=2 (for performance).
Assumptions
These matrices assume an incompressible body.
References
SVC16 : Sabadini, Vermeerson, & Cambiotti (2016, DOI: 10.1007/978-94-017-7552-6) HH14 : Henning & Hurford (2014, DOI: 10.1088/0004-637X/789/1/30) ID : IcyDwarf Code by Marc Neveu (https://github.com/MarcNeveu/IcyDwarf/blob/master/IcyDwarf/Thermal.h)
- TidalPy.RadialSolver.matrix_types.solid_matrix.fundamental_matrix(radius_array_view, density_array_view, gravity_array_view, complex_shear_array_view, degree_l=2, G_to_use=6.6743e-11, perform_checks=True)
Construct the fundamental matrix and its inverse using harmonic degree l.
See Eq. 2.42 of SVC16
Assumptions
These matrices assume an incompressible body.
- param radius_array_view:
Pointer to array of Radius values [m]
- type radius_array_view:
double
- param density_array_view:
Pointer to array of Density at each radius [kg m-3]
- type density_array_view:
double
- param gravity_array_view:
Pointer to array of acceleration due to gravity at each radius [m s-2]
- type gravity_array_view:
double
- param complex_shear_array_view:
Pointer to array of Complex shear modulus at each radius [Pa]
- type complex_shear_array_view:
double complex
- param degree_l:
Harmonic degree.
- type degree_l:
int, default=2
- param G_to_use:
Gravitational constant used in calculations. Can be provided for non-dimensionalized solutions.
- type G_to_use:
double, default=d_G
- param perform_checks:
If True, then checks will be performed on the input arguments to check for issues.
- type perform_checks:
bool, default=True