MotionAnalysisSettings (hwx.inspire.motion)

Controls how long the motion simulation will run.

Some of the settings that can be controlled are:

  • The number of frames in the results output.

  • The type of analysis.

  • Includes gravity.

Inherits:

  • MotionObject (hwx.inspire.motion)

Attributes

active: Bool

activeContactIteration: Bool

addFreeJoints: Bool

addGravity: Bool

addMotionContacts: Bool

addRequests: Enum

addSensors: Enum

analysisType: Enum

animate: Enum

animationFile: Enum

bushingC: Double

bushingCT: Double

bushingK: Double

bushingKT: Double

bushing_calculateRates: Bool

combineGround: Bool

contactType: Enum

cutoffFrequency: Bool

cutoffFrequencyValue: Double

debugPrint: Bool

disableDamping: Bool

domain: Enum

eigenSolution: Bool

endTime: Double

implicitType: Enum

inputs: Attribute

integratorDaeIndex: Enum

integratorError: Double

integratorHmax: Double

integratorKmax: Int

jointType: Enum

keepContactForceResults: Enum

logFiles: Enum

name: Attribute

outputRate: Double

outputs: Attribute

preciseFlexContact: Bool

requestFrame: Enum

sensorError: Double

sensorValue: Double

signalType: Enum

stateSpaceMatrix: Bool

storeResults: Bool

supportType: Enum

visible: Bool

writeEnergyDistrib: Bool

Properties

Public Methods

addRequestsFor (self, obj)

Attribute Details

active : Bool

Returns or sets the object activeness.

Setting this on or off sets all children. Setting to True sets all the parents active too.

activeContactIteration : Bool

Controls the contact force evaluation during corrector iterations.

addFreeJoints : Bool

Specifies whether to include free joints from the motion analysis.

addGravity : Bool

Specifies whether to include gravity from the motion analysis.

addMotionContacts : Bool

Specifies whether to include motion contacts from the motion analysis.

addRequests : Enum (all, notparts, measuresonly, none)

Specifies options to create analysis results used for plotting.

The options can be “All”, “Exclude for parts”, “Measures only” or “None”.

addSensors : Enum (all, notjoints, none)

Provides options for what modeling checking sensors are in effect.

The options can be “All”, “Exclude joint deformation”, “None”.

analysisType : Enum (TRANSIENT, STATICS, ASSEMBLY, STATICS+TRANSIENT)

Specifies what type of motion analysis to perform.

A motion analysis can be either be Assembly, Transient, Static, or Statics+Transient.

  • Transient analysis is used to include dynamic effects in a time-dependent motion simulation. Enable *Start at equilibrium* to begin from an equilibrium solution first.

  • Statics analysis is used to determine the static equilibrium position of your mechanism. For this analysis type, all velocity and damping terms are ignored. This helps you analyze the loading without including dynamic effects.

animate : Enum (solving, finished)

Specifies when to animate the model.

The options to animate are “While Solving”, “When Finished”.

animationFile : Enum (auto, all, notcontact, none)

Specifies the options to generate H3D files containing all motion analysis data.

The options can be “Auto”, “Include all data”, “Exclude contact data” or “None”.

bushingC : Double (units=”damping”)

Specifies the damping rate.

bushingCT : Double (units=”torsion_damping”)

Specifies the torsional damping rate.

bushingK : Double (units=”stiffness”)

Specifies the stiffness rate.

bushingKT : Double (units=”torsion_stiffness”)

Specifies the torsional stiffness rate.

bushing_calculateRates : Bool

By default, the global rates (below) are determined automatically. Disable this option to enter your own rates.

combineGround : Bool

Specifies whether to combine ground parts.

contactType : Enum (rigid, flexible, virtual)

Used to override the default behavior of the contact based joint, during motion analysis.

The behaviors can be “Rigid”, “Flexible” or “Virtual”. Defaults to Flexible.

cutoffFrequency : Bool

Specifies whether to use cut off frequency.

cutoffFrequencyValue : Double (units=”frequency”)

Specifies the value of cut off frquency.

debugPrint : Bool

disableDamping : Bool

Disables damping if set to True, defaults to False.

domain : Enum (TIME_DOMAIN, LINEAR)

Specifies what domain does the motion analysis should follow.

They can be of type

  • Time Domain

  • Linear

eigenSolution : Bool

Specifies whether to use Eigen solution.

endTime : Double (units=”time”)

The end time indicates how long the motion simulation should run.

implicitType : Enum (rigid, flexible, virtual)

Used to override the default behavior of the implicit joint, during motion analysis.

The behaviors can be “Rigid”, “Flexible” or “Virtual”. Defaults to Rigid.

inputs : Attribute

integratorDaeIndex : Enum (i3, si1)

Specifies the DAE formulation to use within the solver.

They can be of type ‘I3’ and ‘SI1’.

  • ‘I3’ is faster but can be slightly inaccurate

  • ‘SI1’ is very accurate, but can be somewhat slower.

integratorError : Double

This tolerance represents the maximum absolute error per integrator step.

integratorHmax : Double (units=”time”)

The maximum step size the integrator is allowed to take.

integratorKmax : Int

This is the maximum order that the integrator can take.

The default value is 5, higher orders lead to higher accuracy, but lower stability.

jointType : Enum (rigid, flexible, virtual)

Used to override the default behavior of the joint, during motion analysis.

The behaviors can be “Rigid”, “Flexible” or “Virtual”. Defaults to Flexible.

  • Flexible, joints behave as a linear bushing model.

  • Rigid, joints are idealized and do not deform.

  • Virtual, it is very similar to a rigid joint, but with “soft constraint” behavior.

keepContactForceResults : Enum (all, region, none)

Specifies what contact force data to be saved in the model.

logFiles : Enum (keep, discard)

Specifies what options to choose to log the Motion analysis related files after a run.

The options could be “Keep” and “Discard”.

  • Select ‘Keep’ to retain motion-related solver files from runs.

  • Select ‘Discard’ to automatically delete the files after a run.

name : Attribute

Returns or sets the name of the object.

It can be any text string, including spaces, although it’s best to avoid using the following characters: ” ‘ * ? and $.

While these characters are allowed, they could create difficulties when you export the model to other applications.

outputRate : Double (units=”frequency”)

The output rate controls the number of frames in the results output.

Larger numbers give smoother, continuous results, but will animate more slowly.

outputs : Attribute

preciseFlexContact : Bool

Performs preliminary analysis to accurately predict contacts on flexible bodies.

requestFrame : Enum (global, i, j)

Specifies options for what reference frame to use.

Used for plotting. The options can be “Global”, “Local to 1st part”, “Local to 2nd part”.

sensorError : Double (units=”length”)

Specifies the sensor error offset value. Defaults to ‘1e-5’.

sensorValue : Double (units=”length”)

Specifies the sensor value. Defaults to ‘1e-3’.

signalType : Enum (cosim, ssm)

stateSpaceMatrix : Bool

Specifies whether to use state space matrix.

storeResults : Bool

Allows to store the motion analysis results in the model stmod file.

Turning this option off will reduce the size of the model file.

supportType : Enum (rigid, flexible, virtual)

Used to override the default behavior of the supports, during motion analysis.

The behaviors can be “Rigid”, “Flexible” or “Virtual”. Defaults to Rigid.

visible : Bool

Determines whether the object is visible in the graphics window.

Setting this on or off sets all children. Setting to True sets all the parents visible too.

writeEnergyDistrib : Bool

Specifies whether to write energy distribution.

Property Details

property addAllSensors

Specifies if the add sensors are not set to None.

property addJointSensors

Specifies if the add sensors are set to All.

property flexibleContacts

Specifies if the contact type is set to Flexible.

property flexibleFasteners

Specifies if the fasteners type is set to Flexible.

property flexibleImplicits

Specifies if the joint type is set to Flexible.

property flexibleJoints

Specifies if the joint type is set to Flexible.

property flexibleSupports

Specifies if the support type is set to Flexible.

property outputInterval

Returns the fraction of the output rate.

property virtualContacts

Specifies if the contact type is set to Virtual.

property virtualImplicits

Specifies if the implicit joint type is set to Virtual.

property virtualJoints

Specifies if the joint type is set to Virtual.

property virtualSupports

Specifies if the support type is set to Virtual.

Method Details

addRequestsFor(self, obj)

Validates if the specified object request are added.

param obj

Object for which the validation requests are added.

type obj

Named

returns

True if the validation is successful, False otherwise.

rtype

bool