Subroutine Type

Utility/Data Access

Definition

The CUSFNC utility subroutine obtains a scalar output from a custom defined function in MotionSolve.  The custom function must already be defined using the MotionSolve custom mapping file.

Calling Syntax

Fortran

CALL CUSFNC (FNCNAM, RPAR, NSIZE, STATE, ERRFLG)

C

c_cusfnc(fncnam, rpar, nsize, state, errflg)

Python

[state, errflg] = py_cusfnc(fncnam, rpar)

Matlab

[state, errflg] = m_cusfnc(fncnam, rpar)

Input Arguments

[string] FNCNAM

A string that specifies the name of the predefined custom function for the CUSFNC call.  Valid function names depend on what has been defined using the custom mapping file.

[double] RPAR

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

[integer] NSIZE

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

[double] STATE

The real value extracted by the function call.

[bool] ERRFLG

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

Complete Definition

This function can be called by any user subroutine.  To create a custom function, please see Writing Custom Functions for MotionSolve.