mbs_rk4.h File Reference

This header defines global functions for Runge Kutta 4 integrator in C. More...

#include "mbs_data.h"
#include "integrator.h"
#include "mbs_dirdyn.h"
#include "useful_functions.h"
#include "mbs_dirdyn_struct.h"
#include "mbs_project_interface.h"
#include "MBSfun.h"

Go to the source code of this file.

Classes
struct	MbsDirdynRK4
	Runge-Kutta 4 structure for dirdyn. More...

Functions
void	initialize_rk4 (MbsData *mbs_data, MbsDirdyn *mbs_dd)
	Initialize all needed fields in MbsDirdyn for RK4 integrator. More...
int	loop_rk4 (double t0, double tf, MbsData *mbs_data, MbsDirdyn *mbs_dd)
	Integrate the motion from t0 to tf. More...
void	finish_rk4 (MbsData *mbs_data, MbsDirdyn *mbs_dd)
	Finalize and clear memory allocated for RK4 integrator. More...
void	error_rk4 (MbsData *mbs_data, MbsDirdyn *dd, int err)
	If an error occurs during time integration, this function prints the error message and call finish_rk4. More...

Detailed Description

This header defines global functions for Runge Kutta 4 integrator in C.

Creation date: December 2017

Author

Olivier Lantsoght

Modification date: April 2018 \modified by Sebastien Timmermans

(c) Universite catholique de Louvain

Function Documentation

error_rk4()

void error_rk4	(	MbsData *	mbs_data,
		MbsDirdyn *	dd,
		int	err
	)

If an error occurs during time integration, this function prints the error message and call finish_rk4.

Parameters

mbs_data	The computed MBS structure
mbs_dd	The associated MbsDirdyn structure
err	The error number

finish_rk4()

void finish_rk4	(	MbsData *	mbs_data,
		MbsDirdyn *	mbs_dd
	)

Finalize and clear memory allocated for RK4 integrator.

Parameters

mbs_data	The computed MBS structure
mbs_dd	The associated MbsDirdyn structure

initialize_rk4()

void initialize_rk4	(	MbsData *	mbs_data,
		MbsDirdyn *	mbs_dd
	)

Initialize all needed fields in MbsDirdyn for RK4 integrator.

Parameters

mbs_data	The computed MBS structure
mbs_dd	The associated MbsDirdyn structure

loop_rk4()

int loop_rk4	(	double	t0,
		double	tf,
		MbsData *	mbs_data,
		MbsDirdyn *	mbs_dd
	)

Integrate the motion from t0 to tf.

Parameters

t0	The initial time
tf	The final time
mbs_data	The computed MBS structure
mbs_dd	The associated MbsDirdyn structure

Returns

Error status, <0 in case of failure.

user loop

user loop