mbs_custom.h File Reference

This header defines global functions for custom integrator in C. Advanced user can modify this file. More...

#include "mbs_project_interface.h"

Go to the source code of this file.

Classes
struct	MbsDirdynCustom
	Custom integrator structure for dirdyn. More...

Functions
void	initialize_custom (MbsData *mbs_data, MbsDirdyn *mbs_dd, int(*derivs)(double, double[], double[], MbsData *, MbsDirdyn *), void(*loop_fct)(MbsData *, MbsDirdyn *), int(*save_realtime_update)(MbsDirdyn *dd, MbsData *mbs_data))
	Initialize all needed fields in MbsDirdyn for Custom integrator. More...
int	loop_custom (double t0, double tf, MbsData *mbs_data, MbsDirdyn *mbs_dd)
	Integrate the motion from t0 to tf with a custom integrator implemented by the user. More...
void	finish_custom (MbsData *mbs_data, MbsDirdyn *mbs_dd)
	Finalize and clear memory allocated for Custom integrator. More...
void	error_custom (MbsData *mbs_data, MbsDirdyn *dd, int err)
	If an error occurs during time integration, this function prints the error message and call finish_custom. More...

Detailed Description

This header defines global functions for custom integrator in C. Advanced user can modify this file.

Creation date: May 2018

Author

Sebastien Timmermans

(c) Universite catholique de Louvain

Function Documentation

error_custom()

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

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

Parameters

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

finish_custom()

void finish_custom	(	MbsData *	mbs_data,
		MbsDirdyn *	mbs_dd
	)

Finalize and clear memory allocated for Custom integrator.

Parameters

mbs_data	The computed MBS structure
mbs_dd	The associated MbsDirdyn structure

initialize_custom()

void initialize_custom	(	MbsData *	mbs_data,
		MbsDirdyn *	mbs_dd,
		int(*)(double, double[], double[], MbsData *, MbsDirdyn *)	derivs,
		void(*)(MbsData *, MbsDirdyn *)	loop_fct,
		int(*)(MbsDirdyn *dd, MbsData *mbs_data)	save_realtime_update
	)

Initialize all needed fields in MbsDirdyn for Custom integrator.

Parameters

mbs_data	The computed MBS structure
mbs_dd	The associated MbsDirdyn structure
derivs	The function computing f'
loop_fct	The function to be called at the end of each time step, or waypoints.

loop_custom()

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

Integrate the motion from t0 to tf with a custom integrator implemented by the user.

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