Merge branch 'main' into zhanqun/prev5

Author: zhangzhanqun

.github/workflows/ci_cd.yml

@@ -25,7 +25,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: PyAnsys documentation style checks
-        uses: pyansys/actions/doc-style@v4
+        uses: ansys/actions/doc-style@v4
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
 
@@ -49,6 +49,18 @@ jobs:
           pip install --upgrade build
           pip install .[doc]
 
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: DPF server activation
+        run: |
+          docker pull ghcr.io/ansys/dpf-core:22.2dev
+          docker run -d --name dpfserver -p 50054:50052 ghcr.io/ansys/dpf-core:22.2dev && echo "DPF Server active on port 50054."
+
       - name: Run server
         run: |
           cd src/ansys/dyna/core/pre/Server
@@ -84,13 +96,19 @@ jobs:
         with:
           name: server-logs-docs
           path: src/ansys/dyna/core/pre/Server/server_output_docs.txt
+      
+      - name: DPF Logs (on screen)
+        if: always()
+        run: |
+          docker logs dpfserver
+          docker stop dpfserver
 
   style:
     name: Code style
     runs-on: ubuntu-latest
     steps:
       - name: PyAnsys code style checks
-        uses: pyansys/actions/code-style@v4
+        uses: ansys/actions/code-style@v4
         with:
           python-version: ${{ env.MAIN_PYTHON_VERSION }}
 
@@ -106,7 +124,7 @@ jobs:
 
     steps:
       - name: Build wheelhouse and perform smoke test
-        uses: pyansys/actions/build-wheelhouse@v4
+        uses: ansys/actions/build-wheelhouse@v4
         with:
           library-name: ${{ env.PACKAGE_NAME }}
           library-namespace: ${{ env.PACKAGE_NAMESPACE }}
@@ -174,7 +192,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Build library source and wheel artifacts
-        uses: pyansys/actions/build-library@v4
+        uses: ansys/actions/build-library@v4
         with:
           library-name: ${{ env.PACKAGE_NAME }}
           python-version: ${{ env.MAIN_PYTHON_VERSION }}
@@ -186,14 +204,14 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Release to the private PyPI repository
-        uses: pyansys/actions/release-pypi-private@v4
+        uses: ansys/actions/release-pypi-private@v4
         with:
           library-name: ${{ env.PACKAGE_NAME }}
           twine-username: "__token__"
           twine-token: ${{ secrets.PYANSYS_PYPI_PRIVATE_PAT }}
 
       - name: Release to GitHub
-        uses: pyansys/actions/release-github@v4
+        uses: ansys/actions/release-github@v4
         with:
           library-name: ${{ env.PACKAGE_NAME }}
 
@@ -204,7 +222,7 @@ jobs:
     needs: [package]
     steps:
       - name: Deploy the latest documentation
-        uses: pyansys/actions/doc-deploy-dev@v4
+        uses: ansys/actions/doc-deploy-dev@v4
         with:
           cname: ${{ env.DOCUMENTATION_CNAME }}
           token: ${{ secrets.GITHUB_TOKEN }}
@@ -216,7 +234,7 @@ jobs:
     needs: [release]
     steps:
       - name: Deploy the stable documentation
-        uses: pyansys/actions/doc-deploy-stable@v4
+        uses: ansys/actions/doc-deploy-stable@v4
         with:
           cname: ${{ env.DOCUMENTATION_CNAME }}
           token: ${{ secrets.GITHUB_TOKEN }}

README.rst

@@ -113,6 +113,15 @@ and install using the preceding command.
 
 Consider installing using a `virtual environment <https://docs.python.org/3/library/venv.html>`_.
 
+Install Solver Docker
+^^^^^^^^^^^^^^^^^^^^^
+
+Once pydyna is installed, the docker-compose.yml file to build and launch the dyna solver docker can be located
+under /src/ansys/dyna/core/solver/. The yml file can be copied locally. To run the docker the following command can be used
+
+.. code:: bash
+    
+	docker-compose up
 
 Documentation
 -------------

examples/Airbag/airbag_deploy.py

@@ -1,9 +1,11 @@
 """
+.. _ref_airbag_deploy:
 Airbag deploy example
-=====================
+---------------------
 
-This example show how to create an Airbag deploy model with Pydyna-pre module. \n
+This example show how to create an Airbag deploy model with Pydyna-pre module.
 LS-DYNA version : ls-dyna_smp_d_R13.0_365-gf8a97bda2a_winx64_ifort190.exe
+
 """
 
 import os
@@ -24,25 +26,62 @@
     ShellPart,
     ShellFormulation,
 )
+
+###############################################################################
+# Manually start the dyna.core.pre server
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+# Copy the folder pyDyna/src/ansys/dyna/core/pre/Server to a desired location
+# Start the dyna.core.pre server at this location as shown below
+#
+# python kwserver.py
+#
+# Now the pre server is up and running and is waiting to be connected to the client
+# Connect to the server using the hostname and the port. In this example, default
+# "localhost" and port "50051" are used
+
 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'
 
 hostname = "localhost"
 if len(sys.argv) > 1:
     hostname = sys.argv[1]
+
+
+###############################################################################
+# Start the Solution workflow
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~
+# Dynasolution class is like a workflow orchestrator.
+# It inherits methods from other classes and helps create a complete workflow
+#
 airbag_solution = DynaSolution(hostname)
 fns = []
 # path = sys.path[0] + os.sep + "input" + os.sep + "airbag_deploy" + os.sep
 path = examples.airbag_deploy + os.sep
 fns.append(path + "airbag_deploy.k")
 airbag_solution.open_files(fns)
-
+###############################################################################
+# Create standard explicit control cards
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+# Dynasolution class is like a workflow orchestrator.
+# It inherits methods from other classes and helps create a complete workflow.
+# "set_termination" method here is used to set the termination time to 0.03 in *CONTROL_TERMINATION.
+# DynaMech class automatically generates the common control cards used in
+# explicit problems. CONTROL_ACCURACY, CONTACT, BULK VISCOCITY, CONTACT
+# are all automatically generated
 airbag_solution.set_termination(0.03)
 
 airbagdeploy = DynaMech()
 airbag_solution.add(airbagdeploy)
 
+###############################################################################
+# Define *AIRBAG_SIMPLE_AIRBAG_MODEL
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+# DynaMech class has Airbag function that can be used to create this keyword.
+# LSDYNA has many different AIRBAG models. Only SIMPLE_AIRBAG_MODEL is supported
+# by pydyna at this moment. Please contact us if there is an urgent need for other
+# Airbag models.
+
 airbag = Airbag(
     set=PartSet([3]),
     heat_capacity_at_constant_volume=1.736e3,
@@ -55,9 +94,19 @@
 )
 airbagdeploy.add(airbag)
 
+###############################################################################
+# Define *RIGIDWALL_PLANAR
+# ~~~~~~~~~~~~~~~~~~~~~~~~
+# Infinite planar rigidwall is generated by defining the coordinates of the heat vector
+# and the tail vector of the plane.
 rigidwall = RigidwallPlanar(Point(0, 0, 0), Point(0, 1, 0), coulomb_friction_coefficient=0.5)
 airbagdeploy.add(rigidwall)
 
+###############################################################################
+# Define *CONTACT_NODES_TO_SURFACE
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+# A contact NODES_TO_SURFACE is defined here by passing a master set and a slave part set.
+
 contact = Contact(category=ContactCategory.NODES_TO_SURFACE)
 contact.set_friction_coefficient(static=0.5, dynamic=0.5)
 surf1 = ContactSurface(PartSet([3]))
@@ -66,6 +115,15 @@
 contact.set_slave_surface(surf1)
 contact.set_master_surface(surf2)
 airbagdeploy.contacts.add(contact)
+###############################################################################
+# Define Material cards
+# ~~~~~~~~~~~~~~~~~~~~~
+# Dyna as we all know has over 300 materials that are used for varied applications.
+# Not all material cards are supported at this time. Some of the most commonly used materials
+# like MAT_ELASTIC, RIGID, PIECEWISE_LINEAR_PLASTICITY, FABRIC are currently supported in pydyna.
+# All the supported material can be accessed from the dynamaterial() class.
+# In the code block below, we define MAT_RIGID for the cylindrical tube and the bottom plate and MAT_FABRIC for
+# the airbag volume. Note here that the "platemat" has the contraints defined as well.
 
 platemat = MatRigid(
     mass_density=7.84e-4,
@@ -82,6 +140,14 @@
     shear_modulus=1.53e6,
 )
 
+###############################################################################
+# Define Sectional Properties
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~
+# We now define the sectional properties of the parts. In this example we have three
+# shell parts. Each part is initialized as a ShellPart with a unique ID and the appropriate
+# shell formulation have been assigned. Again, not all element formulations are supported at this time.
+# The supported formulations can be found in the "dynabase" class
+
 plate = ShellPart(1)
 plate.set_material(platemat)
 plate.set_element_formulation(ShellFormulation.BELYTSCHKO_TSAY)
@@ -101,6 +167,13 @@
 airbagpart.set_integration_points(4)
 airbagdeploy.parts.add(airbagpart)
 
+###############################################################################
+# Define Database Outputs  ASCII and Binary
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+# "set_output_database" and "create_database_binary" methods are used here to define the
+# output frequency of the ASCII and Binary D3PLOT files. Finally the model is written out as
+# an input dyna key file by calling the save_file()
+
 airbag_solution.set_output_database(
     abstat=2.0e-4, glstat=2.0e-4, matsum=2.0e-4, rcforc=2.0e-4, rbdout=2.0e-4, rwforc=2.0e-4
 )

examples/Airbag/airbag_post.py

@@ -0,0 +1,57 @@
+"""
+.. _ref_airbag_deploy_post:
+Airbag deploy post processing example
+-------------------------------------
+
+This example show how to animate the d3plot and display the stress on the airbag.
+
+"""
+# from ansys.dpf import core as dpf
+# from ansys.dpf.core import examples
+###############################################################################
+# Connect to DPF
+# ~~~~~~~~~~~~~~
+# 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
+# 
+# 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.
+# 
+# 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.
+# 
+# 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
+# 
+# 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.
+# 
+# disp = model.results.displacement.on_all_time_freqs.eval()
+# fields_top.animate(deform_by=disp,show_edges=False)