@@ -49,72 +49,6 @@ class Parameters:
4949
5050 See :ref:`ref_parameters` for additional notes.
5151
52- Notes
53- -----
54-
55- **Leading underscored parameters**
56-
57- The parameters starting with underscore ('_') are reserved parameters
58- for MAPDL macros and routines, therefore its use is discouraged, and
59- in PyMAPDL you cannot set them by default.
60-
61- If you need to set one of this parameters, you can use ``mapdl._run``
62- to avoid PyMAPDL parameter name checks. For example
63-
64- >>> mapdl._run('_parameter=123')
65- 'PARAMETER _PARAMETER = 123.00000000'
66-
67- By default, this type of parameters cannot be seen when issuing
68- ``mapdl.parameters``. However, you can change this by setting
69- ``mapdl.parameters.show_leading_underscore_parameters`` equal to True.
70- For example:
71-
72- >>> mapdl.parameters.show_leading_underscore_parameters=True
73- >>> mapdl.parameters
74- MAPDL Parameters
75- ----------------
76- PORT : 50053.0
77- _RETURN : 0.0
78- _STATUS : 0.0
79- _UIQR : 17.0
80-
81-
82- **Trailing underscored parameters**
83-
84- The parameters ending underscore are recommend for user routines
85- and macros.
86- You can set this type of parameters in PyMAPDL, but by default,
87- they cannot be seen in ``mapdl.parameters``, unless
88- ``mapdl.parameters.show_trailing_underscore_parameters`` is set
89- to True.
90-
91- >>> mapdl.parameters['param_'] = 1.0
92- >>> mapdl.parameters
93- MAPDL Parameters
94- ----------------
95- >>> mapdl.parameters.show_trailing_underscore_parameters=True
96- >>> mapdl.parameters
97- MAPDL Parameters
98- ----------------
99- PARAM_ : 1.0
100-
101- **Parameters with leading and trailing underscore**
102-
103- These are an especial type of parameters. They CANNOT be seen
104- in ``mapdl.parameters`` under any circumstances, and because
105- of it, it uses is not recommended.
106-
107- You can still retrieve them using any of the normal methods
108- to retrieve parameters. But you shall know the parameter name.
109- For example:
110-
111- >>> mapdl.parameters["_param_"] = 1.0
112- >>> mapdl.parameters
113- MAPDL Parameters
114- ----------------
115- >>> print(mapdl.parameters['_param_'])
116- 1.0
117-
11852 Examples
11953 --------
12054 Simply list all parameters except for MAPDL MATH parameters.
0 commit comments