Skip to content

Updating docstring in download #1023

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 8, 2022
Merged

Updating docstring in download #1023

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6a1bc90
Fixing docs.
germa89 Apr 6, 2022
fd06246
Improving vimp docstring
germa89 Apr 6, 2022
4f434b9
Updating docstring to `download`. Adding also a check on the chunk_si…
germa89 Apr 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions src/ansys/mapdl/core/_commands/preproc/meshing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2755,17 +2755,17 @@ def vimp(self, vol="", chgbnd="", implevel="", **kwargs):
----------
vol
Number of the volume containing the tetrahedral elements to be
improved. If VOL = ALL (default), improve the tetrahedral elements
in all selected volumes. If VOL = P, graphical picking is enabled
improved. If ``VOL = ALL`` (default), improve the tetrahedral elements
in all selected volumes. If ``VOL = P``, graphical picking is enabled
and all remaining command fields are ignored (valid only in the
GUI). A component name may also be substituted for VOL.
GUI). A component name may also be substituted for ``VOL``.

chgbnd
Specifies whether to allow boundary modification. Boundary
modification includes such things as changes in the connectivity of
the element faces on the boundary and the addition of boundary
nodes. (Also see "Notes" below for important usage information for
CHGBND.)
``CHGBND``.)

0 - Do not allow boundary modification.

Expand All @@ -2782,33 +2782,33 @@ def vimp(self, vol="", chgbnd="", implevel="", **kwargs):

2 - Perform the greatest amount of swapping/smoothing.

3 - Perform the greatest amount of swapping/smoothing, plus additional improvement
techniques (default).
3 - Perform the greatest amount of swapping/smoothing, plus
additional improvement techniques (default).

Notes
-----
VIMP is useful for further improving a volume mesh created in ANSYS
[VMESH], especially quadratic tetrahedral element meshes.
``VIMP`` is useful for further improving a volume mesh created in ANSYS
[``VMESH``], especially quadratic tetrahedral element meshes.

The VIMP command enables you to improve a given tetrahedral mesh by
The ``VIMP`` command enables you to improve a given tetrahedral mesh by
reducing the number of poorly-shaped tetrahedral elements (in
particular, the number of sliver tetrahedral elements)--as well as the
overall number of elements--in the mesh. It also improves the overall
quality of the mesh.

Regardless of the value of the CHGBND argument, boundary mid-nodes can
Regardless of the value of the ``CHGBND`` argument, boundary mid-nodes can
be moved.

When loads or constraints have been placed on boundary nodes or mid-
nodes, and boundary mid-nodes are later moved, ANSYS issues a warning
message to let you know that it will not update the loads or
constraints.

Even when CHGBND = 1, no boundary modification is performed on areas
Even when ``CHGBND = 1``, no boundary modification is performed on areas
and lines that are not modifiable (for example, areas that are adjacent
to other volumes or that contain shell elements, or lines that are not
incident on modifiable areas, contain beam elements, or have line
divisions specified for them [LESIZE]).
divisions specified for them [``LESIZE``]).
"""
command = f"VIMP,{vol},{chgbnd},{implevel}"
return self.run(command, **kwargs)
Expand Down
45 changes: 27 additions & 18 deletions src/ansys/mapdl/core/mapdl_grpc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1477,7 +1477,7 @@ def _get(self, entity, entnum, item1, it1num, item2, it2num):

raise RuntimeError(f"Unsupported type {getresponse.type} response from MAPDL")

def download_project(self, extensions=None, target_dir=None): # pragma: no cover
def download_project(self, extensions=None, target_dir=None):
"""Download all the project files located in the MAPDL working directory.

Parameters
Expand Down Expand Up @@ -1517,6 +1517,8 @@ def download(
): # pragma: no cover
"""Download files from the gRPC instance workind directory

.. warning:: This feature is only available for MAPDL 2021R1 or newer.

Parameters
----------
files : str or List[str] or Tuple(str)
Expand All @@ -1540,27 +1542,19 @@ def download(
recursive : bool
Use recursion when using glob pattern.

.. warning::
This feature is only available for MAPDL 2021R1 or newer.
Notes
-----
There are some considerations to keep in mind when using this command:

.. note::
* The glob pattern search does not search recursively in remote instances.
* In a remote instance, it is not possible to list or download files in different
locations than the MAPDL working directory.
* If you are in local and provide a file path, downloading files
from a different folder is allowed.
However it is not a recommended approach.
* The glob pattern search does not search recursively in remote instances.
* In a remote instance, it is not possible to list or download files in different
locations than the MAPDL working directory.
* If you are in local and provide a file path, downloading files
from a different folder is allowed.
However it is not a recommended approach.

Examples
--------
Download all the simulation files ('out', 'full', 'rst', 'cdb', 'err', 'db', or 'log'):

>>> mapdl.download('all')

Download every single file in the MAPDL workind directory:

>>> mapdl.download('everything')

Download a single file:

>>> mapdl.download('file.out')
Expand All @@ -1569,8 +1563,23 @@ def download(

>>> mapdl.download('file*')

Download every single file in the MAPDL workind directory:

>>> mapdl.download('*.*')

Alternatively, you can download all the files using
:func:`Mapdl.download_project <ansys.mapdl.core.mapdl_grpc.MapdlGrpc.download_project>` (recommended):

>>> mapdl.download_project()

"""

if chunk_size > 4 * 1024 * 1024: # 4MB
raise ValueError(
f"Chunk sizes bigger than 4 MB can generate unstable behaviour in PyMAPDL. "
"Please decrease ``chunk_size`` value."
)

self_files = self.list_files() # to avoid calling it too much

if isinstance(files, str):
Expand Down