mbs_data.py 59.1 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
# -*- coding: utf-8 -*-
"""
-------------------------------
(c) Universite catholique de Louvain, 2019

Creation : 2019 by O. Lantsoght
Last update : 2019

version MBsysC v1.11.2

-------------------------------
Portable Python interface to MBsysC using Ctypes.

Define the class MbsData based on the MbsData structure of MBsysC.
This class has the functions required to manipulate the Data (set the number of
user constraints, set the independant or dependant variables...).
"""

import os
import imp
import ctypes

import numpy as np

# importing MbsysPy classes
from .mbs_sensor import MbsSensor
27
28
from .mbs_dirdyn import MbsDirdyn
from .mbs_part import MbsPart
29
30
31
32
33

# importing libraries
from ..mbsysc_loader.loadlibs import libutilities
from ..mbsysc_loader.loadlibs import libloadXML

34
35
36
# importing utilities function
from ..mbs_utilities import callback_undefined

37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
# importing wrapping function
from ..mbsysc_loader.callback import user_Derivative_wrap
from ..mbsysc_loader.callback import user_DrivenJoints_wrap
from ..mbsysc_loader.callback import user_ExtForces_wrap
from ..mbsysc_loader.callback import user_JointForces_wrap
from ..mbsysc_loader.callback import user_LinkForces_wrap
from ..mbsysc_loader.callback import user_Link3DForces_wrap

from ..mbsysc_loader.callback import mbs_accelred_wrap
from ..mbsysc_loader.callback import mbs_extforces_wrap
from ..mbsysc_loader.callback import mbs_gensensor_wrap
from ..mbsysc_loader.callback import mbs_link_wrap
from ..mbsysc_loader.callback import mbs_link3D_wrap
from ..mbsysc_loader.callback import mbs_sensor_wrap

#==============================================================================
# Global parameter of the current module
#==============================================================================
55
__DEBUG__ = True
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
__MODULE_DIR__ = os.path.dirname(os.path.abspath(__file__))


#==============================================================================
# Defining Python MbsData class
#==============================================================================

class MbsData(object):
    
    """
    Class containing geometrical and dynamical information of robotran Mbs.
    
    Attributes
    ----------
    DonePart : int
        Flag that indicates if the coordinate partitioning module has been 
        executed (default: 0=not done; 1=done).
    dpt : ndarray
        Numpy array containing the coordinates of all anchor points in body 
        fixed frame: [X_i,Y_i,Z_i] = dpt[1:4,i]
76
77
78
    extforce_id : dict
        Dictionary containing the names of the extforces as keys and their ids 
        as values.
79
80
81
82
83
84
85
86
87
88
89
    Fl : ndarray
        Numpy array containing the current values of the forces on each link.
    frc: ndarray
        Numpy array containing the components of the resultant external forces 
        (in the body fixed frame) applied to the center of mass of each body.
    g : ndarray
        The 3 gravity components in the inertial frame: g[1:4]=[g_x, g_y, g_z]
    In : ndarray
        Numpy array containing the inertia tensor component of each body (in 
        the body fixed frame, relative to the center of mass). For body k:
        In[1:10, k]=[I_11,I_12,I_13,I_21,I_22,I_23,I_31,I_32,I_33]
90
91
92
    joint_id : dict
        Dictionary containing the names of the joints as keys and their ids as 
        values.
93
94
95
96
97
98
    l : ndarray
        Numpy array containing the center of mass coordinates in the body fixed
        frame. For body k: l[1:4, k]=[gc_x, gc_y, gc_z]
    lambda_ : ndarray
        Numpy array containing the values of the Lagrange Multipliers related 
        to the constraints.
99
100
101
    link_id : dict
        Dictionary containing the names of the links as keys and their ids as 
        values.
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
    lrod : ndarray
        Numpy array containing the length of each rod.
    m : ndarray
        Numpy array containing the mass of each body.
    mbs_filename : str
        Path to mbs file including the file with the extension (.mbs).
    mbs_name : str
        Filename of the mbs file (excluding path and ".mbs" extension).
    nbody : int
        Number of bodies in the system. The fictious bodies are not taken into 
        account.
    Ncons : int
        Number of algebraic constraints.
    nhu : int
        Number of independent constraints.
    njoint : int
        Number of joints in the system.
    Nlink : int
        Number of forces acting between two points of the system.
    Nloopc : int
        Number of loop constraints.
    npt : int
        Number of anchor points.
    nqa : int
        Number of actuated articulations.
    nqc : int
        Number of driven articulations, it includes qlocked and qdriven..
    nqdriven : int
        Number of driven articulations.
    nqlocked : int
        Number of locked articulations.
    nqu : int
        Number of independent articulations.
    nqv : int
        Number of dependent articulations.
    NRerr : float
        Maximal error on constraint allowed in Newton-Raphson algorithm, 
        default 1.0e-9.
    nrod : int
        Number of rod constraints defined on the system.
    Nsensor : int
        Number of kinematic sensors.
    Nuserc : int
        Number of user constraints.
    Nux : int
        Number of user variable.
    Nxfrc : int
        Number of points where an external force is applied into a body.
    process : int
        Flag that indicate which module is currently running: 
        1=partitioning; 2=equilibrium; 3=direct dynamic; 4=modal
    project_path : str
        Path to the mbs project folder.
    q : ndarray
        Numpy array containing the current values of the generalized 
        coordinates.
    q0 : ndarray
        Numpy array containing the initial values of the generalized 
        coordinates.
    qa : ndarray of int
        Numpy array of integers containing the indices of actuated 
        articulations (only for inverse dynamic). Those articulations are 
        controlled by an actuator.
    qc : ndarray of int
        Numpy array of integers containing the indices of driven (locked and 
        driven) articulations.
    Qc : ndarray
        Numpy array containing the value of joint force introduced in driven 
        joints to respect the user function. The driven forces/torques are 
        saved in the entries given by index vector 'qc'.
    qd : ndarray
        Numpy array containing the current values of the generalized 
        velocities.
    qd0 : ndarray
        Numpy array containing the initial values of the generalized 
        velocities.
    qdd : ndarray
        Numpy array containing the current values of the generalized 
        accelerations.
    qdd0 : ndarray
        Numpy array containing the initial values of the generalized 
        accelerations.
    qdriven : ndarray of int
        Numpy array of integers containing the indices of driven articulations.
        Those articulations are controlled by a user function: 
        q[qdriven]=f(tsim)
    qlocked : ndarray of int
        Numpy array of integers containing the indices of locked articulations.
        Those articulations have a constant position defined by the user:
        q[qlocked]=cte
    Qq : ndarray
        Numpy array containing the values of the joint forces.
    qu : ndarray of int
        Numpy array of integers containing the indices of the independent 
        articulations.
    qv : ndarray of int
        Numpy array of integers containing the indices of the dependent 
        articulations.
200
201
202
    sensor_id : dict
        Dictionary containing the names of the sensors as keys and their ids as 
        values.
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
    sensors : list of MbsSensor
        List containing one instance of MbsSensor (without defined id). User 
        can append as many as needed sensor in the list. Sensors defined in 
        this list can be used by the user for various computation.
    SWr : ndarray
        Numpy array containing the Swr vector for each external forces.
        for force k, Swr[k,1:10] = [Fx, Fy, Fz, Mx, My, Mz, dxF] with
          - Force components (expressed in the inertial frame) : Fx,Fy,Fz
          - Pure torque components (expressed in the inertial frame) : Mx,My,Mz
          - Application point local coordinates vector (expressed in the body 
            fixed frame): dxF[1:4]
    t0 : scalar
        Initial time of the simulation [s]. For dirdyn and invdyn only. This 
        parameter is set from dirdyn/invyn option at start of time simulation.
    tf : scalar
        Final time of the simulation [s]. For dirdyn and invdyn only. This 
        parameter is set from dirdyn/invyn option at start of time simulation.
    trq : ndarray
        Numpy array containing the components of the resultant external torques
        (pure torque and couple produced by forces displacement in the body 
        fixed frame) applied to each body.
    tsim : scalar
        The time value.
226
227
228
229
    user_model : dict
        Dictionary containing the names of the user models as keys and a second
        dictionary with their parameters as values. The second dictionary
        contains the names of the parameters as keys and their values as values
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
    ux : ndarray
        Numpy array containing the values of the user variables.
    ux0 : ndarray
        Numpy array containing the initial values of the user variables.
    uxd : ndarray
        Numpy array containing the values of the time derivative of the user 
        variables.
    xfidpt : ndarray of int
        Numpy array of integers containing the indices of the points defined as
        force application points.
    Z : ndarray
        Numpy array containing the current values of the distances between of 
        the points of a link.
    Zd : ndarray
        Numpy array containing the current values of the speed (spreading) 
        between of the points of a link.
Louis Beauloye's avatar
Louis Beauloye committed
246
247
248
249
250
        
    
    Example
    -------
        
251
    >>> mbs_data = MBsysPy.MbsData("../dataR/UExampleProject.mbs")
Louis Beauloye's avatar
Louis Beauloye committed
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
    >>> mbs_data.user_model["MyUserModel"]["MyScalar"] = 3.0
    >>> print(mbs_data.user_model["MyUserModel"]["MyScalar"])
        3.0    
    >>> #get a copy of the scalar
    >>> a = mbs_data.user_model["MyUserModel"]["MyScalar"]
    >>> a = 2
    >>> print(mbs_data.user_model["MyUserModel"]["MyScalar"])
        3.0
    >>> print(mbs_data.user_model["MyUserModel"]["MyVector"])
        array([1.0, 3.0])
    >>> mbs_data.user_model["MyUserModel"]["MyVector"] = [1.0, 2.0]
    >>> print(mbs_data.user_model["MyUserModel"]["MyVector"])
        array([1.0, 2.0])
    >>> b = mbs_data.user_model["MyUserModel"]["MyVector"]
    >>> b[1] = 10.0
    >>> print(mbs_data.user_model["MyUserModel"]["MyVector"])
        array([1.0, 10.0])
    >>> b = np.array([2.0, 4.0])
    >>> print(mbs_data.user_model["MyUserModel"]["MyVector"])
        array([1.0, 10.0])
    
273
274
    """
    
275
    def __init__(self, name, user_path=None, symbolic_path=None, prj_functions_c=None, prj_lib_path = None):
276
277
278
279
280
281
282
283
284
285
286
287
288
        """
        Load a specific *.mbs file into a MbsData class instance.

        Parameters
        ----------
        name : str
            The path to the .mbs file to load, including the file extension.
        user_path : str, optionnal
            The path to the folder containing the user functions if the default
            project structure are not used.
        symbolic_path : str, optionnal
            The path to the folder containing the symbolic functions if the 
            default project structure are not used.
289
        prj_functions_c : None or str, optionnal
290
291
292
293
294
295
            Option to load some of the project functions from the project C 
            library. Accepted values are:
             - None : All project function are defined in python
             - "symbolic_only" or "S" : Symbolic function comes from C library
             - "symbolic_and_user" or "SU" : Symbolic and user functions come from C library
            default is None
296
        prj_lib_path : None or str, optionnal
297
            Required if 'prj_functions_c' is not None
298
299
300
301
302
303
304
305
306
307
308
             - In Linux, it gives the location of the folder containing the 
               "symbolicR/" and, or "userfctR/" folders. Each one of the subfolder
               have to contain the corresponding library (ie: libProject_symbolic.so).
             - In Windows, it gives the location of the folder containing the project
               libraries (Project_symbolic.dll and/or Project_userfct.dll).
             - In MacOs the expected behavior is the same as Linux. It must be tested.
            default is None
            
        Returns
        -------
            A loaded mbs file in a MbsData instance.
309
        """
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
        # Retrieve prj_functions_c value
        if prj_functions_c is None:
            self.opt_load_c = 0
            if not (prj_lib_path is None):
                print("Argument 'prj_lib_path' is ignored as option 'prj_functions_c' is 'None'.")
                prj_lib_path = None
        elif (type(prj_functions_c) is str):
            if prj_functions_c == "symbolic_only" or prj_functions_c == "S":
                self.opt_load_c = 1
            elif prj_functions_c == "symbolic_and_user" or prj_functions_c == "SU":
                self.opt_load_c = 2
            else:
                raise ValueError("prj_functions_c is not valid:'"+prj_functions_c+"'.")
                
            if (prj_lib_path is None):
                raise ValueError("prj_lib_path must be given if 'prj_functions_c' is set.")
            if not (type(prj_lib_path) is str):
                raise TypeError("prj_lib_path type must be str but it is '"+type(prj_lib_path)+"'.")
            else:
                prj_lib_path = os.path.abspath(prj_lib_path).encode('utf-8')
        else:
            raise TypeError("prj_functions_c type is not valid:'"+type(prj_functions_c)+"'.")            

333
334
        # Create a byte object from the string
        name_c = name.encode('utf-8')
335
        # Load the MbsInfos and keep a copy
336
        if __DEBUG__ : print( "DEBUG>>  Loading: '"+name+"' from:'"+os.getcwd()+"'.")
337
        self.mbs_infos_ptr = libloadXML.mbs_info_reader(name_c)
338
        if __DEBUG__ : print( "DEBUG>>  mbs_infos structure loaded")
339
340
341
342
343
        
        # Preparing loader and its options for loading 
        loader = libloadXML.mbs_new_loader()
        if __DEBUG__ : print( "DEBUG>>  Loader structure created")
        
344
        loader.contents.opts.contents.no_project_fct = self.opt_load_c
345
346
        if __DEBUG__ : print( "DEBUG>>  flag ignoring project function set")
        
347
        loader.contents.mbs_infos = self.mbs_infos_ptr
348
        if __DEBUG__ : print( "DEBUG>>  mbs_infos assigned to loader")
349
350
        
        # Load and retrieve MbsData structure
351
352
        self.mbs_data_ptr = libloadXML.mbs_load_with_loader(name_c, prj_lib_path, loader)
        print(type(self.mbs_data_ptr))
353
        if __DEBUG__ : print( "DEBUG>>  MbsData loaded")
354
        libloadXML.mbs_delete_loader(loader)
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
        # symbolic and user function folder
        self.user_path = None
        self.symbolic_path = None
        
        # Storing project function pointer
        # User function that only relies on MbsData structure
        self.user_cons_hJ = None
        self.user_cons_jdqd = None
        self.user_derivative = None
        self.user_DrivenJoints = None
        self.user_ExtForces = None
        self.user_JointForces = None
        self.user_LinkForces = None
        self.user_Link3DForces = None
        # User function also related to dirdyn, equil...
        self.user_dirdyn_init = None
        self.user_dirdyn_loop = None
        self.user_dirdyn_finish = None
        
        # Symbolic functions
        self.mbs_accelred = None
        self.mbs_cons_hJ = None
        self.mbs_cons_jdqd = None
        self.mbs_dirdyna = None
        self.mbs_extforces = None
        self.mbs_gensensor = None
        self.mbs_invdyna = None
        self.mbs_link = None
        self.mbs_link3D = None
        self.mbs_sensor = None
        
386
387
388
        # pointers dict to avoid garbage collecting
        self.ptrs_to_user_fcts = dict()
        self.ptrs_to_symb_fcts = dict()
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
        
        # Exposing some memory
        if __DEBUG__ : print( "DEBUG>>  Exposing MbsData fields")
        # Geometric and dynamic datas
        self.__dpt = np.ctypeslib.as_array(self.mbs_data_ptr.contents.dpt[0], (3+1, self.npt+1))
        self.__l = np.ctypeslib.as_array(self.mbs_data_ptr.contents.l[0], (3+1, self.njoint+1))
        self.__m = np.ctypeslib.as_array(self.mbs_data_ptr.contents.m, (self.njoint+1,))
        self.__In = np.ctypeslib.as_array(self.mbs_data_ptr.contents.In[0], (9+1, self.njoint+1))
        self.__g = np.ctypeslib.as_array(self.mbs_data_ptr.contents.g, (4,))
        
        # Partitioning informations
        self.__qu = np.ctypeslib.as_array(self.mbs_data_ptr.contents.qu, (self.njoint+1,))
        self.__qc = np.ctypeslib.as_array(self.mbs_data_ptr.contents.qc, (self.njoint+1,))
        self.__qlocked = np.ctypeslib.as_array(self.mbs_data_ptr.contents.qlocked, (self.njoint+1,))
        self.__qdriven = np.ctypeslib.as_array(self.mbs_data_ptr.contents.qdriven, (self.njoint+1,))
        self.__qa = np.ctypeslib.as_array(self.mbs_data_ptr.contents.qa, (self.njoint+1,))
        self.__qv = np.ctypeslib.as_array(self.mbs_data_ptr.contents.qv, (self.njoint+1,))
        
        # Generalized coordinates velocities and acceleration
        self.__q = np.ctypeslib.as_array(self.mbs_data_ptr.contents.q, (self.njoint+1,))
        self.__qd = np.ctypeslib.as_array(self.mbs_data_ptr.contents.qd, (self.njoint+1,))
        self.__qdd = np.ctypeslib.as_array(self.mbs_data_ptr.contents.qdd, (self.njoint+1,))
        
        self.__q0 = np.ctypeslib.as_array(self.mbs_data_ptr.contents.q0, (self.njoint+1,))
        self.__qd0 = np.ctypeslib.as_array(self.mbs_data_ptr.contents.qd0, (self.njoint+1,))
        self.__qdd0 = np.ctypeslib.as_array(self.mbs_data_ptr.contents.qdd0, (self.njoint+1,))
        
        # Forces array
        self.__frc = np.ctypeslib.as_array(self.mbs_data_ptr.contents.frc[0], (3+1, self.njoint+1))
        self.__trq = np.ctypeslib.as_array(self.mbs_data_ptr.contents.trq[0], (3+1, self.njoint+1))
        self.__Qq = np.ctypeslib.as_array(self.mbs_data_ptr.contents.Qq, (self.njoint+1,))
420
        self.__Qa = np.ctypeslib.as_array(self.mbs_data_ptr.contents.Qa, (self.njoint+1,))
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
        
        # Constraints datas
        self.nrod = 0
        self.__lrod = None
        if (self.mbs_data_ptr.contents.lrod):
            print(self.mbs_data_ptr.contents.lrod)
            print(self.mbs_data_ptr.contents.lrod is None)
            self.nrod = int(round(self.mbs_data_ptr.contents.lrod[0]))
            self.__lrod = np.ctypeslib.as_array(self.mbs_data_ptr.contents.lrod,(self.nrod+1,))
        
        self.__lambda_ = np.ctypeslib.as_array(self.mbs_data_ptr.contents.lambda_,(self.njoint+1,))
        self.__Qc = np.ctypeslib.as_array(self.mbs_data_ptr.contents.Qc,(self.njoint+1,))
        
        # LinksForces
        self.__Z = self.__Zd = self.__Fl = None
        if self.Nlink:
            self.__Z = np.ctypeslib.as_array(self.mbs_data_ptr.contents.Z, (self.Nlink+1,))
            self.__Zd = np.ctypeslib.as_array(self.mbs_data_ptr.contents.Zd, (self.Nlink+1,))
            self.__Fl = np.ctypeslib.as_array(self.mbs_data_ptr.contents.Fl, (self.Nlink+1,))
            
        # ExtForces
        self.__xfidpt = self.__SWr = None
        if self.Nxfrc:
            self.__xfidpt = np.ctypeslib.as_array(self.mbs_data_ptr.contents.xfidpt, (self.Nxfrc+1,))
445
            self.__SWr = np.ctypeslib.as_array(self.mbs_data_ptr.contents.SWr[0], (self.Nxfrc+1, 9+1))
446
447
448
449
450
451
452
453
454
455
456
        
        # User State
        self.__ux = self.__ux0 = self.__uxd = None
        if self.Nux:
            self.__ux = np.ctypeslib.as_array(self.mbs_data_ptr.contents.ux, (self.Nux+1,))
            self.__ux0 = np.ctypeslib.as_array(self.mbs_data_ptr.contents.ux0, (self.Nux+1,))
            self.__uxd = np.ctypeslib.as_array(self.mbs_data_ptr.contents.uxd, (self.Nux+1,))
        
        # Adding internal sensor
        self.sensors = [MbsSensor(self,None)]
        
457
458
459
460
461
462
463
        # ID
        self.joint_id = {}
        self.link_id = {}
        self.extforce_id = {}
        self.sensor_id = {}
        self.__generate_id__()
        
464
        #UserModel
Louis Beauloye's avatar
Louis Beauloye committed
465
        self.user_model = _UserModelDict()
466
467
        self.__load_user_model__()
        
468
        
469
        # Loading user function
470
471
472
        if self.opt_load_c < 2:
            if __DEBUG__ : print( "DEBUG>>  Loading user functions")
            self.__load_user_fct__(user_path)
473
        # Loading symbolic function
474
475
476
        if self.opt_load_c < 1:
            if __DEBUG__ : print( "DEBUG>>  Loading symbolic functions")
            self.__load_symbolic_fct__(symbolic_path)
477
478
479
480
481
482
483
484
485
486
        

    def __str__(self):
        if __DEBUG__ : print( "DEBUG>>  start of __str")
        
        libutilities.mbs_print_data(self.mbs_data_ptr)
        if __DEBUG__ : print( "DEBUG>>  MbsData printed")
        
        return "MbsData instance printed from C library!"
    
487
    def __load_user_fct__(self, user_path=None):
488
        """ 
Olivier Lantsoght's avatar
Olivier Lantsoght committed
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
        Load all user functions where arguments are in MbsData instance.
        
        Only load the user functions in which the arguments are not 
        dependent of another module instance (ie. MbsPart, MbsDirdyn...).
        The other user functions will be loaded when a module is created.
        The functions will be assigned to the MbsData instance when 
        the 'run' function in other modules is called and unassigned 
        at the end.
        
        The loader user functions are :
         - user_derivatives (from derivatives.py)
         - user_DrivenJoints (from driven_joints.py)
         - user_ExtForces (from ext_forces.py)
         - user_JointForces (from joint_forces.py)
         - user_LinkForces (from link_forces.py)
         - user_Link3DForces (from link3D_forces.py)
505
506
507
508
509
510
511

        Parameters
        ----------
        user_path : str or None, optionnal
            The path to the folder containing the user functions if the default
            project structure are not used.
            default is None
512
        """
513
        template_path = os.path.join(__MODULE_DIR__,'../templates/user')
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
        project_path = self.project_path
        
        # Creating user path
        if user_path == None:
            user_path = os.path.join(project_path, "userfctR")
        else:
            user_path = os.path.join(project_path, user_path)
        # Error handeling
        if not os.path.isdir(user_path):
            print ('The user function directory does not exist: "'+ user_path+'"')
            print ('The current root folder is: "'+os.getcwd()+'"')
        self.user_path = user_path

        # derivative
        user_file = "derivatives.py"
        path = os.path.abspath(os.path.join(user_path, user_file))
530
        if not os.path.isfile(path):
531
            if __DEBUG__ : print( "DEBUG>>  file '"+user_file+"' not found in folder '"+os.path.dirname(path))
532
533
534
            path = os.path.abspath(os.path.join(template_path, user_file))
        module = imp.load_source(user_file[:-3], path)
        self.user_derivative = module.user_derivatives
535
536
537
538

        # drivenJoints
        user_file = "driven_joints.py"
        path = os.path.abspath(os.path.join(user_path, user_file))
539
        if not os.path.isfile(path):
540
            if __DEBUG__ : print( "DEBUG>>  file '"+user_file+"' not found in folder '"+os.path.dirname(path))
541
542
543
            path = os.path.abspath(os.path.join(template_path, user_file))
        module = imp.load_source(user_file[:-3], path)
        self.user_DrivenJoints = module.user_DrivenJoints
544
545
546
547

        # ext_forces
        user_file = "ext_forces.py"
        path = os.path.abspath(os.path.join(user_path, user_file))
548
        if not os.path.isfile(path):
549
            if __DEBUG__ : print( "DEBUG>>  file '"+user_file+"' not found in folder '"+os.path.dirname(path))
550
551
552
            path = os.path.abspath(os.path.join(template_path, user_file))
        module = imp.load_source(user_file[:-3], path)
        self.user_ExtForces = module.user_ExtForces
553
554
555
556

        # joint_forces
        user_file = "joint_forces.py"
        path = os.path.abspath(os.path.join(user_path, user_file))
557
        if not os.path.isfile(path):
558
            if __DEBUG__ : print( "DEBUG>>  file '"+user_file+"' not found in folder '"+os.path.dirname(path))
559
560
561
            path = os.path.abspath(os.path.join(template_path, user_file))
        module = imp.load_source(user_file[:-3], path)
        self.user_JointForces = module.user_JointForces
562
563
564
565

        # link_forces
        user_file = "link_forces.py"
        path = os.path.abspath(os.path.join(user_path, user_file))
566
        if not os.path.isfile(path):
567
            if __DEBUG__ : print( "DEBUG>>  file '"+user_file+"' not found in folder '"+os.path.dirname(path))
568
569
570
            path = os.path.abspath(os.path.join(template_path, user_file))
        module = imp.load_source(user_file[:-3], path)
        self.user_LinkForces = module.user_LinkForces
571
572
573
574

        # link3D_forces
        user_file = "link3D_forces.py"
        path = os.path.abspath(os.path.join(user_path, user_file))
575
        if not os.path.isfile(path):
576
            if __DEBUG__ : print( "DEBUG>>  file '"+user_file+"' not found in folder '"+os.path.dirname(path))
577
578
579
            path = os.path.abspath(os.path.join(template_path, user_file))
        module = imp.load_source(user_file[:-3], path)
        self.user_Link3DForces = module.user_Link3DForces
580
581
582
583
            
        return
        
    
584
    def __load_symbolic_fct__(self, symb_path=None):
585
        """ 
Olivier Lantsoght's avatar
Olivier Lantsoght committed
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
        Load all symbolic functions if all args are in MbsData instance.
        
        Only load the symbolic functions in which the arguments are not 
        dependent of another module instance (ie. MbsPart, MbsDirdyn...).
        The other symbolic functions will be loaded when a module is 
        instancied.
        The functions will be assigned to the MbsData instance when 
        the 'run' function in other modules is called and unassigned 
        at the end.
        
        The loader symbolic functions are :
         - mbs_accelred (from mbs_accelred_MBSNAME.py)
         - extforces (from mbs_extforces_MBSNAME.py)
         - sensor (from mbs_gensensor_MBSNAME.py)
         - sensor (from mbs_sensor_MBSNAME.py)
         - link (from mbs_link_MBSNAME.py)
         - link3D (from mbs_link3D_MBSNAME.py)
603
604
605
606
607
608
609

        Parameters
        ----------
        symbolic_path : str, optionnal
            The path to the folder containing the symbolic functions if the 
            default project structure are not used.
            defult is None
610
        """
611
        
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
        mbs_name = self.mbs_name
        template_path = os.path.join(__MODULE_DIR__,'../templates/symbolic')
        project_path = self.project_path
        
        # Creating user path
        if symb_path == None:
            symb_path = os.path.join(project_path, "symbolicR")
        else:
            symb_path = os.path.join(project_path, symb_path)
        # Error handeling
        if not os.path.isdir(symb_path):
            print ('The symbolic function directory does not exist: "'+ symb_path+'"')
            print ('The current root folder is: "'+os.getcwd()+'"')
        self.symbolic_path = symb_path
            
        # mbs_accelred
        symb_file = "mbs_accelred_"+mbs_name+".py"
        path = os.path.abspath(os.path.join(symb_path, symb_file))
630
        if not os.path.isfile(path):
631
632
            if __DEBUG__ : print( "DEBUG>>  file '"+symb_file+"' not found in folder '"+os.path.dirname(path))
            symb_file = "mbs_accelred_PRJ.py"
633
634
635
636
            path = os.path.abspath(os.path.join(template_path, symb_file))  
        module = imp.load_source(symb_file[:-3], path)
        self.mbs_accelred = module.mbs_accelred
            
637
638
639
640
        
        # mbs_extforces
        symb_file = "mbs_extforces_"+mbs_name+".py"
        path = os.path.abspath(os.path.join(symb_path, symb_file))
641
        if not os.path.isfile(path):
642
            if __DEBUG__ : print( "DEBUG>>  file '"+symb_file+"' not found in folder '"+os.path.dirname(path))
643
644
645
646
            symb_file = "mbs_extforces_PRJ.py"
            path = os.path.abspath(os.path.join(template_path, symb_file))
        module = imp.load_source(symb_file[:-3], path)
        self.mbs_extforces = module.extforces
647
648
649
650
        
        # mbs_gensensor
        symb_file = "mbs_gensensor_"+mbs_name+".py"
        path = os.path.abspath(os.path.join(symb_path, symb_file))
651
        if not os.path.isfile(path):
652
            if __DEBUG__ : print( "DEBUG>>  file '"+symb_file+"' not found in folder '"+os.path.dirname(path))
653
654
655
656
            symb_file = "mbs_gensensor_PRJ.py"
            path = os.path.abspath(os.path.join(template_path, symb_file))
        module = imp.load_source(symb_file[:-3], path)
        self.mbs_gensensor = module.sensor
657
658
659
660
        
        # mbs_link
        symb_file = "mbs_link_"+mbs_name+".py"
        path = os.path.abspath(os.path.join(symb_path, symb_file))
661
        if not os.path.isfile(path):
662
            if __DEBUG__ : print( "DEBUG>>  file '"+symb_file+"' not found in folder '"+os.path.dirname(path))
663
664
665
666
            symb_file = "mbs_link_PRJ.py"
            path = os.path.abspath(os.path.join(template_path, symb_file))
        module = imp.load_source(symb_file[:-3], path)
        self.mbs_link = module.link
667
668
669
670
        
        # mbs_link3D
        symb_file = "mbs_link3D_"+mbs_name+".py"
        path = os.path.abspath(os.path.join(symb_path, symb_file))
671
        if not os.path.isfile(path):
672
            if __DEBUG__ : print( "DEBUG>>  file '"+symb_file+"' not found in folder '"+os.path.dirname(path))
673
674
675
676
            symb_file = "mbs_link3D_PRJ.py"
            path = os.path.abspath(os.path.join(template_path, symb_file))
        module = imp.load_source(symb_file[:-3], path)
        self.mbs_link3D = module.link3D
677
        
678
        # mbs_sensor
679
680
        symb_file = "mbs_sensor_"+mbs_name+".py"
        path = os.path.abspath(os.path.join(symb_path, symb_file))
681
        if not os.path.isfile(path):
682
            if __DEBUG__ : print( "DEBUG>>  file '"+symb_file+"' not found in folder '"+os.path.dirname(path))
683
684
685
686
            symb_file = "mbs_sensor_PRJ.py"
            path = os.path.abspath(os.path.join(template_path, symb_file))
        module = imp.load_source(symb_file[:-3], path)
        self.mbs_sensor = module.sensor
687
688
689
690
        
        
    def __assign_user_fct__(self):
        """ 
Olivier Lantsoght's avatar
Olivier Lantsoght committed
691
692
693
694
695
696
697
698
        Assign all user functions if all args are in MbsData instance.
        
        Assign and wrap python user functions in which the arguments are 
        not dependent of another module instance (ie. MbsPart, MbsDirdyn...).
        Store the functions in the MbsData instance and assign the pointer 
        of functions in the C structure. 
        The other user functions will be assigned when a module is
        instancied.
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
        """
        data_c_ptr=self.mbs_data_ptr.contents

        # derivative
        self.ptrs_to_user_fcts["user_Derivative"] = user_Derivative_wrap(lambda mbs : self.user_derivative(self))
        data_c_ptr.user_Derivative = self.ptrs_to_user_fcts["user_Derivative"]

        # drivenJoints
        self.ptrs_to_user_fcts["user_DrivenJoints"] = user_DrivenJoints_wrap(lambda mbs,t : self.user_DrivenJoints(self, t))
        data_c_ptr.user_DrivenJoints = self.ptrs_to_user_fcts["user_DrivenJoints"]

        # ext_forces
        self.ptrs_to_user_fcts["user_ExtForces"] = user_ExtForces_wrap(lambda PxF,RxF,VxF,OMxF,AxF,OMPxF,mbs,tsim,ixF : self.__callback_user_ExtForces(self.user_ExtForces,PxF,RxF,VxF,OMxF,AxF,OMPxF,tsim,ixF))
        data_c_ptr.user_ExtForces = self.ptrs_to_user_fcts["user_ExtForces"]

        # joint_forces
        self.ptrs_to_user_fcts["user_JointForces"] = user_JointForces_wrap(lambda mbs,t : self.user_JointForces(self, t))
        data_c_ptr.user_JointForces = self.ptrs_to_user_fcts["user_JointForces"]

        # link_forces
        self.ptrs_to_user_fcts["user_LinkForces"] = user_LinkForces_wrap(lambda Z, Zd, mbs, tsim, ilnk : self.user_LinkForces(Z, Zd, self, tsim, ilnk))
        data_c_ptr.user_LinkForces = self.ptrs_to_user_fcts["user_LinkForces"]

        # link3D_forces
        self.ptrs_to_user_fcts["user_Link3DForces"] = user_Link3DForces_wrap(lambda PxF,RxF,VxF,OMxF,AxF,OMPxF,mbs,tsim,ixF : self.__callback_user_Link3DForces(self.user_Link3DForces,PxF,RxF,VxF,OMxF,AxF,OMPxF,tsim,ixF))
        data_c_ptr.user_Link3DForces = self.ptrs_to_user_fcts["user_Link3DForces"]
            
        return
        
    
    def __assign_symb_fct__(self):
        """ 
Olivier Lantsoght's avatar
Olivier Lantsoght committed
731
732
733
734
735
736
737
738
        Assign all symbolic functions if all args are in MbsData instance.
        
        Assign and wrap python symbolic functions in which the arguments are 
        not dependent of another module instance (ie. MbsPart, MbsDirdyn...).
        Store the functions in the MbsData instance and assign the pointer 
        of functions in the C structure. 
        The other user functions will be assigned when a module is
        instancied.
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
            
        """
        data_c_ptr=self.mbs_data_ptr.contents
            
        # mbs_accelred
        self.ptrs_to_symb_fcts["mbs_accelred"] = mbs_accelred_wrap(lambda mbs,tsim : self.mbs_accelred(self, tsim))
        data_c_ptr.mbs_accelred = self.ptrs_to_symb_fcts["mbs_accelred"]
            
        
        # mbs_extforces
        self.ptrs_to_symb_fcts["mbs_extforces"] = mbs_extforces_wrap(lambda frc,trq,mbs,tsim : self.mbs_extforces(self.frc,self.trq, self, tsim))
        data_c_ptr.mbs_extforces = self.ptrs_to_symb_fcts["mbs_extforces"]
        
        # mbs_gensensor
        self.ptrs_to_symb_fcts["mbs_gensensor"] = mbs_gensensor_wrap(lambda sens,mbs,isens : self.__callback_mbs_sensor(self.mbs_gensensor, sens, isens))
        data_c_ptr.mbs_gensensor = self.ptrs_to_symb_fcts["mbs_gensensor"]
        
        # mbs_link
        self.ptrs_to_symb_fcts["mbs_link"] = mbs_link_wrap(lambda frc,trq,Flnk,Z,Zd,mbs,tsim : self.mbs_link(self.frc,self.trq,self.Fl,self.Z,self.Zd, self, tsim))
        data_c_ptr.mbs_link = self.ptrs_to_symb_fcts["mbs_link"]
        
        # mbs_link3D
        self.ptrs_to_symb_fcts["mbs_link3D"] = mbs_link3D_wrap(lambda frc,trq,mbs,tsim : self.mbs_link3D(self.frc,self.trq,self, tsim))
        data_c_ptr.mbs_link3D = self.ptrs_to_symb_fcts["mbs_link3D"]
        
        # mbs_sensor
765
766
        self.ptrs_to_symb_fcts["mbs_sensor"] = mbs_sensor_wrap(lambda sens,mbs,isens : self.__callback_mbs_sensor(self.mbs_sensor, sens, isens))
        data_c_ptr.mbs_sensor = self.ptrs_to_symb_fcts["mbs_sensor"]
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
    
    def __callback_user_ExtForces(self, fun, PxF,RxF,VxF,OMxF,AxF,OMPxF,tsim,ixF):
        __PxF = np.ctypeslib.as_array(PxF, (4,))
        __RxF = np.ctypeslib.as_array(RxF, (4,4))
        __VxF = np.ctypeslib.as_array(VxF, (4,))
        __OMxF = np.ctypeslib.as_array(OMxF, (4,))
        __AxF = np.ctypeslib.as_array(AxF, (4,))
        __OMPxF = np.ctypeslib.as_array(OMPxF, (4,))
        SWr = fun(__PxF, __RxF, __VxF, __OMxF, __AxF, __OMPxF, self, tsim, ixF)
        self.SWr[ixF,:] = SWr[:]
        
    def __callback_user_Link3DForces(self, fun, PxF,RxF,VxF,OMxF,AxF,OMPxF,tsim,ixF):
        __PxF = np.ctypeslib.as_array(PxF, (4,))
        __RxF = np.ctypeslib.as_array(RxF, (4,4))
        __VxF = np.ctypeslib.as_array(VxF, (4,))
        __OMxF = np.ctypeslib.as_array(OMxF, (4,))
        __AxF = np.ctypeslib.as_array(AxF, (4,))
        __OMPxF = np.ctypeslib.as_array(OMPxF, (4,))
        SWr = fun(__PxF, __RxF, __VxF, __OMxF, __AxF, __OMPxF, self, tsim, ixF)
        self.SWr[ixF,1:7] = SWr[1:7]
787
    
788
    def __callback_mbs_sensor(self, fun, sens, isens):
Olivier Lantsoght's avatar
Olivier Lantsoght committed
789
        """ callback for gensensor, forcesensor and sensor """
790
791
792
793
794
795
        self.__sens.__reassign_memory__(sens)
        fun(self.__sens,self, isens)
    
    def __callback_mbs_invdyna(self, fun,Q, tsim):
        __Q = np.ctypeslib.as_array(Q, (self.njoint+1,))
        fun(self, tsim, __Q)
796
        
797
798
    def __unassign_user_fct__(self):
        """
Olivier Lantsoght's avatar
Olivier Lantsoght committed
799
800
801
802
        Unassign all user function if all args are in MbsData instance.
        
        Only unassign the user functions in which the arguments are not 
        dependent of another module instance (ie. MbsPart, MbsDirdyn...).
803
804
805
806
807
808
809
810
811
812
813
814
815
816
        """
        #not necessary but if not present, dictionary must be filled in the load 
        #function and not the assign function
        self.ptrs_to_user_fcts = {}
        
        self.mbs_data_ptr.contents.user_Derivative = user_Derivative_wrap(lambda mbs : callback_undefined("user_Derivative"))
        self.mbs_data_ptr.contents.user_DrivenJoints = user_DrivenJoints_wrap(lambda mbs,t : callback_undefined("user_DrivenJoints"))
        self.mbs_data_ptr.contents.user_ExtForces = user_ExtForces_wrap(lambda PxF,RxF,VxF,OMxF,AxF,OMPxF,mbs,tsim,ixF : callback_undefined("user_ExtForces"))
        self.mbs_data_ptr.contents.user_JointForces  = user_JointForces_wrap(lambda mbs,t : callback_undefined("user_JointForces"))
        self.mbs_data_ptr.contents.user_LinkForces = user_LinkForces_wrap(lambda Z, Zd, mbs, tsim, ilnk : callback_undefined("user_LinkForces"))
        self.mbs_data_ptr.contents.user_Link3DForces = user_Link3DForces_wrap(lambda PxF,RxF,VxF,OMxF,AxF,OMPxF,mbs,tsim,ixF : callback_undefined("user_Link3DForces"))
        
    def __unassign_symb_fct__(self):
        """
Olivier Lantsoght's avatar
Olivier Lantsoght committed
817
818
819
820
        Unassign all symbolic function if all args are in MbsData instance.
        
        Only unassign the symbolic functions in which the arguments are not 
        dependent of another module instance (ie. MbsPart, MbsDirdyn...).
821
822
823
824
825
826
827
828
829
830
831
832
833
834
        """
        #not necessary but if not present, dictionary must be filled in the load
        #function and not the assign function
        self.ptrs_to_symb_fcts = {}
        
        self.mbs_data_ptr.contents.mbs_accelred = mbs_accelred_wrap(lambda mbs,tsim : callback_undefined("mbs_accelred"))
        self.mbs_data_ptr.contents.mbs_extforces= mbs_extforces_wrap(lambda frc,trq,mbs,tsim : callback_undefined("mbs_extforces"))
        self.mbs_data_ptr.contents.mbs_gensensor = mbs_gensensor_wrap(lambda sens,mbs,isens : callback_undefined("mbs_gensensor"))
        self.mbs_data_ptr.contents.mbs_link = mbs_link_wrap(lambda frc,trq,Flnk,Z,Zd,mbs,tsim : callback_undefined("mbs_link"))
        self.mbs_data_ptr.contents.mbs_link3D = mbs_link3D_wrap(lambda frc,trq,mbs,tsim  : callback_undefined("mbs_link3D"))
        self.mbs_data_ptr.contents.mbs_sensor = mbs_sensor_wrap(lambda sens,mbs,isens : callback_undefined("mbs_sensor"))
        
    def __generate_id__(self):
        """
Olivier Lantsoght's avatar
Olivier Lantsoght committed
835
836
       Read the id's of the joints, links, sensors and extforces from MbsInfos
       structure and store them into dictionaries in the MbsData instance.
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
        """
        
        for i in range(self.njoint):
            name = self.mbs_infos_ptr.contents.bodytree.contents.joint_list[i].contents.name.decode('utf-8')
            self.joint_id[name] = i+1
            
        if self.Nlink:
            for i in range(self.Nlink):
                name = self.mbs_infos_ptr.contents.links.contents.link_list[i].contents.name.decode('utf-8')
                self.link_id[name] = i+1
                
        if self.Nsensor:
            for i in range(self.Nsensor):
                index = self.mbs_infos_ptr.contents.sensor_point_list[i]
                name = self.mbs_infos_ptr.contents.point_list[index].contents.sensor.contents.name.decode('utf-8')
                self.sensor_id[name] = i+1
        
        if self.Nxfrc:
            for i in range(self.Nxfrc):
                index = self.mbs_infos_ptr.contents.extforce_point_list[i]
                name = self.mbs_infos_ptr.contents.point_list[index].contents.extforce.contents.name.decode('utf-8')
                self.extforce_id[name] = i+1
859
860
861
                
                
    def __load_user_model__(self):
Louis Beauloye's avatar
Louis Beauloye committed
862
        """
Olivier Lantsoght's avatar
Olivier Lantsoght committed
863
864
865
866
867
868
869
        Load user models in 2 nested dictionaries
        
        
        The first one contains the names of the user models as keys and a
        second dictionary for the parameters as values.
        The second one contains the names of the parameters as keys and
        numpy arrays that point toward C memory as values
Louis Beauloye's avatar
Louis Beauloye committed
870
        """
871
872
873
874
875
        self.user_model._locked = False
        infos_c_ptr=self.mbs_infos_ptr.contents
        for i in range(infos_c_ptr.user_models.contents.n_user_model):
            user_model_list = infos_c_ptr.user_models.contents.user_model_list[i].contents
            name = user_model_list.name.decode('utf-8')
Louis Beauloye's avatar
Louis Beauloye committed
876
            self.user_model[name] = _UserModelDict()
877
878
879
880
881
882
883
884
885
886
887
888
            self.user_model[name]._parent_key = name
            self.user_model[name]._locked = False
            self.user_model[name]._type = dict()
            for j in range(user_model_list.n_parameter):
                parameter_list = user_model_list.parameter_list[j].contents
                name2 = parameter_list.name.decode('utf-8')
                val_ptr = parameter_list.val_ptr
                value_list = parameter_list.value_list
                self.user_model[name]._type[name2] = parameter_list.type
                size = parameter_list.n_value
                UmPy = (ctypes.cast(val_ptr, ctypes.c_void_p).value==ctypes.cast(value_list, ctypes.c_void_p).value)
                if UmPy :
Louis Beauloye's avatar
Louis Beauloye committed
889
890
891
892
893
                    if self.user_model[name]._type[name2] == 5:
                        self.user_model[name][name2] = np.array(np.ctypeslib.as_array(val_ptr, (1,size)), dtype = np.int)
                    else:
                        self.user_model[name][name2] = np.ctypeslib.as_array(val_ptr, (1,size))
                    #in full python project, the C memory is always a double
894
895
896
897
898
899
900
901
                else :
                    #not yet tested, it requires user and symbolic fonctions in C
                    if self.user_model[name]._type[name2] == 5 or self.user_model[name]._type[name2] == 7:
                        self.user_model[name][name2] = np.ctypeslib.as_array(ctypes.cast(val_ptr, ctypes.POINTER(ctypes.c_int)), (1,size))
                    else :
                        self.user_model[name][name2] = np.ctypeslib.as_array(val_ptr, (1,size))
            self.user_model[name]._locked = True
        self.user_model._locked = True
902
903
            
        
904
905
    
    def set_nb_userc(self, nb):
906
907
908
909
910
911
912
913
        """
        Set the number of user constraints.

        Parameters
        ----------
        nb : int
            The number of user constraints.
        """
914
915
916
        libutilities.mbs_set_nb_userc(self.mbs_data_ptr, nb)
    
    def set_qu(self, indices):
917
918
919
920
921
922
923
924
925
        """
        Set the specified joints as independent.

        Parameters
        ----------
        indices : int, list or numpy.ndarray
            The ids of the joints to set as independent.
        
        """
926
927
928
929
930
931
932
        if isinstance(indices,(list,np.ndarray)):
            for index in indices:
                libutilities.mbs_set_qu(self.mbs_data_ptr, index)
        else:
            libutilities.mbs_set_qu(self.mbs_data_ptr, indices)
    
    def set_qv(self, indices):
933
934
935
936
937
938
939
940
        """
        Set the specified joints as dependent.

        Parameters
        ----------
        indices : int, list or numpy.ndarray
            The ids of the joints to set as dependent.
        """
941
942
943
944
945
        if isinstance(indices,(list,np.ndarray)):
            for index in indices:
                libutilities.mbs_set_qv(self.mbs_data_ptr, index)
        else:
            libutilities.mbs_set_qv(self.mbs_data_ptr, indices)
946
            
947
    def set_qa(self, indices):
948
949
950
951
952
953
954
955
956
957
958
959
        """
        Set the specified joints as actuated.
        
        Actuated joints are only used by equilibrium analysis (in some cases)
        and inverse dynamics. Actuated joint are also member of one of the other
        partition (independent or dependent).

        Parameters
        ----------
        indices : int, list or numpy.ndarray
            The ids of the joints to set as actuated.
        """
960
961
962
963
964
965
966
        if isinstance(indices,(list,np.ndarray)):
            for index in indices:
                libutilities.mbs_set_qa(self.mbs_data_ptr, index)
        else:
            libutilities.mbs_set_qa(self.mbs_data_ptr, indices)
    
    def unset_qa(self, indices):
967
968
969
970
971
972
973
974
        """
        Remove the specified joints from the actuated joints.

        Parameters
        ----------
        indices : int, list or numpy.ndarray
            The ids of the joints to be removed from the actuated list.
        """
975
976
977
978
979
980
981
        if isinstance(indices,(list,np.ndarray)):
            for index in indices:
                libutilities.mbs_unset_qa(self.mbs_data_ptr, index)
        else:
            libutilities.mbs_unset_qa(self.mbs_data_ptr, indices)
            
    def empty_qa(self):
Olivier Lantsoght's avatar
Olivier Lantsoght committed
982
        """ Remove all joints from the actuated partition. """
983
984
        libutilities.mbs_empty_qa(self.mbs_data_ptr)
        
985
986
987
988
    def __del__(self):
        libloadXML.mbs_delete_infos(self.mbs_infos_ptr)
        libloadXML.mbs_delete_data(self.mbs_data_ptr)
        if __DEBUG__ : print("DEBUG>>  MbsData pointer deleted")
989
        
Olivier Lantsoght's avatar
Olivier Lantsoght committed
990
    def reset(self,verbose=False):
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
        """ 
        Reset mbs_data fields to its inital value.
        
        The following fields are resetted according to the values storied in the
        field in parentheses:
         - MbsData.q (MbsData.q0)
         - MbsData.qd (MbsData.qd0)
         - MbsData.qdd (MbsData.qdd0)
         - MbsData.ux (MbsData.ux0)
         - MbsData.Qq (filled with 0)
         - MbsData.Qa (filled with 0)
         - MbsData.Qc (filled with 0)
         - MbsData.tsim (MbsData.t0)

        Parameters
        ----------
        verbose : bool, optional
            Set to 'True' to print resetting validation.
            default is False
        """
1011
1012
1013
1014
        libutilities.mbs_reset_data(self.mbs_data_ptr)
        if verbose :
           print("mbs_data reseted to initial value")
    
1015
    def mbs_load_from_file(self, baseFileName="dirdyn", result_path="resultsR", time = -1):
1016
        """ Load a state to MbsData instance from files for specific time.
Olivier Lantsoght's avatar
Olivier Lantsoght committed
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
        
        If the time specified is not found in the file, the last time step 
        lower than the specification is taken.
        The fieds q, qd, qdd, ux, uxd, q0, qd0, qdd0, ux0 ant tsim are set.

        Parameters
        ----------
        baseFileName : str
            The path and resfilename containing the state to load. The suffix 
            _q, _qd, _ux.res will be added. 
            default is "dirdyn"
        result_path : str
            The relative path of the result folder from the project folder.
            default is "resultsR"
        time : float
            The time corresponding to the state to load.
            defaut is "-1" (last state of the files).
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
        """
        def find_index(temp, t):
            if (t == -1):
                index = -1
            else:
                # Look the specified time
                index = np.nonzero(temp[:,0]>=t)
                if (np.size(index)):
                    index=index[0][0]
                    if not temp[index,0]==t:
                        if __DEBUG__ : print ("Time specified not found, take the last occurence where t<time")
                        index = index-1
                else:
                    if __DEBUG__ : print ("Time specified greather than time in files, taking the last state.")
                    index = -1
            return(index)
        
        project_path = self.project_path
            
        
1054
        result_path = os.path.join(project_path, result_path)
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
        # Error handeling
        if not os.path.isdir(result_path):
            if __DEBUG__ : print ('DEBUG>> The result directory does not exist: "'+ result_path+'"')
            
        index = -2
        # Generalized coordinates
        CurFile = baseFileName+'_q.res'
        path = os.path.abspath(os.path.join(result_path, CurFile))
        if (os.path.isfile(path) ):
            temp = np.loadtxt(path)
            index = find_index(temp, time)
            self.q[1:] = temp[index, 1:]
            self.q0[1:] = self.q[1:]
            self.tsim = temp[index, 0]
        else:
            if __DEBUG__ : print( "DEBUG>>  file '"+CurFile+"' not found in folder '"+os.path.dirname(path))
        
        # Generalized velocities
        # Assumption: index is still valid
        CurFile = baseFileName+'_qd.res'
        path = os.path.abspath(os.path.join(result_path, CurFile))
        if (os.path.isfile(path)):
            temp = np.loadtxt(path)
            if index == -2:
                index = find_index(temp, time)
            self.qd[1:] = temp[index, 1:]
            self.qd0[1:] = self.qd[1:]
        else:
             if __DEBUG__ : print( "DEBUG>>  file '"+CurFile+"' not found in folder '"+os.path.dirname(path))
             
        # Generalized accelerations
        # Assumption: index is still valid    
        CurFile = baseFileName+'_qdd.res'
        path = os.path.abspath(os.path.join(result_path, CurFile))
        if (os.path.isfile(path)):
            temp = np.loadtxt(path)
            if index == -2:
                index = find_index(temp, time)
            self.qdd[1:] = temp[index, 1:]
            self.qdd0[1:] = self.qdd[1:]
        else:
             if __DEBUG__ : print( "DEBUG>>  file '"+CurFile+"' not found in folder '"+os.path.dirname(path))
        
        # Generalized user state
        # Assumption: index is still valid
        if self.Nux:
            CurFile = baseFileName+'_ux.res'
            path = os.path.abspath(os.path.join(result_path, CurFile))
            if (os.path.isfile(path) ):
                temp = np.loadtxt(path)
                if index == -2:
                    index = find_index(temp, time)              
                self.ux[1:] = temp[index, 1:]
                self.ux0[1:] = self.ux[1:]
            else:
                if __DEBUG__ : print( "DEBUG>>  file '"+CurFile+"' not found in folder '"+os.path.dirname(path))
            
            CurFile = baseFileName+'_uxd.res'
            path = os.path.abspath(os.path.join(result_path, CurFile))
            if (os.path.isfile(path)):
                temp = np.loadtxt(path)
                if index == -2:
                    index = find_index(temp, time)              
                self.uxd[1:] = temp[index, 1:]
            else:
                if __DEBUG__ : print( "DEBUG>>  file '"+CurFile+"' not found in folder '"+os.path.dirname(path))
1121
1122
                
    def exe_dirdyn(self, **kwargs):
Olivier Lantsoght's avatar
Olivier Lantsoght committed
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
        """ Run a dirdyn module with a specified set of options.
        
        Also run a partitioning module if needed. 
        Partioning options are setted to default values expect rowperm = 1

        Parameters
        ----------
        kwargs
            Options to user for the analysis (see 'set_options' in MbsDirdyn).
        
        Returns
        -------
        results : MbsResults instance
            This object contains the results of the dirdyn analysis.
1137
1138
1139
1140
1141
        """
        if (not self.DonePart) and self.Ncons:
            mbs_part = MbsPart(self)
            mbs_part.set_options(verbose=False, rowperm = True)
            mbs_part.run()
1142
1143
1144
1145

        mbs_dirdyn = MbsDirdyn(self)
        mbs_dirdyn.set_options(**kwargs)
        results = mbs_dirdyn.run()
Louis Beauloye's avatar
Louis Beauloye committed
1146
1147
            
        return results
1148
1149
            
    def exe_part(self, **kwargs):
Olivier Lantsoght's avatar
Olivier Lantsoght committed
1150
1151
1152
1153
1154
1155
        """ Run a partitioning module with the specified set of options.

        Parameters
        ----------
        kwargs : 
            Options of the partitioning module (see 'set_options' in MbsPart).
1156
1157
1158
1159
1160
            
        """
        mbs_part = MbsPart(self)
        mbs_part.set_options(**kwargs)
        mbs_part.run()
1161

1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
    #==========================================================================
    # Defining properties
    #==========================================================================
    @property
    def npt(self):
        return self.mbs_data_ptr.contents.npt
    
    @property
    def dpt(self):
        return self.__dpt
    
    @property
    def l(self):
        return self.__l
    
    @property
    def m(self):
        return self.__m
    
    @property
    def In(self):
        return self.__In
    
    @property
    def g(self):
        return self.__g
    
    @property
    def nbody(self):
        return self.mbs_data_ptr.contents.nbody
    
    @property
    def njoint(self):
        return self.mbs_data_ptr.contents.njoint
    
    @property
    def nqu(self):
        return self.mbs_data_ptr.contents.nqu
    
    @property
    def nqc(self):
        return self.mbs_data_ptr.contents.nqc
    
    @property
    def nqlocked(self):
        return self.mbs_data_ptr.contents.nqlocked
    
    @property
    def nqdriven(self):
        return self.mbs_data_ptr.contents.nqdriven
    
    @property
    def nqa(self):
        return self.mbs_data_ptr.contents.nqa
    
    @property
    def nqv(self):
        return self.mbs_data_ptr.contents.nqv
    
    @property
    def nhu(self):
        return self.mbs_data_ptr.contents.nhu
    
    @property
    def qc(self):
        return self.__qc
    
    @property
    def qa(self):
        return self.__qa
    
    @property
    def q(self):
        return self.__q
    
    @property
    def qd(self):
        return self.__qd
        
    @property
    def qdd(self):
        return self.__qdd
    
    @property
    def q0(self):
        return self.__q0
    
    @property
    def qd0(self):
        return self.__qd0
        
    @property
    def qdd0(self):
        return self.__qdd0
        
    @property
    def frc(self):
        return self.__frc
        
    @property
    def trq(self):
        return self.__trq
    
1265
1266
1267
1268
    @property
    def Qa(self):
        return self.__Qa
    
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
    @property
    def Qq(self):
        return self.__Qq
    
    @property
    def tsim(self):
        return self.mbs_data_ptr.contents.tsim
        
    @tsim.setter
    def tsim(self, value):
        self.mbs_data_ptr.contents.tsim = value
    
    @property
    def t0(self):
        return self.mbs_data_ptr.contents.t0
        
    @t0.setter
    def t0(self, value):
        self.mbs_data_ptr.contents.t0 = value
    
    @property
    def tf(self):
        return self.mbs_data_ptr.contents.tf
        
    @tf.setter
    def tf(self, value):
        self.mbs_data_ptr.contents.tf = value
    
    @property
    def lrod(self):
        return self.__lrod
    
    @property
    def Nloopc(self):
        return self.mbs_data_ptr.contents.Nloopc
    
    @property
    def Ncons(self):
        return self.mbs_data_ptr.contents.Ncons
    
    @property
    def Nuserc(self):
        return self.mbs_data_ptr.contents.Nuserc
    
    @property
    def lambda_(self):
        return self.__lambda_
    
    @property
    def Qc(self):
        return self.__Qc
        
    @property
    def Nlink(self):
        return self.mbs_data_ptr.contents.Nlink
        
    @property
    def Z(self):
        return self.__Z
        
    @property
    def Zd(self):
        return self.__Zd
    
    @property
    def Fl(self):
        return self.__Fl
        
#    @property
#    def Nlink3D(self):
#        return self.mbs_data_ptr.contents.Nlink3D
    
    @property
    def Nsensor(self):
        return self.mbs_data_ptr.contents.Nsensor
        
    @property
    def Nxfrc(self):
        return self.mbs_data_ptr.contents.Nxfrc
    
    @property
    def xfidpt(self):
        return self.__xfidpt
    
    @property
    def SWr(self):
        return self.__SWr
    
    @property
    def ux(self):
        return self.__ux
    
    @property
    def uxd(self):
        return self.__uxd
    
    @property
    def ux0(self):
        return self.__ux0
    
    @property
    def Nux(self):
        return self.mbs_data_ptr.contents.Nux
    
    @property
    def DonePart(self):
        return self.mbs_data_ptr.contents.DonePart
    
    @property
    def process(self):
        return self.mbs_data_ptr.contents.process
        
    @process.setter
    def process(self, value):
        self.mbs_data_ptr.contents.process = value
    
    @property
    def mbs_filename(self):
        return ctypes.string_at(self.mbs_data_ptr.contents.mbs_filename).decode("utf-8")
    
    @property
    def project_path(self):
        return ctypes.string_at(self.mbs_data_ptr.contents.project_path).decode("utf-8")
    
    @property
    def mbs_name(self):
1395
        return ctypes.string_at(self.mbs_data_ptr.contents.mbs_name).decode("utf-8")
1396
1397
    
    
Louis Beauloye's avatar
Louis Beauloye committed
1398
1399
1400
1401
1402
1403
1404
class _UserModelDict(dict):
    """
        Class defined for user models, inherites from dict
        
        
        setitem and getitem function were updated
    """
1405
1406
1407
1408
        
    def __init__(self, *args, **kwargs):
        dict.__init__(self, *args, **kwargs)
        self._locked = True 
Louis Beauloye's avatar
Louis Beauloye committed
1409
        "flag that locks the addition of a new item"
1410
        self._parent_key = None
Louis Beauloye's avatar
Louis Beauloye committed
1411
1412
1413
        "key of the parent dict, None if not"
        self._type = None
        "type of the parameter, None if not"
1414
1415
1416
1417
        
    def __setitem__(self, key, value):
            
        if self._locked == True:
Louis Beauloye's avatar
Louis Beauloye committed
1418
            # if it is a parameter and not a parent 
1419
            if not (self._type is None):
Louis Beauloye's avatar
Louis Beauloye committed
1420
1421
1422
1423
1424
1425
1426
                if key in self.keys():
                    if self._type[key] == 1:
                        if type(value) is float:
                            tab = self.__getarray__(key)
                            tab[0][0] = value
                        elif type(value) is int:
                            tab = self.__getarray__(key)
1427
                            tab[0][0] = float(value)
Louis Beauloye's avatar
Louis Beauloye committed
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
                        else :
                            print("UserModel "+self._parent_key+"."+key+" is a float, "+str(type(value))+" was given")
                    elif self._type[key] == 7:
                        if type(value) is int:
                            tab = self.__getarray__(key)
                            tab[0][0] = value
                        else :
                            print("UserModel "+self._parent_key+"."+key+" is an int, "+str(type(value))+" was given")
                    elif self._type[key] == 2 or self._type[key] == 5:
                        if type(value) is np.ndarray or type(value) is list:
                            tab = self.__getarray__(key)
                            if np.size(value) == np.size(tab):
                                tab[:] = value[:]
                            else:
                                print("UserModel "+self._parent_key+"."+key+" is an array of size "+str(np.size(tab))+", array of size "+str(np.size(value))+" was given")
                        else :
                            print("UserModel "+self._parent_key+"."+key+" is an array, "+str(type(value))+" was given")
                    elif self._type[key] == 3:
                        print("Type lut1D for a user mode is not available in python")
                    elif self._type[key] == 4:
                        print("Type lut2D for a user mode is not available in python")
                    elif self._type[key] == 6:
                        print("Type structure for a user model is not available in python")
1451
                    else :
1452
                        print("Invalid type for the user model, type ID is: "+str(self._type[key]))
Louis Beauloye's avatar
Louis Beauloye committed
1453
1454
                else:
                    print("Unknown user model "+str(self._parent_key)+"."+str(key))
1455
1456
1457
1458
1459
                        
        else :
            dict.__setitem__(self, key, value)
            
    def __getarray__(self, key):
Louis Beauloye's avatar
Louis Beauloye committed
1460
1461
1462
        """
            Get the full array stored in the dict
        """
1463
1464
1465
1466
        
        return dict.__getitem__(self, key)
        
    def __getitem__(self, key):
Louis Beauloye's avatar
Louis Beauloye committed
1467
1468
1469
1470
1471
1472
        """
            Get the item in the array in the dict
            
            if scalar, return a scalar
            if vector, return a vector
        """
1473
1474
1475
1476
        
        if self._type is None:
            return dict.__getitem__(self, key)
        else :
Louis Beauloye's avatar
Louis Beauloye committed
1477
            if key in self.keys():
1478
1479
1480
1481
                if self._type[key] == 1:
                    return float(dict.__getitem__(self, key)[0][0])
                elif self._type[key] == 7:
                    return int(dict.__getitem__(self, key)[0][0])
Louis Beauloye's avatar
Louis Beauloye committed
1482
1483
1484
1485
                else:
                    return dict.__getitem__(self, key)[0]
            else: 
                print("Unknown user model "+str(self._parent_key)+"."+str(key))
1486
1487
1488