pyissm.model.classes.love
Classes
|
Default parameters class for Love number calculations in ISSM. |
|
Default parameters class for Fourier Love number calculations in ISSM. |
- class pyissm.model.classes.love.default(other=None)
Bases:
manage_stateDefault parameters class for Love number calculations in ISSM.
This class defines the default parameters for the Love number computation process.
- Parameters:
other (any, optional) – Any other class object that contains common fields to inherit from. If values in other differ from default values, they will override the default values.
- nfreq
Number of frequencies sampled (elastic case: 1).
- Type:
int, default=1
- frequencies
Frequencies sampled (0 for elastic case) [Hz].
- Type:
float or array-like, default=0
- sh_nmax
Maximum spherical harmonic degree.
- Type:
int, default=256
- sh_nmin
Minimum spherical harmonic degree.
- Type:
int, default=1
- g0
Gravity constant [m/s^2].
- Type:
float, default=9.81
- r0
Reference radius [m].
- Type:
float, default=6371000.0
- mu0
Reference stress [Pa].
- Type:
float, default=1e11
- Gravitational_Constant
Newtonian constant of gravitation [m^3 kg^-1 s^-2].
- Type:
float, default=6.67259e-11
- chandler_wobble
Include inertial terms for Chandler wobble in rotational feedback Love numbers.
- Type:
int, default=0
- allow_layer_deletion
Allow migration of the integration boundary with increasing spherical harmonic degree.
- Type:
int, default=1
- underflow_tol
Threshold for deep to surface Love number ratio to trigger deletion of layers.
- Type:
float, default=1e-16
- pw_threshold
Threshold for bypassing the Post-Widder transform for time-dependent Love numbers.
- Type:
float, default=1e-3
- min_integration_steps
Minimum number of radial steps per layer.
- Type:
int, default=500
- max_integration_dr
Maximum length of radial steps [m].
- Type:
float, default=1e4
- integration_scheme
Integration scheme identifier.
- Type:
int, default=2
- istemporal
1 for time-dependent Love numbers, 0 for frequency-dependent or elastic.
- Type:
int, default=1
- n_temporal_iterations
Number of spectral samples per time step (inverse Laplace transform).
- Type:
int, default=7
- time
Time vector for deformation [s].
- Type:
float or array-like, default=0
- love_kernels
Compute Love numbers at depth.
- Type:
int, default=0
- forcing_type
Nature and depth of the forcing for the Love number calculation.
- Type:
int, default=11
- inner_core_boundary
Interface index for inner core boundary forcing.
- Type:
int, default=1
- core_mantle_boundary
Interface index for core mantle boundary forcing.
- Type:
int, default=2
- complex_computation
Return Love numbers as real (0) or complex (1).
- Type:
int, default=0
- quad_precision
Use 32-digit precision for computation and Post-Widder transform.
- Type:
int, default=0
- debug
Output yi system matrix prior to solving.
- Type:
int, default=0
- hypergeom_table1
Table 1 for hypergeometric function (EBM rheology).
- Type:
int, default=1
- hypergeom_table2
Table 2 for hypergeometric function (EBM rheology).
- Type:
int, default=1
- hypergeom_nalpha
Length of hypergeometric table (EBM rheology).
- Type:
int, default=1
- hypergeom_nz
Width of hypergeometric table (EBM rheology).
- Type:
int, default=1
- hypergeom_z
Abscissa for hypergeometric table (EBM rheology).
- Type:
int, default=0
- __init__(self, other=None)
Initializes the default Love number parameters, optionally inheriting from another instance.
- __repr__(self)
Returns a detailed string representation of the Love number parameters.
- __str__(self)
Returns a short string identifying the class.
- marshall_class(self, fid, prefix, md=None)
Marshall parameters to a binary file.
Examples
md.love = pyissm.model.classes.love.default()
- check_consistency(md, solution, analyses)
Check consistency of the [love.default] parameters.
- Parameters:
md (
pyissm.model.Model) – The model object to check.solution (
str) – The solution name to check.analyses (list of
str) – List of analyses to check consistency for.
- Returns:
md – The model object with any consistency errors noted.
- Return type:
- marshall_class(fid, prefix, md=None)
Marshall [love.default] parameters to a binary file.
- Parameters:
fid (file object) – The file object to write the binary data to.
prefix (str) – Prefix string used for data identification in the binary file.
md (ISSM model object, optional.) – ISSM model object needed in some cases.
- Return type:
None
- class pyissm.model.classes.love.fourier(other=None)
Bases:
manage_stateDefault parameters class for Fourier Love number calculations in ISSM.
This class defines the default parameters for the Fourier (frequency-dependent) Love number computation process.
- Parameters:
other (any, optional) – Any other class object that contains common fields to inherit from. If values in other differ from default values, they will override the default values.
- nfreq
Number of frequencies sampled (elastic case: 1).
- Type:
int, default=1
- frequencies
Frequencies sampled (0 for elastic case) [Hz].
- Type:
float or array-like, default=0
- sh_nmax
Maximum spherical harmonic degree.
- Type:
int, default=256
- sh_nmin
Minimum spherical harmonic degree.
- Type:
int, default=1
- g0
Gravity constant [m/s^2].
- Type:
float, default=9.81
- r0
Reference radius [m].
- Type:
float, default=6371000.0
- mu0
Reference stress [Pa].
- Type:
float, default=1e11
- Gravitational_Constant
Newtonian constant of gravitation [m^3 kg^-1 s^-2].
- Type:
float, default=6.67259e-11
- chandler_wobble
Include inertial terms for Chandler wobble in rotational feedback Love numbers.
- Type:
int, default=0
- allow_layer_deletion
Allow migration of the integration boundary with increasing spherical harmonic degree.
- Type:
int, default=1
- underflow_tol
Threshold for deep to surface Love number ratio to trigger deletion of layers.
- Type:
float, default=1e-16
- pw_threshold
Threshold for bypassing the Post-Widder transform for time-dependent Love numbers.
- Type:
float, default=1e-3
- integration_steps_per_layer
Number of radial steps per layer.
- Type:
int, default=100
- istemporal
1 for time-dependent Love numbers, 0 for frequency-dependent or elastic.
- Type:
int, default=0
- n_temporal_iterations
Number of spectral samples per time step (inverse Laplace transform).
- Type:
int, default=8
- time
Time vector for deformation [s].
- Type:
float or array-like, default=0
- love_kernels
Compute Love numbers at depth.
- Type:
int, default=0
- forcing_type
Nature and depth of the forcing for the Love number calculation.
- Type:
int, default=11
- inner_core_boundary
Interface index for inner core boundary forcing.
- Type:
int, default=1
- core_mantle_boundary
Interface index for core mantle boundary forcing.
- Type:
int, default=2
- complex_computation
Return Love numbers as real (0) or complex (1).
- Type:
int, default=0
- __init__(self, other=None)
Initializes the Fourier Love number parameters, optionally inheriting from another instance.
- __repr__(self)
Returns a detailed string representation of the Fourier Love number parameters.
- __str__(self)
Returns a short string identifying the class.
- marshall_class(self, fid, prefix, md=None)
Marshall parameters to a binary file.
Examples
md.love = pyissm.model.classes.love.fourier()
- check_consistency(md, solution, analyses)
Check consistency of the [love.fourier] parameters.
- Parameters:
md (
pyissm.model.Model) – The model object to check.solution (
str) – The solution name to check.analyses (list of
str) – List of analyses to check consistency for.
- Returns:
md – The model object with any consistency errors noted.
- Return type:
- marshall_class(fid, prefix, md=None)
Marshall [love.fourier] parameters to a binary file.
- Parameters:
fid (file object) – The file object to write the binary data to.
prefix (str) – Prefix string used for data identification in the binary file.
md (ISSM model object, optional.) – ISSM model object needed in some cases.
- Return type:
None