Edits to 24.2 ACP API doc

2024R2_Test/acp_module_markdown-2024R2/classes_plot.md

@@ -56,7 +56,7 @@ Create a Angle Plot object.
   - show_on_solids: True or False (default). Whether to show the results on the shell or solid model (if present).
   - show_on_section_cuts: Whether to show the results on the surface section cuts as well. Default is True.
   - show_ply_offsets: True or False (default). Whether to display ply-wise visualizations with ply offsets or not.
-  - ply_offset_scale_factor: Scale factor for the offsets of the visualized plies if show_ply_offsets=True.
+  - ply_offset_scale_factor: Scale factor for the offsets of the visualized plies if show_ply_offsets = ``True``.
 * **Returns:**
   The plot object.
 
@@ -147,7 +147,7 @@ Create a Material Plot object.
   - data_scope: Object(s) defining the scope for which data is computed and returned. Applicable are: Element Set, Oriented Selection Set, Modeling Ply, Sampling Point.
   - show_on_solids: True or False (default). Whether to show the results on the shell or solid model (if present).
   - show_ply_offsets: True or False (default). Whether to display ply-wise visualizations with ply offsets or not.
-  - ply_offset_scale_factor: Scale factor for the offsets of the visualized plies if show_ply_offsets=True.
+  - ply_offset_scale_factor: Scale factor for the offsets of the visualized plies if show_ply_offsets = ``True``.
   - component: Specifies the component.
   - use_all_available_fields: True (default) or False. Whether to enable all available field variables in the evaluation or not.
 * **Returns:**
@@ -178,9 +178,6 @@ Create a Field Plot object.
 * **Returns:**
   The plot object.
 
-**Example:**
-  Create a field plot with Data Scope set to Element Set “All_Elements” in ply_wise mode:: tbdtbdtbd.
-
 <a id="compolyx.plot_data.LayupPlotDict.create_thickness_plot"></a>
 
 #### create_thickness_plot(name=None, id=None, scope_entire_model=True, data_scope=[], ply_wise=False, show_on_solids=False, show_ply_offsets=False, ply_offset_scale_factor=1.0, add_to_active_set=True, locked=False, component='thickness')
@@ -195,7 +192,7 @@ Create a Thickness Plot object.
   - ply_wise: True or False (default). Decides whether to return the thickness of the individual plies or of the whole stack of plies present at an element.
   - show_on_solids: True or False (default). Whether to show the results on the shell or solid model (if present).
   - show_ply_offsets: True or False (default). Whether to display ply-wise visualizations with ply offsets or not.
-  - ply_offset_scale_factor: Scale factor for the offsets of the visualized plies if show_ply_offsets=True.
+  - ply_offset_scale_factor: Scale factor for the offsets of the visualized plies if show_ply_offsets = ``True``.
   - component: Specifies the component.
 * **Returns:**
   The plot object.
@@ -221,14 +218,14 @@ Create a user-defined plot object.
   - data_scope: Object(s) defining the scope for which data is computed and returned. Applicable are: Element Set, Oriented Selection Set, Modeling Ply, Sampling Point.
   - user_data: Retrieve or provide the user data, which must obey the order of the user_element_indices or user_element_labels, respectively.
   - user_text: Access to the user-defined text of the plot. Empty strings can be inserted when no labels are to be shown for certain elements.
-  - user_script: The body of the script to be executed on update if user_script_enabled = True.
+  - user_script: The body of the script to be executed on update if user_script_enabled = ``True``.
   - user_script_enabled: Boolean that controls if a custom script is run on update.
   - show_on_solids: True or False (default). Whether to show the results on the shell or solid model (if present).
   - show_user_text: True or False (default). Whether to show the text, which the user provided.
   - text_threshold_type: “show_all” (default), “show_only_values_above_threshold”, “show_only_values_below_threshold. Threshold can be set using the text_threshold property
   - text_threshold: Threshold used for showing text if text_threshold_type is not “show_all”
   - show_ply_offsets: True or False (default). Whether to display ply-wise visualizations with ply offsets or not.
-  - ply_offset_scale_factor: Scale factor for the offsets of the visualized plies if show_ply_offsets=True.
+  - ply_offset_scale_factor: Scale factor for the offsets of the visualized plies if show_ply_offsets = ``True``.
 * **Returns:**
   The plot object.
 
@@ -290,13 +287,13 @@ Create a Failure Criterion Plot object.
   - ply_wise: True or False (default). Decides whether to evaluate for individual plies or pick the most critical ply per element.
   - show_on_solids: True or False (default). Whether to show the results on the shell or solid model (if present).
   - show_critical_failure_mode: True (default) or False. Whether to show the text, which indicates the mode of failure.
-  - show_critical_layer: Ture or False (default). Whether to show the text, which indicates the number of the failing ply (only if ply_wise = False).
+  - show_critical_layer: Ture or False (default). Whether to show the text, which indicates the number of the failing ply (only if ply_wise = ``False``).
   - show_critical_load_case: Ture or False (default). Whether to show the text, which indicates the load case for which failure is predicted (only for Envelope Solutions).
   - text_threshold: Threshold value above/below which text for an element is hidden. This helps to declutter the text plot.
   - text_threshold_auto: True (default) or False. If True, suggested text_thersold values are used.
   - failure_criteria_definition: Object of the failure criterion definition to be used for this plot.
   - show_ply_offsets: True or False (default). Whether to display ply-wise visualizations with ply offsets or not.
-  - ply_offset_scale_factor: Scale factor for the offsets of the visualized plies if show_ply_offsets=True.
+  - ply_offset_scale_factor: Scale factor for the offsets of the visualized plies if show_ply_offsets = ``True``.
   - solution_set: Selection of the Solution Set.
 * **Returns:**
   The plot object.
@@ -322,7 +319,7 @@ Create a Material Plot object.
   - data_scope: Object(s) defining the scope for which data is computed and returned. Applicable are: Element Set, Oriented Selection Set, Modeling Ply, Sampling Point.
   - show_on_solids: True or False (default). Whether to show the results on the shell or solid model (if present).
   - show_ply_offsets: True or False (default). Whether to display ply-wise visualizations with ply offsets or not.
-  - ply_offset_scale_factor: Scale factor for the offsets of the visualized plies if show_ply_offsets=True.
+  - ply_offset_scale_factor: Scale factor for the offsets of the visualized plies if show_ply_offsets = ``True``.
   - component: Specifies the component.
   - use_all_available_fields: True (default) or False. Whether to enable all available field variables in the evaluation or not.
   - solution_set: Selection of the Solution Set.
@@ -342,11 +339,11 @@ Create a Progressive Damage Plot object.
   - scope_entire_model: If true, then the scope of this plot is the entire model. If not, then set to false and use the data_scope to specify a sub scope.
   - data_scope: Object(s) defining the scope for which data is computed and returned. Applicable are: Element Set, Oriented Selection Set, Modeling Ply, Sampling Point.
   - component: ‘state’, ‘fc’, ‘ft’, ‘mc’, ‘mt’, ‘s’ which are damage status, fiber compressive/tension damage, matrix compressive/tension damage and shear damage.
-  - spot: ‘bot’, ‘top’, ‘mid’ (only if ply_wise = True)
+  - spot: ‘bot’, ‘top’, ‘mid’ (only if ply_wise = ``True``)
   - ply_wise: True (default) or False. Decides whether to evaluate for individual plies or return the result of the finite element.
   - show_on_solids: True or False (default). Whether to show the results on the shell or solid model (if present).
   - show_ply_offsets: True or False (default). Whether to display ply-wise visualizations with ply offsets or not.
-  - ply_offset_scale_factor: Scale factor for the offsets of the visualized plies if show_ply_offsets=True.
+  - ply_offset_scale_factor: Scale factor for the offsets of the visualized plies if show_ply_offsets = ``True``.
   - solution_set: Selection of the Solution Set.
 * **Returns:**
   The plot object.
@@ -371,11 +368,11 @@ Create a Strain Plot object.
   - scope_entire_model: If true, then the scope of this plot is the entire model. If not, then set to false and use the data_scope to specify a sub scope.
   - data_scope: Object(s) defining the scope for which data is computed and returned. Applicable are: Element Set, Oriented Selection Set, Modeling Ply, Sampling Point.
   - component: ‘e1’, ‘e2’, ‘e3’, ‘e12’, ‘e23’, ‘e13’, ‘eI’, ‘eII’, ‘eIII’.
-  - spot: ‘bot’, ‘top’, ‘mid’ (only if ply_wise = True).
+  - spot: ‘bot’, ‘top’, ‘mid’ (only if ply_wise = ``True``).
   - ply_wise: True (default) or False. Decides whether to evaluate for individual plies or return the result of the finite element.
   - show_on_solids: True or False (default). Whether to show the results on the shell or solid model (if present).
   - show_ply_offsets: True or False (default). Whether to display ply-wise visualizations with ply offsets or not.
-  - ply_offset_scale_factor: Scale factor for the offsets of the visualized plies if show_ply_offsets=True.
+  - ply_offset_scale_factor: Scale factor for the offsets of the visualized plies if show_ply_offsets = ``True``.
   - solution_set: Selection of the Solution Set.
 * **Returns:**
   The plot object.
@@ -400,11 +397,11 @@ Create a Stress Plot object.
   - scope_entire_model: If true, then the scope of this plot is the entire model. If not, then set to false and use the data_scope to specify a sub scope.
   - data_scope: Object(s) defining the scope for which data is computed and returned. Applicable are: Element Set, Oriented Selection Set, Modeling Ply, Sampling Point.
   - component: ‘s1’, ‘s2’, ‘s3’, ‘s12’, ‘s23’, ‘s13’, ‘sI’, ‘sII’, ‘sIII’.
-  - spot: ‘bot’, ‘top’, ‘mid’ (only if ply_wise = True).
+  - spot: ‘bot’, ‘top’, ‘mid’ (only if ply_wise = ``True``).
   - ply_wise: True (default) or False. Decides whether to evaluate for individual plies or return the result of the finite element.
   - show_on_solids: True or False (default). Whether to show the results on the shell or solid model (if present).
   - show_ply_offsets: True or False (default). Whether to display ply-wise visualizations with ply offsets or not.
-  - ply_offset_scale_factor: Scale factor for the offsets of the visualized plies if show_ply_offsets=True.
+  - ply_offset_scale_factor: Scale factor for the offsets of the visualized plies if show_ply_offsets = ``True``.
   - solution_set: Selection of the Solution Set.
 * **Returns:**
   The plot object.
@@ -428,7 +425,7 @@ Create a Temperature Plot object.
   - active: Whether the plot is active or not.
   - scope_entire_model: If true, then the scope of this plot is the entire model. If not, then set to false and use the data_scope to specify a sub scope.
   - data_scope: Object(s) defining the scope for which data is computed and returned. Applicable are: Element Set, Oriented Selection Set, Modeling Ply, Sampling Point
-  - spot: ‘bot’, ‘top’, ‘mid’ (only if ply_wise = True)
+  - spot: ‘bot’, ‘top’, ‘mid’ (only if ply_wise = ``True``)
   - ply_wise: True (default) or False. Decides whether to evaluate for individual plies or return the result of the finite element.
   - solution_set: Selection of the Solution Set.
 * **Returns:**
@@ -455,14 +452,14 @@ Create a user-defined plot object.
   - data_scope: Object(s) defining the scope for which data is computed and returned. Applicable are: Element Set, Oriented Selection Set, Modeling Ply, Sampling Point.
   - user_data: Retrieve or provide the user data, which must obey the order of the user_element_indices or user_element_labels, respectively.
   - user_text: Access to the user-defined text of the plot. Empty strings can be inserted when no labels are to be shown for certain elements.
-  - user_script: The body of the script to be executed on update if user_script_enabled = True.
+  - user_script: The body of the script to be executed on update if user_script_enabled = ``True``.
   - user_script_enabled: Boolean that controls if a custom script is run on update.
   - show_on_solids: True or False (default). Whether to show the results on the shell or solid model (if present).
   - show_user_text: True or False (default). Whether to show the text, which the user provided.
   - text_threshold_type: “show_all” (default), “show_only_values_above_threshold”, “show_only_values_below_threshold. Threshold can be set using the text_threshold property.
   - text_threshold: Threshold used for showing text if text_threshold_type is not “show_all”
   - show_ply_offsets: True or False (default). Whether to display ply-wise visualizations with ply offsets or not.
-  - ply_offset_scale_factor: Scale factor for the offsets of the visualized plies if show_ply_offsets=True.
+  - ply_offset_scale_factor: Scale factor for the offsets of the visualized plies if show_ply_offsets = ``True``.
   - solution_set: Selection of the Solution Set.
 * **Returns:**
   The plot object.

2024R2_Test/acp_module_markdown-2024R2/classes_postprocessing_definitions.md

@@ -39,37 +39,37 @@ For instance, MaxStressCriterion(s1=1, s2=1, s3=0, s12=1, s13=0, s23=0, wf_s1=1,
 
 #### *property* s1
 
-Specifies whether to compute max stress in 1 direction.
+Specifies whether to compute max stress in the material 1 direction.
 
 <a id="compolyx.MaxStressCriterion.s12"></a>
 
 #### *property* s12
 
-Specifies whether to compute max shear stress in 1 direction.
+Specifies whether to compute max shear stress in the material 1 direction.
 
 <a id="compolyx.MaxStressCriterion.s13"></a>
 
 #### *property* s13
 
-Specifies whether to compute max normal stress in 1 direction.
+Specifies whether to compute max normal stress in the material 1 direction.
 
 <a id="compolyx.MaxStressCriterion.s2"></a>
 
 #### *property* s2
 
-Specifies whether to compute max stress in 2 direction.
+Specifies whether to compute max stress in the material 2 direction.
 
 <a id="compolyx.MaxStressCriterion.s23"></a>
 
 #### *property* s23
 
-Specifies whether to compute max normal stress in 2 direction.
+Specifies whether to compute max normal stress in the material 2 direction.
 
 <a id="compolyx.MaxStressCriterion.s3"></a>
 
 #### *property* s3
 
-Specifies whether to compute max stress in 3 direction.
+Specifies whether to compute max stress in the material 3 direction.
 
 <a id="compolyx.MaxStressCriterion.serialize"></a>
 

2024R2_Test/acp_module_markdown-2024R2/classes_scene.md

@@ -68,7 +68,7 @@ Logo type: default or black.
 
 #### *property* mode
 
-Current ACP mode (pre or post).
+Current ACP mode, ACP (Pre) or ACP (Post) - UNSUPPORTED.
 
 <a id="compolyx.Scene.projection"></a>
 

2024R2_Test/acp_module_markdown-2024R2/classes_solution.md

@@ -53,7 +53,7 @@ Resets the failure criteria results for each layered element.
 
 #### *property* enabled
 
-Defines whether this object is currently enabled. Mainly defined through the current application mode pre or post.
+Defines whether this object is currently enabled. Mainly defined through the current application mode, ACP (Pre) or ACP (Post) - UNSUPPORTED.
 
 <a id="compolyx.Solution.export_results_to_csv"></a>
 
@@ -69,7 +69,7 @@ Exports the shell results of the selected entities to a .csv file.
   - solids: Boolean whether to take the results of the solid elements or not. Default is False (results of shells).
   - spots: Layer positions for which the results are exported. Allowed are ‘bot’, ‘mid’, ‘top’, ‘bot/top’, and ‘all’.
 
-Export results of solid models: Select the element set which is selected in the extrusion settings.
+Export results of solid models: Choose the element set which is selected in the extrusion settings.
 
 * **Usage:**
   ```pycon
@@ -142,7 +142,7 @@ Query results from the solution.
     CombinedFailureCriteria object or as string such as
     ‘strains’, ‘stresses’, ‘laminate_forces’, ‘deformations’, ‘temperatures’, or ‘progressive_damage’.
   - options: Dict with the additional options used to fully configure the definition.
-    - stresses: options={“eval_ins”:True} to enable the interlaminar normal stress evaluation for shells.
+    - stresses: options = ``{“eval_ins”:True}`` to enable the interlaminar normal stress evaluation for shells.
   - position: Position where data is queried:
     - nodal, centroid, element_nodal, integration_point, or element_results.
   - selection: The selection set determines the selected nodes and elements.
@@ -271,7 +271,7 @@ Clear Solution Sets of Envelope Solution.
 
 #### *property* enabled
 
-Whether this object is currently enabled or not. Mainly defined through the current application mode pre or post.
+Whether this object is currently enabled or not. Mainly defined through the current application mode, ACP (Pre) or ACP (Post) - UNSUPPORTED.
 
 <a id="compolyx.EnvelopeSolution.remove_solution_set"></a>
 

2024R2_Test/acp_module_markdown-2024R2/db_database.md

@@ -109,7 +109,7 @@ Refresh an acph5 db (Workbench mode only).
       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 yet exist).
-  - unit_system_type: Defines the unit system of the main/downstream ACP file. (TODO: Do we need this?)
+  - unit_system_type: Defines the unit system of the main/downstream ACP file.
   - upgrade_from: Defines the path of a legacy (.acp) ACP DB that has to be upgrade to the new format (load composite definitions and save as ACPH5).
 
 <a id="compolyx.DB.reload"></a>