Skip to content

Commit

Permalink
DOCS: improving documentation of add mesh link (#5341)
Browse files Browse the repository at this point in the history
  • Loading branch information
anur7 authored Oct 30, 2024
2 parents ae13f36 + dcdc7a8 commit 25c9ca1
Showing 1 changed file with 17 additions and 4 deletions.
21 changes: 17 additions & 4 deletions src/ansys/aedt/core/modules/solve_setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -802,17 +802,17 @@ def add_mesh_link(
apply_mesh_operations=True,
adapt_port=True,
):
"""Add a mesh link to another design.
"""Import mesh from a source design solution to the target design.
Parameters
----------
design : str
Name of the design.
Name of the source design.
solution : str, optional
Name of the solution in the format ``"name : solution_name"``.
Name of the source design solution in the format ``"name : solution_name"``.
If ``None``, the default value is ``name : LastAdaptive``.
parameters : dict, optional
Dictionary of the parameters.
Dictionary of the "mapping" variables from the source design.
If ``None``, the default is `appname.available_variations.nominal_w_values_dict`.
project : str, optional
Name of the project with the design. The default is ``"This Project*"``.
Expand All @@ -837,7 +837,20 @@ def add_mesh_link(
----------
>>> oModule.EditSetup
Examples
--------
>>> from ansys.aedt.core import Maxwell3d
>>> m3d = Maxwell3d(design="source_design")
>>> m3d.create_setup(name="setup1")
The target design is duplicated from the source design and made it active design.
>>> m3d.duplicate_design(name="source_design", save_after_duplicate=True)
The mesh link is assigned to the target design analysis setup.
>>> m3d.setups[0].add_mesh_link(design="source_design", solution=m3d.nominal_adaptive)
>>> m3d.release_desktop()
"""

auto_update = self.auto_update
try:
self.auto_update = False
Expand Down

0 comments on commit 25c9ca1

Please sign in to comment.