LALInspiral 5.0.3.1-eeff03c
Header LALSQTPNIntegrator.h

Detailed Description

Contains the function declarations and structures needed by the integration method.

Author
László Veréb
Date
2010.05.21.

Prototypes

int XLALSQTPNIntegratorInit (LALSQTPNIntegratorSystem *integrator, INT2 num, void *params, int(*derivator)(REAL8, const REAL8[], REAL8[], void *))
 The function initialize the integration method. More...
 
void XLALSQTPNIntegratorFree (LALSQTPNIntegratorSystem *integrator)
 The function deallocates the memory allocated for the integrator function. More...
 
int XLALSQTPNIntegratorFunc (REAL8 values[], LALSQTPNIntegratorSystem *integrator, REAL8 step)
 The function evolves the system with the given time-step. More...
 

Data Structures

struct  LALSQTPNIntegratorSystem
 The structure contains the integration method and its settings. More...
 

Function Documentation

◆ XLALSQTPNIntegratorInit()

int XLALSQTPNIntegratorInit ( LALSQTPNIntegratorSystem integrator,
INT2  num,
void *  params,
int(*)(REAL8, const REAL8[], REAL8[], void *)  derivator 
)

The function initialize the integration method.

Parameters
[out]integrator: the structure containing the integration method
[in]num: the number of the dynamic variables
[in]params: the parameters used in the derivative function
[in]derivator: pointer to the derivative function

Definition at line 11 of file LALSQTPNIntegrator.c.

◆ XLALSQTPNIntegratorFree()

void XLALSQTPNIntegratorFree ( LALSQTPNIntegratorSystem integrator)

The function deallocates the memory allocated for the integrator function.

Parameters
[in]integrator: the structure containing the integration method

Definition at line 47 of file LALSQTPNIntegrator.c.

◆ XLALSQTPNIntegratorFunc()

int XLALSQTPNIntegratorFunc ( REAL8  values[],
LALSQTPNIntegratorSystem integrator,
REAL8  step 
)

The function evolves the system with the given time-step.

Parameters
[in,out]values: as input parameters the system's actual position, as ouput the system's next position.
[in]integrator: the integration method
[in]step: the step size

Definition at line 59 of file LALSQTPNIntegrator.c.