Submit edits to PY files for API

Author: PipKat

src/ansys/dyna/core/pre/README.md

@@ -1,6 +1,6 @@
 # PyDYNA ``pre`` service
 
-The PyDYNA ``pre`` service provide the ability to create a keyword input deck through the gRPC framework. 
+The PyDYNA ``pre`` service provide the ability to create keyword input decks through the gRPC framework. 
 
 ## Run the ``pre`` service in a virtual environment
 
@@ -12,20 +12,20 @@ Install virtualenv:
 pip install virtualenv
 ```
 
-Create a Python virtual environment of the same version as ``virtualenv``,installed into the subdirectory "venv":
+Create a Python virtual environment of the same version as ``virtualenv``, installed in the subdirectory ``venv``:
 
 ```
 virtualenv venv
 ```
 
-Activate the ``venv`` environment on Windows by running these commands: 
+On Windows, activate the ``venv`` environment by running these commands: 
 
 ```
 cd venv
 ./Scripts/activate
 ```
 
-Activate the ``venv`` environment on Linux by running these commands: 
+On Linux, activate the ``venv`` environment by running these commands: 
 
 ```
 cd venv
@@ -57,9 +57,9 @@ cd pyDyna/requirement/pythonxx
 pip install -r requirements.txt
 ```
 
-## Start the Server
+## Start the server
 
-So far, Python 3.6 through 3-8 can be used to start server. Validate by running
+Python 3.6 through 3.8 can be used to start the server. Validate by running
 these commands:
 
 ```
@@ -84,7 +84,7 @@ Server/
 
 ### Start the server on Windows
 
-Start the server on Windows by running these commands:
+On Windows, start the server by running these commands:
 
 ```shell
 (venv) C:\pyDyna\ansys\dyna\pre\Server> python .\kwserver.py
@@ -93,18 +93,17 @@ kwgrpc Server listening on: localhost:50051
 
 ### Start the server on Linux
 
-Start the server on Linux by running these commands:
+On Linux, start the server by running these commands:
 
 ```
 (venv) :~/pyDyna/ansys/dyna/pre/Server> python kwserver.py
 ```
 
 ## Run the PyDYNA ``pre`` service
 
-See the ``Examples`` folder for some basic usage examples. More
-examples are to be added later.
+See the ``Examples`` folder for basic usage examples.
 
-### Structure ALE demo
+### S-ALE (Structure ALE) demo
 
 Go to the ``pyDyna/examples/pre`` directory and run the ``sale_efp.py`` file:
 

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

@@ -2,7 +2,7 @@
 Mechanical API
 ==============
 
-Module to setup Explicit or Implicit analysis
+Module for settting up explicit or implicit analysis.
 """
 
 from .dynabase import *  # noqa : F403
@@ -15,7 +15,7 @@ class AnalysisType(Enum):
 
 
 class DynaMech(DynaBase):
-    """Define an Mechanical analysis."""
+    """Defines a Mechanical analysis."""
 
     def __init__(self, analysis=AnalysisType.EXPLICIT):
         DynaBase.__init__(self)
@@ -27,18 +27,23 @@ def create_control_output(self, npopt=0, neecho=0):
 
         Parameters
         ----------
-        npopt : int
-            Print suppression during input phase flag for the d3hsp file:
-            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
-            Print suppression during input phase flag for echo file:
-            EQ.0: All data printed.
-            EQ.1: Nodal printing is suppressed.
-            EQ.2: Element printing is suppressed.
-            EQ.3: Both nodal and element printing is suppressed.
+        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.
+            - EQ.3: Both nodal and element printing is suppressed.
 
         Returns
         -------
@@ -50,14 +55,14 @@ def create_control_output(self, npopt=0, neecho=0):
         return ret
 
     def set_init_velocity(self, translational=Velocity(0, 0, 0), rotational=RotVelocity(0, 0, 0)):
-        """Define initial nodal point velocities using nodal set ID.
+        """Define initial nodal point velocities using a nodal set ID.
 
         Parameters
         ----------
         nsid : int
             Nodal set ID.
         translational : Velocity
-            Initial translational velocity in x,y,z-direction.
+            Initial translational velocity in the x,y,z-direction.
         rotational : RotVelocity
             Initial rotational velocity about the x,y,z-axis.
 
@@ -86,20 +91,20 @@ def create_defineorientation(self, vid, iop, vector, node1, node2):
         vid : int
             Orientation vector ID.
         iop : int
-            Option:
+            Options are:
 
-            * EQ.0: deflections/rotations are measured and forces/moments applied
+            - EQ.0: Deflections/rotations are measured and forces/moments are applied
               along the following orientation vector.
-            * EQ.1: deflections/rotations are measured and forces/moments applied
+            - EQ.1: Deflections/rotations are measured and forces/moments are applied
               along the axis between the two spring/damper nodes projected onto the plane normal
               to the following orientation vector.
-            * EQ.2: deflections/rotations are measured and forces/moments applied
+            - EQ.2: Deflections/rotations are measured and forces/moments are applied
               along a vector defined by the following two nodes.
-            * EQ.3: deflections/rotations are measured and forces/moments applied
+            - EQ.3: Deflections/rotations are measured and forces/moments are applied
               along the axis between the two spring/damper nodes projected onto the
               plane normal to the a vector defined by the following two nodes.
         vector : list [x,y,z]
-            x,y,z : x,y,z-value of orientation vector.
+            x,y,z : x,y,z-value of the orientation vector.
         node1 : int
             Node 1 ID.
         node2 : int
@@ -122,13 +127,13 @@ def create_shellset(self, option, title, sid, eids):
         Parameters
         ----------
         option : string
-            Available options:<BLANK>,LIST,GENERAL
+            Available options. Choices are ``<BLANK>``,``LIST``, and ``GENERAL``.
         title : string
-            Define title for shell set.
+            Title for the shell set.
         sid : int
             Set ID.
         eids : list
-            Shell element IDs.
+            List of shell element IDs.
 
         Returns
         -------
@@ -145,7 +150,7 @@ def create_solidset(self, title, sid, ki):
         Parameters
         ----------
         title : string
-            Define title for solid set.
+            Title for the set of solid elements.
         sid : int
             Set ID.
         ki : list
@@ -166,9 +171,9 @@ def create_section_solid(self, title, secid, elform):
         Parameters
         ----------
         title : string
-            Define title for section solid.
+            Title for section solid.
         secid : int
-            Section ID. SECID is referenced on the \*PART card.
+            Section ID. ``SECID`` is referenced on the ``\*PART`` card.
             A unique number must be specified.
         elform : int
             Element formulation options.
@@ -189,22 +194,24 @@ def create_section_discrete(self, secid, dro=0, kd=0, v0=0, cl=0, fd=0, cdl=0, t
         ----------
         secid : int
             Section ID.
-        dro : int
-            Displacement/Rotation Option:
-            EQ.0: the material describes a translational spring/damper,
-            EQ.1: the material describes a torsional spring/damper.
-        kd : float
-            Dynamic magnification factor.
-        v0 : float
-            Test velocity.
-        cl : float
-            Clearance.
-        fd : float
-            Failure deflection.
-        cdl : float
-            Deflection limit in compression.
-        cd1 : float
-            Deflection limit in tension.
+        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
+            Test velocity. The default is ``0``.
+        cl : float, optional
+            Clearance. The default is ``0``.
+        fd : float, optional
+            Failure deflection. The default is ``0``.
+        cdl : float, optional
+            Deflection limit in compression. The default is ``0``.
+        td1 : float, optional
+            Deflection limit in tension. The default is ``0``.
 
         Returns
         -------
@@ -226,16 +233,16 @@ def create_hourglass(self, ghid, ihq, qm=0.1, q1=1.5, q2=0.06, qb=1e-9, qw=1e-9)
             Hourglass ID. A unique number or label must be specified.
         ihq : int
             Hourglass control type.
-        qm : float
-            Hourglass coefficient.
-        q1 : float
-            Quadratic bulk viscosity coefficient.
-        q2 : float
-            Linear bulk viscosity coefficient.
-        qb : float
-            Hourglass coefficient for shell bending.
-        qw : float
-            Hourglass coefficient for shell warping.
+        qm : float, optional
+            Hourglass coefficient. The default is ``0.1``.
+        q1 : float, optional
+            Quadratic bulk viscosity coefficient. The default is ``1.5``.
+        q2 : float, optional
+            Linear bulk viscosity coefficient. The default is ``0.06``.
+        qb : float, optional
+            Hourglass coefficient for shell bending. The default is ``1e-09``.
+        qw : float, optional
+            Hourglass coefficient for shell warping. The default is ``1e-09``.
 
         Returns
         -------
@@ -314,26 +321,31 @@ def save_file(self, defaultsetting=1):
 
 
 class Airbag:
-    """Define an airbag or control volume.
+    """Defines an airbag or control volume.
 
     Parameters
     ----------
-    Set : SegmentSet/PartSet
-        Set : EQ.0:segment EQ.1: part set ID.
-    heat_capacity_at_constant_volume : float
-        Heat capacity at constant volume.
-    heat_capacity_at_constant_pressure : float
-        Heat capacity at constant pressure.
-    input_gas_temperature : float
-        Temperature of input gas.
-    input_mass_flow_rate : int
-        Load curve ID specifying input mass flow rate.
-    shape_factor_for_exit_hole : float
-        Shape factor for exit hole.
-    ambient_pressure : float
-        Ambient pressure.
-    ambient_density : float
-        Ambient density.
+    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
+        Heat capacity at constant pressure. The default is ``0``.
+    input_gas_temperature : float, optional
+        Temperature of the input gas. The default is ``0``.
+    input_mass_flow_rate : int, optional
+        Load curve ID specifying the input mass flow rate.
+        The default is ``0``.
+    shape_factor_for_exit_hole : float, optional
+        Shape factor for exit hole. The default is ``0``.
+    ambient_pressure : float, optional
+        Ambient pressure. The default is ``0``.
+    ambient_density : float, optional
+        Ambient density. The default is ``0``.
 
     Returns
     -------
@@ -367,7 +379,7 @@ def __init__(
             self.sidtyp = 1
 
     def create(self):
-        """Create airbag."""
+        """Create an airbag."""
         self.stub.CreateAirbagModel(
             AirbagModelRequest(
                 modeltype="SIMPLE_AIRBAG_MODEL",

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

@@ -2,7 +2,7 @@
 NVH API
 ==========
 
-Module to create NVH dyna input deck
+Module for creating an NVH Dyna input deck.
 """
 
 import logging
@@ -11,7 +11,7 @@
 
 
 class DynaNVH(DynaBase):
-    """Contains methods to create keyword related to NVH."""
+    """Contains methods for creating a keyword related to NVH."""
 
     def __init__(self):
         DynaBase.__init__(self)
@@ -56,7 +56,7 @@ class ResponseType(Enum):
 
 
 class FrequencyDomain:
-    """Provide a way of defining and solving frequency domain vibration and acoustic problems."""
+    """Provides a way of defining and solving frequency domain vibration and acoustic problems."""
 
     def __init__(self):
         self.stub = DynaBase.get_stub()
@@ -82,8 +82,20 @@ def set_frequency_response_function(
 
         Parameters
         ----------
-        box : Box
-            When l save eract with the structure.
+        excitation_input_set :
+        excitation_input_dof : 
+        excitation_input_type :
+        max_natural_frequency :
+        modal_damping_coefficient :
+        modal_damping_coefficient_curve :
+        modal_damping_coefficient_curve_type :
+        response_output_set :
+        response_output_dof :
+        response_output_type :
+        frf_output_min_frequency :
+        frf_output_max_frequency :
+        frf_output_num_frequency :
+
         """
         self.defined_frf = True
         self.n1 = excitation_input_set
@@ -101,7 +113,7 @@ def set_frequency_response_function(
         self.nfreq = frf_output_num_frequency
 
     def create(self):
-        """Define frequency domain vibration and acoustic problems."""
+        """Define a frequency domain vibration and acoustic problem."""
         if self.defined_frf:
             if self.lcdam is not None:
                 cid = self.lcdam.create(self.stub)