Commit edited example files through ICFD and other misc. edits

Author: PipKat

README.rst

@@ -2,18 +2,18 @@ PyDYNA
 ######
 
 PyDYNA is a Pythonic package for providing a more convenient and complete way to
-build an Ansys DYNA input deck, submit it to the Ansys LS-Dyna solver, and
+build an Ansys DYNA input deck, submit it to the Ansys LS-DYNA solver, and
 finally postprocess the results. 
 
 Overview
---------
+========
 In the PyDYNA installation, the ``docker`` directory has two child
 directories:
 
 - ``pre``: Provides the interface for creating DYNA input decks.
-   This service includes highly abstracted APIs for setting up
-   LSN-DYNA input decks. Included are DynaMech, DynaIGA, DynaICFD,
-   DynaSALE, DynaEM, and DynaAirbag.
+  This service includes highly abstracted APIs for setting up
+  LSN-DYNA input decks. Included are DynaMech, DynaIGA, DynaICFD,
+  DynaSALE, DynaEM, and DynaAirbag.
 - ``solver``: Contains the code for interfacing directly with
   the Ansys LS-DYNA solver. Because LS-DYNA is primarily a batch
   solver with very limited interactive capabilities, the code in
@@ -23,7 +23,7 @@ directories:
   input files to the container, start LS-DYNA and monitor its progress,
   and then retrieve results (RST) files.
 
-Once you have results, you can use the Data Processing Framework (DPF),
+Once you have results, you can use the Ansys Data Processing Framework (DPF),
 which is designed to provide numerical simulation users and engineers
 with a toolbox for accessing and transforming simulation data. DPF
 can access data from Ansys solver result files and from several
@@ -74,7 +74,7 @@ For more information, see Python's
 PyDYNA has three installation modes: user, developer, and offline.
 
 Install in user mode
-^^^^^^^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~~~~~~~
 
 Before installing PyDYNA in user mode, make sure you have the latest version of
 `pip`_ with this command:
@@ -105,7 +105,7 @@ Then, install PyDYNA with this command:
         pip install ansys-dyna-core --index-url=https://${PRIVATE_PYPI_ACCESS_TOKEN}@pkgs.dev.azure.com/pyansys/_packaging/pyansys/pypi/simple/
 
 Install in developer mode
-^^^^^^^^^^^^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Installing PyDYNA in developer mode allows you to modify the source and enhance it.
 
@@ -123,11 +123,12 @@ Start by cloning and installing the repository with these commands:
    pip install -e .
 
 Install in offline mode
-^^^^^^^^^^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~~~~~~~~~~
+
 If you lack an internet connection on your installation machine (or you do not have access
 to the private Ansys PyPI packages repository), you should install PyDYNA by downloading
 the wheelhouse archive for your corresponding machine architecture from the
-`Releases Page <https://github.com/pyansys/pydyna/releases>`_ .
+`Releases Page <https://github.com/pyansys/pydyna/releases>`_.
 
 Each wheelhouse archive contains all the Python wheels necessary to install
 PyDYNA from scratch on Windows and Linux for Python 3.8 through 3.11. You can install

doc/source/index.rst

@@ -15,7 +15,7 @@ PyDYNA documentation  |version|
        {% if build_api %}
        autoapi/index
        {% endif %}
-       contributing
        {% if build_examples %}
        examples/index
        {% endif %}
+       contributing

docker/pre/README.rst

@@ -1,11 +1,11 @@
 Build the Docker image for the ``pre`` service
-==============================================
+----------------------------------------------
 
 You must build the Docker image for the PyDNA ``pre`` service and then
 run the image as a container.
 
 Prerequisites
--------------
+~~~~~~~~~~~~~
 
 * Ensure that you have cloned the PyDYNA repository locally with these commands:
 
@@ -28,7 +28,7 @@ Prerequisites
 
 
 Build the Docker image
-----------------------
+~~~~~~~~~~~~~~~~~~~~~~
 
 Once all prerequisites are met, perform these steps to build the Docker image:
 
@@ -57,7 +57,8 @@ Once all prerequisites are met, perform these steps to build the Docker image:
 
 
 Run the image as a container
-----------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
 Perform these steps to run the image as a container:
 
 #. Run this Docker command:

docker/solver/README.rst

@@ -1,11 +1,11 @@
 Build the Docker image for the ``solver`` service
-=================================================
+-------------------------------------------------
 
 You must build the Docker image for the PyDNA ``solver`` service and then
 run the image as a container.
 
 Prerequisites
--------------
+~~~~~~~~~~~~~
 
 * Ensure that you have cloned the PyDYNA repository locally with these commands:
 
@@ -22,7 +22,7 @@ Prerequisites
 
 * If you are building the image on Windows, ensure that the Windows Subsystem for Linux (WSL)
   is installed. For installation information, see Microsoft's
-  `Install Linux on Windows with WSL <https://learn.microsoft.com/en-us/windows/wsl/install>`.
+  `Install Linux on Windows with WSL <https://learn.microsoft.com/en-us/windows/wsl/install>`_.
 
 * Download the latest Linux release artifacts for the Linux Docker container:
   `mppdyna_docker_centos7.zip <https://github.com/ansys/pydyna/releases/download/v0.2.1/mppdyna_docker_centos7.zip>`_.
@@ -31,7 +31,7 @@ Prerequisites
 
 
 Build the Docker image
-----------------------
+~~~~~~~~~~~~~~~~~~~~~~
 
 Once all prerequisites are met, perform these steps to build the Docker image:
 
@@ -59,14 +59,15 @@ Once all prerequisites are met, perform these steps to build the Docker image:
 
 
 Run the image as a container
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
 Perform these steps to run the image as a container:
 
 #. In the ``docker-compose.yml`` file, replace ``<license_server_name>`` with the correct
-  license server hosting the DYNA license.
-  If you are using Ansy Flexlm license 
+   license server hosting the DYNA license.
+   If you are using Ansy Flexlm license 
 
-* Run this Docker command:
+#. Run this Docker command:
 
   .. code:: bash
 

examples/Airbag/README.txt

@@ -1,4 +1,4 @@
 Airbag examples
 ~~~~~~~~~~~~~~~~
 
-These examples show how to create Airbag model.
+These examples show how to create and use an airbag model.

examples/Airbag/airbag_deploy.py

@@ -1,15 +1,14 @@
 """
-Airbag deploy example
----------------------
-
+Airbag deploy
+-------------
 This example shows how to create an airbag deploy model with the PyDNYA ``pre`` service.
 The executable file for LS-DYNA is ``ls-dyna_smp_d_R13.0_365-gf8a97bda2a_winx64_ifort190.exe``.
 
 """
 ###############################################################################
 # Perform required imports
 # ~~~~~~~~~~~~~~~~~~~~~~~~
-# Import  required imports.
+# Peform required imports.
 
 import os
 import sys
@@ -31,7 +30,7 @@
 )
 
 ###############################################################################
-# Manually start the ``pre`` server
+# Manually start the ``pre`` service
 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 # Copy the ``pyDyna/src/ansys/dyna/core/pre/Server``folder to a desired location.
 # Start the ``pre``service at this location by running this command:
@@ -41,7 +40,7 @@
 # Once the ``pre`` servic is running, you can connect a client to it using
 # the hostname and the port. This example uses the default local host and port
 # (``"localhost"`` and ``"50051"`` respectively).
-
+#
 from ansys.dyna.core.pre.dynamaterial import MatRigid, MatFabric
 from ansys.dyna.core.pre import examples
 # sphinx_gallery_thumbnail_path = '_static/pre/airbag/airbag.png'
@@ -50,7 +49,6 @@
 if len(sys.argv) > 1:
     hostname = sys.argv[1]
 
-
 ###############################################################################
 # Start the solution workflow
 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -63,6 +61,7 @@
 path = examples.airbag_deploy + os.sep
 fns.append(path + "airbag_deploy.k")
 airbag_solution.open_files(fns)
+
 ###############################################################################
 # Create standard explicit control cards
 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -80,9 +79,9 @@
 ###############################################################################
 # Define *AIRBAG_SIMPLE_AIRBAG_MODEL* as a keyword
 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-# Using the ``Airbag`` function in the ``DynaMech`` class, create
+# Use the ``Airbag`` function in the ``DynaMech`` class to define
 # *AIRBAG_SIMPLE_AIRBAG_MODEL* as a keyword. While LS-DYNA has many different
-# airbag models, PyDNYA currently supports only one airbag model:
+# airbag models, PyDYNA currently supports only one airbag model,
 # SIMPLE_AIRBAG_MODEL. If you have an urgent need for PyDYNA to support
 # another airbag model, email `[email protected] <mailto:[email protected]>`_.
 
@@ -108,9 +107,9 @@
 airbagdeploy.add(rigidwall)
 
 ###############################################################################
-# Define a contact *NODES_TO_SURFACE*
-# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-# Define a contact NODES_TO_SURFACE by passing a master part set and a slave
+# Define a node-to-surface contact
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+# Define a node-to-surface contact by passing a master part set and a slave
 # part set.
 
 contact = Contact(category=ContactCategory.NODES_TO_SURFACE)
@@ -178,10 +177,10 @@
 airbagdeploy.parts.add(airbagpart)
 
 ###############################################################################
-# Define database outputs in ASCII and binary
-# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-# Use the ``set_output_database()`` and ``create_database_binary``methods to define the
-# output frequency of the ASCII and binary D3PLOT files. The, use the ``save_file()``
+# Define database outputs
+# ~~~~~~~~~~~~~~~~~~~~~~~
+# Use the ``set_output_database()`` and ``create_database_binary()`` methods to define the
+# output frequency of the ASCII and binary D3PLOT files. Then, use the ``save_file()``
 # method to write out the model as an input DYNA key file.
 
 airbag_solution.set_output_database(

examples/Airbag/airbag_post.py

@@ -1,56 +1,73 @@
 """
-Airbag deploy post processing example
--------------------------------------
-
-This example show how to animate the d3plot and display the stress on the airbag.
+Airbag deploy postprocessing
+----------------------------
+This example shows how to animate the d3plot and display the stress on the airbag.
 
 """
+###############################################################################
+# Perform required imports
+# ~~~~~~~~~~~~~~~~~~~~~~~~
+# Import  required imports.
+#
 from ansys.dpf import core as dpf
 from ansys.dpf.core import examples
+
 ###############################################################################
 # Connect to DPF
 # ~~~~~~~~~~~~~~
+# Connect to DPF Server.
+#
 dpf.connect_to_server()
 
 ###############################################################################
 # Load the model
 # ~~~~~~~~~~~~~~
-# Load the model and print the contents of the model. All parts in the model are shell parts.
-# Model info lists the result components as well as the number of states available in the d3plot
+# Load the model and print the contents of the model. All parts in the model
+# are shell parts. Model information includes the result components and the
+# number of states available in the d3plot.
 # 
 """ ds = dpf.DataSources()
 ds.set_result_file_path(r'D:\PYDYNA_BETA_V.0.1\example-data\pydyna\Airbag\d3plot', 'd3plot')
 model = dpf.Model(ds)
 print(model) """
 
 ###############################################################################
-# Let's extract the stress on all the parts. The stress field container is scoped to all time frequencies
-# so as to be able to animate the change in stress on the airbag fabric.
+# Extract stress on all parts
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~
+# Extract the stress on all the parts. The stress fields container is scoped to
+# all time frequencies to be able to animate the change in stress on the
+# airbag fabric.
 # 
 """ stress = model.results.stress.on_all_time_freqs()
 stress.inputs.data_sources(ds)
 stress.inputs.requested_location.connect("Nodal")
 fieldsStr = stress.outputs.fields_container()"""
 
 ###############################################################################
-# Since the shell stress is reported at three through thickness points as default
-# in the d3plot file, the next few lines depicts how the stress
-# can be extracted on the mid integration point.
+# Extract stress on mid integration point
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+# In the d3plot file, the shell stress is reported at three through-thickness
+# points by default. Extract the stress on the mid integration point.
 # 
 """ shell_layer_extract = dpf.operators.utility.change_shell_layers()
 shell_layer_extract.inputs.fields_container.connect(fieldsStr)
 shell_layer_extract.inputs.e_shell_layer.connect(dpf.common.shell_layers.mid.value)
 fields_top = shell_layer_extract.outputs.fields_container_as_fields_container() """
 
 ###############################################################################
-# Plot the deformed state at 9ms
+# Plot deformed state
+# ~~~~~~~~~~~~~~~~~~~
+# Plot the deformed state at 9ms.
 # 
 """ N = fields_top[19]
 D = model.results.displacement(time_scoping=[19]).eval()
 N.plot(deform_by=D[0],show_edges=False) """
 
 ###############################################################################
-# Finally display the stress field and set the mesh to deform by the displacement of the nodes.
+# Display stress field and set mesh
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+# Display the stress field and set the mesh to deform by the displacement of
+# the nodes.
 # 
 """ disp = model.results.displacement.on_all_time_freqs.eval()
 fields_top.animate(deform_by=disp,show_edges=False) """

examples/EM/README.txt

@@ -1,4 +1,4 @@
 EM examples
 ~~~~~~~~~~~~
 
-These examples show how to create electromagnetic model.
+These examples show how to create and use electromagnetic models.

examples/EM/em_resistive_heating.py

@@ -2,8 +2,9 @@
 Resistive heating
 =================
 
-This example introduces the user to the minimum number of keywords required to turn on the EM resistive heating solver. \n
-LS-DYNA version : ls-dyna_smp_d_R13.1_138-g8429c8a10f_winx64_ifort190.exe
+This example shows the minimum number of keywords required to turn on the
+EM resistive heating solver. The executable file for LS-DYNA is
+``ls-dyna_smp_d_R13.1_138-g8429c8a10f_winx64_ifort190.exe``.
 """
 
 import os

examples/EM/em_resistive_heating_2d.py

@@ -1,9 +1,9 @@
 """
 Resistive heating 2D
 ====================
+This example of a simple metal bar imposes potential on both ends. The executable
+file for LS-DYNA is ``ls-dyna_smp_d_R13.1_138-g8429c8a10f_winx64_ifort190.exe``.
 
-This example features a simple metal bar where potential is imposed on both ends. \n
-LS-DYNA version : ls-dyna_smp_d_R13.1_138-g8429c8a10f_winx64_ifort190.exe
 """
 
 import os