Skip to content

Make cut off and drop off names consistent #718

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 7 commits into from
Nov 28, 2024
Merged

Make cut off and drop off names consistent #718

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
bb441f8
Rename 'Cutoff' to 'CutOff' and 'cutoff' to 'cut_off'
greschd Nov 28, 2024
b7c30b6
Rename 'Dropoff' to 'DropOff' and 'dropoff' to 'drop_off'
greschd Nov 28, 2024
c6f46f4
Update doc/source/user_guide/howto/print_model.rst
greschd Nov 28, 2024
7ad8494
Update src/ansys/acp/core/_tree_objects/cut_off_selection_rule.py
greschd Nov 28, 2024
af6fa1d
Update src/ansys/acp/core/_tree_objects/cut_off_selection_rule.py
greschd Nov 28, 2024
ac5307b
Apply suggestions from code review
greschd Nov 28, 2024
9e6dcf8
Merge branch 'main' into feat/make_cut_off_and_drop_off_names_consistent
greschd Nov 28, 2024
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
8 changes: 4 additions & 4 deletions doc/source/api/enum_types.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,12 @@ Enumeration data types
BaseElementMaterialHandling
BooleanOperationType
CutOffGeometryOrientationType
CutoffMaterialHandling
CutoffRuleType
CutOffMaterialHandling
CutOffRuleType
DimensionType
DrapingMaterialModel
DrapingType
DropoffMaterialHandling
DropOffMaterialHandling
DropOffType
EdgeSetType
ElementalDataType
Expand All @@ -42,7 +42,7 @@ Enumeration data types
SolidModelOffsetDirectionType
OffsetType
SnapToGeometryOrientationType
PlyCutoffType
PlyCutOffType
PlyGeometryExportFormat
PlyType
ReinforcingBehavior
Expand Down
4 changes: 2 additions & 2 deletions doc/source/api/mesh_data.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ Mesh data objects
AnalysisPlyNodalData
BooleanSelectionRuleElementalData
BooleanSelectionRuleNodalData
CutoffSelectionRuleElementalData
CutoffSelectionRuleNodalData
CutOffSelectionRuleElementalData
CutOffSelectionRuleNodalData
CylindricalSelectionRuleElementalData
CylindricalSelectionRuleNodalData
ElementSetElementalData
Expand Down
2 changes: 1 addition & 1 deletion doc/source/api/tree_objects.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ ACP objects
CADComponent
CADGeometry
CutOffGeometry
CutoffSelectionRule
CutOffSelectionRule
CylindricalSelectionRule
EdgeSet
ElementSet
Expand Down
2 changes: 1 addition & 1 deletion doc/source/user_guide/howto/print_model.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ The ``hide_empty`` label can be set to ``False`` to also show empty groups:
Cylindrical Selection Rules
Spherical Selection Rules
Tube Selection Rules
Cutoff Selection Rules
Cut Off Selection Rules
Geometrical Selection Rules
Variable Offset Selection Rules
Boolean Selection Rules
Expand Down
6 changes: 3 additions & 3 deletions examples/modeling_features/020-solid_model.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,17 +171,17 @@ def create_virtual_geometry_from_file(
# ---------------
#
# The :class:`.CutOffGeometry` is used to crop elements from the solid model.
cutoff_cad_geom, cutoff_virtual_geom = create_virtual_geometry_from_file(
cut_off_cad_geom, cut_off_virtual_geom = create_virtual_geometry_from_file(
ExampleKeys.CUT_OFF_GEOMETRY_SOLID_MODEL
)
solid_model.create_cut_off_geometry(
name="Cut-off Geometry",
cad_geometry=cutoff_virtual_geom,
cad_geometry=cut_off_virtual_geom,
orientation_type=CutOffGeometryOrientationType.UP,
)

model.update()
plot_model_with_geometry(cutoff_cad_geom)
plot_model_with_geometry(cut_off_cad_geom)


# %%
Expand Down
26 changes: 13 additions & 13 deletions examples/modeling_features/03-advanced-selection-rules.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,37 +179,37 @@
plotter.show()

# %%
# Create a cutoff selection rule
# ------------------------------
# Create a cut-off selection rule
# -------------------------------

# %%
# Add the cutoff CAD geometry to the model.
cutoff_plane_path = get_example_file(ExampleKeys.CUT_OFF_GEOMETRY, WORKING_DIR)
# Add the cut off CAD geometry to the model.
cut_off_plane_path = get_example_file(ExampleKeys.CUT_OFF_GEOMETRY, WORKING_DIR)
cut_off_plane = model.create_cad_geometry()
cut_off_plane.refresh(cutoff_plane_path)
cut_off_plane.refresh(cut_off_plane_path)

# Note: It is important to update the model here, because the root_shapes of the
# cad_geometry are not available until the model is updated.
model.update()

# %%
# Create a virtual geometry from the CAD geometry.
cutoff_virtual_geometry = model.create_virtual_geometry(
name="cutoff_virtual_geometry", cad_components=cut_off_plane.root_shapes.values()
cut_off_virtual_geometry = model.create_virtual_geometry(
name="cut_off_virtual_geometry", cad_components=cut_off_plane.root_shapes.values()
)

# %%
# Create the cutoff selection rule.
cutoff_selection_rule = model.create_cutoff_selection_rule(
name="cutoff_rule",
cutoff_geometry=cutoff_virtual_geometry,
# Create the cut_off selection rule.
cut_off_selection_rule = model.create_cut_off_selection_rule(
name="cut_off_rule",
cut_off_geometry=cut_off_virtual_geometry,
)


# %%
# Assign the cutoff selection rule to the ply. Plot the ply extent with
# Assign the cut_off selection rule to the ply. Plot the ply extent with
# the outline of the geometry.
modeling_ply.selection_rules = [LinkedSelectionRule(cutoff_selection_rule)]
modeling_ply.selection_rules = [LinkedSelectionRule(cut_off_selection_rule)]

model.update()
assert model.elemental_data.thickness is not None
Expand Down
20 changes: 10 additions & 10 deletions src/ansys/acp/core/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,14 +57,14 @@
CoordinateTransformation,
CutOffGeometry,
CutOffGeometryOrientationType,
CutoffMaterialHandling,
CutoffRuleType,
CutoffSelectionRule,
CutOffMaterialHandling,
CutOffRuleType,
CutOffSelectionRule,
CylindricalSelectionRule,
DimensionType,
DrapingMaterialModel,
DrapingType,
DropoffMaterialHandling,
DropOffMaterialHandling,
DropOffSettings,
DropOffType,
EdgeSet,
Expand Down Expand Up @@ -115,7 +115,7 @@
OffsetType,
OrientedSelectionSet,
ParallelSelectionRule,
PlyCutoffType,
PlyCutOffType,
PlyGeometryExportFormat,
PlyType,
PrimaryPly,
Expand Down Expand Up @@ -175,16 +175,16 @@
"CoordinateTransformation",
"CutOffGeometry",
"CutOffGeometryOrientationType",
"CutoffMaterialHandling",
"CutoffRuleType",
"CutoffSelectionRule",
"CutOffMaterialHandling",
"CutOffRuleType",
"CutOffSelectionRule",
"CylindricalSelectionRule",
"DimensionType",
"DirectLaunchConfig",
"DockerComposeLaunchConfig",
"DrapingMaterialModel",
"DrapingType",
"DropoffMaterialHandling",
"DropOffMaterialHandling",
"DropOffSettings",
"DropOffType",
"EdgeSet",
Expand Down Expand Up @@ -245,7 +245,7 @@
"OffsetType",
"OrientedSelectionSet",
"ParallelSelectionRule",
"PlyCutoffType",
"PlyCutOffType",
"PlyGeometryExportFormat",
"SolidModelOffsetDirectionType",
"PlyType",
Expand Down
30 changes: 15 additions & 15 deletions src/ansys/acp/core/_tree_objects/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,10 @@
from .cad_component import CADComponent
from .cad_geometry import CADGeometry, TriangleMesh
from .cut_off_geometry import CutOffGeometry
from .cutoff_selection_rule import (
CutoffSelectionRule,
CutoffSelectionRuleElementalData,
CutoffSelectionRuleNodalData,
from .cut_off_selection_rule import (
CutOffSelectionRule,
CutOffSelectionRuleElementalData,
CutOffSelectionRuleNodalData,
)
from .cylindrical_selection_rule import (
CylindricalSelectionRule,
Expand All @@ -49,12 +49,12 @@
BaseElementMaterialHandling,
BooleanOperationType,
CutOffGeometryOrientationType,
CutoffMaterialHandling,
CutoffRuleType,
CutOffMaterialHandling,
CutOffRuleType,
DimensionType,
DrapingMaterialModel,
DrapingType,
DropoffMaterialHandling,
DropOffMaterialHandling,
DropOffType,
EdgeSetType,
ElementalDataType,
Expand All @@ -72,7 +72,7 @@
MeshImportType,
NodalDataType,
OffsetType,
PlyCutoffType,
PlyCutOffType,
PlyGeometryExportFormat,
PlyType,
ReinforcingBehavior,
Expand Down Expand Up @@ -196,18 +196,18 @@
"CoordinateTransformation",
"CutOffGeometry",
"CutOffGeometryOrientationType",
"CutoffMaterialHandling",
"CutoffRuleType",
"CutoffSelectionRule",
"CutoffSelectionRuleElementalData",
"CutoffSelectionRuleNodalData",
"CutOffMaterialHandling",
"CutOffRuleType",
"CutOffSelectionRule",
"CutOffSelectionRuleElementalData",
"CutOffSelectionRuleNodalData",
"CylindricalSelectionRule",
"CylindricalSelectionRuleElementalData",
"CylindricalSelectionRuleNodalData",
"DimensionType",
"DrapingMaterialModel",
"DrapingType",
"DropoffMaterialHandling",
"DropOffMaterialHandling",
"DropOffSettings",
"DropOffType",
"EdgeSet",
Expand Down Expand Up @@ -276,7 +276,7 @@
"ParallelSelectionRule",
"ParallelSelectionRuleElementalData",
"ParallelSelectionRuleNodalData",
"PlyCutoffType",
"PlyCutOffType",
"PlyGeometryExportFormat",
"PlyType",
"PrimaryPly",
Expand Down
Loading
Loading