Robotran C Documentation
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Attributes | List of all members
MbsModalOptions Struct Reference

#include <mbs_modal_struct.h>

Public Attributes

int save2file
 no = 0, yes = 1, flag to save any results or animations [default = 1] More...
 
int save_mat
 no = 0, yes = 1, flag to save the linearized matrix A,Mr,Gr,Kr [default = 0] More...
 
int save_eval
 no = 0, yes = 1, flag to save the eigen values in two separate files: "_a" for Real part and "_b" for Imag part [default = 0] More...
 
int save_evec
 no = 0, yes = 1, flag to save the eigen vector in two separate files: "_a" for Real part, "_b" for Imag part, "_r" for magnitude and "_phi" for phase [default = 0] More...
 
int save_result
 no = 0, yes = 1, flag to save the modal results summary [default = 1] More...
 
int save_anim
 no = 0, yes = 1, flag to save and generate the animation for the modes [default = 0] More...
 
int verbose
 Verbosity level propagated to other compatible module: More...
 
double mode_ampl
 amplification factor for the animation of the modes, application dependent [default = 0.2] More...
 
int compute_uxd
 no = 0, yes = 1, flag to compute the modes associated with the extra constitutive differential equations [default = 1] More...
 
int compute_JS
 no = 0, yes = 1, flag to compute the non diagonal terms [default = 0] TO IMPLEMENT ! More...
 
int norm_evec
 no = 0, yes = 1, flag to normalize the eigenvectors [default = 1] More...
 
double zeroEigenPrecision
 Define the limit at which the eigen value will be considered as null [default = 1e-6]. More...
 
int lpk_itermax
 See MbsLpk::itermax [default = 10]. More...
 
double lpk_relincr
 See MbsLpk::relincr [default = 1e-2]. More...
 
double lpk_absincr
 See MbsLpk::absincr [default = 1e-3]. More...
 
double lpk_absincr_max
 See MbsLpk::absincr_max [default = 1e-3]. More...
 
double lpk_equitol
 See MbsLpk::equitol [default = 1e-6]. More...
 
double lpk_lintol
 See MbsLpk::lintol [default = 1e-3]. More...
 
int anim_speed
 flag to decide whether the independent speeds have to be integrated while generating the animation files [default = 0] More...
 
double anim_dt
 delta t for the animation generation [default = 1e-2] More...
 
double anim_t
 time for the animation generation [default = 2] More...
 
char * resfilename
 

Basename of the results files, suffixes and extension added automatically.

More...
 
char * respath
 

Path in which results file are saved.

More...
 
char * animpath
 

Path in which animation file is saved.

More...
 

Member Data Documentation

◆ anim_dt

double anim_dt

delta t for the animation generation [default = 1e-2]

◆ anim_speed

int anim_speed

flag to decide whether the independent speeds have to be integrated while generating the animation files [default = 0]

◆ anim_t

double anim_t

time for the animation generation [default = 2]

◆ animpath

char* animpath

Path in which animation file is saved.

The provided memory must be static or freed by the provider. The adress in this variable cannot be used to free dyamically allocated memory as It will be redirected by the module.

Default: the animationR folder of the project

◆ compute_JS

int compute_JS

no = 0, yes = 1, flag to compute the non diagonal terms [default = 0] TO IMPLEMENT !

◆ compute_uxd

int compute_uxd

no = 0, yes = 1, flag to compute the modes associated with the extra constitutive differential equations [default = 1]

◆ lpk_absincr

double lpk_absincr

See MbsLpk::absincr [default = 1e-3].

◆ lpk_absincr_max

double lpk_absincr_max

See MbsLpk::absincr_max [default = 1e-3].

◆ lpk_equitol

double lpk_equitol

See MbsLpk::equitol [default = 1e-6].

◆ lpk_itermax

int lpk_itermax

See MbsLpk::itermax [default = 10].

◆ lpk_lintol

double lpk_lintol

See MbsLpk::lintol [default = 1e-3].

◆ lpk_relincr

double lpk_relincr

See MbsLpk::relincr [default = 1e-2].

◆ mode_ampl

double mode_ampl

amplification factor for the animation of the modes, application dependent [default = 0.2]

◆ norm_evec

int norm_evec

no = 0, yes = 1, flag to normalize the eigenvectors [default = 1]

◆ resfilename

char* resfilename

Basename of the results files, suffixes and extension added automatically.

The provided memory must be static or freed by the provider. The adress in this variable cannot be used to free dyamically allocated memory as It will be redirected by the module.

The filename can contains relative path from MbsDirdynOptions::respath.

Default: 'modal'

◆ respath

char* respath

Path in which results file are saved.

The provided memory must be static or freed by the provider. The adress in this variable cannot be used to free dyamically allocated memory as It will be redirected by the module.

Default: the resultsR folder of the project

◆ save2file

int save2file

no = 0, yes = 1, flag to save any results or animations [default = 1]

◆ save_anim

int save_anim

no = 0, yes = 1, flag to save and generate the animation for the modes [default = 0]

◆ save_eval

int save_eval

no = 0, yes = 1, flag to save the eigen values in two separate files: "_a" for Real part and "_b" for Imag part [default = 0]

◆ save_evec

int save_evec

no = 0, yes = 1, flag to save the eigen vector in two separate files: "_a" for Real part, "_b" for Imag part, "_r" for magnitude and "_phi" for phase [default = 0]

◆ save_mat

int save_mat

no = 0, yes = 1, flag to save the linearized matrix A,Mr,Gr,Kr [default = 0]

◆ save_result

int save_result

no = 0, yes = 1, flag to save the modal results summary [default = 1]

◆ verbose

int verbose

Verbosity level propagated to other compatible module:

  • MBS_VERBOSE_ERROR: Only print error related messages;
  • MBS_VERBOSE_WARNING: Print error and warning related messages;
  • MBS_VERBOSE_ALL: Print all normal release messages (default);
  • MBS_VERBOSE_DEBUG: Maximal verbosity level;

◆ zeroEigenPrecision

double zeroEigenPrecision

Define the limit at which the eigen value will be considered as null [default = 1e-6].


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