Robotran C Documentation
mbs_invdyn.h
Go to the documentation of this file.
1 
12 #ifndef MBS_INVDYN_h
13 #define MBS_INVDYN_h
14 
15 #include "mbs_data.h"
16 #include "mbs_invdyn_struct.h"
17 
18 #ifdef __cplusplus
19 extern "C" {
20 #endif
21 
30 MbsInvdyn* mbs_new_invdyn(MbsData* mbs_data);
31 
32 
41 MbsInvdyn* mbs_new_invdyn_aux(MbsData* mbs_data, MbsAux* mbs_aux);
42 
43 
55 int mbs_run_invdyn(MbsInvdyn* invdyn, MbsData* mbs_data);
56 
57 
67 int mbs_invdyn_init(MbsInvdyn* invdyn, MbsData* mbs_data);
68 
69 
82 int mbs_invdyn_loop(MbsInvdyn* invdyn, MbsData* mbs_data);
83 
84 
94 int mbs_invdyn_finish(MbsInvdyn* invdyn, MbsData* mbs_data);
95 
96 
101 void mbs_delete_invdyn(MbsInvdyn* invdyn, MbsData* mbs_data);
102 
103 #ifdef __cplusplus
104 }
105 #endif
106 
117 
125 int mbs_fct_invdyn(MbsData *s, MbsInvdyn *invdyn);
126 
127 #endif
MbsLutRes::tq
double ** tq
2D array containing the time (first column) and the corresponding coordinates value
Definition: lut.h:44
mbs_lut_res_free
void mbs_lut_res_free(MbsLutRes *lut)
Release memory used by 2D LUT structure.
Definition: lut.c:105
MbsInvOptions::resfilename
char * resfilename
The keyword used for determining the name of result files.
Definition: mbs_solvekin_struct.h:94
BUFFER_OTHER
@ BUFFER_OTHER
Definition: mbs_buffer.h:23
BUFFER_QC
@ BUFFER_QC
Definition: mbs_buffer.h:22
mbs_lut_res_interp
int mbs_lut_res_interp(MbsLutRes *lut, double t, double *coord)
Interpolate the coordinates from a Results Look Up Table for a specific time value.
Definition: lut.c:287
get_char_cpy
char * get_char_cpy(const char *fmt,...)
Copy the provided formatted string into a newly allocated memory.
Definition: useful_functions.c:191
MbsData::qd
double * qd
Array with the current values of the generalized velocities.
Definition: mbs_data.h:188
MbsInvdyn
General structure of the inverse dynamics module.
Definition: mbs_invdyn_struct.h:27
MbsData::qa
int * qa
Array with the indices of actuated articulations (only for inverse dynamic).
Definition: mbs_data.h:180
MbsData::dt0
double dt0
Initial value of the integration step size [s]. For dirdyn and invdyn only. This parameter is set fro...
Definition: mbs_data.h:212
MbsInvOptions::buffer_format
char * buffer_format
The format of the results in the res file.
Definition: mbs_solvekin_struct.h:137
mbs_invdyn_write_buffers
int mbs_invdyn_write_buffers(MbsInvdyn *invd)
Write the content of buffer associated to the given MbsInvdyn to disk.
Definition: mbs_invdyn.c:841
BUFFER_LINK_ZD
@ BUFFER_LINK_ZD
Definition: mbs_buffer.h:22
MbsInvOptions::saveperiod
int saveperiod
The number of time steps between two buffer records.
Definition: mbs_solvekin_struct.h:118
MbsInvOptions::buffersize
int buffersize
The number of time step that can be recorded in the buffer.
Definition: mbs_solvekin_struct.h:130
MbsData::tsim
double tsim
The time value.
Definition: mbs_data.h:208
mbs_error_msg
void mbs_error_msg(char *msg,...)
Send an error message.
Definition: mbs_message.c:102
MbsData::nqv
int nqv
Number of dependent articulations.
Definition: mbs_data.h:170
MbsInvOptions::max_save_user
int max_save_user
The maximal number of user variables saved.
Definition: mbs_solvekin_struct.h:123
mbs_delete_invdyn
void mbs_delete_invdyn(MbsInvdyn *invdyn, MbsData *mbs_data)
Free memory of the inverse dynamic structure The options (MbsInvOptions) and MbsAux structures are al...
Definition: mbs_invdyn.c:84
mbs_data.h
MbsData::qc
int * qc
Array with the indices of driven (locked and driven) articulations.
Definition: mbs_data.h:175
BUFFER_QQ
@ BUFFER_QQ
Definition: mbs_buffer.h:21
user_invdyn_init
void user_invdyn_init(MbsData *mbs_data, MbsInvdyn *mbs_invdyn)
Definition: user_invdyn.c:16
mbs_fct_invdyn
int mbs_fct_invdyn(MbsData *s, MbsInvdyn *invdyn)
inverse dynamic computation of q, qd and qdd
Definition: mbs_invdyn.c:858
MbsData::nqu
int nqu
Number of independent articulations.
Definition: mbs_data.h:165
BUFFER_LINK_F
@ BUFFER_LINK_F
Definition: mbs_buffer.h:22
_MBS_ERR_LOW_FILES
#define _MBS_ERR_LOW_FILES
Low Level error number Error during opening/writing files = -9.
Definition: mbs_errors_names.h:147
mbs_new_invdyn_aux
MbsInvdyn * mbs_new_invdyn_aux(MbsData *mbs_data, MbsAux *mbs_aux)
Fills a new inverse dynamic auxilliary structure.
Definition: mbs_invdyn.c:38
MbsInvdyn::buffers
MbsBuffer ** buffers
Buffer to store generalized coordinates, velocities, acceleration.
Definition: mbs_invdyn_struct.h:45
MbsData::njoint
int njoint
Number of joints in the system.
Definition: mbs_data.h:162
mbs_project_interface.h
mbs_buffer_write
int mbs_buffer_write(MbsBuffer *b)
Write the content of the buffer to disk.
Definition: mbs_buffer.c:347
BUFFER_LINK_Z
@ BUFFER_LINK_Z
Definition: mbs_buffer.h:22
MbsData::tf
double tf
Final time of the simulation [s]. For dirdyn and invdyn only. This parameter is set from dirdyn/invyn...
Definition: mbs_data.h:211
MbsInvOptions::trajectoryqddname
char * trajectoryqddname
Give the path and filename (with extention) to the file containing the input trajectory in accelerati...
Definition: mbs_solvekin_struct.h:73
MbsLutRes::nt
int nt
number of time steps
Definition: lut.h:43
mbs_fct_invdyn
int mbs_fct_invdyn(MbsData *s, MbsInvdyn *invd)
inverse dynamic computation of q, qd and qdd
Definition: mbs_invdyn.c:858
mbs_invdyn_finish
int mbs_invdyn_finish(MbsInvdyn *invd, MbsData *mbs_data)
Run the finalization operations of the run_invdyn function.
Definition: mbs_invdyn.c:770
mbs_new_invdyn_aux
MbsInvdyn * mbs_new_invdyn_aux(MbsData *mbs_data, MbsAux *mbs_aux)
Fills a new inverse dynamic auxilliary structure.
Definition: mbs_invdyn.c:38
closeloop
@ closeloop
Definition: mbs_solvekin_struct.h:25
mbs_invdyn_loop
int mbs_invdyn_loop(MbsInvdyn *invd, MbsData *mbs_data)
Time loop of the run_invdyn function:
Definition: mbs_invdyn.c:640
mbs_invdyn_init
int mbs_invdyn_init(MbsInvdyn *invd, MbsData *mbs_data)
Run the startup operations of the run_invdyn function.
Definition: mbs_invdyn.c:186
free_set_output
void free_set_output()
release memory of auto_output
Definition: set_output.c:56
mbs_invdyn.h
mbs_buffer_save
int mbs_buffer_save(MbsBuffer *b, double t, double *x)
Save the given array to the specified buffer with the specified time.
Definition: mbs_buffer.c:212
mbs_invdyn_finish
int mbs_invdyn_finish(MbsInvdyn *invdyn, MbsData *mbs_data)
Run the finalization operations of the run_invdyn function.
Definition: mbs_invdyn.c:770
MbsInvOptions::dt
double dt
Time step, default = 0.001.
Definition: mbs_solvekin_struct.h:86
invdynared
int invdynared(MbsAux *mbs_aux, MbsData *s)
Compute the required forces ont the actuated joints in a configuration.
Definition: mbs_invdynared.c:26
mbs_growing_buffer_write
int mbs_growing_buffer_write(MbsGrowingBuffer *b)
write the content of the growing buffer to disk
Definition: mbs_buffer.c:557
_MBS_ERR_MOD_SPEC_15
#define _MBS_ERR_MOD_SPEC_15
Generic error number Module specific errors range from -11 to -19 please read the error message a...
Definition: mbs_errors_names.h:186
BUFFER_Q
@ BUFFER_Q
Definition: mbs_buffer.h:21
user_invdyn_loop
void user_invdyn_loop(MbsData *mbs_data, MbsInvdyn *mbs_invdyn)
Definition: user_invdyn.c:21
_MBS_ERR_LOW_NAN
#define _MBS_ERR_LOW_NAN
Low Level error number Number is NaN (not a number) = -7.
Definition: mbs_errors_names.h:142
MbsInvOptions::motion
int motion
Determines how the evolution of q, qd qdd are provided.
Definition: mbs_solvekin_struct.h:40
MbsInvOptions::framerate
int framerate
Number of frame per second for the .anim file, default = 1000.
Definition: mbs_solvekin_struct.h:113
_MBS_ERR_INIT
#define _MBS_ERR_INIT
Generic error number Check user options at initialization = -10.
Definition: mbs_errors_names.h:156
MBSfun.h
mbs_check_nhu_nqv
int mbs_check_nhu_nqv(MbsData *mbs_data)
Check the coherence between the number of (independant) constraints and the number of dependant varia...
Definition: mbs_check.c:19
MbsInvOptions::t0
double t0
Initial time of the simulation, default = 0.0.
Definition: mbs_solvekin_struct.h:76
MbsLutRes::nq
int nq
number coordinates
Definition: lut.h:42
MbsInvOptions::animpath
const char * animpath
Path in which anim file is saved.
Definition: mbs_solvekin_struct.h:104
MbsData::Nlink
int Nlink
Number of forces acting between two points of the system (force law implemented in user_LinkForces())...
Definition: mbs_data.h:237
MbsInvOptions::trajectoryqname
char * trajectoryqname
Give the path and filename (with extention) to the file containing the input trajectory in position o...
Definition: mbs_solvekin_struct.h:51
MbsInvdyn::q
MbsLutRes * q
Pointer to save the input trajectories.
Definition: mbs_invdyn_struct.h:69
MbsData::flag_safety_checks
int flag_safety_checks
Flag to activate safety checks everywhere in mbsysc core. Faster computation if this flag is put to 0...
Definition: mbs_data.h:307
mbs_msg
void mbs_msg(char *msg,...)
Send a message.
Definition: mbs_message.c:76
mbs_new_invdyn
MbsInvdyn * mbs_new_invdyn(MbsData *mbs_data)
Create a new inverse dynamic structure.
Definition: mbs_invdyn.c:28
MbsBuffer
Definition: mbs_buffer.h:46
mbs_growing_buffer_save
int mbs_growing_buffer_save(MbsGrowingBuffer *b, double t)
Save the given values of auto_output to the specified buffer with the specified time.
Definition: mbs_buffer.c:253
mbs_delete_buffer
void mbs_delete_buffer(MbsBuffer *b)
Free memory of the specified MbsBuffer.
Definition: mbs_buffer.c:164
MbsInvdyn::qdd
MbsLutRes * qdd
Definition: mbs_invdyn_struct.h:69
mbs_delete_growing_buffer
void mbs_delete_growing_buffer(MbsGrowingBuffer *b)
release memory for growing buffer
Definition: mbs_buffer.c:188
MbsData::Fl
double * Fl
Array with the current values of the forces on each link (see: user_LinkForces()).
Definition: mbs_data.h:241
MbsData::qu
int * qu
Array with the indices of the independent articulations (free)
Definition: mbs_data.h:174
mbs_new_invdyn
MbsInvdyn * mbs_new_invdyn(MbsData *mbs_data)
Create a new inverse dynamic structure.
Definition: mbs_invdyn.c:28
MbsData::Qc
double * Qc
Array with the value of joint force introduced in driven joint to respect the user function.
Definition: mbs_data.h:233
mbs_run_invdyn
int mbs_run_invdyn(MbsInvdyn *invdyn, MbsData *mbs_data)
Run the inverse kinematic analysis.
Definition: mbs_invdyn.c:100
BUFFER_QA
@ BUFFER_QA
Definition: mbs_buffer.h:23
freeMbsAux
void freeMbsAux(MbsAux *mbs_aux, MbsData *s)
Definition: mbs_aux.c:174
MbsData::Zd
double * Zd
Array with the current values of the speed (spreading) between of the points of a link (see: user_Lin...
Definition: mbs_data.h:240
MbsInvdyn::mbs_aux
MbsAux * mbs_aux
Structure to store auxiliary value needed during computation.
Definition: mbs_invdyn_struct.h:34
MbsData::Qq
double * Qq
Array with the values of the joint forces.
Definition: mbs_data.h:204
MbsData::q
double * q
Array with the current values of the generalized coordinates.
Definition: mbs_data.h:187
MbsInvOptions::verbose
int verbose
Gives informations during the process.
Definition: mbs_solvekin_struct.h:143
BUFFER_LAMBDA
@ BUFFER_LAMBDA
Definition: mbs_buffer.h:23
free_dvec_1
void free_dvec_1(double *vec)
release memory for a vector of doubles, starting at index 1
Definition: mbs_1D_array.c:901
BUFFER_QD
@ BUFFER_QD
Definition: mbs_buffer.h:21
trajectory
@ trajectory
Definition: mbs_solvekin_struct.h:25
MbsData::project_path
char * project_path
Path to the mbs project folder.
Definition: mbs_data.h:312
mbs_init_sin_cos_q_vecs
int mbs_init_sin_cos_q_vecs(MbsData *s, int *qrot_qu_indvec, int *qrot_qc_indvec, int *qrot_qv_indvec)
Initialize the three vectors of indices (they are usually contained in the mbs_aux structure)
Definition: mbs_trigo.c:23
MbsData::nqdriven
int nqdriven
Number of driven articulations.
Definition: mbs_data.h:168
MbsInvOptions::trajectoryqdname
char * trajectoryqdname
Give the path and filename (with extention) to the file containing the input trajectory in velocity o...
Definition: mbs_solvekin_struct.h:62
MbsInvdyn::tsim
double tsim
Current simulation time.
Definition: mbs_invdyn_struct.h:38
mbs_check_mbs_data_values
int mbs_check_mbs_data_values(MbsAux *module_mbs_aux, MbsData *mbs_data)
Check the coherence between the mbs_data used before module initialization and module run.
Definition: mbs_check.c:87
mbs_trigo.h
This header defines the functions for trigonometric handling in MBsysC integrator in C.
MbsInvdyn::user_buffer
MbsGrowingBuffer * user_buffer
Growing buffer to store user values.
Definition: mbs_invdyn_struct.h:48
MbsInvdyn::trajectorytype
int trajectorytype
Value to store the type of trajectory provided by the user, automatically set.
Definition: mbs_invdyn_struct.h:66
MbsInvdyn::qd
MbsLutRes * qd
Definition: mbs_invdyn_struct.h:69
mbs_new_growing_buffer
MbsGrowingBuffer * mbs_new_growing_buffer(int max_nx, int size, const char *respath)
create a new growing buffer for the user inputs to save
Definition: mbs_buffer.c:120
MbsInvOptions::tf
double tf
Final time of the simulation, default = 5.0.
Definition: mbs_solvekin_struct.h:79
MbsInvOptions
Structure defining the option of both inverse kinematics and inverse dynamic analysis.
Definition: mbs_solvekin_struct.h:31
mbs_lut_res_load_file
MbsLutRes * mbs_lut_res_load_file(char *fileName)
Load a file and return a new allocated results LUT structure.
Definition: lut.c:827
lut.h
Interpolation of value from array (Look Up Table) main header.
MbsData::nqc
int nqc
Number of driven articulations, it includes qlocked and qdriven.
Definition: mbs_data.h:166
set_output.h
set_output function called by the user to output his own variables
mbs_message.h
_MBS_ERR_MOD_SPEC_14
#define _MBS_ERR_MOD_SPEC_14
Generic error number Module specific errors range from -11 to -19 please read the error message a...
Definition: mbs_errors_names.h:180
MbsInvOptions::respath
const char * respath
Path in which result file are saved.
Definition: mbs_solvekin_struct.h:99
initMbsAux
MbsAux * initMbsAux(MbsData *s)
Definition: mbs_aux.c:18
user_invdyn_finish
void user_invdyn_finish(MbsData *mbs_data, MbsInvdyn *mbs_invdyn)
Definition: user_invdyn.c:27
MbsData
Definition: mbs_data.h:149
_MBS_ERR_MOD_INV_DYN
#define _MBS_ERR_MOD_INV_DYN
Module error number module: Inverse Dynamics = -600.
Definition: mbs_errors_names.h:68
oneshot
@ oneshot
Definition: mbs_solvekin_struct.h:25
_MBS_ERR_MOD_SPEC_11
#define _MBS_ERR_MOD_SPEC_11
Mid Level error number Module specific errors range from -11 to -19 please read the error message...
Definition: mbs_errors_names.h:162
MbsData::qlocked
int * qlocked
Array with the indices of locked articulations.
Definition: mbs_data.h:176
MbsInvdyn::options
MbsInvOptions * options
Structure defining the options of a inverse dynamics analysis.
Definition: mbs_invdyn_struct.h:31
get_output_vector_size
int get_output_vector_size(int index)
get the output vector size corresponding to the requested index
Definition: set_output.c:222
MbsData::t0
double t0
Initial time of the simulation [s]. For dirdyn and invdyn only. This parameter is set from dirdyn/inv...
Definition: mbs_data.h:210
get_output_vector_nb
int get_output_vector_nb()
get the number of user vector inputs
Definition: set_output.c:240
init_set_output
void init_set_output(int max_nb_curves)
initialize the static auto_output structure
Definition: set_output.c:23
MbsData::Z
double * Z
Array with the current values of the distances between of the points of a link (see: user_LinkForces(...
Definition: mbs_data.h:239
mbs_invdyn_init
int mbs_invdyn_init(MbsInvdyn *invdyn, MbsData *mbs_data)
Run the startup operations of the run_invdyn function.
Definition: mbs_invdyn.c:186
MbsInvdyn::savedArrays
double ** savedArrays
Pointer to the array that must be saved to buffers.
Definition: mbs_invdyn_struct.h:54
MbsData::flag_stop
int flag_stop
stop the simulation. For dirdyn, equil, invdyn and solvekin only.
Definition: mbs_data.h:298
get_dvec_1
double * get_dvec_1(int l_v)
create (with memory allocation) a vector (length l_v) of doubles, starting at index 1
Definition: mbs_1D_array.c:885
MbsInvOptions::save2file
int save2file
Determine whether results are written to files on disk (in MbsSolvekinOptions::respath folder):
Definition: mbs_solvekin_struct.h:91
BUFFER_QDD
@ BUFFER_QDD
Definition: mbs_buffer.h:21
MbsData::qdriven
int * qdriven
Array with the indices of driven articulations.
Definition: mbs_data.h:178
MbsData::lambda
double * lambda
Array with the values of the Lagrange Multipliers related to the constraints.
Definition: mbs_data.h:222
find_ivec_1
int find_ivec_1(int *vec, int l_v, int f)
return the index of the value f in the (x sized) vector vec of integers, starting with index 1....
Definition: mbs_1D_array.c:832
reset_flag_output
void reset_flag_output()
reset the flag_output to 0. Useful when running several simulation in a row with different save2file ...
Definition: set_output.c:15
MbsInvdyn::tindex
int tindex
Current time index.
Definition: mbs_invdyn_struct.h:41
MbsData::nqa
int nqa
Number of actuated articulations.
Definition: mbs_data.h:169
MbsInvOptions::save_anim
int save_anim
Determine whether animation file is generated (only valid if MbsSolvekinOptions::save2file is set to ...
Definition: mbs_solvekin_struct.h:110
mbs_invdyn_save
int mbs_invdyn_save(MbsInvdyn *invd, MbsData *mbs_data, double t)
Save the values of invdyn analysis in the buffers.
Definition: mbs_invdyn.c:150
MbsData::nqlocked
int nqlocked
Number of locked articulations.
Definition: mbs_data.h:167
MbsData::qdd
double * qdd
Array with the current values of the generalized acceleration.
Definition: mbs_data.h:189
get_output_vector_label
char * get_output_vector_label(int index)
get the output vector label corresponding to the requested index
Definition: set_output.c:211
mbs_check.h
mbs_new_buffer
MbsBuffer * mbs_new_buffer(char *filename, char *anim_name, int nx, int size, int id, char *buf_format, int save_anim, int save_visu, double anim_period)
Allocate and initialize a MbsBuffer structure.
Definition: mbs_buffer.c:27
mbs_delete_invdyn
void mbs_delete_invdyn(MbsInvdyn *invdyn, MbsData *mbs_data)
Free memory of the inverse dynamic structure The options (MbsInvOptions) and MbsAux structures are al...
Definition: mbs_invdyn.c:84
print_ivec_0
void print_ivec_0(int *vec, int l_v)
print a (l_v sized) vector of integers in console, starting with index 0
Definition: mbs_1D_array.c:494
mbs_invdyn_write_buffers
int mbs_invdyn_write_buffers(MbsInvdyn *invdyn)
Write the content of buffer associated to the given MbsInvdyn to disk.
Definition: mbs_invdyn.c:841
MbsInvdyn::bufferNb
int bufferNb
Number of buffers.
Definition: mbs_invdyn_struct.h:51
mbs_invdyn_struct.h
mbs_invdyn_loop
int mbs_invdyn_loop(MbsInvdyn *invdyn, MbsData *mbs_data)
Time loop of the run_invdyn function:
Definition: mbs_invdyn.c:640
same_ivec_1
int same_ivec_1(int *v1, int *v2)
Compare if two vector are the same.
Definition: mbs_1D_array.c:864
mbs_run_invdyn
int mbs_run_invdyn(MbsInvdyn *invd, MbsData *mbs_data)
Run the inverse kinematic analysis.
Definition: mbs_invdyn.c:100
MbsData::nhu
int nhu
Number of independent constraints.
Definition: mbs_data.h:171
get_output_vector_ptr
double * get_output_vector_ptr(int index)
get the pointer to the output vector at the requested index
Definition: set_output.c:259
user_DrivenJoints
void user_DrivenJoints(MbsData *mbs_data, double tsim)
Compute the positions, velocities and acceleration of driven joint.
Definition: user_DrivenJoints.c:15
mbs_errors_names.h