Skip to content

Commit f6c88a0

Browse files
authored
Removing redundant map function (#1403)
* Removing redundant map function * Improving docstring. * Fixing docs. * testing removing map * Resetting cache.
1 parent 445e853 commit f6c88a0

File tree

4 files changed

+8
-47
lines changed

4 files changed

+8
-47
lines changed

.github/workflows/ci.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,10 @@ env:
2121
# You should go up in number, if you go down (or repeat a previous value)
2222
# you might end up reusing a previous cache if it haven't been deleted already.
2323
# It applies 7 days retention policy by default.
24-
RESET_PIP_CACHE: 3
25-
RESET_EXAMPLES_CACHE: 3
26-
RESET_DOC_BUILD_CACHE: 3
27-
RESET_AUTOSUMMARY_CACHE: 3
24+
RESET_PIP_CACHE: 2
25+
RESET_EXAMPLES_CACHE: 2
26+
RESET_DOC_BUILD_CACHE: 2
27+
RESET_AUTOSUMMARY_CACHE: 2
2828
PACKAGE_NAME: PyMAPDL
2929

3030
concurrency:

doc/source/mapdl_commands/map.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ and map it onto a geometry.
1313
:toctree: _autosummary/
1414

1515
Mapdl.ftype
16-
Mapdl.map_
1716
Mapdl.plgeom
1817
Mapdl.plmap
1918
Mapdl.read

src/ansys/mapdl/core/_commands/map_cmd.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ def ftype(self, filetype="", prestype="", **kwargs):
4848
command = f"FTYPE,{filetype},{prestype}"
4949
return self.run(command, **kwargs)
5050

51-
def map_(self, kdim="", kout="", limit="", **kwargs):
51+
def map(self, kdim="", kout="", limit="", **kwargs):
5252
"""Maps pressures from source points to target surface elements.
5353
5454
APDL Command: MAP
@@ -66,15 +66,16 @@ def map_(self, kdim="", kout="", limit="", **kwargs):
6666
Key to control how pressure is applied when a target node is
6767
outside of the source region:
6868
69-
* ``"0"`` : Use the pressure(s) of the nearest source point for target nodes outside of the region (default).
69+
* ``"0"`` : Use the pressure(s) of the nearest source point
70+
for target nodes outside of the region (default).
7071
7172
* ``"1"`` : Set pressures outside of the region to zero.
7273
7374
limit
7475
Number of nearby points considered for interpolation. The minimum
7576
is 5; the default is 20. Lower values reduce processing
7677
time. However, some distorted or irregular meshes will require a
77-
higher LIMIT value to find the points encompassing the target node
78+
higher ``LIMIT`` value to find the points encompassing the target node
7879
in order to define the region for interpolation.
7980
8081
Notes

src/ansys/mapdl/core/_commands/session/processor_entry.py

Lines changed: 0 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -95,45 +95,6 @@ def finish(self, **kwargs):
9595
command = "FINISH,"
9696
return self.run(command, **kwargs)
9797

98-
def map(self, kdim="", kout="", limit="", **kwargs):
99-
"""Maps pressures from source points to target surface elements.
100-
101-
APDL Command: MAP
102-
103-
Parameters
104-
----------
105-
kdim
106-
Interpolation key:
107-
108-
0 or 2 - Interpolation is done on a surface (default).
109-
110-
3 - Interpolation is done within a volume. This option is
111-
useful if the supplied source data is volumetric field
112-
data rather than surface data.
113-
114-
kout
115-
Key to control how pressure is applied when a target node is
116-
outside of the source region:
117-
118-
0 - Use the pressure(s) of the nearest source point for
119-
target nodes outside of the region (default).
120-
121-
1 - Set pressures outside of the region to zero.
122-
123-
limit
124-
Number of nearby points considered for interpolation. The
125-
minimum is 5; the default is 20. Lower values reduce
126-
processing time. However, some distorted or irregular
127-
meshes will require a higher LIMIT value to find the
128-
points encompassing the target node in order to define the
129-
region for interpolation.
130-
131-
Notes
132-
-----
133-
Maps pressures from source points to target surface elements.
134-
"""
135-
return self.run(f"MAP,,{kdim},,{kout},{limit}", **kwargs)
136-
13798
def post1(self, **kwargs):
13899
"""Enters the database results postprocessor.
139100

0 commit comments

Comments
 (0)