Subroutine Type

Utility/Data Access

Definition

The SYSFNC utility subroutine allows you to query MotionSolve for a single system state such as displacement, velocity, and force, inside a user subroutine.  SYSFNC should be called with the appropriate input argument (listed below) and it returns the corresponding system state.

Calling Syntax

Fortran

CALL SYSFNC (FNCNAM, IPAR, NSIZE, STATE, ERRFLG)

C

c_sysfnc(fncnam, ipar, nsize, state, errflg)

Python

[state, errflg] = py_sysfnc(fncnam, ipar)

Matlab

[state, errflg] = m_sysfnc(fncnam, ipar)

Input Arguments

FNCNAM

A string that specifies the name of the function for the SYSFNC call.  Valid function names are listed below.

IPAR

A real vector containing input parameters for the FNCNAM.  The size of this array must be NSIZE.

NSIZE

A scalar integer variable that contains the number of parameters for the SYSFNC call.

STATE

The real value extracted by the function call.

ERRFLG

A logical flag that represents the success of the SYSFNC function call.

Complete Definition

This function can be called only by a subset of user defined subroutines: ARYSUB, CONSUB, DIFSUB, GFOSUB, REQSUB, SENSUB, SEVSUB, SFOSUB, TUNSUB, VARSUB, VFOSUB, and VTOSUB.  In particular, it cannot be called by UCOSUB, COUSUB, COUXX, COUXX2, FIESUB, MOTSUB, GSESUB, GSEXX, GSEXU, GSEYX and GSEYU.  For the above mentioned routines, system states must be explicitly passed as input arguments and cannot be extracted via the SYSARAY or SYSFNC call.

The table below lists each of the supported function names with the size of the arguments that are required.

Note:  Please refer to the documentation for each of these functions for more details on their syntax.

See Also:

Data Access Subroutines