Subroutine Type

Utility/Data Access

Definition

This subroutine returns information about the current simulation step in a MotionSolve simulation.

Use

This function-style subroutine can be called from within any user-written subroutine to obtain information about the current simulation step for a MotionSolve model.  This utility can be used to check, for example, whether the current step is a predictor step, a corrector step or a converged step, for example.

Calling Syntax

Fortran

call GET_STEP_INFO(FLAG)

C

c_get_step_info(flag)

Python

flag = py_get_step_info()

MATLAB

flag = m_get_step_info()

Output Values

[integer] FLAG

The integer value returned by this function:

0: Indicates the current step is a converged step.

1: Indicates the current step is a predictor step.

2: Indicates the current step is a corrector step.

-1: Indicates that the current analysis is not a transient analysis.

Complete Definition

This function can be called in any user subroutine to get information about the current solver step in a transient analysis.  If this function is called during any other analysis, a value of -1 is returned.