Edits to first example and typo fixes

Author: PipKat

examples/Airbag/airbag_deploy.py

@@ -2,10 +2,14 @@
 Airbag deploy example
 ---------------------
 
-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
+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.
 
 import os
 import sys
@@ -27,16 +31,16 @@
 )
 
 ###############################################################################
-# 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
+# Manually start the ``pre`` server
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+# 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:
 #
-# python kwserver.py
+# ``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
+# 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
@@ -48,10 +52,10 @@
 
 
 ###############################################################################
-# Start the Solution workflow
+# Start the solution workflow
 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~
-# Dynasolution class is like a workflow orchestrator.
-# It inherits methods from other classes and helps create a complete workflow
+# The ``DynaSolution`` class is like a workflow orchestrator.
+# It inherits methods from other classes and helps create a complete workflow.
 #
 airbag_solution = DynaSolution(hostname)
 fns = []
@@ -62,24 +66,25 @@
 ###############################################################################
 # 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
+# This code uses the ``set_termination`` method to set the termination time
+# to ``0.03`` in ``*CONTROL_TERMINATION*``. The ``DynaMech`` class
+# automatically generates the common control cards used in
+# explicit problems. ``CONTROL_ACCURACY``, ``CONTACT``, ``BULK VISCOCITY``,
+# and ``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.
+# Define *AIRBAG_SIMPLE_AIRBAG_MODEL* as a keyword
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+# Using the ``Airbag`` function in the ``DynaMech`` class, create
+# *AIRBAG_SIMPLE_AIRBAG_MODEL* as a keyword. While LS-DYNA has many different
+# airbag models, PyDNYA 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]>`_.
 
 airbag = Airbag(
     set=PartSet([3]),
@@ -94,17 +99,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.
+# Generate an infinite planar rigid wall
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+# To generate an infinite planar rigidwall, define 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.
+# Define a contact *NODES_TO_SURFACE*
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+# Define a contact NODES_TO_SURFACE by passing a master part set and a slave
+# part set.
 
 contact = Contact(category=ContactCategory.NODES_TO_SURFACE)
 contact.set_friction_coefficient(static=0.5, dynamic=0.5)
@@ -114,15 +121,18 @@
 contact.set_slave_surface(surf1)
 contact.set_master_surface(surf2)
 airbagdeploy.contacts.add(contact)
+
 ###############################################################################
-# Define Material cards
+# 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.
+# LS-DYNA has over 300 materials that are used for varied applications.
+# Whlie PyDYNA does not yet support all material cards, it does support some
+# of the most commonly used materials, including ``FABRIC``, `MAT_ELASTIC``,
+# ``PIECEWISE_LINEAR_PLASTICITY``, and ``RIGID``. All supported materials
+# are accessed from the ``dynamaterial`` class. In the following code,
+# ``MAT_RIGID`` is defined as the material  for the cylindrical tube and the
+# bottom plate. ``MAT_FABRIC`` is defined as the material for the airbag volume.
+# Note that ``platemat`` has contraints defined as well.
 
 platemat = MatRigid(
     mass_density=7.84e-4,
@@ -140,12 +150,13 @@
 )
 
 ###############################################################################
-# Define Sectional Properties
+# 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
+# The following code defines the sectional properties of the parts. This example
+# has three shell parts. Each shell part is initialized as ``ShellPart`` with a
+# unique ID and an appropriate shell formulation has been assigned. Again,
+# PyDYNA does not yet support all element formulations. You can find the
+# supported formulations in ``dynabase`` class.
 
 plate = ShellPart(1)
 plate.set_material(platemat)
@@ -167,11 +178,11 @@
 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()
+# 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()``
+# method to write out the model as an input DYNA key 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/README.txt

@@ -5,4 +5,4 @@ Examples
 ========
 
 
-Here are a series of examples using LS-DYNA with the ``ansys-dyna-core`` library.
+Here are a series of examples using LS-DYNA with PyDYNA.

src/ansys/dyna/core/pre/dynamech.py

@@ -2,7 +2,7 @@
 Mechanical API
 ==============
 
-Module for settting up explicit or implicit analysis.
+Module for setting up explicit or implicit analysis.
 """
 
 from .dynabase import *  # noqa : F403
@@ -30,16 +30,16 @@ def create_control_output(self, npopt=0, neecho=0):
         npopt : int, optional
             Print suppression during the input phase flag for the D3HSP file.
             The default is ``0``. Options are:
-            
+
             - EQ.0: No suppression.
             - EQ.1: Nodal coordinates, element connectivities, rigid wall definitions,
               nodal SPCs, initial velocities, initial strains, adaptive constraints, and
               SPR2/SPR3 constraints are not printed.
-        
+
         neecho : int, optional
             Print suppression during the input phase flag for the echo file.
             The default is ``0``. Options are:
-            
+
             - EQ.0: All data is printed.
             - EQ.1: Nodal printing is suppressed.
             - EQ.2: Element printing is suppressed.
@@ -196,10 +196,10 @@ def create_section_discrete(self, secid, dro=0, kd=0, v0=0, cl=0, fd=0, cdl=0, t
             Section ID.
         dro : int, optional
             Displacement/rotation. The default is ``0``. Options are:
-            
+
             - EQ.0: Material describes a translational spring/damper.
             - EQ.1: Material describes a torsional spring/damper.
-        
+
         kd : float, optional
             Dynamic magnification factor. The default is ``0``.
         v0 : float, optional
@@ -327,10 +327,10 @@ class Airbag:
     ----------
     Set : SegmentSet or PartSet
         Set. Options are:
-        
+
         - EQ.0: Segment set ID.
         - EQ.1: Part set ID.
-    
+
     heat_capacity_at_constant_volume : float, optional
         Heat capacity at constant volume. The default is ``0``.
     heat_capacity_at_constant_pressure : float, optional

src/ansys/dyna/core/pre/dynanvh.py

@@ -83,7 +83,7 @@ def set_frequency_response_function(
         Parameters
         ----------
         excitation_input_set :
-        excitation_input_dof : 
+        excitation_input_dof :
         excitation_input_type :
         max_natural_frequency :
         modal_damping_coefficient :

src/ansys/dyna/core/pre/dynasale.py

@@ -73,7 +73,7 @@ def fill(
             Material name.
         geometry_type : string
             Geometry type. The default is ``"Null"``. Options are:
-            
+
             - BOXCOR
             - BOXCPT
             - CYLINDER
@@ -82,7 +82,7 @@ def fill(
             - PLANE
             - SEGSET
             - SPHERE
-        
+
         nsample : int, optional
             Number of sampling points. The default is ``4``.
         define_geometry_parameters : list
@@ -94,7 +94,7 @@ def fill(
         vid : int, optional
             Flag for assigning the initial velocity to the material filling the domain.
             The default is ``0``.
-        reference_pressure : 
+        reference_pressure :
 
         Returns
         -------
@@ -312,7 +312,7 @@ def set_output_database(self, matsum=0, glstat=0):
         matsum : float, optional
             Time interval between outputs of part energies. The
             default is ``0``.
-        glstat : float, optinal
+        glstat : float, optional
             Time interval between outputs of global statistics and energies.
             The default is ``0``.