Top | ![]() |
![]() |
![]() |
![]() |
Functions
gint | (*NcmODEEvalF) () |
gint | (*NcmODEEvalJDense) () |
NcmODEEval * | ncm_ode_eval_ref () |
void | ncm_ode_eval_free () |
void | ncm_ode_eval_clear () |
gint | ncm_ode_eval_df () |
gint | ncm_ode_eval_J_dense () |
#define | NCM_ODE_EVAL_DECLARE_IMPL() |
#define | NCM_ODE_EVAL_DEFINE_IMPL() |
Description
This class implement an abstract interface between the Ordinary differential equation (ODE) system (see NcmODE) and the evaluation of its derivatives $\mathrm{d}f$ and its Jacobian matrix $J$.
Functions
NcmODEEvalF ()
gint (*NcmODEEvalF) (NcmODEEval *ode_eval
,const guint sys_size
,const gdouble t
,const gdouble * restrict f
,gdouble * restrict df
);
NcmODEEvalJDense ()
gint (*NcmODEEvalJDense) (NcmODEEval *ode_eval
,const guint sys_size
,const gdouble t
,const gdouble * restrict f
,gdouble ** restrict J_col
);
ncm_ode_eval_ref ()
NcmODEEval *
ncm_ode_eval_ref (NcmODEEval *ode_eval
);
Increases the reference count of ode_eval
by one atomically.
ncm_ode_eval_free ()
void
ncm_ode_eval_free (NcmODEEval *ode_eval
);
Atomically decrements the reference count of ode_eval
by one.
If the reference count drops to 0, all memory allocated by ode_eval
is released.
ncm_ode_eval_clear ()
void
ncm_ode_eval_clear (NcmODEEval **ode_eval
);
If ode_eval
is different from NULL,
atomically decrements the reference count of ode_eval
by one.
If the reference count drops to 0, all memory allocated
by ode_eval
is released and ode_eval
is set to NULL.
ncm_ode_eval_df ()
gint ncm_ode_eval_df (NcmODEEval *ode_eval
,const guint sys_size
,const gdouble t
,const gdouble * restrict f
,gdouble * restrict df
);
Computes the time derivatives of the ODE system in df
using the
current state in f
.
Return: status
[virtual df]
ncm_ode_eval_J_dense ()
gint ncm_ode_eval_J_dense (NcmODEEval *ode_eval
,const guint sys_size
,const gdouble t
,const gdouble * restrict f
,gdouble ** restrict J_col
);
Computes the jacobian matrix $J$ of the ODE system in J_col
using the
current state in f
.
Return: status
[virtual J_dense]
NCM_ODE_EVAL_DECLARE_IMPL()
#define NCM_ODE_EVAL_DECLARE_IMPL(ModuleObjName, module_obj_name, MODULE, OBJ_NAME, LocalStruct)
Property Details
The “sys-size”
property
“sys-size” guint
The ordinary differential equation (EDO) system size.
Owner: NcmODEEval
Flags: Read / Write / Construct
Allowed values: >= 1
Default value: 1