Post: User Outputs Request

Model ElementThe Post_UserAPIS element allows you to generate your own results file. Post_UserAPIS supports more than one Post_UserAPI with an ID.

Format

<Post_UserAPIS>
     ID                  = "integer"
     USRSUB_PARAM_STRING = "USER( [[par_1 [, ...][,par_n]] )"
     SYNCHRONIZATION      = { "REQUEST" | "MRF" }
     USRSUB_DLL_NAME     = valid_path_name
     USRSUB_FNC_NAME     = custom_fnc_name >
|     
     SCRIPT_NAME         = valid_path_name
     INTERPRETER         = "string"  

     USRSUB_PARAM_STRING = "USER([[par_1[,...][,par_n]])"
     USRSUB_FNC_NAME     = "custom_fnc_name" >
</Post_UserAPI>

Attributes

id
Element identification number (integer>0). This number is unique among all the Post_UserAPIS elements in the model.
usrsub_param_string
The list of parameters that are passed from the data file to the user written subroutine Post_UserAPIS.
synchronization
Specifies the frequency of calling the user subroutine POST_SUBS.
MRF: Calls POST_SUBS at the same time steps when data is written to the MRF file during the simulation.
REQUEST: Calls POST_SUBS at the output time steps.
The default is MRF.
usrsub_dll_name
Specifies the path and name of the DLL or shared library containing user subroutine. MotionSolve uses this information to load the user subroutine in the DLL at run time.
usrsub_fnc_name
Specifies an alternative name for the user subroutine POST_SUBS.
script_name
Specifies the path and name of the user written script that contains the routine specified by usrsub_fnc_name.
interpreter
Specifies the interpreted language that the user script is written in (example: "PYTHON"). See User-Written Subroutines for a choice of valid interpreted languages.