ansys.mapdl.core.Mapdl.starstatus#
- Mapdl.starstatus(par='', imin='', imax='', jmin='', jmax='', kmin='', kmax='', lmin='', lmax='', mmin='', mmax='', kpri='', **kwargs)#
Lists the current parameters and abbreviations.
Mechanical APDL Command: *STATUS
- Parameters:
- par
str
Specifies the parameter or sets of parameters listed. For array parameters, use
IMIN
,IMAX
, etc. to specify ranges. Use dim to define array parameters. Use*VEDIT
to review array parameters interactively. Use vwrite to print array values in a formatted output. IfPar
is blank, list all scalar parameter values, array parameter dimensions, and abbreviations. If ARGX, list the active set of local macro parameters (ARG1 to ARG9 and AR10 to AR99) ( use ).The following are possible values for
Par
ALL or blank
- Lists all parameters (except local macro parameters and those with names beginning or ending with an underbar) and toolbar abbreviations._PRM
- Lists only parameters with names beginning with an underbar (_). These are Mechanical APDL internal parameters.PRM_
- Lists only parameters with names ending with an underbar (_). A good APDL programming convention is to ensure that all parameters created by your system programmer are named with a trailing underbar.ABBR
- Lists all toolbar abbreviations.PARM
- Lists all parameters (except local macro parameters and those with names beginning or ending with an underbar).MATH
- Lists all APDL Math parameters, including vectors, matrices, and linear solvers.PARNAME
- Lists only the parameter specified.PARNAME
cannot be a local macro parameter name.ARGX
- Lists all local macro parameter values (ARG1- AR99) that are non-zero or non-blank.
- imin
str
Range of array elements to display (in terms of the dimensions (row, column, plane, book, and shelf). Minimum values default to 1. Maximum values default to the maximum dimension values. Zero may be input for
IMIN
,JMIN
, andKMIN
to display the index numbers. See taxis command to list index numbers of 4- and 5-D tables.- imax
str
Range of array elements to display (in terms of the dimensions (row, column, plane, book, and shelf). Minimum values default to 1. Maximum values default to the maximum dimension values. Zero may be input for
IMIN
,JMIN
, andKMIN
to display the index numbers. See taxis command to list index numbers of 4- and 5-D tables.- jmin
str
Range of array elements to display (in terms of the dimensions (row, column, plane, book, and shelf). Minimum values default to 1. Maximum values default to the maximum dimension values. Zero may be input for
IMIN
,JMIN
, andKMIN
to display the index numbers. See taxis command to list index numbers of 4- and 5-D tables.- jmax
str
Range of array elements to display (in terms of the dimensions (row, column, plane, book, and shelf). Minimum values default to 1. Maximum values default to the maximum dimension values. Zero may be input for
IMIN
,JMIN
, andKMIN
to display the index numbers. See taxis command to list index numbers of 4- and 5-D tables.- kmin
str
Range of array elements to display (in terms of the dimensions (row, column, plane, book, and shelf). Minimum values default to 1. Maximum values default to the maximum dimension values. Zero may be input for
IMIN
,JMIN
, andKMIN
to display the index numbers. See taxis command to list index numbers of 4- and 5-D tables.- kmax
str
Range of array elements to display (in terms of the dimensions (row, column, plane, book, and shelf). Minimum values default to 1. Maximum values default to the maximum dimension values. Zero may be input for
IMIN
,JMIN
, andKMIN
to display the index numbers. See taxis command to list index numbers of 4- and 5-D tables.- lmin
str
Range of array elements to display (in terms of the dimensions (row, column, plane, book, and shelf). Minimum values default to 1. Maximum values default to the maximum dimension values. Zero may be input for
IMIN
,JMIN
, andKMIN
to display the index numbers. See taxis command to list index numbers of 4- and 5-D tables.- lmax
str
Range of array elements to display (in terms of the dimensions (row, column, plane, book, and shelf). Minimum values default to 1. Maximum values default to the maximum dimension values. Zero may be input for
IMIN
,JMIN
, andKMIN
to display the index numbers. See taxis command to list index numbers of 4- and 5-D tables.- mmin
str
Range of array elements to display (in terms of the dimensions (row, column, plane, book, and shelf). Minimum values default to 1. Maximum values default to the maximum dimension values. Zero may be input for
IMIN
,JMIN
, andKMIN
to display the index numbers. See taxis command to list index numbers of 4- and 5-D tables.- mmax
str
Range of array elements to display (in terms of the dimensions (row, column, plane, book, and shelf). Minimum values default to 1. Maximum values default to the maximum dimension values. Zero may be input for
IMIN
,JMIN
, andKMIN
to display the index numbers. See taxis command to list index numbers of 4- and 5-D tables.- kpri
int
orstr
Use this field to list your primary variable labels (X, Y, Z, TIME, etc.).
1
- List the labels (default). YES, Y, or ON are also valid entries.0
- Do not list the labels. NO, N, or OFF are also valid entries.
- par
Notes
Warning
This function contains specificities regarding the argument definitions. Please refer to the command documentation for further explanations.
Argument Descriptions
par : str
- Specifies the parameter or sets of parameters listed. For array parameters, use
IMIN
,IMAX
,etc. to specify ranges. Use dim to define array parameters. Use
*VEDIT
to review array parameters interactively. Use vwrite to print array values in a formatted output. IfPar
is blank, list all scalar parameter values, array parameter dimensions, and abbreviations. If ARGX, list the active set of local macro parameters (ARG1 to ARG9 and AR10 to AR99) ( use ).The following are possible values for
Par
ALL or blank
- Lists all parameters (except local macro parameters and those with names beginning or ending with an underbar) and toolbar abbreviations._PRM
- Lists only parameters with names beginning with an underbar (_). These are Mechanical APDL internal parameters.PRM_
- Lists only parameters with names ending with an underbar (_). A good APDL programming convention is to ensure that all parameters created by your system programmer are named with a trailing underbar.ABBR
- Lists all toolbar abbreviations.PARM
- Lists all parameters (except local macro parameters and those with names beginning or ending with an underbar).MATH
- Lists all APDL Math parameters, including vectors, matrices, and linear solvers.PARNAME
- Lists only the parameter specified.PARNAME
cannot be a local macro parameter name.ARGX
- Lists all local macro parameter values (ARG1- AR99) that are non-zero or non-blank.
imin, imax, jmin, jmax, kmin, kmax, lmin, lmax, mmin, mmax : str
- Range of array elements to display (in terms of the dimensions (row, column, plane, book, and shelf). Minimum values default to 1. Maximum values default to the maximum dimension values. Zero may be input forIMIN
,JMIN
, andKMIN
to display the index numbers. See taxis command to list index numbers of 4- and 5-D tables.kpri : int
- Use this field to list your primary variable labels (X, Y, Z, TIME, etc.).1
- List the labels (default). YES, Y, or ON are also valid entries.0
- Do not list the labels. NO, N, or OFF are also valid entries.
You cannot obtain the value for a single local parameter (for example, starstatus,ARG2). You can only request all local parameters simultaneously using starstatus,ARGX.
This command is valid in any processor.