Robotran Matlab Documentation
Public Attributes | List of all members
MBS_equil_opt Struct Reference

MBS equilibrium option structure. More...

Public Attributes

MBS_equil opt solvemethod
 Method used for computing equilibrium. More...
 
MBS_equil opt relax
 Taux de relaxation de la méthode NR
1.0 : no relaxation
0.1 : strong relaxation
default : 1.0. More...
 
MBS_equil opt smooth
 
MBS_equil opt tol
 Precision of the solution (norm of the reduced force vector)
default : 1E-6. More...
 
MBS_equil opt itermax
 Max number of iterations
default : 30. More...
 
MBS_equil opt xeqchoice
 Definition of the variables used for equilibrium (other than the actual qu)
default : independent coordinates (qu)
example : {2,’user_model.my_susp.my_Z0’}. More...
 
MBS_equil opt verbose
 Display of the equilibrium information in the command window. More...
 
MBS_equil opt clearmbsglobal
 Deletion of the global variables. More...
 
MBS_equil opt visualize
 Display of the 3D graphical model. More...
 

Detailed Description

MBS equilibrium option structure.

Todo:
document struct and each members

To be completed

Member Data Documentation

◆ clearmbsglobal

MBS_equil opt clearmbsglobal

Deletion of the global variables.

  • 'inout' : delete the global MBS_equil and MBS_data variables
  • 'out' : delete the global MBS_equil variable
  • 'none' : no deletion of the global variables
  • 'all' : delete all the global variables

◆ itermax

MBS_equil opt itermax

Max number of iterations
default : 30.

◆ relax

MBS_equil opt relax

Taux de relaxation de la méthode NR
1.0 : no relaxation
0.1 : strong relaxation
default : 1.0.

Todo:
To be translated Relaxation rate?

◆ smooth

MBS_equil opt smooth
Todo:
To be defined

◆ solvemethod

MBS_equil opt solvemethod

Method used for computing equilibrium.

  • 'fsolvepk' : equilibrium solved using Newton-Raphson method
  • 'optim' : equilibrium solved using an optimisation method (not yet implemented)
    Todo:
    will it ever be implemented?

◆ tol

Precision of the solution (norm of the reduced force vector)
default : 1E-6.

◆ verbose

MBS_equil opt verbose

Display of the equilibrium information in the command window.

  • 'yes'
  • 'no'

◆ visualize

MBS_equil opt visualize

Display of the 3D graphical model.

  • 'yes'
  • 'no'

◆ xeqchoice

MBS_equil opt xeqchoice

Definition of the variables used for equilibrium (other than the actual qu)
default : independent coordinates (qu)
example : {2,’user_model.my_susp.my_Z0’}.


The documentation for this struct was generated from the following file: