get_value#
- Mapdl.get_value(entity='', entnum='', item1='', it1num='', item2='', it2num='', item3='', it3num='', item4='', it4num='', **kwargs)#
Runs the MAPDL GET command and returns a Python value.
This method uses
Mapdl.get()
.See the full MADPL command documentation at *GET :rtype:
Union
[float
,str
]Note
This method is not available when within the
Mapdl.non_interactive()
context manager.- Parameters:
- entity
str
Entity keyword. Valid keywords are
"NODE"
,"ELEM"
,"KP"
,"LINE"
,"AREA"
,"VOLU"
,"PDS"
, etc.- entnum
str
,int
,optional
The number or label for the entity. In some cases, a zero (or blank
""
)entnum
represents all entities of the set.- item1
str
,optional
The name of a particular item for the given entity.
- it1num
str
,int
,optional
The number (or label) for the specified Item1 (if any). Some Item1 labels do not require an IT1NUM value.
- item2
str
,optional
A second set of item labels and numbers to further qualify the item for which data are to be retrieved. Most items do not require this level of information.
- it2num
str
,int
,optional
The number (or label) for the specified
item2
(if any). Someitem2
labels do not require anit2num
value.- item3
str
,optional
A third set of item labels and numbers to further qualify the item for which data are to be retrieved. Most items do not require this level of information.
- it3num
str
,int
,optional
The number (or label) for the specified
item3
(if any). Someitem3
labels do not require anit3num
value.- item4
str
,optional
A fourth set of item labels and numbers to further qualify the item for which data are to be retrieved. Most items do not require this level of information.
- it4num
str
,int
,optional
The number (or label) for the specified
item4
(if any). Someitem4
labels do not require anit4num
value.
- entity
- Returns:
float
Floating point value of the parameter.
Examples
Retrieve the number of nodes.
>>> value = mapdl.get_value('node', '', 'count') >>> value 3003
Retrieve the number of nodes using keywords.
>>> value = mapdl.get_value(entity='node', item1='count') >>> value 3003