GET_STEP_INFO

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, or about the current solver step in a transient analysis. 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. If this function is called during any other analysis, a value of -1 is returned.

Format

Fortran Calling Syntax

call GET_STEP_INFO(FLAG)

C/C++ Calling Syntax

c_get_step_info(flag)

Python Calling Syntax

flag = py_get_step_info()

MATLAB Calling Syntax

flag = m_get_step_info()

Output

FLAG

[integer]

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.