add nodla boundary conditions and input force; bump to 0.42.2

Author: akaszynski

docs/loading_results.rst

@@ -1,16 +1,29 @@
-Working with a ANSYS Result File (rst)
-======================================
+Working with a ANSYS Result Files
+=================================
+The `pyansys` module supports the following result types from MAPDL:
+
+- ".rfl"
+- ".rmg"
+- ".rst"
+- ".rth"
+
 The ANSYS result file is a FORTRAN formatted binary file containing
 the results written from an ANSYS analysis.  The results, at a
 minimum, contain the geometry of the model analyzed along with the
 nodal and element results.  Depending on the analysis, these results
-could be anything from modal displacements to nodal temperatures.  At
-this time, only the following results are supported by this code:
+could be anything from modal displacements to nodal temperatures.
+This includes (and is not limited to):
 
     - Nodal DOF results from a static analysis or modal analysis.
     - Nodal DOF results from a cyclic static or modal analysis.
     - Nodal averaged component stresses (i.e. x, y, z, xy, xz, yz)
     - Nodal principal stresses (i.e. S1, S2, S3, SEQV, SINT)
+    - Nodal elastic, plastic, and thermal stress
+    - Nodal time history
+    - Nodal boundary conditions and force
+    - Nodal temperatures
+    - Nodal thermal strain
+    - Various element results (see ``element_solution_data``)
 
 We're working on adding additional plotting and retrieval functions to the code If you would like us to add an additional result type to be loaded, please open an issue in `GitHub <https://github.com/akaszynski/pyansys>`_  and include result file for the result type you wish to load.
 
@@ -20,7 +33,7 @@ Loading the Result File
 As the ANSYS result files are binary files, the entire file does not
 need to be loaded into memory in order to retrieve results.  This
 module accesses the results through a python object `result` which you
-can create with:
+can initialize with:
 
 .. code:: python
 
@@ -31,31 +44,85 @@ Upon initialization the ``ResultFile`` object contains several
 properties to include the time values from the analysis, node
 numbering, element numbering, etc.
 
+The `pyansys` module can determine the correct result type by reading
+the header of the file, which means that if it is an ANSYS binary
+file, `pyansys` can probably read it (at least to some degree.  For
+example, a thermal result file can be read with
+
+.. code:: python
+
+    rth = pyansys.read_binary('file.rth')
+
 
 ResultFile Properties
 ---------------------
-The properties of the ``ResultFile`` are contained in the result header.
+The properties of the ``ResultFile`` can be quickly shown by printing the result file with:
 
 .. code:: python
 
-    result.resultheader
+    >>> result = pyansys.read_binary('file.rst')
+    >>> print(result)
+    PyANSYS MAPDL Result file object
+    Units       : User Defined
+    Version     : 20.1
+    Cyclic      : False
+    Result Sets : 1
+    Nodes       : 321
+    Elements    : 40
+
+
+    Available Results:
+    EMS : Miscellaneous summable items (normally includes face pressures)
+    ENF : Nodal forces
+    ENS : Nodal stresses
+    ENG : Element energies and volume
+    EEL : Nodal elastic strains
+    ETH : Nodal thermal strains (includes swelling strains)
+    EUL : Element euler angles
+    EPT : Nodal temperatures
+    NSL : Nodal displacements
+    RF  : Nodal reaction forces
+
 
 To obtain the time or frequency values of an analysis use:
 
 .. code:: python
 
-    tval = result.time_values
-    
+    >>> result.time_values
+    array([1.])
+
+
+Individual results can be obtained with one of the many methods
+available to the result object.  For example, the nodal displacement
+for the first result can be accessed with:
+
+.. code:: python
+
+    >>> nnum, disp = rst.nodal_displacement(0)
+    >>> nnum
+    array([  1,   2,   3, ..., 318, 319, 320, 321], dtype=int32)
+
+    >>> disp
+    array([[-2.03146520e-09, -3.92491045e-03,  5.00047448e-05],
+           [ 1.44630651e-09,  1.17747356e-02, -1.49992672e-04],
+           [ 0.00000000e+00,  0.00000000e+00,  0.00000000e+00],
+           ...
+           [-7.14982194e-03,  3.12495002e-03,  5.74992265e-04],
+           [-7.04982329e-03,  2.44996706e-03,  5.74992939e-04],
+           [-6.94982520e-03,  1.77498362e-03,  5.74992891e-04]])
+
+
 The sorted node and element numbering of a result can be obtained with:
 
 .. code:: python
 
-    # sorted node numbering
-    nnum = result.nnum
-    
-    # sorted element numbering
-    enum = result.enum
+    >>> rst.geometry.nnum
+    array([  1,   2,   3, ..., 318, 319, 320, 321], dtype=int32)
 
+    >>> result.geometry.enum
+    array([ 1,  3,  2,  4,  5,  7,  6,  8,  9, 11, 10, 12, 13, 15, 14, 16, 17,
+           19, 18, 20, 21, 23, 22, 24, 25, 27, 26, 28, 29, 31, 30, 32, 33, 35,
+           34, 36, 37, 39, 38, 40], dtype=int32)
 
 Geometry
 --------
@@ -87,7 +154,9 @@ Which contains the following attributes:
 
 Coordinate Systems
 ~~~~~~~~~~~~~~~~~~
-Non default coordinate systems are always saved to an ANSYS result file.  The coordinate system is zero indexed and individual coordinate systems can be accessed with:
+Non-default coordinate systems are always saved to an ANSYS result
+file.  The coordinate system is zero indexed and individual coordinate
+systems can be accessed with:
 
 .. code:: python
 
@@ -167,7 +236,10 @@ This yields::
     pCnvVal 0.0
 
 
-The DOF solution for an analysis for each node in the analysis can be obtained using the code block below.  These results correspond to the node numbers in the result file.  This array is sized by the number of nodes by the number of degrees of freedom.
+The DOF solution for an analysis for each node in the analysis can be
+obtained using the code block below.  These results correspond to the
+node numbers in the result file.  This array is sized by the number of
+nodes by the number of degrees of freedom.
 
 .. code:: python    
 
@@ -182,7 +254,9 @@ The DOF solution for an analysis for each node in the analysis can be obtained u
     # normalized displacement can be plotted by excluding the direction string
     result.plot_nodal_solution(0, label='Normalized')
 
-Stress can be obtained as well using the below code.  The nodal stress is computed in the same manner as ANSYS by averaging the stress evaluated at that node for all attached elements.
+Stress can be obtained as well using the below code.  The nodal stress
+is computed in the same manner as ANSYS by averaging the stress
+evaluated at that node for all attached elements.
 
 .. code:: python
     
@@ -197,12 +271,15 @@ Stress can be obtained as well using the below code.  The nodal stress is comput
     nnum, pstress = result.principal_nodal_stress(0)
     result.plot_principal_nodal_stress(0, 'SEQV')
 
-Element stress can be obtained using the following segment of code.  Ensure that the element results are expanded for a modal analysis within ANSYS with::
+Element stress can be obtained using the following segment of code.
+Ensure that the element results are expanded for a modal analysis
+within ANSYS with::
 
     /SOLU
     MXPAND, ALL, , , YES
 
-This block of code shows how you can access the non-averaged stresses for the first result from a modal analysis.
+This block of code shows how you can access the non-averaged stresses
+for the first result from a modal analysis.
 
 .. code:: python
     
@@ -254,7 +331,9 @@ These stresses can be verified using ANSYS using:
 
 Accessing Element Solution Data
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Individual element results for the entire solution can be accessed using the ``element_solution_data`` method.  For example, to get the volume of each element:
+Individual element results for the entire solution can be accessed
+using the ``element_solution_data`` method.  For example, to get the
+volume of each element:
 
 .. code:: python
 
@@ -269,12 +348,11 @@ Individual element results for the entire solution can be accessed using the ``e
     edata = np.asarray(edata)
     volume = edata[:, 0]
 
-Documentation for the underlying results can be found in `Description of the Results File <https://www.sharcnet.ca/Software/Ansys/16.2.3/en-us/help/ans_prog/Hlp_P_INT1_2.html>`_.
-
 
 Animiating a Modal Solution
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Solutions from a modal analysis can be animated using ``animate_nodal_solution``.  For example:
+Solutions from a modal analysis can be animated using
+``animate_nodal_solution``.  For example:
 
 .. code:: python
 
@@ -285,7 +363,6 @@ Solutions from a modal analysis can be animated using ``animate_nodal_solution``
     result.animate_nodal_solution(3)
 
 
-
 Results from a Cyclic Analysis
 ------------------------------
 ``pyansys`` can load and display the results of a cyclic analysis:
@@ -297,7 +374,9 @@ Results from a Cyclic Analysis
     # load the result file    
     result = pyansys.read_binary('rotor.rst')
     
-You can reference the load step table and harmonic index tables by printing the result header dictionary keys ``'ls_table'`` and ``'hindex'``:
+You can reference the load step table and harmonic index tables by
+printing the result header dictionary keys ``'ls_table'`` and
+``'hindex'``:
 
 .. code:: python
 
@@ -314,7 +393,9 @@ You can reference the load step table and harmonic index tables by printing the
     array([0, 0, 0, 0, 0, 1, 1, 1, 1, 1, 2, 2, 2, 2, 2, 3, 3, 3, 3, 3, 4, 4, 4,
            4, 4, 5, 5, 5, 5, 5, 6, 6, 6, 6, 6, 7, 7, 7, 7, 7], dtype=int32)
 
-Where each harmonic index entry corresponds a cumulative index.  For example, result number 11 is the first mode for the 2nd harmonic index:
+Where each harmonic index entry corresponds a cumulative index.  For
+example, result number 11 is the first mode for the 2nd harmonic
+index:
 
 .. code:: python
 
@@ -333,7 +414,10 @@ Alternatively, the result number can be obtained by using:
     >>> result.harmonic_index_to_cumulative(mode, harmonic_index)
     24
 
-    Using this indexing method, repeated modes are indexed by the same mode index.  To access the other repeated mode, use a negative harmonic index.  Should a result not exist, pyansys will return which modes are available:
+Using this indexing method, repeated modes are indexed by the same
+mode index.  To access the other repeated mode, use a negative
+harmonic index.  Should a result not exist, pyansys will return which
+modes are available:
 
 .. code:: python
 
@@ -343,7 +427,11 @@ Alternatively, the result number can be obtained by using:
     Exception: Invalid mode for harmonic index 1
     Available modes: [0 1 2 3 4 5 6 7 8 9]
 
-Results from a cyclic analysis require additional post processing to be interperted correctly.  Mode shapes are stored within the result file as unprocessed parts of the real and imaginary parts of a modal solution.  ``pyansys`` combines these values into a single complex array and then returns the real result of that array.
+Results from a cyclic analysis require additional post processing to
+be interperted correctly.  Mode shapes are stored within the result
+file as unprocessed parts of the real and imaginary parts of a modal
+solution.  ``pyansys`` combines these values into a single complex
+array and then returns the real result of that array.
 
 .. code:: python
 
@@ -353,7 +441,8 @@ Results from a cyclic analysis require additional post processing to be interper
      [ 42.339, 48.516, 52.475]
      [ 36.000, 33.121, 39.044]]
 
-Sometimes it is necessary to determine the maximum displacement of a mode.  To do so, return the complex solution with:
+Sometimes it is necessary to determine the maximum displacement of a
+mode.  To do so, return the complex solution with:
 
 .. code:: python
 
@@ -370,24 +459,31 @@ Sometimes it is necessary to determine the maximum displacement of a mode.  To d
     
 See ``help(result.nodal_solution)`` for more details.
 
-The real displacement of the sector is always the real component of the mode shape ``ms``, and this can be varied by multiplying the mode shape by a complex value for a given phase.  To change the phase by 90 degrees simply:
+The real displacement of the sector is always the real component of
+the mode shape ``ms``, and this can be varied by multiplying the mode
+shape by a complex value for a given phase.
 
-The results of a single sector can be displayed as well using the ``plot_nodal_solution``
+The results of a single sector can be displayed as well using the
+``plot_nodal_solution``
 
 .. code:: python
 
-    # Plot the result from the first mode of the 2nd harmonic index
     rnum = result.harmonic_index_to_cumulative(0, 2)
     result.plot_nodal_solution(rnum, label='Displacement', expand=False)
     
 .. image:: ./images/rotor.jpg
 
-The phase of the result can be changed by modifying the ``phase`` option.  See ``help(result.plot_nodal_solution)`` for details on its implementation.
+The phase of the result can be changed by modifying the ``phase``
+option.  See ``help(result.plot_nodal_solution)`` for details on its
+implementation.
 
 
 Exporting to ParaView
 ---------------------
-ParaView is a visualization application that can be used for rapid generation of plots and graphs using VTK through a GUI.  ``pyansys`` can translate the ANSYS result files to ParaView compatible files containing the geometry and nodal results from the analysis:
+ParaView is a visualization application that can be used for rapid
+generation of plots and graphs using VTK through a GUI.  ``pyansys``
+can translate the ANSYS result files to ParaView compatible files
+containing the geometry and nodal results from the analysis:
 
 .. code:: python
 
@@ -400,7 +496,13 @@ ParaView is a visualization application that can be used for rapid generation of
     # save as a binary vtk xml file
     result.save_as_vtk('beam.vtu')
 
-The vtk xml file can now be loaded using ParaView.  This screenshot shows the nodal displacement of the first result from the result file plotted within `ParaView <https://www.paraview.org/>`_.  Within the vtk file are two point arrays (``NodalResult`` and ``nodal_stress``) for each result in the result file.  The nodal result values will depend on the analysis type, while nodal stress will always be the node average stress in the Sx, Sy Sz, Sxy, Syz, and Sxz directions.
+The vtk xml file can now be loaded using ParaView.  This screenshot
+shows the nodal displacement of the first result from the result file
+plotted within `ParaView <https://www.paraview.org/>`_.  Within the
+vtk file are two point arrays (``NodalResult`` and ``nodal_stress``)
+for each result in the result file.  The nodal result values will
+depend on the analysis type, while nodal stress will always be the
+node average stress in the Sx, Sy Sz, Sxy, Syz, and Sxz directions.
 
 .. image:: ./images/paraview.jpg
 

examples/02-mapdl-examples/mapdl_3d_beam.py

@@ -15,7 +15,7 @@
 import pyansys
 
 os.environ['I_MPI_SHM_LMT'] = 'shm'  # necessary on ubuntu
-mapdl = pyansys.launch_mapdl(override=True)
+mapdl = pyansys.launch_mapdl(override=True, additional_switches='-smp')
 
 mapdl.cdread('db', examples.hexarchivefile)
 mapdl.esel('s', 'ELEM', vmin=5, vmax=20)
@@ -44,5 +44,5 @@
 
 # view the results using pyansys's result viewer
 result = mapdl.result
-result.animate_nodal_solution(0, show_edges=True, loop=False,
+result.animate_nodal_solution(0, show_edges=True, loop=False, displacement_factor=10,
                               movie_filename='demo.gif')