API Reference

DEF1 coupling function.

Typically parameterized by external parameters :α0 and :β0.

DEF3 coupling function.

Typically parameterized by external parameters :α0 and :β0.

DEFp_Model{T}(cf, eos)

Damour-Esposito-Farese scalar-tensor stellar-structure model.

cf is a coupling-function instance (e.g. DEF1_CouplingFunction()), and eos is an equation of state (e.g. PWP_EoS(...)). The model stores

• inner parameters inparams (e.g. :pc, :φc),
• external parameters exparams / exparams_symbolic,
• computed global quantities and derivatives.

FamilySimulation(sample_model, regime, family_params, int_params)

Scan one (or several) parameters and store results on an N-D grid.

Results are stored in sim.family.inparams, sim.family.quantities, and sim.family.derivatives.

GeneralSimulation(model_type, regime, int_params)

Run an N-D parameter scan with ShootingRegime and store outputs in sim.data.

Results are stored in sim.data.quantities and sim.data.derivatives as N-D arrays.

GridSimulation(sample_model, sample_regime, family_params, grid_params, int_params)

Grid-of-families simulation.

Typically you will use the convenience constructor:

sim = GridSimulation(family_constructor, family_params, grid_params, int_params)

and then run:

calculate!(sim, family_constructor)

IntParams(; maxiters, dtmax, reltol, abstol)

Integration / solver parameters used across simulations.

• maxiters: maximum solver iterations.
• dtmax: maximum step size.
• reltol, abstol: relative/absolute tolerances.

Piecewise-polytropic equation of state.

PWP_EoS supports several constructors, including a convenient named form:

PWP_EoS(low_eos=:SLy, high_eos=:MPA1)

The EoS provides get_density, get_pressure, get_energy_density, etc.

ShootingRegime(inparams_fixed, inparams_shooting, quantities_fixed, exparams)

General shooting regime that supports mixing fixed values and grids.

Dict values can be either scalars (fixed) or vectors (grid dimensions). This regime is used together with GeneralSimulation.

Simple_DirectRegime(inparams_fixed, exparams)

Direct (non-shooting) regime.

• inparams_fixed: fixed inner parameters (e.g. :pc, :φc).
• exparams: fixed external parameters (e.g. :α0, :β0).

Used with SingleSimulation / FamilySimulation.

Simple_ShootingRegime(inparams_fixed, exparams, exparams_symbolic, inparams_shooting, quantities_fixed)

Shooting regime for a single model.

The solver varies parameters in inparams_shooting to satisfy target boundary conditions given by quantities_fixed.

Typical use: shoot on :φc to enforce :bc_φ∞ == 0.0.

SingleSimulation(model, regime, int_params)

Solve a single stellar model for a given model and regime.

Run with calculate!(sim).

    Table_EoS(name::Symbol)

Tabulated equation of state using simple linear interpolation in log-space.

This is the "known-working" table EoS implementation. The input tables are taken from table_eos_base in src/eos_data.jl.

Notes:

• table_eos_base uses number density n in fm^-3, so this constructor converts n -> ρ via ρ = n * 10^39 * m_p (in g/cm^3).
• The Hermite-based experimental implementation is kept as Table_EoS_Hermite.

LogRange(L, R, N)

Return N logarithmically spaced points from L to R (inclusive).

Equivalent to 10 .^ LinRange(log10(L), log10(R), N).

V_fun(cf, exparams, φ)

Convenience potential-like function (implementation-specific) associated with the coupling.

calculate!(simulation)

Run a simulation in-place and return it.

Implemented for SingleSimulation, FamilySimulation, GridSimulation (with a constructor callback), and GeneralSimulation.

calculate_old!(args...)

Backward-compatible alias for calculate!.

calculate_quantities(rs_solution, model::DEFp_Model; save_to_model::Bool)

Post-process an ODE solution and compute global quantities/diagnostics.

If save_to_model=true, results are written into model.quantities.

find_max_pressure(eos::PWP_EoS; c_max=c)

Return an estimate of the maximum pressure (in CGS) for which the sound speed does not exceed c_max.

This is useful for building central-pressure grids that avoid superluminal sound speeds.

get_energy_density(eos, val; from, units=:cgs)

Return energy density corresponding to val.

In CGS, this is typically returned in erg/cm^3.

get_internal_energy(eos, val; from, units=:cgs)

Return internal energy per unit mass (implementation-dependent normalization) corresponding to val.

get_pressure(eos, val; from, units=:cgs)

Return pressure corresponding to val.

from specifies what val represents. In CGS, pressure is typically returned in dyn/cm^2.

get_sound_velocity(eos, val; from, units=:cgs)

Return the (adiabatic) sound speed corresponding to val.

In CGS, returned in cm/s.

get_specific_enthalpy(eos, val; from, units=:cgs)

Return specific enthalpy (implementation-dependent normalization) corresponding to val.

internal_physics(rs_vars::Vector, model::DEFp_Model, q::Real)

Compute local matter quantities used by the ODE system.

Returns (A, α, ñ, ε̃) evaluated at the current state.

ode_system!(D_rs_vars::Vector, rs_vars::Vector, model::DEFp_Model, q::Real)

Right-hand side for the stellar structure ODE system in DEF scalar-tensor gravity.

q is a dimensionless pressure coordinate used internally by the solver (with physical pressure p̃ = q * pc, where pc = model.inparams[:pc]).

φ∞_const(cf, exparams)

Asymptotic scalar-field value used as a reference for boundary conditions.

G

Newtonian gravitational constant in CGS units.

Unit: cm^3 g^-1 s^-2.

c

Speed of light in vacuum in CGS units.

Unit: cm/s.

high_pwp3_eos_names

Names (symbols) of built-in high-density piecewise-polytrope parameter sets available for PWP_EoS.

mp

Baryon mass used by the package in CGS units.

Unit: g.

Table_EoS_Hermite(n, ε, p; name=:unknown)

Experimental Hermite-interpolated table EoS.

This implementation is intentionally not the default Table_EoS because it is unfinished / not validated for the bundled tables.