Class

NumCosmoMathOdeSpline

Description [src]

final class NumCosmoMath.OdeSpline : GObject.Object
{
  /* No available fields */
}

Automatic generation of splines from ODE solvers.

This class defines an object that integrates an ODE and generates a spline from the solution.

Ancestors

Constructors

ncm_ode_spline_new

This function creates a new NcmOdeSpline.

ncm_ode_spline_new_full

This function creates a new NcmOdeSpline setting all its members.

Functions

ncm_ode_spline_clear

Atomically decrements the reference count of os by one. If the reference count drops to 0, all memory allocated by os is released. The pointer is set to NULL.

Instance methods

ncm_ode_spline_auto_abstol

If on is TRUE, the object uses the value of $\mathrm{d}y_i$ to estimate the abstol as $T_\mathrm{abs} = \dot{y}i \mathrm{d}t_m T\mathrm{rel}$, where $T_\mathrm{rel}$ is the relative tolerance and $\mathrm{d}t_m$ is the minimum time step #NCM_ODE_SPLINE_MIN_STEP. Useful when computing integrals as ODEs.

ncm_ode_spline_free

Decreases the reference count of os by one.

ncm_ode_spline_get_ini_step

Gets the current guess for the initial step size.

ncm_ode_spline_get_min_subdivisions

Gets the current minimum number of subdivisions setting.

ncm_ode_spline_get_yf_attained

Gets the last value of the function attained during the integration.

ncm_ode_spline_peek_spline

Peeks at the last prepared spline.

ncm_ode_spline_prepare

This function prepares the NcmOdeSpline os and fills its internal NcmSpline with the evaluated ode’s solution.

ncm_ode_spline_set_abstol

This functions sets the absolute tolerance, abstol, of the edo integrator.

ncm_ode_spline_set_ini_step

Sets a guess for the initial step size. If ini_step is zero it uses the automatic determination based on the tolerances.

ncm_ode_spline_set_interval

This function sets os interval [xi, xf] and its initial value yi in order to integrate the ode.

ncm_ode_spline_set_min_subdivisions

Sets the minimum number of subdivisions for the integration interval. When set to a value greater than zero, the integrator will cap the maximum step size at (xf - xi) / min_subdivisions, guaranteeing at least min_subdivisions points in the resulting spline. Set to 0 to disable (default behavior).

ncm_ode_spline_set_reltol

This functions sets the relative tolerance, reltol, of the edo integrator.

ncm_ode_spline_set_xf

This function sets the final point, xf, to integrate the edo. Note that if yf is also set, yf will take precedence.

ncm_ode_spline_set_xi

This function sets the initial point, xi, to integrate the edo.

ncm_ode_spline_set_yf

This function sets the final value of the function to be evaluated. When yf is reached, the edo’s integration is stopped. Note that if xf is also set, yf will take precedence.

ncm_ode_spline_set_yi

This function sets the initial value of the function to be evaluated.

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Properties

NumCosmoMath.OdeSpline:abstol

Integrator’s absolute tolerance.

NumCosmoMath.OdeSpline:auto-abstol

Boolean to set whether or not the absolute tolerance is going to be estimated internally by the ode integrator.

NumCosmoMath.OdeSpline:dydx

A pointer to the dydx function, a.k.a. the Jacobian.

NumCosmoMath.OdeSpline:ini-step

The integration initial step size.

NumCosmoMath.OdeSpline:min-subdivisions

Minimum number of subdivisions of the integration interval. When set to a value greater than zero, the integrator will enforce a maximum step size of (xf - xi) / min_subdivisions. This guarantees at least min_subdivisions points in the resulting spline. Default is 0 (no enforcement).

NumCosmoMath.OdeSpline:reltol

Integrator’s relative tolerance.

NumCosmoMath.OdeSpline:spline

The spline algorithm to be used.

NumCosmoMath.OdeSpline:stop-hnil

Whether treat hnil as error.

NumCosmoMath.OdeSpline:xf

The final point to integrate the ode.

NumCosmoMath.OdeSpline:xi

The initial point to integrate the ode.

NumCosmoMath.OdeSpline:yf

The final value of the function to be evaluated.

NumCosmoMath.OdeSpline:yi

The initial value of the function to be evaluated.

Signals

Signals inherited from GObject (1)
GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Class structure

struct NumCosmoMathOdeSplineClass {
  GObjectClass parent_class;
  
}

No description available.

Class members
parent_class: GObjectClass

No description available.