*SetState()

Sets the state of an entity.

Syntax

*SetState(entity_name, ON|OFF)

Arguments

entity_name
The existing entity, for example system, force/forcepair and joint/jointpair, for which the state is being specified.
Data type: varname
ON|OFF
ON turns on the specified entity.
OFF turns off the specified entity.
Data type: boolean

Example

For a system:
*BeginMDL(model, "Model 1")
  *System( sys_frnt_susp, "Frnt mac susp",
           def_sys_frnt_susp, B_Ground)
  *System(sys_stabar, "Sta bar", sysdef_stabar, 
                                 sys_frnt_susp.b_lca, 
                                 B_Ground)
  *SetSystem(model)
     *SetState(sys_stabar, OFF)
*EndMDL()
For a joint:
*BeginMDL(model, "Model 1")
  *RevJoint( j_rev, "Rev Joint", body_1, body_2, p_point, v_vector)
   *SetState( j_rev, OFF )
*EndMDL()

Context

*BeginMdl()

*DefineAnalysis()

*DefineSystem()

Comments

If there is no *SetState() statement for an entity, the state is ON by default.

When an entity is turned off, it is ignored in subsequent solver simulations.