From 433c35e9ae2ff0c71e7a0c34a01924ccfc7c9579 Mon Sep 17 00:00:00 2001 From: Nellie Shum Date: Fri, 7 Jun 2024 13:33:37 -0400 Subject: [PATCH] Second edits to 24.2 ACP doc --- .../classes_materialdata.md | 18 +-- .../classes_model.md | 133 +++++++++--------- .../classes_plot.md | 55 ++++---- .../classes_scene.md | 4 +- .../acp_module_markdown-2024R2/db_database.md | 14 +- 5 files changed, 109 insertions(+), 115 deletions(-) diff --git a/2024R2_Test/acp_module_markdown-2024R2/classes_materialdata.md b/2024R2_Test/acp_module_markdown-2024R2/classes_materialdata.md index e4caa85af0..bf36acb76b 100644 --- a/2024R2_Test/acp_module_markdown-2024R2/classes_materialdata.md +++ b/2024R2_Test/acp_module_markdown-2024R2/classes_materialdata.md @@ -575,9 +575,9 @@ Generates 2D-plots with the results of interest * **Parameters:** - query: query arguments * **Options:** - - layup:[‘pp’] Production plies - - polar_properties:[‘E1’,’E2’,’G12’] polar plot of laminate stiffess - - text_plot:[‘materials’, ‘angles’, ‘thicknesses’] + - layup: [‘pp’] Production plies + - polar_properties: [‘E1’,’E2’,’G12’] polar plot of laminate stiffess + - text_plot: [‘materials’, ‘angles’, ‘thicknesses’] * **Examples:** ```pycon >>> query={'polar_properties':['E1', 'G12'], layup:['pp'], text_plot:['materials', 'angles', 'thicknesses']} @@ -740,9 +740,9 @@ Generates 2D-plots with the results of interest - query: Query parameters - core_scale_factor: Scale core thickness by this value. * **Options:** - - layup:[‘pp’, ‘ap’] Production Ply and Analysis Plies - - polar_properties:[‘E1’,’E2’,’G12’] polar plot of laminate stiffesses - - text_plot:[‘materials’,’angles’,’thicknesses’] property to show as label in the layup plot + - layup: [‘pp’, ‘ap’] Production Ply and Analysis Plies + - polar_properties: [‘E1’,’E2’,’G12’] polar plot of laminate stiffesses + - text_plot: [‘materials’,’angles’,’thicknesses’] property to show as label in the layup plot * **Examples:** ```pycon >>> query={'polar_properties':['E1', 'G12'], layup:['pp'], text_plot:['materials']} @@ -930,9 +930,9 @@ Generates 2D-plots with the results of interest - query: query parameters - core_scale_factor: Scale core thickness by this value. * **Options:** - - layup:[‘mp’, ‘pp’, ‘ap’] Modeling Ply, Production Plies and Analysis Plies - - polar_properties:[‘E1’,’E2’,’G12’] polar plot of laminate stiffesses - - text_plot:[‘materials’,’thicknesses’,’angles’] text plot shown in the layup plot + - layup: [‘mp’, ‘pp’, ‘ap’] Modeling Ply, Production Plies and Analysis Plies + - polar_properties: [‘E1’,’E2’,’G12’] polar plot of laminate stiffesses + - text_plot: [‘materials’,’thicknesses’,’angles’] text plot shown in the layup plot * **Example:** ```pycon >>> query={'polar_properties':['E1', 'G12'], layup:['pp'], text_plot:['materials']} diff --git a/2024R2_Test/acp_module_markdown-2024R2/classes_model.md b/2024R2_Test/acp_module_markdown-2024R2/classes_model.md index ebc8882ee6..a79421ea95 100644 --- a/2024R2_Test/acp_module_markdown-2024R2/classes_model.md +++ b/2024R2_Test/acp_module_markdown-2024R2/classes_model.md @@ -77,7 +77,7 @@ angle = sign(angle) \* 90° otherwise with const = reference_radius \* sin(nominal_angle) Each layer is a dict with the following properties: -: * fabric: Fabric of the layer (Stackups and Sublaminates are not supported) + * fabric: Fabric of the layer (Stackups and Sublaminates are not supported) * angle: Nominal angle at Reference Radius with respect to the axis of symmetry (in degree) * selection_rule_limits: A dictionary with the entries “upper” and “lower” that define the extent of the plies in axial direction. @@ -88,7 +88,7 @@ Each layer is a dict with the following properties: twice the original thickness of the layer The function generates the following objects: -: - A cylindrical Rosette + - A cylindrical Rosette - An Oriented Selection Set which defines a reference direction along the axial direction of the axisymmetric body - A Lookup Table with the thickness corrections and angles @@ -178,9 +178,9 @@ Copy a Combined Failure Criteria Definition #### copy_edge_set(source) -Copy a edge set -:Parameters: -- source: Source object to copy +Copy an edge set +* **Parameters:** + - source: Source object to copy * **Returns:** New instance of edge set @@ -868,7 +868,7 @@ Exports all ACP composite defintions. Export layup to Composite CAE HDF5 file. -> * **parameters:** +> * **Parameters:** > - path: Save path of the h5 file. > - remove_midside_nodes: Whether midside nodes should be exported or not. > - layup_representation_3d: Whether to compute the 3D lay-up representation of the model. See note. @@ -889,7 +889,7 @@ This can be resolved by exporting sub-parts (element sets). Save composite definitions to HDF5 file. Function is mainly used to exchange composite definitions with ANSYS Workbench -> * **parameters:** +> * **Parameters:** > - path: Save path of the h5 file @@ -944,13 +944,13 @@ Find materials with the given properties or property ranges * **Returns:** A list with materials which match the given properties. If nothing matches an empty list is returned. -Examples: +* **Example:** -```pycon ->>> materials = model.find_materials(E1=100000.0, nu12=0.3) ->>> materials = model.find_materials( name='1') ->>> materials = model.find_materials(E1=[200000.0, 220000.0], nu12=0.3, G12=[4500.0,5500.0]) -``` + ```pycon + >>> materials = model.find_materials(E1=100000.0, nu12=0.3) + >>> materials = model.find_materials( name='1') + >>> materials = model.find_materials(E1=[200000.0, 220000.0], nu12=0.3, G12=[4500.0,5500.0]) + ``` @@ -971,7 +971,7 @@ Geometry node Returns the element label of the closest element with respect to the given point. * **Parameters:** - -point: Tuple of the global coordinates + - point: Tuple of the global coordinates @@ -1239,8 +1239,8 @@ Section computation relative thickness tolerance Reloads the mesh (nodes, elements and named selections) Ignored imported entities are the materials and rosettes. -Parameters: -: - path: New mesh path. Default is the current model path. +* **Parameters:** + - path: New mesh path. Default is the current model path. - format: New format. Default is the current format @@ -1285,7 +1285,7 @@ Save ACP model to .acph5 file Save actual analysis model to disc -> * **parameters:** +> * **Parameters:** > - path Save path of the cdb file @@ -1294,7 +1294,7 @@ Save actual analysis model to disc Save APDL commands for composite definitions of actual model -> * **parameters:** +> * **Parameters:** > - path Save path of the cdb file @@ -1550,13 +1550,13 @@ Edge Set for Rosette #### get_global_coordinates(coordinates) Evaluates the global coordinates of a point given in local rosette coordinates: -CYLINDRICAL, RADIAL and SPHERICAL coord sys type: Give phi and theta in RAD +CYLINDRICAL, RADIAL, and SPHERICAL. Coordinate system type: Give phi and theta in RAD. * **Parameters:** - - (x, y, z): x = x for PARALLEL, r for CYLINDRICAL, RADIAL and SPHERICAL) - -    y = y for PARALLEL, phi for CYLINDRICAL, RADIAL and SPHERICAL - z = z for PARALLEL, CYLINDRICAL, RADIAL and theta for SPHERICAL) + - (x, y, z): + - x = x for PARALLEL, and r for CYLINDRICAL, RADIAL and SPHERICAL + - y = y for PARALLEL, and phi for CYLINDRICAL, RADIAL and SPHERICAL + - z = z for PARALLEL, CYLINDRICAL and RADIAL, and theta for SPHERICAL * **Usage:** ```pycon >>> rosette.get_global_coordinates((1.,2.,3.)) @@ -1566,14 +1566,14 @@ CYLINDRICAL, RADIAL and SPHERICAL coord sys type: Give phi and theta in RAD #### get_global_vector_components(vector) -gets global vector components from local rosette vector components -CYLINDRICAL, RADIAL and SPHERICAL coord sys type: Give phi and theta in RAD +Gets global vector components from local rosette vector components +CYLINDRICAL, RADIAL, and SPHERICAL. Coordiante system type: Give phi and theta in RAD. * **Parameters:** - - (x, y, z): x = x for PARALLEL, r for CYLINDRICAL, RADIAL and SPHERICAL) - -    y = y for PARALLEL, phi for CYLINDRICAL, RADIAL and SPHERICAL - z = z for PARALLEL, CYLINDRICAL, RADIAL and theta for SPHERICAL) + - (x, y, z): + - x = x for PARALLEL, and r for CYLINDRICAL, RADIAL and SPHERICAL + - y = y for PARALLEL, and phi for CYLINDRICAL, RADIAL and SPHERICAL + - z = z for PARALLEL, CYLINDRICAL and RADIAL, and theta for SPHERICAL * **Usage:** ```pycon >>> rosette.get_global_vector_components((1.,2.,3.)) @@ -1589,11 +1589,11 @@ Evaluates the local rosette coordinates of a point given in global coordinates: - (x, y, z): coordinates in global (parallel) coordinates - returns (x,y,z): - - x = x for PARALLEL, r for CYLINDRICAL, RADIAL and SPHERICAL) - y = y for PARALLEL, phi for CYLINDRICAL, RADIAL and SPHERICAL - z = z for PARALLEL, CYLINDRICAL, RADIAL and theta for SPHERICAL) - CYLINDRICAL, RADIAL and SPHERICAL coord sys type: phi and theta in RAD + - x = x for PARALLEL, and r for CYLINDRICAL, RADIAL and SPHERICAL + - y = y for PARALLEL, and phi for CYLINDRICAL, RADIAL and SPHERICAL + - z = z for PARALLEL, CYLINDRICAL and RADIAL, and theta for SPHERICAL + + CYLINDRICAL, RADIAL and SPHERICAL coord sys type: phi and theta in RAD * **Usage:** ```pycon @@ -1610,11 +1610,11 @@ Returns local rosette vector components from global vector components - (x, y, z): components in global (parallel) coordinates - returns (x,y,z): - - x = x for PARALLEL, r for CYLINDRICAL, RADIAL and SPHERICAL) - y = y for PARALLEL, phi for CYLINDRICAL, RADIAL and SPHERICAL - z = z for PARALLEL, CYLINDRICAL, RADIAL and theta for SPHERICAL) - CYLINDRICAL, RADIAL and SPHERICAL coord sys type: phi and theta in RAD + - x = x for PARALLEL, and r for CYLINDRICAL, RADIAL and SPHERICAL + - y = y for PARALLEL, and phi for CYLINDRICAL, RADIAL and SPHERICAL + - z = z for PARALLEL, CYLINDRICAL,and RADIAL, and theta for SPHERICAL + + CYLINDRICAL, RADIAL and SPHERICAL coord sys type: phi and theta in RAD * **Usage:** ```pycon @@ -1705,15 +1705,15 @@ Look-Up Table Class associates scalar or vector values to points -Example: +* **Example:** -```pycon ->>> table = db.models['class40.1'].create_lookup_table1d(name='LookUpTable1D.1') ->>> table.columns['Location'].values = [0,1,2,3] ->>> db.models['class40.1'].lookup_tables['LookUpTable1D.2'].create_column( name='Radius', type='scalar' ) ->>> r = db.models['class40.1'].lookup_tables['LookUpTable1D.2'].columns['Radius'] ->>> r.values = [0,0.3,0.6,1] -``` + ```pycon + >>> table = db.models['class40.1'].create_lookup_table1d(name='LookUpTable1D.1') + >>> table.columns['Location'].values = [0,1,2,3] + >>> db.models['class40.1'].lookup_tables['LookUpTable1D.2'].create_column( name='Radius', type='scalar' ) + >>> r = db.models['class40.1'].lookup_tables['LookUpTable1D.2'].columns['Radius'] + >>> r.values = [0,0.3,0.6,1] + ``` @@ -2439,7 +2439,7 @@ Add Selection Rule to Boolean Selection rule - rule_values: Parameters of the template rule (For instance upper and lower limit of a ParallelSelectionRule) - operation_type: Boolean operation type (intersect, add, remove) -Example: +* **Example:** >>> boolean_rule.add_rule(rule=model.selection_rules[‘ParallelRule.1’],template_rule=True, rule_values=(-20.0, 50.0), operation_type=’intersect’) @@ -3417,12 +3417,12 @@ Copy a modeling ply Creates an new butt joint sequences and adds it to this modeling group * **Parameters:** - -name: Name of the butt joint - -id: ID of the name - -global_ply_nr: Global ply number which orders the ply sequences - -primary_plies: List of tuples (modeling ply, level). Define the source of the thickness between plies. - -secondary_plies: Single or list of modeling plies. Secondary plies inherit the thickness from the primary plies - -active: Boolean whether the butt joint sequence is active or not + - name: Name of the butt joint + - id: ID of the name + - global_ply_nr: Global ply number which orders the ply sequences + - primary_plies: List of tuples (modeling ply, level). Define the source of the thickness between plies. + - secondary_plies: Single or list of modeling plies. Secondary plies inherit the thickness from the primary plies + - active: Boolean whether the butt joint sequence is active or not * **Return:** New butt joint sequence @@ -3436,9 +3436,7 @@ Create Interface Layer - name: Name of the new Interface Layer - id: Optional id of the new Interface Layer - global_ply_nr: Ply number for stacking sequence - - oriented_selection_sets: Oriented Selection Set for the expansion - -    of the Interface Layer + - oriented_selection_sets: Oriented Selection Set for the expansion of the Interface Layer - open_area_sets: Defines the initial crack of a VCCT layer (optional) - active: Interface Layer active. Default True * **Returns:** @@ -3466,9 +3464,7 @@ Create modeling ply - ply_angle: Angle of the Ply Material - number_of_layers: Multiplier of this layer - global_ply_nr: Ply number for stacking sequence - - oriented_selection_sets: Oriented Selection Set for the expansion - -    of the Modeling Ply + - oriented_selection_sets: Oriented Selection Set for the expansion of the Modeling Ply - selection_rules: Element Selection Rules for the Modeling Ply - draping: The type of draping to be used “no_draping”, “evaluate_draping”, or “tabular_values” - draping_seed_point: Start/Seed Point for Draping @@ -3537,9 +3533,7 @@ specified as a target, the modeling plies retain their original global ply numbe * **Parameters:** - source: list of plies to insert at new position - target: position to insert plies. Can be modeling group or sequence entity - - option: where to insert: after\`(default), \`before, or end (for SequenceEntity targets) keep (for - -    ModelingGroup targets) + - option: where to insert: after\`(default), \`before, or end (for SequenceEntity targets) keep (for ModelingGroup targets) - after: paste right after the target - before: paste right before the target - end: paste at the end of the ModelingGroup containing target @@ -4810,14 +4804,14 @@ Exports the suface section cut to BECAS or ANSYS MAPDL - export_strength_limits: Whether to export the strength limits for BECAS. True by default. Ignored if the format is not ‘becas:in’. - mapdl_model_type: The type of the model to be exported to ANSYS MAPDL. Ignored if the format is not ‘ansys:cdb’. - mapdl_model_type: str + mapdl_model_type: str -    - ‘mesh_only’: Only the mesh (elements and nodes) is exported. This is the default. + - ‘mesh_only’: Only the mesh (elements and nodes) is exported. This is the default. - solid_model: The section cut is expanded into a slice of solid elements. -    In addition, the material properties are exported and the element coordinate systems - are alinged with the fiber direction. This model can be used to compute the equivalent - beam properties of the section cut. + In addition, the material properties are exported and the element coordinate systems + are alinged with the fiber direction. This model can be used to compute the equivalent + beam properties of the section cut. * **Usage:** ```pycon >>> section_cut.export_surface_section_cut(r'D:\tmp\section_cut.cdb', 'ansys:cdb', mapdl_model_type='mesh_only') @@ -4843,7 +4837,8 @@ Transforms global coordinates into the local coordinate system of the section cu * **Parameters:** - global_coords: The global coordinates to be transformed. (x, y, z) -Example: section_cut.from_global_to_local((2.3, 1.2, 4.3)) +* **Example:** + >> section_cut.from_global_to_local((2.3, 1.2, 4.3)) diff --git a/2024R2_Test/acp_module_markdown-2024R2/classes_plot.md b/2024R2_Test/acp_module_markdown-2024R2/classes_plot.md index ec9280607c..f0baa3c6bc 100644 --- a/2024R2_Test/acp_module_markdown-2024R2/classes_plot.md +++ b/2024R2_Test/acp_module_markdown-2024R2/classes_plot.md @@ -24,7 +24,7 @@ Copy a plot object. Object of the plot duplicate. **Examples:** -: Make a copy of the thickness plot “My_Thickness_Plot”: + Make a copy of the thickness plot “My_Thickness_Plot”:
```default >>> plot_copy = db.active_model.layup_plots.copy_plot( db.active_model.layup_plots['My_Thickness_Plot'] ) @@ -61,7 +61,7 @@ Create a Angle Plot object. the plot object **Example:** -: Create a angle plot with Data Scope set to Element Set “All_Elements”: + Create a angle plot with Data Scope set to Element Set “All_Elements”:
```default >>> angle_plot = db.active_model.layup_plots.create_angle_plot(self, name="MyPlot", data_scope=db.active_model.element_sets['All_Elements']) @@ -80,7 +80,7 @@ Create a Draping Plot object. the plot object **Example:** -: Create a draping plot with Data Scope set to Element Set “All_Elements”: + Create a draping plot with Data Scope set to Element Set “All_Elements”:
```default >>> draping_plot = db.active_model.layup_plots.create_draping_plot(self, name="MyPlot") @@ -102,7 +102,7 @@ Create a FieldDefinition Plot object. the plot object **Example:** -: Create a field definition plot for field degradation with Data Scope set to Element Set “All_Elements” in ply_wise mode: + Create a field definition plot for field degradation with Data Scope set to Element Set “All_Elements” in ply_wise mode:
```default >>> field_plot = db.active_model.layup_plots.create_field_definition_plot(self, name="MyPlot", field_variable_name="degradation", data_scope=db.active_model.element_sets['All_Elements'], ply_wise = True) @@ -127,7 +127,7 @@ Create a Layup Mapping Plot object. the plot object **Example:** -: Create a thickness plot with Data Scope set to Element Set “All_Elements” in ply_wise mode: + Create a thickness plot with Data Scope set to Element Set “All_Elements” in ply_wise mode:
```default >>> thick_plot = db.active_model.layup_plots.create_layup_mapping_plot(self, name="MyPlot", data_scope=[db.active_model.solid_models['ImportedSolidModel'], ply_wise = True) @@ -154,7 +154,7 @@ Create a Material Plot object. the plot object **Example:** -: Create a material plot with Data Scope set to Element Set “All_Elements” showing the Young Modulus E2: + Create a material plot with Data Scope set to Element Set “All_Elements” showing the Young Modulus E2:
```default >>> E2_plot = db.active_model.layup_plots.create_material_plot(name="E2_Plot", data_scope=[db.active_model.element_sets['All_Elements']], component = 'E2') @@ -179,7 +179,7 @@ Create a Field Plot object. the plot object **Example:** -: Create a field plot with Data Scope set to Element Set “All_Elements” in ply_wise mode:: tbdtbdtbd + Create a field plot with Data Scope set to Element Set “All_Elements” in ply_wise mode:: tbdtbdtbd @@ -201,7 +201,7 @@ Create a Thickness Plot object. the plot object **Example:** -: Create a thickness plot with Data Scope set to Element Set “All_Elements” in ply_wise mode: + Create a thickness plot with Data Scope set to Element Set “All_Elements” in ply_wise mode:
```default >>> thick_plot = db.active_model.layup_plots.create_thickness_plot(self, name="MyPlot", data_scope=db.active_model.element_sets['All_Elements'], ply_wise = True) @@ -233,7 +233,7 @@ Create a User-defined Plot object. the plot object **Example:** -: Create a user-defined plot with Data Scope set to Element Set “All_Elements”: + Create a user-defined plot with Data Scope set to Element Set “All_Elements”:
```default >>> u_plot = db.active_model.layup_plots.create_user_defined_plot(self, name="MyPlot", data_scope=db.active_model.element_sets['All_Elements']) @@ -268,7 +268,7 @@ Create a Deformation Plot object. the plot object **Example:** -: Create a deformation plot with Data Scope set to Element Set “All_Elements” for ‘rotx’: + Create a deformation plot with Data Scope set to Element Set “All_Elements” for ‘rotx’:
```default >>> defo_plot = db.active_model.solutions['Solution.1'].plots.create_deformation_contour_plot(self, name="MyPlot", data_scope=db.active_model.element_sets['All_Elements'], component = 'rotx') @@ -302,7 +302,7 @@ Create a Failure Criterion Plot object. the plot object **Example:** -: Create a failure criterion plot with Data Scope set to Element Set “All_Elements”, showing the inverse reserve factor with the most critical layer per element for failure criterion “MyFC”, and not showing any text.: + Create a failure criterion plot with Data Scope set to Element Set “All_Elements”, showing the inverse reserve factor with the most critical layer per element for failure criterion “MyFC”, and not showing any text.:
```default >>> fc_plot = db.active_model.solutions['Solution.1'].plots.create_failure_plot(self, name="MyPlot", data_scope=db.active_model.element_sets['All_Elements'], component = 'irf', ply_wise = False, show_critical_failure_mode = False, failure_criteria_definition = db.active_model.definitions['MyFC']) @@ -352,7 +352,7 @@ Create a Progressive Damage Plot object. the plot object **Example:** -: Create a progressive damage plot with Data Scope set to Element Set “All_Elements” for ‘e1’ at ‘mid’ in ply_wise mode: + Create a progressive damage plot with Data Scope set to Element Set “All_Elements” for ‘e1’ at ‘mid’ in ply_wise mode:
```default >>> pd_plot = db.active_model.solutions['Solution.1'].plots.create_progressive_damage_plot(self, name="MyPlot", data_scope=db.active_model.element_sets['All_Elements'], component = 'state', spot = 'bot', ply_wise = Flase) @@ -381,7 +381,7 @@ Create a Strain Plot object. the plot object **Example:** -: Create a strain plot with Data Scope set to Element Set “All_Elements” for ‘e1’ at ‘mid’ in ply_wise mode: + Create a strain plot with Data Scope set to Element Set “All_Elements” for ‘e1’ at ‘mid’ in ply_wise mode:
```default >>> strain_plot = db.active_model.solutions['Solution.1'].plots.create_strain_plot(self, name="MyPlot", data_scope=db.active_model.element_sets['All_Elements'], component = 's1', spot = 'mid', ply_wise = True) @@ -410,7 +410,7 @@ Create a Stress Plot object. the plot object **Example:** -: Create a stress plot with Data Scope set to Element Set “All_Elements” for ‘s1’ at ‘mid’ in ply_wise mode: + Create a stress plot with Data Scope set to Element Set “All_Elements” for ‘s1’ at ‘mid’ in ply_wise mode:
```default >>> stress_plot = db.active_model.solutions['Solution.1'].plots.create_stress_plot(self, name="MyPlot", data_scope=db.active_model.element_sets['All_Elements'], component = 's1', spot = 'mid', ply_wise = True) @@ -435,7 +435,7 @@ Create a Temperature Plot object. the plot object **Example:** -: Create a temperature plot with Data Scope set to Element Set “All_Elements” with spot set to ‘mid’ in ply_wise mode: + Create a temperature plot with Data Scope set to Element Set “All_Elements” with spot set to ‘mid’ in ply_wise mode:
```default >>> temp_plot = db.active_model.solutions['Solution.1'].plots.create_temperature_plot(self, name="MyPlot", data_scope=db.active_model.element_sets['All_Elements'], spot = 'mid', ply_wise = True) @@ -468,7 +468,7 @@ Create a User-Defined Plot object. the plot object **Example:** -: Create a user-defined plot with Data Scope set to Element Set “All_Elements”: + Create a user-defined plot with Data Scope set to Element Set “All_Elements”:
```default >>> u_plot = db.active_model.layup_plots.create_user_defined_plot(self, name="MyPlot", data_scope=db.active_model.element_sets['All_Elements']) @@ -508,7 +508,7 @@ Add 1 entity to the Data Scope of a plot. - entity: Entity to be added. Applicable are Element Set, Oriented Selection Set, Modeling Ply, Production Ply, Analysis Ply, and Sampling Point **Example:** -: Add the Element Set “My_ESet” to a my_plot: + Add the Element Set “My_ESet” to a my_plot:
```default >>> my_plot.add_data_scope_entity(entity = db.active_model.element_sets['My_ESet']) @@ -592,7 +592,7 @@ Get data of plot. Data is returned independent of update status of plot, but only if results for the current plot configuration are available, else an empty array is returned. -Examples: +**Examples:** Get data for current ply-wise plot with visible scope set to element set “All_Elements” and with ply1 and ply2 selected:
@@ -632,12 +632,11 @@ Get element indices (ACP internal element numbers starting from 0) of plot Indices are returned independent of update status of plot, but only if results for the current plot configuration are available, else an empty array is returned. **Examples:** -: Get element indices for current plot with visible scope set to element set “All_Elements” and with ply1 and ply2 selected: + Get element indices for current plot with visible scope set to element set “All_Elements” and with ply1 and ply2 selected:
```default >>> eis = my_plot.get_element_indices(visible=db.active_model.element_sets['All_Elements'], selected=[ply1, ply2]) ``` -
Get element indices for current plot with visible scope equal to all objects visible in current scene:
```default @@ -721,7 +720,7 @@ Remove 1 entity to the Data Scope of a plot. - entity: Entity to be removed. Applicable are Element Set, Oriented Selection Set, Modeling Ply, Production Ply, Analysis Ply, and Sampling Point **Example:** -: Remove the Element Set “My_ESet” from my_plot: + Remove the Element Set “My_ESet” from my_plot:
```default >>> my_plot.remove_data_scope_entity(entity = db.active_model.element_sets['My_ESet']) @@ -819,7 +818,7 @@ Get the offset between plies and reference surface. > - selection_scope defined by selected **Example:** -: Get the ply-offsets for the current ply-wise plot with visible scope set to element set “All_Elements” and with ply1 and ply2 selected: + Get the ply-offsets for the current ply-wise plot with visible scope set to element set “All_Elements” and with ply1 and ply2 selected:
```default >>> p_offs = my_contour_plot.get_ply_offsets(visible=db.active_model.element_sets['All_Elements'], selected=[ply1, ply2]) @@ -902,8 +901,8 @@ Get the coordinates of the supporting points. Data is returned independent of update status of plot. -Examples: -: Get coordinates for supporting points defining look-up table plot: +**Example:** + Get coordinates for supporting points defining look-up table plot:
```default >>> coords = my_plot._get_support_point_coordinates() @@ -920,8 +919,8 @@ Get the identifiers for the supporting points. Labels are returned independent of update status of plot. -Examples: -: Get labels for supporting points defining look-up table plot: +**Example:** + Get labels for supporting points defining look-up table plot:
```default >>> coords = my_plot._get_support_point_labels() @@ -938,8 +937,8 @@ Get the scalar values defined at the supporting points. Values are returned independent of update status of plot. -Examples: -: Get scalar values for supporting points defining look-up table plot: +**Example:** + Get scalar values for supporting points defining look-up table plot:
```default >>> coords = my_plot._get_support_point_values() diff --git a/2024R2_Test/acp_module_markdown-2024R2/classes_scene.md b/2024R2_Test/acp_module_markdown-2024R2/classes_scene.md index e8122eae8a..de504854cb 100644 --- a/2024R2_Test/acp_module_markdown-2024R2/classes_scene.md +++ b/2024R2_Test/acp_module_markdown-2024R2/classes_scene.md @@ -104,7 +104,9 @@ Serialize to Python string #### *property* show_element_type -Highlight “shell” or “solid” elements, or use “automatic” to select solid elements if the object belongs to a solid model.Note: Only analysis plies have solid elements. Shell elements are highlighted for modeling and production plies. +Highlight “shell” or “solid” elements, or use “automatic” to select solid elements if the object belongs to a solid model. + +Note: Only analysis plies have solid elements. Shell elements are highlighted for modeling and production plies. diff --git a/2024R2_Test/acp_module_markdown-2024R2/db_database.md b/2024R2_Test/acp_module_markdown-2024R2/db_database.md index aff3541b07..caae836aec 100644 --- a/2024R2_Test/acp_module_markdown-2024R2/db_database.md +++ b/2024R2_Test/acp_module_markdown-2024R2/db_database.md @@ -33,7 +33,7 @@ Function clears the eventually stored update results and deletes the generated d Production and Analysis Plies, Solid Models etc. * **Parameters:** - -model: the ACP model to be cleared + - model: the ACP model to be cleared @@ -100,14 +100,12 @@ Refresh an acph5 db (Workbench mode only) * **Parameters:** - path: file path to acph5 file - - external_sources: nested dict provided by ACP WB Add-in containing all the - -    external sources info (the file path, whether the source was modified, its ID etc.). - The keys of the dict are: [‘model’, ‘materials’, ‘cad_geometries’, ‘imported_solid_models’, ‘pre_db’, ‘solutions’]. + - external_sources: nested dict provided by ACP WB Add-in containing all the external sources info (the file path, whether the source was modified, its ID etc.). + - The keys of the dict are: [‘model’, ‘materials’, ‘cad_geometries’, ‘imported_solid_models’, ‘pre_db’, ‘solutions’]. Values for ‘model’ and ‘materials’ are dicts with the following fields [‘path’, ‘external_id’, ‘modified’]. - Values for ‘cad_geometries’, ‘imported_solid_models’ and ‘pre_db’ are list + - Values for ‘cad_geometries’, ‘imported_solid_models’, and ‘pre_db’ are list of dicts with fields [‘name’, ‘path’, ‘external_id’, ‘modified’]. - Values for ‘solutions’ are dicts with fields [‘name’, ‘path’, ‘external_id’, ‘modified’, ‘renumbering_mapping_paths’] where + - Values for ‘solutions’ are dicts with fields [‘name’, ‘path’, ‘external_id’, ‘modified’, ‘renumbering_mapping_paths’] where renumbering_mapping_paths is a list of file paths. - input_parameters: a dict of (name, value) pairs of WB input parameters. - initialize: specifies whether the acph5 database needs to be initialized (i.e. the file does not @@ -123,7 +121,7 @@ Refresh an acph5 db (Workbench mode only) Reloads the reference surface (mesh) of the model. See reload_mesh in the model for more details * **Parameters:** - -model: the model to be reloaded + - model: the model to be reloaded