Skip to content

Commit 5406134

Browse files
refactor: Update 2d meshing test and doc. (#3965)
In the 2d meshing test and doc, the attributes under advanced options are accessed before setting the advanced options as True. This was showing up as an error message. This is corrected now. --------- Co-authored-by: pyansys-ci-bot <[email protected]>
1 parent 54e98ea commit 5406134

File tree

3 files changed

+17
-8
lines changed

3 files changed

+17
-8
lines changed

doc/changelog.d/3965.maintenance.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Update 2d meshing test and doc.

doc/source/user_guide/meshing/new_meshing_workflows.rst

+6-2
Original file line numberDiff line numberDiff line change
@@ -438,9 +438,11 @@ Generate surface mesh
438438

439439
.. code:: python
440440
441+
# NOTE: Setting `show_advanced_options = True` is required to configure advanced preferences.
442+
# This dependency may be removed in a future release as the API evolves.
443+
two_dim_mesh.generate_initial_surface_mesh.surface_2d_preferences.show_advanced_options = True
441444
two_dim_mesh.generate_initial_surface_mesh.surface_2d_preferences.merge_edge_zones_based_on_labels = "no"
442445
two_dim_mesh.generate_initial_surface_mesh.surface_2d_preferences.merge_face_zones_based_on_labels = "no"
443-
two_dim_mesh.generate_initial_surface_mesh.surface_2d_preferences.show_advanced_options = True
444446
two_dim_mesh.generate_initial_surface_mesh()
445447
446448
two_dim_mesh.add_2d_boundary_layers_child_1.revert()
@@ -452,9 +454,11 @@ Generate surface mesh
452454
two_dim_mesh.add_2d_boundary_layers_child_1()
453455
454456
457+
# NOTE: Setting `show_advanced_options = True` is required to configure advanced preferences.
458+
# This dependency may be removed in a future release as the API evolves.
459+
two_dim_mesh.generate_initial_surface_mesh.surface_2d_preferences.show_advanced_options = True
455460
two_dim_mesh.generate_initial_surface_mesh.surface_2d_preferences.merge_edge_zones_based_on_labels = "no"
456461
two_dim_mesh.generate_initial_surface_mesh.surface_2d_preferences.merge_face_zones_based_on_labels = "no"
457-
two_dim_mesh.generate_initial_surface_mesh.surface_2d_preferences.show_advanced_options = True
458462
two_dim_mesh.generate_initial_surface_mesh()
459463
460464
Switch to solution mode

tests/test_new_meshing_workflow.py

+10-6
Original file line numberDiff line numberDiff line change
@@ -407,15 +407,17 @@ def test_new_2d_meshing_workflow(new_meshing_session_wo_exit):
407407
two_dim_mesh.add_2d_boundary_layers.offset_method_type = "aspect-ratio"
408408
two_dim_mesh.add_2d_boundary_layers.add_child_and_update(defer_update=False)
409409

410+
# NOTE: Setting `show_advanced_options = True` is required to configure advanced preferences.
411+
# This dependency may be removed in a future release as the API evolves.
412+
two_dim_mesh.generate_initial_surface_mesh.surface_2d_preferences.show_advanced_options = (
413+
True
414+
)
410415
two_dim_mesh.generate_initial_surface_mesh.surface_2d_preferences.merge_edge_zones_based_on_labels = (
411416
"no"
412417
)
413418
two_dim_mesh.generate_initial_surface_mesh.surface_2d_preferences.merge_face_zones_based_on_labels = (
414419
"no"
415420
)
416-
two_dim_mesh.generate_initial_surface_mesh.surface_2d_preferences.show_advanced_options = (
417-
True
418-
)
419421
two_dim_mesh.generate_initial_surface_mesh()
420422

421423
two_dim_mesh.add_2d_boundary_layers_child_1.revert()
@@ -426,15 +428,17 @@ def test_new_2d_meshing_workflow(new_meshing_session_wo_exit):
426428
two_dim_mesh.add_2d_boundary_layers_child_1.offset_method_type = "uniform"
427429
two_dim_mesh.add_2d_boundary_layers_child_1()
428430

431+
# NOTE: Setting `show_advanced_options = True` is required to configure advanced preferences.
432+
# This dependency may be removed in a future release as the API evolves.
433+
two_dim_mesh.generate_initial_surface_mesh.surface_2d_preferences.show_advanced_options = (
434+
True
435+
)
429436
two_dim_mesh.generate_initial_surface_mesh.surface_2d_preferences.merge_edge_zones_based_on_labels = (
430437
"no"
431438
)
432439
two_dim_mesh.generate_initial_surface_mesh.surface_2d_preferences.merge_face_zones_based_on_labels = (
433440
"no"
434441
)
435-
two_dim_mesh.generate_initial_surface_mesh.surface_2d_preferences.show_advanced_options = (
436-
True
437-
)
438442
two_dim_mesh.generate_initial_surface_mesh()
439443

440444
# Switch to solution mode

0 commit comments

Comments
 (0)