Solver Strings

A solver string provides a string to the solver that can be accessed within the model, for example, to pass into a user subroutine.

User-defined subroutines often need inputs such as keywords or file paths. These inputs can be defined as a solver string. A solver string ID is passed as an argument to the subroutine through its USER call.

For information on how to add or edit an entity like a solver string, see Entity Creation.

Solver String Properties

Descriptions of solver string properties in the Property Editor.

Table 1.
Property Name Description
General
Name Name of the entity
Variable Name The variable name, a unique identifier string of the entity
ID A unique identifying integer
Properties
String A valid string or an expression that evaluates to a string.
User-defined Use a subroutine to define the solver string.
  • For User expr, provide an expression with the USER solver function with parameters being passed to the user subroutine.
  • Turn on Use local file and function name to provide a local file for the subroutine. Otherwise, Inspire Motion will search for the subroutine within its search path.
    1. Specify a Local file where the subroutine code can be accessed by the solver. If this option is not specified, the application will search for a subroutine following its user subroutine loading rules.
      Note: The type of file to be specified will depend on the selected function type. For example, if DLL/SO is selected, you can specify a file with a .dll extension (for Windows) or an .so extension (for Linux).
    2. Select a Function type from the dropdown menu:
      • DLL/SO
      • Python
      • MatLab
      • Compose
    3. Specify the Function name in the subroutine that defines the entity, or accept the default name provided by the application.