Md/docs refs

docs/src/explanation/iter_proc.md

@@ -19,11 +19,11 @@ deformation, a.k.a. the $n$th degree Lovenumber $k_n(\sigma)$; the
 planet-wide loading Lovenumber $k'_n(\sigma)$; and the normalized
 heating profile in the segment. All the details regarding these models
 will be given in the corresponding sections below. The currently
-available tidal models are "solid0d", "solid1d", "solid1d_relax",
-"solid1d_mush", "solid1d_mush_relax"; "fluid0d", "fluid1d"; "interp",
-"none". For details see the Reference documantation.
+available tidal models are `"solid0d"`, `"solid1d"`, `"solid1d_relax"`,
+`"solid1d_mush"`, `"solid1d_mush_relax"`, `"solid1d_equil_relax"`; `"fluid0d"`, `"fluid1d"`; `"interp"`,
+`"none"`. For details see the Reference documantation.
 
-The "interp" model requires knowledge of heating at both interfaces, as
+The `"interp"` model requires knowledge of heating at both interfaces, as
 such an additional code block is included to update the heating in the
-"interp" region during the tidal calculation in the next segment after
-the "interp" region.
+`"interp"` region during the tidal calculation in the next segment after
+the `"interp"` region.

docs/src/explanation/main_loop.md

@@ -40,15 +40,15 @@ determined by the code. The desired range increases with eccentricity,
 for our purposes the desired range $K$ contains
 
 ```math
-\{k \in K \, \forall \, k : X^{-(n+1), m}_k \geq 0.01\ | k \in Z\}
+K = \{k \in \mathbb{Z} \, \big| \, |X^{-(n+1), m}_k| \geq 0.001 \}
 ```
 
 where $X^{-(n+1), m}_k$ is the Hansen coefficient. Basically, we only
 include $k$ in the range $K$ if the corresponding Hansen coefficient
-signifies a contribution greater than 1% to the complete tidal response.
+signifies a contribution greater than 0.1% to the complete tidal response.
 One may specify a different criterion and generate their $K$ using the
 included Notebook on the Obliqua Github repository
-"/examples/hansen_k_table.ipynb".
+`"/examples/hansen_k_table.ipynb"`.
 
 For testing convenience Obliqua includes two modes: "full" and
 "adaptive". In principle, one should use "full" to test the tidal

docs/src/explanation/post_proc.md

@@ -48,7 +48,7 @@ The tidal potential is
 
 $$U_{n,m,1} = \frac{GM}{a} \left(\frac{R}{a}\right)^n A_{n,m,1}(e)$$ 
 
-The prefactor is $$\text{prefactor} \, = \frac{(2n + 1)R}{8πG} \sigma$$ The
+The prefactor is $$\text{prefactor} \, = \frac{(2n + 1)R}{8πG} \sigma$$. The
 normalized heating profile is then simply
 
 $$H(r, \sigma) = \tilde{H}(r, \sigma) \times |U_{n,m,1}|^2$$ 

docs/src/how-to-guides/config_file.md

@@ -53,28 +53,6 @@ This block controls output and logging.
 
 ---
 
-### Stellar Parameters
-
-Defines the host star.
-
-```@raw html
-<p class="class-header"><span class="class-label">config</span> <span class="class-name">[star]</span></p>
-```
-
-```@raw html
-<div class="attributes-table">
-```
-
-| NAME | TYPE | DESCRIPTION |
-| :--- | :--- | :--- |
-| `mass` | float | Stellar mass in solar masses ($M_\odot$). |
-
-```@raw html
-</div>
-```
-
----
-
 ### Tidal Model Parameters
 
 Controls the tidal response model.
@@ -93,24 +71,24 @@ Controls the tidal response model.
 | `enforce_ec` | bool | Boolean flag to enforce energy conservation in tidal response calculations. |
 | `optimize_scales` | bool | Boolean flag to optimize scaling factors for numerical stability. |
 | `solid_shell` | bool | Boolean flag to add an infinitesimal solid shell around the core to couple y2 and y4 in fluid mantles. |
+| `cap_LN` | bool | Boolean flag to cap the Love number response to avoid divergences. |
 | `min_frac` | float | Minimum segment fraction of total mantle before it is considered. |
-| `max_frac` | float | Maximum segment fraction of total mantle before it is considered. |
 | `visc_l` | float | Liquid viscosity. |
 | `visc_lus` | float | Liquid-Mush handoff viscosity. |
 | `visc_s` | float | Solid viscosity. |
 | `visc_sus` | float | Solid-Mush handoff viscosity. |
 | `n` | array | Radial dependence exponent in $(r/a)^n$. |
 | `m` | array | Tidal harmonic (e.g., $m=2$ for semidiurnal tides). |
-| `spectrum` | str | Frequency sampling strategy (`"full"` or `"adaptive"`). |
+| `spectrum` | str | Frequency sampling strategy (`"full"`, `"adaptive"`, or `"legacy"`). |
 | `N_sigma` | int | Number of sampled forcing frequencies. |
 | `p_min` | float | Minimum period ($\log_{10}$ kyr). |
 | `p_max` | float | Maximum period ($\log_{10}$ kyr). |
-| `s_min` | int | Minimum Fourier mode. |
-| `s_max` | int | Maximum Fourier mode. |
+| `s_min` | int or `"none"` | Minimum Fourier mode. `"none"` derives it from the eccentricity relation. |
+| `s_max` | int or `"none"` | Maximum Fourier mode. `"none"` derives it from the eccentricity relation. |
 | `material_mu` | str | Rheological model for shear modulus (`"andrade"`, `"maxwell"`, or `"elastic"`). |
 | `material_k` | str | Rheological model for bulk modulus (`"andrade"`, `"maxwell"`, or `"elastic"`). |
 | `alpha` | float | Andrade power-law exponent. |
-| `module_solid` | str | Solid interior model (`"solid0d"`, `"solid1d"`, `"solid1d-relax"`, `"solid1d-mush"`, `"solid1d-mush-relax"`, or `"solid1d-equil-relax"`). |
+| `module_solid` | str | Solid interior model (`"none"`, `"solid0d"`, `"solid1d"`, `"solid1d-relax"`, `"solid1d-mush"`, `"solid1d-mush-relax"`, or `"solid1d-equil-relax"`). |
 | `module_mushy` | str | Mushy layer model (`"none"` or `"interp"`). |
 | `module_fluid` | str | Fluid layer model (`"none"`, `"fluid0d"`, or `"fluid1d"`). |
 
@@ -135,7 +113,7 @@ Controls the tidal response model.
 | `ncalc` | int | Number of radial layers (shooting method). |
 | `dr_min` | int | Minimum grid spacing for relaxation solver [m]. |
 | `dr_max` | int | Maximum grid spacing for relaxation solver [m]. |
-| `core` | str | Core boundary condition (`"liquid"`, `"solid"`, `"inertial"`). |
+| `core` | str | Core boundary condition (`"liquid"`, `"solid"`, `"inertial-liquid"`, `"inertial"`). |
 | `core_props` | str | Core properties (shear modulus, bulk modulus) to use for CMB boundary condition (`"core"`, `"mantle"`). |
 | `inertial_terms` | bool | Boolean flag to include inertial terms in the motion matrix. |
 | `bulk_l` | float | Liquid bulk modulus [Pa]. |

docs/src/how-to-guides/usage.md

@@ -1,14 +1,16 @@
 
 # Usage
 
-This section describes how to use Obliqua. The module can be run three ways:
+This section describes how to use Obliqua. The module can be run four ways:
 
 - **Full spectrum (Standalone)**: Compute the tidal ``k``-Love number response for a full spectrum of forcing frequencies. This mode is agnostic to the orbital parameters that feed into the Hansen mode weights and dissipative response. The generated spectrum can be used as a lookup table, or to probe the quantative dissipative response of the tidal model to a wide range of forcing frequencies.
 
 - **Adaptive (Standalone)**: Compute the tidal ``k``-Love number response for a subset of forcing frequencies that are adaptively selected based on the orbital parameters and Hansen mode weights. This mode targets the physically relevant forcing frequencies and, hence, also allows for the computation of the dissipative response. 
 
 - **Adaptive (PROTEUS)**: By extension of the previous mode, the adaptive mode can be used in conjunction with the PROTEUS framework. This allows Obliqua to interact with both dynamically evolving orbital parameters and interior properties. The tidal ``k``-Love number response is computed on-the-fly and is used to update the orbital evolution while the dissipative response feedsback into the interior. 
 
+- **Legacy (Standalone)**: Compute the tidal ``k``-Love number response for the subset of dominant forcing frequencies at small eccentricities. Given that the other modes explicitely reduce to this mode, this mode is provided for legacy purposes and is not recommended for use in new applications. Specifically, the `legacy` mode forces the returned Love numbers to be the same across the included set of modes, this makes the output directly compatible with simplified orbital dynamics models that do not resolve the full tidal spectrum.
+
 Naturally, one can also use the full spectrum mode in conjunction with PROTEUS in post-processing. This can forexample be used to validate the adaptive mode or to study the impact of different forcing frequencies on the tidal response. Moreover, it may be used to test model convergence. Below, we provide here an example run of the full spectrum mode in conjunction with PROTEUS computed in post-processing.
 
 In all cases you configure the model through a configuration file, described in the [configuration guide](@ref "Configuration file"). If you run into problems, see the [troubleshooting](@ref "Troubleshooting") page.