Ansys Prog Features PDF

Guide to ANSYS User
Programmable Features
ANSYS Release 10.0
002187
August 2005
ANSYS, Inc. and

ANSYS Europe,
Ltd. are UL
registered ISO
9001:2000
Companies.
Guide to ANSYS User Programmable
Features
ANSYS Release 10.0
ANSYS, Inc.
Southpointe
275 Technology Drive
Canonsburg, PA 15317
[email protected]
http://www.ansys.com
(T) 724-746-3304
(F) 724-514-9494
Revision History
Number Release Date
001385 ANSYS 5.7.1 May 2001
001514 ANSYS 6.1 March 2002
001975 ANSYS 8.1 April 2004
002099 ANSYS 9.0 November 2004
002187 ANSYS 10.0 August 2005
Copyright and Trademark Information

© 2005 SAS IP, Inc. All rights reserved. Unauthorized use, distribution or duplication is prohibited.
ANSYS, ANSYS Workbench, CFX, AUTODYN, and any and all ANSYS, Inc. product and service names are registered trademarks or trademarks of ANSYS, Inc.
or its subsidiaries located in the United States or other countries. ICEM CFD is a trademark licensed by ANSYS, Inc. All other trademarks or registered
trademarks are the property of their respective owners.
Disclaimer Notice
THIS ANSYS SOFTWARE PRODUCT AND PROGRAM DOCUMENTATION INCLUDE TRADE SECRETS AND ARE CONFIDENTIAL AND PROPRIETARY PRODUCTS
OF ANSYS, INC., ITS SUBSIDIARIES, OR LICENSORS. The software products and documentation are furnished by ANSYS, Inc., its subsidiaries, or affiliates
under a software license agreement that contains provisions concerning non-disclosure, copying, length and nature of use, compliance with exporting
laws, warranties, disclaimers, limitations of liability, and remedies, and other provisions. The software products and documentation may be used, disclosed,
transferred, or copied only in accordance with the terms and conditions of that software license agreement.
ANSYS, Inc. and ANSYS Europe, Ltd. are UL registered ISO 9001:2000 Companies.
U.S. GOVERNMENT RIGHTS

For U.S. Government users, except as specifically granted by the ANSYS, Inc. software license agreement, the use, duplication, or disclosure by the United
States Government is subject to restrictions stated in the ANSYS, Inc. software license agreement and FAR 12.212 (for non-DOD licenses).
Third-Party Software
See the online documentation in the product help files for the complete Legal Notice for ANSYS proprietary software and third-party software. The ANSYS
third-party software information is also available via download from the Customer Portal on the ANSYS web page. If you are unable to access the third-
party legal notices, please contact ANSYS, Inc.
Published in the U.S.A.

Table of Contents
Preface ...................................................................................................................................................... xiii
1. Using User Programmable Features (UPFs) ........................................................................................ 1–1
1.1. Introduction to UPFs ..................................................................................................................... 1–1
1.1.1. What Are UPFs? .................................................................................................................... 1–1
1.1.2. What You Should Know Before Using UPFs ........................................................................... 1–2
1.1.3. Planning Your UPFs .............................................................................................................. 1–3
1.1.4. Studying the ANSYS User Routines ....................................................................................... 1–3
1.1.5. Programming in Languages Other than FORTRAN ................................................................ 1–3
1.1.6. Developing UPFs: a Suggested Strategy ................................................................................ 1–3
1.1.7. Include Decks ...................................................................................................................... 1–4
1.1.8. Linking User Routines ........................................................................................................... 1–5
1.1.9. Compiling and Linking UPFs on UNIX Systems ...................................................................... 1–5
1.1.10. Compiling and Linking UPFs on Windows Systems .............................................................. 1–6
1.1.11. Activating UPFs .................................................................................................................. 1–7
1.1.12. Running Your Custom Executable ....................................................................................... 1–8
1.1.13. Verifying Your Routines ...................................................................................................... 1–8
1.1.14. Debugging Commands ...................................................................................................... 1–9
1.1.14.1. Tracking the Path of Program Logic ........................................................................... 1–9
1.1.14.2. Debugging Elements and Solutions ........................................................................... 1–9
1.1.14.2.1. Solution Debug Format ..................................................................................... 1–9
1.1.14.2.2. Element Debug Format ................................................................................... 1–10
1.1.14.2.3. General Debug Format .................................................................................... 1–11
1.1.15. Other Useful Commands .................................................................................................. 1–11
1.1.16. Generating Output ........................................................................................................... 1–12
1.2. Reading Large Data Files More Rapidly ........................................................................................ 1–12
1.3. Routines for Creating New Elements ........................................................................................... 1–12
1.3.1. Input and Output Abbreviations ......................................................................................... 1–12
1.3.2. User Routines ..................................................................................................................... 1–13
1.3.3. Subroutine uec100 (Defining Characteristics of the usr100 Routine) .................................... 1–13
1.3.3.1. Subroutines uec101 through uec105 ......................................................................... 1–14
1.3.4. Subroutine uex100 (Overriding Element Characteristic Defaults) ......................................... 1–14
1.3.4.1. Subroutines uex101 through uex105 ......................................................................... 1–14
1.3.5. Subroutine uel100 (Computing Element Matrices, Load Vectors, and Results) ...................... 1–14
1.3.6. Subroutines uel101 through uel105 .................................................................................... 1–15
1.3.7. Subroutine uep100 (Printing Output for User Elements) ...................................................... 1–15
1.3.8. Subroutines uep101 through uep105 ................................................................................. 1–16
1.3.9. Subroutine usertr (Adjusting the Nodal Orientation Matrix) ................................................. 1–16
1.3.10. Subroutine userac (Accessing Element Information) .......................................................... 1–17
1.4. Supporting Subroutines for Element Creation ............................................................................. 1–17
1.4.1. Subroutine nminfo (Returning Element Reference Names) .................................................. 1–17
1.4.2. Subroutine svgidx (Fetching the Index for Saved Variables) ................................................. 1–17
1.4.3. Subroutine svrget (Fetching Saved Variable Data for an Element) ........................................ 1–18
1.4.4. Subroutine svrput (Writing an Element's Saved Variable Set) ............................................... 1–18
1.4.5. Subroutine svpidx (Writing the Saved Variable Element Index to a File) ............................... 1–19
1.4.6. Subroutine mreuse (Determining Which Element Matrices Can Be Reused) ......................... 1–19
1.4.7. Subroutine subrd (Reading Element Load Data for a Substructure Generation Run) ............. 1–20
1.4.8. Subroutine subwrt (Writing an Element Load Vector to a File for a Substructure Generation
Run) ........................................................................................................................................... 1–21
1.4.9. Subroutine rvrget (Fetching Real Constants for an Element) ................................................ 1–21
1.4.10. Subroutine propev (Evaluating a Group of Material Properties) .......................................... 1–22
Guide to ANSYS User Programmable Features . ANSYS Release 10.0 . 002187 . © SAS IP, Inc.
Guide to ANSYS User Programmable Features
1.4.11. Subroutine prope1 (Evaluating One Material Property) ...................................................... 1–22

1.4.12. Subroutine pstev1 (Evaluating Material Properties for 1-D Elements) ................................. 1–23
1.4.13. Subroutine tbuser (Retrieving User Table Data) ................................................................. 1–23
1.4.14. Subroutine plast1 (Updating an Element's Plastic History) ................................................. 1–23
1.4.15. Subroutine plast3 (Updating an Element's Plastic History, 4 or 6 components) ................... 1–24
1.4.16. Subroutine creep1 (Updating an Element's Creep History) ................................................. 1–25
1.4.17. Subroutine creep3 (Updating an Element's Creep History, 3-D Elements) ........................... 1–25
1.4.18. Subroutine swell1 (Updating an Element's Swelling History) .............................................. 1–26
1.4.19. Subroutine swell3 (Updating an Element's Swelling History, 3-D Elements) ........................ 1–26
1.4.20. Function elLenPsvrBuf (Determining additional ESAV Record for Plasticity) ........................ 1–27
1.4.21. Function nlget (Retrieving Material Nonlinear Property Information) ................................. 1–27
1.4.22. Subroutine usereo (Storing Data in the nmisc Record) ....................................................... 1–28
1.4.23. Subroutine eldwrtL (Writing Element Data to a File) .......................................................... 1–28
1.4.24. Subroutine eldwrnL (Writing Element Nonsummable Miscellaneous Data to the Results
File) ............................................................................................................................................ 1–29
1.4.25. Subroutine trrot (Computing the Rotation Vector) ............................................................ 1–29
1.4.26. Subroutine rottr (Computing the Transformation Matrix) .................................................. 1–29
1.4.27. Subroutine xyzup3 (Updating an Element's 3-D Nodal Coordinates) .................................. 1–30
1.4.28. Subroutine updrot (Updating the Rotation Pseudovector) ................................................. 1–30
1.4.29. Subroutine tmpget (Defining Current Temperature Loads) ................................................ 1–30
1.4.30. Subroutine prsget (Defining Current Pressure Loads) ........................................................ 1–31
1.4.31. Subroutine cnvget (Defining Current Convection Loads) ................................................... 1–31
1.4.32. Subroutine hgnget (Defining Current Heat Generation Loads) ........................................... 1–32
1.5. Routines for Modifying and Monitoring Existing Elements ........................................................... 1–32
1.5.1. Subroutine userfd (Computing the Complex Load Vector for Frequency Domain Logic) ....... 1–33
1.5.2. Subroutine userou (Storing User-Supplied Element Output) ................................................ 1–33
1.5.3. Subroutine useran (Modifying Orientation of Material Properties) ....................................... 1–34
1.5.4. Subroutine usanly (Modifying Orientation of Material Properties and Stresses of Layers) ...... 1–35
1.5.5. Subroutine userrc (Performing User Operations on COMBIN7 and COMBIN37 Parameters) ... 1–35
1.5.6. Function userpe (Calculating Rotation Caused by Internal Pressure) .................................... 1–36
1.5.7. Subroutine UElMatx (Accessing Element Matrices and Load Vectors) ................................... 1–36
1.5.8. Subroutine UTHICK (Getting User-defined Initial Thickness) ................................................ 1–37
1.5.9. Subroutine USTRESS (Getting User-defined Initial Stress) ..................................................... 1–37
1.5.10. Subroutine UsrFictive (Providing User-defined Fictive Temperature Relationship) .............. 1–38
1.5.11. Subroutine UsrViscEl (Performs Viscoelastic Computation) ................................................ 1–38
1.6. Routines for Customizing Material Behavior ................................................................................ 1–39
1.6.1. Subroutine usermat (Writing Your Own Material Models) .................................................... 1–40
1.6.2. Subroutine userpl (Writing Your Own Plasticity Laws) .......................................................... 1–42
1.6.3. Subroutines usercreep and usercr (Defining Viscoplastic/Creep Material Behavior) .............. 1–44
1.6.3.1. Creep Subroutine usercreep ...................................................................................... 1–44
1.6.3.2. Creep Subroutine usercr ............................................................................................ 1–45
1.6.4. Subroutine usersw (Writing Your Own Swelling Laws) ......................................................... 1–47
1.6.5. Subroutine UserHyper (Writing Your Own Hyperelasticity Laws) .......................................... 1–47
1.6.6. Subroutine uservp (Updating Nonlinear Strain History for Materials) ................................... 1–48
1.6.7. Subroutine userck (Checking User-Defined Material Data) ................................................... 1–49
1.6.8. Subroutine usermc (Controlling Hygrothermal Growth) ...................................................... 1–49
1.6.9. Subroutine usrfc6 (Defining Custom Failure Criteria) ........................................................... 1–50
1.6.10. Subroutines usrfc1 through usrfc5 .................................................................................... 1–50
1.6.11. Subroutine UserVisLaw (Defining Viscosity Laws) .............................................................. 1–50
1.6.12. Supporting Function egen ................................................................................................ 1–51
1.7. Routines for Customizing Loads .................................................................................................. 1–52
1.7.1. Subroutine usrefl (Changing Scalar Fields to User-Defined Values) ....................................... 1–52
vi Guide to ANSYS User Programmable Features . ANSYS Release 10.0 . 002187 . © SAS IP, Inc.
1.7.2. Subroutine userpr (Changing Element Pressure Information) .............................................. 1–53

1.7.3. Subroutine usercv (Changing Element Face Convection Surface Information) ...................... 1–54
1.7.4. Subroutine userfx (Changing Element Face Heat Flux Surface Information) ......................... 1–55
1.7.5. Subroutine userch (Changing Element Face Charge Density Surface Information) ............... 1–55
1.8. Running ANSYS as a Subroutine .................................................................................................. 1–56
1.9. Defining Your Own Commands ................................................................................................... 1–57
1.9.1. Function user01 ................................................................................................................. 1–57
1.9.2. Function user02 (Demonstrates Offsetting Selected Nodes) ................................................ 1–58
1.9.3. Function user03 (Demonstrates Using ANSYS Memory) ....................................................... 1–59
1.9.4. Function user04 ................................................................................................................. 1–61
1.9.5. Functions user05 through user10 ....................................................................................... 1–63
1.10. Supporting Subroutines ............................................................................................................ 1–63
1.10.1. Function GetRForce (Getting Nodal Reaction Force values) ............................................... 1–63
1.10.2. Function GetStackDisp (Getting Current Displacement Values) .......................................... 1–64
1.10.3. Subroutine ElResultStrt (Getting Load Data from Analysis Results) ..................................... 1–64
1.10.4. Subroutine ElResultGet (Getting Results Values at Selected Points) .................................... 1–65
1.10.5. Subroutine ElInterp (Finding Element Coordinates) ........................................................... 1–65
1.11. Access at the Beginning and End of Various Operations ............................................................. 1–65
1.12. Creating Your Own Optimization Routine .................................................................................. 1–67
1.12.1. Linking a Custom Optimization Program to ANSYS ............................................................ 1–67
1.12.2. Subroutine userop (Defining a Custom Optimization Routine) ........................................... 1–68
1.12.3. Structuring Your Input ...................................................................................................... 1–69
1.12.3.1. Example of User Input for Optimization .................................................................... 1–70
1.13. Memory Management Routines ................................................................................................ 1–70
1.13.1. Using the Memory Management Routines ........................................................................ 1–70
1.13.2. Function fAnsMemAlloc (Allocating Space and Returning a Pointer) .................................. 1–71
1.13.3. Subroutine fAnsMemFree (Deallocating Space) ................................................................ 1–72
1.14. Parameter Processing Routines ................................................................................................. 1–72
1.14.1. Subroutine pardim (Creating a Dimensioned Parameter) ................................................... 1–72
1.14.2. Function parevl (Finding and Evaluating a Parameter) ....................................................... 1–72
1.14.3. Subroutine pardef (Adding a Parameter) ........................................................................... 1–73
1.15. Miscellaneous Useful Functions ................................................................................................. 1–74
1.15.1. Using Function RunCommand .......................................................................................... 1–74
1.15.2. Using the /UNDO Command ............................................................................................. 1–75
1.15.3. Using the /HOLD command .............................................................................................. 1–75
2. Accessing the ANSYS Database ........................................................................................................... 2–1
2.1. What This Chapter Covers ............................................................................................................. 2–1
2.2. Inputs and Outputs for Database Access Routines ......................................................................... 2–1
2.3. Types of Database Access Routines ............................................................................................... 2–1
2.4. Routines for Selecting and Retrieving Nodes and Elements ............................................................ 2–1
2.4.1. ndnext Function (Getting the Next Node Number) ................................................................ 2–1
2.4.2. ndprev Function (Getting the Number of the Previous Selected Node) .................................. 2–2
2.4.3. ndnxdf Function (Getting the Number of the Next Defined Node) ......................................... 2–2
2.4.4. ndsel Function (Selecting, Unselecting, Deleting, or Inverting a Node) ................................... 2–2
2.4.5. elnext Function (Getting the Number of the Next Element) ................................................... 2–3
2.4.6. elprev Function (Getting the Number of the Previous Selected Element) ............................... 2–3
2.4.7. elnxdf Function (Getting the Number of the Next Defined Element) ...................................... 2–3
2.4.8. elsel Subroutine (Selecting, Unselecting, Deleting, or Inverting an Element) .......................... 2–4
2.5. Node Information Routines ........................................................................................................... 2–4
2.5.1. ndinqr Function (Getting Information About a Node) ............................................................ 2–4
2.5.2. getnod Function (Getting a Nodal Point) .............................................................................. 2–5
2.5.3. putnod Function (Storing a Node) ........................................................................................ 2–5
Guide to ANSYS User Programmable Features . ANSYS Release 10.0 . 002187 . © SAS IP, Inc. vii
2.5.4. ndgall Function (Getting the XYZ/Rotation Coordinates Vector for a Node) ........................... 2–6
2.5.5. ndspgt Subroutine (Getting the Nodal Solution for a Node of an Element) ............................. 2–6
2.6. Element Attribute Routines ........................................................................................................... 2–7
2.6.1. elmiqr Function (Getting Information About an Element) ...................................................... 2–7
2.6.2. elmget Function (Getting an Element's Attributes and Nodes) ............................................... 2–7
2.6.3. elmput Subroutine (Storing an Element) ............................................................................... 2–8
2.6.4. etyiqr Function (Getting a Data Item About an Element Type) ............................................... 2–8
2.6.5. etyget Function (Getting Information About an Element Type) ............................................. 2–9
2.6.6. etyput Subroutine (Storing Element Type Data) .................................................................... 2–9
2.6.7. echrtr Subroutine (Getting Information About Element Characteristics) ................................ 2–9
2.6.8. etysel Subroutine (Selecting, Unselecting, Deleting, or Inverting an Element Type) .............. 2–10
2.6.9. mpinqr Function (Getting Information About a Material Property) ....................................... 2–10
2.6.10. mpget Function (Getting a Material Property Table) .......................................................... 2–11
2.6.11. mpput Subroutine (Storing a Material Property Table) ....................................................... 2–12
2.6.12. mpdel Subroutine (Deleting a Material Property Table) ..................................................... 2–12
2.6.13. rlinqr Function (Getting Information About a Real Constant Set) ........................................ 2–12
2.6.14. rlget Function (Getting Real Constant Data) ...................................................................... 2–13
2.6.15. rlsel Subroutine (Selecting or Deleting a Real Constant Set) ............................................... 2–13
2.6.16. csyiqr Function (Getting Information About a Coordinate System) ..................................... 2–14
2.6.17. csyget Function (Getting a Coordinate System) ................................................................. 2–14
2.6.18. csyput Subroutine (Storing a Coordinate System) .............................................................. 2–15
2.6.19. csydel Subroutine (Deleting a Coordinate System) ............................................................ 2–15
2.6.20. userac Subroutine (Demonstrates Use of Element Attribute Routines) ............................... 2–15
2.7. Coupling and Constraint Routines ............................................................................................... 2–15
2.7.1. cpinqr Function (Getting Information About a Coupled Set) ................................................ 2–15
2.7.2. cpget Function (Getting a Coupled Set) .............................................................................. 2–16
2.7.3. cpput Subroutine (Storing a Coupled Set) ........................................................................... 2–16
2.7.4. cpsel Subroutine (Selecting or Deleting a Coupled Set) ....................................................... 2–17
2.7.5. ceinqr Function (Getting Information About a Constraint Equation Set) ............................... 2–17
2.7.6. ceget Function (Getting an Constraint Equation) ................................................................. 2–17
2.7.7. ceput Subroutine (Storing a Constraint Equation) ............................................................... 2–18
2.7.8. cesel Subroutine (Deleting or Selecting a Constraint Equation) ............................................ 2–18
2.8. Nodal Loading Routines .............................................................................................................. 2–18
2.8.1. disiqr Function (Getting a Information About Constraints) .................................................. 2–18
2.8.2. disget Function (Getting a Constraint from the Database) ................................................... 2–19
2.8.3. disput Subroutine (Storing a Constraint at a Node) .............................................................. 2–19
2.8.4. disdel Subroutine (Deleting a Constraint at a Node) ............................................................ 2–19
2.8.5. foriqr Function (Getting Information About Nodal Loads) .................................................... 2–20
2.8.6. forget Function (Getting a Constraint from the Database) ................................................... 2–20
2.8.7. forput Subroutine (Storing a Nodal Load at a Node) ............................................................ 2–20
2.8.8. fordel Subroutine (Deleting a Nodal Load at a Node) ........................................................... 2–21
2.8.9. ntpiqr Function (Getting Information About a Nodal Temperature) ..................................... 2–21
2.8.10. ntpget Function (Getting a Specified Nodal Temperature) ................................................. 2–21
2.8.11. ntpput Subroutine (Storing a Nodal Temperature) ............................................................ 2–22
2.8.12. ntpdel Subroutine (Deleting a Nodal Temperature) ........................................................... 2–22
2.8.13. nhgiqr Function (Getting Information About Nodal Heat Generations) .............................. 2–22
2.8.14. nhgget Function (Getting a Nodal Heat Generation) ......................................................... 2–23
2.8.15. nhgput Subroutine (Storing Nodal Heat Generation) ......................................................... 2–23
2.8.16. nhgdel Subroutine (Deleting a Nodal Heat Generation) ..................................................... 2–23
2.8.17. nfuiqr Function (Getting Information About Nodal Fluences) ............................................ 2–23
2.8.18. nfuget Function (Getting a Nodal Fluence) ........................................................................ 2–24
2.8.19. nfuput Subroutine (Storing a Nodal Fluence) .................................................................... 2–24
viii Guide to ANSYS User Programmable Features . ANSYS Release 10.0 . 002187 . © SAS IP, Inc.
2.8.20. nfudel Subroutine (Deleting a Nodal Fluence) ................................................................... 2–24

2.8.21. ndciqr Function (Getting Information About Nodal Current Densities) ............................... 2–24
2.8.22. ndcget Function (Getting a Nodal Current Density) ........................................................... 2–25
2.8.23. ndcput Subroutine (Storing a Nodal Current Density) ........................................................ 2–25
2.8.24. ndcdel Subroutine (Deleting a Nodal Current Density) ...................................................... 2–25
2.8.25. nvdiqr Function (Getting Information About Nodal Magnetic Virtual Displacements) ......... 2–26
2.8.26. nvdget Function (Getting a Nodal Magnetic Virtual Displacement) .................................... 2–26
2.8.27. nvdput Subroutine (Storing a Nodal Virtual Displacement) ................................................ 2–26
2.8.28. nvddel Subroutine (Deleting a Nodal Virtual Displacement) .............................................. 2–27
2.9. Element Loading Routines .......................................................................................................... 2–27
2.9.1. epriqr Function (Getting Information About Element Pressure/Convection) ......................... 2–27
2.9.2. eprget Function (Getting an Element Face Pressure) ........................................................... 2–27
2.9.3. eprput Subroutine (Storing an Element Face Pressure) ........................................................ 2–28
2.9.4. eprdel Subroutine (Deleting an Element Pressure/Convection) ............................................ 2–28
2.9.5. ecviqr Function (Getting Information About Element Convections) ..................................... 2–28
2.9.6. ecvget Function (Getting an Element Face Convection) ...................................................... 2–29
2.9.7. ecvput Subroutine (Storing an Element Face Convection) ................................................... 2–29
2.9.8. ecvdel Subroutine (Deleting a Convection on an Element) .................................................. 2–30
2.9.9. etpiqr Function (Getting Information About Element Temperatures) ................................... 2–30
2.9.10. etpget Function (Getting an Element Temperature) .......................................................... 2–31
2.9.11. etpput Subroutine (Storing an Element Temperature) ....................................................... 2–31
2.9.12. etpdel Subroutine (Deleting an Element Temperature) ..................................................... 2–31
2.9.13. ehgiqr Function (Getting Information About Element Heat Generation) ............................ 2–32
2.9.14. ehgget Function (Getting an Element Heat Generation) .................................................... 2–32
2.9.15. ehgput Subroutine (Storing an Element Heat Generation) ................................................. 2–33
2.9.16. ehgdel Subroutine (Deleting an Element Heat Generation) ............................................... 2–33
2.9.17. efuiqr Function (Getting Information About Element Fluences) ......................................... 2–33
2.9.18. efuget Function (Getting an Element Fluence) .................................................................. 2–34
2.9.19. efuput Subroutine (Storing an Element Fluence) ............................................................... 2–34
2.9.20. efudel Subroutine (Deleting an Element Fluence) .............................................................. 2–34
2.9.21. edciqr Function (Getting Information About Element Current Densities) ............................ 2–34
2.9.22. edcget Function (Getting Element Current Densities) ........................................................ 2–35
2.9.23. edcput Subroutine (Storing an Element Current Density) .................................................. 2–35
2.9.24. edcdel Subroutine (Deleting an Element Current Density) ................................................. 2–35
2.9.25. evdiqr Function (Getting Information About Element Virtual Displacements) ..................... 2–36
2.9.26. evdget Function (Getting an Element Virtual Displacement) .............................................. 2–36
2.9.27. evdput Subroutine (Storing an Element Virtual Displacement) .......................................... 2–36
2.9.28. eimiqr Function (Getting Information About Element Impedances) ................................... 2–37
2.9.29. eimget Function (Getting an Element Face Impedance) .................................................... 2–37
2.9.30. eimput Subroutine (Storing an Element Impedance) ......................................................... 2–37
2.9.31. eimdel Subroutine (Deleting an Element Impedance) ........................................................ 2–38
2.9.32. esfiqr Function (Getting Information About Element Surface Stress Data) .......................... 2–38
2.9.33. esfget Function (Getting Element Surface Stress Data) ...................................................... 2–38
2.9.34. esfput Subroutine (Storing Element Surface Stress Data) ................................................... 2–39
2.9.35. esfdel Subroutine (Deleting an Element's Surface Stress Data) ........................................... 2–39
2.9.36. efsdel Subroutine (Deleting a Flagged Surface on an Element) .......................................... 2–39
2.9.37. efsget function (Getting Element Face Flagged Surfaces) .................................................. 2–39
2.9.38. efsiqr function (Getting Information About Flagged Surfaces) ........................................... 2–40
2.9.39. efsput Subroutine (Storing an Element Face Flagged Surface) ........................................... 2–40
2.10. Results Information Routines ..................................................................................................... 2–40
2.10.1. dspiqr Function (Getting Information About Nodal Results) ............................................... 2–40
2.10.2. dspget Function (Getting a Nodal Result from the Database) ............................................. 2–41
Guide to ANSYS User Programmable Features . ANSYS Release 10.0 . 002187 . © SAS IP, Inc. ix
2.10.3. dspput Subroutine (Storing a Constraint at a Node) .......................................................... 2–41

2.10.4. dspdel Subroutine (Deleting a Result at a Node) ................................................................ 2–41
2.10.5. emsiqr Function (Getting Information About an Element's Miscellaneous Summable
Data) .......................................................................................................................................... 2–42
2.10.6. emsget Function (Getting an Element's Miscellaneous Summable Data) ............................ 2–42
2.10.7. emsput Subroutine (Storing an Element's Miscellaneous Summable Data) ......................... 2–42
2.10.8. emsdel Subroutine (Deleting an Element's Miscellaneous Summable Data) ....................... 2–43
2.10.9. enfiqr Function (Getting Information About Element Nodal Forces) ................................... 2–43
2.10.10. enfget Function (Getting an Element's Nodal Forces) ...................................................... 2–43
2.10.11. enfput Subroutine (Storing an Element's Nodal Forces) ................................................... 2–44
2.10.12. enfdel Subroutine (Deleting an Element's Nodal Forces) .................................................. 2–44
2.10.13. ensiqr Function (Getting Information About an Element's Nodal Stresses) ....................... 2–44
2.10.14. ensget Function (Getting an Element's Nodal Stresses) .................................................... 2–44
2.10.15. ensput Subroutine (Storing Nodal Stresses at an Element) ............................................... 2–45
2.10.16. ensdel Subroutine (Deleting an Element's Nodal Stresses) ............................................... 2–46
2.10.17. engiqr Function (Getting Information About an Element's Energies) ................................ 2–46
2.10.18. engget Function (Getting an Element's Energies) ............................................................ 2–46
2.10.19. engput Subroutine (Storing an Element's Energies and Volume) ...................................... 2–47
2.10.20. engdel Subroutine (Deleting an Element's Energies) ....................................................... 2–47
2.10.21. egriqr Function (Getting Information About an Element's Nodal Gradients) ..................... 2–47
2.10.22. egrget Function (Getting an Element's Nodal Gradients) ................................................. 2–48
2.10.23. egrput Subroutine (Storing an Element's Nodal Gradients) .............................................. 2–48
2.10.24. egrdel Subroutine (Deleting an Element's Nodal Gradients) ............................................. 2–48
2.10.25. eeliqr Function (Getting Information About an Element's Nodal Elastic Strains) ................ 2–49
2.10.26. eelget Function (Getting an Element's Nodal Elastic Strains) ............................................ 2–49
2.10.27. eelput Subroutine (Storing an Element's Nodal Elastic Strains) ......................................... 2–50
2.10.28. eeldel Subroutine (Deleting an Element's Nodal Elastic Strains) ....................................... 2–50
2.10.29. epliqr Function (Getting Information About an Element's Nodal Plastic Strains) ............... 2–50
2.10.30. eplget Function (Getting an Element's Nodal Plastic Strains) ............................................ 2–51
2.10.31. eplput Subroutine (Storing an Element's Nodal Plastic Strains) ........................................ 2–51
2.10.32. epldel Subroutine (Deleting an Element's Nodal Plastic Strains) ....................................... 2–52
2.10.33. ecriqr Function (Getting Information About an Element's Nodal Creep Strains) ................ 2–52
2.10.34. ecrget Function (Getting an Element's Nodal Creep Strains) ............................................ 2–53
2.10.35. ecrput Subroutine (Storing an Element's Nodal Creep Strains) ......................................... 2–53
2.10.36. ecrdel Subroutine (Deleting an Element's Nodal Creep Strains) ........................................ 2–54
2.10.37. ethiqr Function (Getting Information About an Element's Nodal Thermal Strains) ............ 2–54
2.10.38. ethget Function (Getting an Element's Nodal Thermal Stresses) ....................................... 2–55
2.10.39. ethput Subroutine (Storing an Element's Nodal Thermal Stresses) ................................... 2–55
2.10.40. ethdel Subroutine (Deleting an Element's Thermal, Initial, and Swelling Strains) ............... 2–56
2.10.41. euliqr Function (Getting Information About an Element's Euler Angles) ........................... 2–56
2.10.42. eulget Function (Getting an Element's Nodal Euler Angles) .............................................. 2–56
2.10.43. eulput Subroutine (Storing an Element's Euler Angles) .................................................... 2–57
2.10.44. euldel Subroutine (Deleting an Element's Euler Angles) ................................................... 2–57
2.10.45. efxiqr Function (Getting Information About Element Fluxes) ........................................... 2–57
2.10.46. efxget Function (Getting an Element Flux) ...................................................................... 2–58
2.10.47. efxput Subroutine (Storing an Element's Fluxes) .............................................................. 2–58
2.10.48. efxdel Subroutine (Deleting Element Fluxes) ................................................................... 2–58
2.10.49. elfiqr Function (Getting Information About Element Local Forces) ................................... 2–59
2.10.50. elfget Function (Getting an Element Local Force) ............................................................ 2–59
2.10.51. elfput Subroutine (Storing an Element's Local Forces) ..................................................... 2–59
2.10.52. elfdel Subroutine (Deleting Element Local Forces) ........................................................... 2–60
x Guide to ANSYS User Programmable Features . ANSYS Release 10.0 . 002187 . © SAS IP, Inc.
2.10.53. emniqr Function (Getting Information About Element Miscellaneous Non-summable

Data) .......................................................................................................................................... 2–60
2.10.54. emnget Function (Getting an Element's Miscellaneous Non-summable Data) .................. 2–60
2.10.55. emnput Subroutine (Storing an Element's Miscellaneous Non-summable Data) ............... 2–61
2.10.56. emndel Subroutine (Deleting an Element's Miscellaneous Non-summable Data) ............. 2–61
2.10.57. ecdiqr Function (Getting Information About Element Current Densities) .......................... 2–61
2.10.58. ecdget Function (Getting an Element Current Density) .................................................... 2–62
2.10.59. ecdput Subroutine (Storing an Element's Current Densities) ............................................ 2–62
2.10.60. ecddel Subroutine (Deleting Element Current Densities) ................................................. 2–62
2.10.61. enliqr Function (Getting Information About Element Nonlinear Tables) ........................... 2–62
2.10.62. enlget Function (Getting Element Nonlinear Tables) ........................................................ 2–63
2.10.63. enlput Subroutine (Storing an Element's Nonlinear Tables) .............................................. 2–63
2.10.64. enldel Subroutine (Deleting Element Nonlinear Tables) ................................................... 2–63
2.10.65. ehciqr Function (Getting Information About Calculated Element Heat Generations) ......... 2–64
2.10.66. ehcget Function (Getting a Calculated Element Heat Generation) .................................... 2–64
2.10.67. ehcput Subroutine (Storing an Element's Calculated Heat Generations) ........................... 2–64
2.10.68. ehcdel Subroutine (Deleting Element Calculated Heat Generations) ................................ 2–65
3. Subroutines for Users' Convenience ................................................................................................... 3–1
3.1. What Subroutines Does This Chapter Describe? ............................................................................. 3–1
3.1.1. Input and Output Abbreviations ........................................................................................... 3–1
3.2. General Subroutines ..................................................................................................................... 3–1
3.2.1. dptoch Subroutine (Retrieve Eight Characters From a Double Precision Variable) .................. 3–1
3.2.2. wrinqr Function (Obtain Information About Output) ............................................................. 3–2
3.2.3. erinqr Subroutine (Obtaining Information from the Errors Common) ..................................... 3–2
3.2.4. TrackBegin Subroutine (Beginning Tracking for a Subroutine Call) ......................................... 3–4
3.2.5. TrackEnd Subroutine (Ending Tracking for a Subroutine Call) ................................................ 3–4
3.2.6. erhandler Subroutine (Displaying ANSYS Errors) ................................................................... 3–4
3.2.7. intrp Subroutine (Doing Single Interpolation) ....................................................................... 3–5
3.2.8. tranx3 Subroutine (Processing Geometry for 3-D Line Elements) ........................................... 3–5
3.2.9. systop Subroutine (Stopping an ANSYS Program Run) .......................................................... 3–6
3.3. Vector Functions ........................................................................................................................... 3–6
3.3.1. vdot Function (Computing the Dot Product of Two Vectors) ................................................. 3–6
3.3.2. vsum Function (Summing Vector Components) .................................................................... 3–7
3.3.3. vmax Function (Retrieving the Maximum Vector Value at a Given Location) .......................... 3–7
3.3.4. lastv Function (Retrieving the Position of the Last Nonzero Term in a Double Precision Vec-
tor) ............................................................................................................................................... 3–7
3.3.5. izero Function (Setting an Integer Vector to Zero) ................................................................. 3–7
3.3.6. imove Function (Assigning Equal Values to Two Integer Vectors) .......................................... 3–7
3.3.7. vzero Subroutine (Initializing a Vector to Zero) ...................................................................... 3–7
3.3.8. vmove Subroutine (Moving One Vector into Another) ........................................................... 3–8
3.3.9. vimove Subroutine (Moving One Vector into Another Incrementally) .................................... 3–8
3.3.10. vinit Subroutine (Assigning a Scalar Constant to a Vector) ................................................... 3–8
3.3.11. viinit Subroutine (Assigning a Scalar Constant to a Vector Incrementally) ............................ 3–9
3.3.12. vapb Subroutine (Setting a Vector to Sum of Two Vectors) .................................................. 3–9
3.3.13. vapb1 Subroutine (Combining Two Vectors in One) ............................................................ 3–9
3.3.14. vapcb1 Subroutine (Multiplying a Vector to a Constant) ...................................................... 3–9
3.3.15. vamb Subroutine (Gets a Third Vector by Subtracting One Vector from Another) ................. 3–9
3.3.16. vamb1 Subroutine (Subtracting One Vector from Another) ............................................... 3–10
3.3.17. vmult Subroutine (Multiplying a Vector by a Constant) ...................................................... 3–10
3.3.18. vmult1 Subroutine (Multiplying a Vector by a Constant) .................................................... 3–10
3.3.19. vcross Subroutine (Defining a Vector via a Cross Product) .................................................. 3–10
3.3.20. vnorme Subroutine (Normalizing a Three-Component Vector) .......................................... 3–11
Guide to ANSYS User Programmable Features . ANSYS Release 10.0 . 002187 . © SAS IP, Inc. xi
3.3.21. vnorm Subroutine (Normalizing a Vector to Unit Length) .................................................. 3–11

3.3.22. ndgxyz Function (Getting the X,Y,Z Vector for a Node) ...................................................... 3–11
3.3.23. ndpxyz Subroutine (Storing X,Y,Z for a Node) .................................................................... 3–12
3.4. Matrix Subroutines ..................................................................................................................... 3–12
3.4.1. maxv Subroutine (Multiplying a Vector by a Matrix) ............................................................ 3–12
3.4.2. maxv1 Subroutine (Multiplying a Vector by a Matrix) .......................................................... 3–12
3.4.3. matxv Subroutine (Multiplying a Vector by a Full Transposed Matrix) .................................. 3–12
3.4.4. matxv1 Subroutine (Multiplying a Vector by a Full Transposed Matrix) ................................ 3–13
3.4.5. matxb Subroutine (Transposing a matrix) ........................................................................... 3–13
3.4.6. maat Subroutine (Changing a Matrix Value via Addition, Multiplication, and Transposi-
tion) ........................................................................................................................................... 3–13
3.4.7. matsym Subroutine (Filling the Upper Triangle from the Lower Triangle) ............................. 3–14
3.4.8. mctac Subroutine (Transposing a symmetric matrix) ........................................................... 3–14
3.4.9. tran Subroutine (Transposing a matrix) ............................................................................... 3–15
3.4.10. symeqn Subroutine (Solving Simultaneous Linear Equations) ............................................ 3–15
A. Creating External Commands in UNIX ................................................................................................... A–1
A.1. Introduction to External Commands ............................................................................................. A–1
A.2. Tasks in Creating an External Command ....................................................................................... A–1
A.2.1. Creating Compatible Code .................................................................................................. A–1
A.2.2. Creating a Shared Library .................................................................................................... A–2
A.2.3. Creating an External Table File ............................................................................................. A–3
A.2.4. Setting the ANSYS_EXTERNAL_PATH Environment Variable ................................................. A–4
A.2.5. Using External Commands ................................................................................................... A–4
A.2.6. Checking External Command Status .................................................................................... A–4
A.2.7. Resetting External Commands ............................................................................................. A–4
B. Creating External Commands in Windows ............................................................................................. B–1
B.1. Tasks in Creating an External Command ........................................................................................ B–1
B.1.1. Creating Compatible Code ................................................................................................... B–1
B.1.2. Creating a New Project ........................................................................................................ B–2
B.1.3. Creating an External Definition File ...................................................................................... B–2
B.1.4. Creating a Shared Library ..................................................................................................... B–2
B.1.5. Creating an External Table File ............................................................................................. B–2
B.1.6. Setting the ANSYS_EXTERNAL_PATH Environment Variable .................................................. B–3
B.1.7. Using External Commands ................................................................................................... B–3
B.1.8. Checking External Command Status ..................................................................................... B–4
B.1.9. Resetting External Commands ............................................................................................. B–4
Index ................................................................................................................................................. Index–1
List of Tables
1.1. ANSYS Exit Codes .............................................................................................................................. 1–56
xii Guide to ANSYS User Programmable Features . ANSYS Release 10.0 . 002187 . © SAS IP, Inc.
Preface
Conventions Used in This Guide
This guide uses the following typographic conventions to indicate various types of information:
Convention Indicates
COMMAND ANSYS commands. These are shown as uppercase, bold text (for example,
K, DDELE, and so on). In the online documentation, these provide hyper-
links to the appropriate command reference information.
Menu > Item Menu paths (sometimes referred to as GUI paths). These are shown as bold
text with mixed-case, separated by angle brackets ">". An angle bracket
indicates a branch to a new menu item.
path/filename.ext File names, which may or may not include directory paths. These are shown
as lower-case, bold text, unless case is significant. Examples are shown
with the UNIX directory separator character "/" (slash); if you are using a
Microsoft Windows system, use "\" (backslash) as your directory separator
character.
ARGUMENT Arguments for numeric values (such as VALUE, INC, TIME) in command
syntax. These are shown as upper-case italic text. On some commands,
non-numeric convenience labels (for example, ALL and P) can also be
entered for these arguments.
Argument Arguments for alphanumeric values (for example, Lab or Fname) in com-
mand syntax. These are shown in mixed-case, italic letters. The guide also
uses italic text for emphasis.
ANSYS Guide Title The name of an ANSYS manual.
command,arg1,arg2 Command input listings, ANSYS output listings, and text that a user enters
are shown in fixed-width font.
Note-- Information that supplements the main topic being discussed, such as
important tips or guidelines.
Caution: Actions or situations that could cause problems, unexpected ANSYS beha-
vior, or unexpected results.
Warning Actions or situations that can shut down ANSYS, damage files, cause loss
of data, and so on.
About the Programmer's Guide Set

The ANSYS programmer's guide set provides information about the various programming interfaces available
to customers. These manuals assume that you have at least a basic knowledge of programming (a working
knowledge of Fortran 90 would be very helpful). The set of four manuals includes:
The APDL Programmer's Guide

This guide was designed for ANSYS users that have some programming skills and wish to tap the power of
the ANSYS Parametric Design Language (APDL) to increase the productivity. APDL is a scripting language
that is very similar to Fortran 90. The guide describes how to define parameters (variables), how to create
macro programs using APDL, how to use APDL for simple user interaction, how to encrypt an APDL macro,
and how to debug an APDL macro.
The UIDL Programmer's Guide
The UIDL Programmer's Guide covers the User Interface Design Language (UIDL) including how to modify
or construct menus, dialogs and online help from within ANSYS.
Preface
Guide To ANSYS User Programmable Features

ANSYS provides a set of Fortran 90 functions and routines that are available to extend or modify the program's
capabilities. Using these routines requires relinking the ANSYS program, resulting in a custom version of
ANSYS. ANSYS provides an external commands capability which you can use to create shared libraries
available to ANSYS (either from ANSI standard C or Fortran 90). you can use this feature to add custom exten-
sions to ANSYS without the need to rebuild the ANSYS executable.
Guide to Interfacing with ANSYS
This guide describes a group of utilities as well as a set Fortran 90 routines that you can use to directly access
the ANSYS database. You can also use these capabilities to access data in any of the binary files that ANSYS
writes or uses.
xiv Guide to ANSYS User Programmable Features . ANSYS Release 10.0 . 002187 . © SAS IP, Inc.
Chapter 1: Using User Programmable Features
(UPFs)
1.1. Introduction to UPFs
Because the ANSYS program has an open architecture, you can write your own routines or subroutines in C or
FORTRAN and either link them to ANSYS or use them as external commands. In fact, some of the ANSYS features
you see today as "standard" offerings originated as user programmable features (UPFs). You can take advantage
of UPFs if you are licensed for any of the following products:
• ANSYS Multiphysics
• ANSYS Mechanical
• ANSYS Structural
• ANSYS PrepPost
• ANSYS University Advanced
• ANSYS University Research
Other versions of the ANSYS program do not support UPFs.
1.1.1. What Are UPFs?

User programmable features are ANSYS capabilities you can use to write your own routines. Using UPFs, you
can tailor the ANSYS program to your organization's needs. For instance, you may need to define a new material
behavior, a special element, or a modified failure criterion for composites. You can even write your own design
optimization algorithm that calls the entire ANSYS program as a subroutine.
UPFs provide the following capabilities:
• To read information into or fetch information from the ANSYS database, you can create subroutines and
either link them into the ANSYS program or use them in the external command feature (see Appendix A:,
Creating External Commands in UNIX for more information about external commands). If you link these
subroutines into ANSYS, you are limited to 10 database access commands. Such commands, created
through either method, operate at all levels of ANSYS operation, including the begin, preprocessor, gen-
eral postprocessor, time-history postprocessor, and solution levels. For more information about accessing
the ANSYS database, see Chapter 2, “Accessing the ANSYS Database”.
• ANSYS provides a set of routines you can use to specify various types of loads, including BF or BFE loads,
pressures, convections, heat fluxes, and charge densities. These routines are described under Section 1.7:
Routines for Customizing Loads.
• Another set of UPF routines enables you to define the following material properties: plasticity, creep,
swelling law, viscoplasticity, hyperelasticity, and layered element failure criteria. To see inputs and outputs
for these routines, see Section 1.6: Routines for Customizing Material Behavior.
• Several sets of UPFs enable you to define new elements and to adjust the nodal orientation matrix. See
Section 1.3: Routines for Creating New Elements for more information.
• Another group of UPFs enables you to modify and monitor existing elements. For details, see Section 1.5:
Routines for Modifying and Monitoring Existing Elements.
Chapter 1: Using User Programmable Features (UPFs)
• You can customize UPF userop to create a custom design optimization routine. For more information,
see Section 1.12: Creating Your Own Optimization Routine.
• You can call the ANSYS program as a subroutine in a program you have written. To learn how, see Sec-
tion 1.8: Running ANSYS as a Subroutine.
1.1.2. What You Should Know Before Using UPFs

Before you do anything with linked UPFs, contact your on-site ANSYS system support person to get the permissions
needed to access the appropriate ANSYS files.
The UPF subroutines are written in FORTRAN 90; some extensions are used. They contain comments intended
to give you enough detail to develop your own versions of the subroutines.
To use UPFs successfully, you need strong working knowledge of the following:
• The ANSYS program.

• The UPF subroutines themselves. Study the UPF subroutines before customizing them, and make sure
that you fully understand the subroutines, as well as any applicable functions. Unless you review them
carefully, a few UPF subroutines may seem like a maze with many logic paths to consider. You may have
to set special variables correctly in order to run your customized ANSYS program without errors. Even if
you have in-depth knowledge of the ANSYS input and your desired outputs, you still need to ensure that
everything that needs to be done in the UPF subroutines is done properly in your custom version.
• FORTRAN 90. Besides knowing how to write FORTRAN 90 subroutines, you must be sure that the level of
the FORTRAN 90 compiler is as least as high as the level mentioned in your ANSYS installation manual.
You also need to know what to do should the computer abort the program due to an arithmetic error, a
file read error, a memory access error, and so on.
• The mathematics of the phenomenon you are planning to include.
Important
• UPFs are not available or will behave unpredictably in certain data center environments or on some
hardware configurations. You should take special care when using UPFs on parallel systems. You should
never use the /CONFIG command or a config.ans file to activate parallelization on a system with UPFs.
For additional information, consult your ANSYS installation manual or your on-site ANSYS system support
person
• Carefully consider whether you wish to use UPFs, especially if you are linking them into ANSYS (rather
than into a shared library for use as external commands). When you add your own routines to ANSYS by
either method, you are creating a customized, site-dependent version of the program. ANSYS, Inc. considers
the use of UPFs a nonstandard use of the program, one that the ANSYS Quality Assurance verification
testing program does not cover. Therefore, you are responsible for verifying that the results produced
are accurate and that your customizations do not adversely affect unchanged areas of the ANSYS program.
• Although the flexibility that UPFs offer can be highly attractive, UPF usage is a complicated process that
can introduce errors. Consider what you want your customizations to accomplish. You may be able to
customize ANSYS more easily and safely with macros than with UPFs.
For other guidelines for nonstandard uses of the ANSYS program, see the ANSYS Advanced Analysis Techniques
Guide.
1–2 Guide to ANSYS User Programmable Features . ANSYS Release 10.0 . 002187 . © SAS IP, Inc.
Section 1.1: Introduction to UPFs
1.1.3. Planning Your UPFs

UPFs can range from a simple element output routine for customized output to a complex user optimization.
Before you start programming, ask yourself these questions:
• Does the capability you want already exist in the ANSYS program? Remember, a capability may not be
obvious at first, especially to a novice ANSYS user.
• Does your proposed subroutine fit into the ANSYS program architecture and specifications? For example,
you can not program a user element that has more than 32 degrees of freedom per node or more than
44 nodes per element.
Use your experience and judgment to answer these questions. If you need help to do so, consult your ANSYS
Support Distributor. If you can respond "no" to both questions, then the user routine you are planning will be
both useful and feasible.
1.1.4. Studying the ANSYS User Routines

Your ANSYS distribution medium contains the source codes for all user routines:
• If you have a UNIX version of ANSYS, the source code for the UPF routines resides in directory /an-
sys_inc/v100/ansys/customize/user/<platform>.
• If you are running the ANSYS program under Windows, the UPF source code resides in directory Program
Files\Ansys Inc\V100\ansys\custom\user\<platform>.
Most of the user routines have at least simple functionality, so print out the routines of interest before you start
programming. All source routines are concatenated onto file user.f or user.for. Delete the routines you do not
want and make appropriate changes to the others.
1.1.5. Programming in Languages Other than FORTRAN

If you access UPFs by compiling and linking a custom version of ANSYS, the preferred method is to design and
program your custom routine in FORTRAN 90. Although you can use languages other than FORTRAN 90, in each
case FORTRAN 90 must provide the interface to the rest of the ANSYS program. If you do use a language other
than FORTRAN 90, such as the C programming language, your code may require a FORTRAN shell.
You need to take care when calling FORTRAN subroutines from C subroutines. You must use the symbol associated
with the FORTRAN subroutine when invoking the subroutine from a C function. This symbol typically differs
slightly from the FORTRAN subroutine name, and is extremely system dependent.
On many UNIX systems, you build this symbol name by taking the FORTRAN subroutine name, converting it to
lower case, and appending an underscore. For example, the symbol name for the FORTRAN subroutine
HeapInquire would be heapinquire_. You would have to use the symbol heapinquire_ in the invoking C
function to avoid an unsatisfied external reference when the program is linked.
Keep in mind that the instance described above is just an example. Compilers from different vendors may construct
the symbols differently. Please consult the manuals for your specific compiler for information on how to call
FORTRAN subroutines from C functions.
1.1.6. Developing UPFs: a Suggested Strategy

When developing UPFs by compiling and linking a custom version of ANSYS, you can avoid problems and reduce
debugging time by following a gradual, orderly process. Start with a trivial test. Then, add a few changes at a
Guide to ANSYS User Programmable Features . ANSYS Release 10.0 . 002187 . © SAS IP, Inc. 1–3
time so that if something goes wrong, the error that caused the problem should be isolated and relatively easy
to locate.
The example procedure below illustrates this type of gradual process. The example assumes that you are creating
a new element for the ANSYS program. You develop and test it by performing these steps:
1. Get the applicable element subroutines for uel101 from the ANSYS distribution medium. Add a small
change (such as a misspelling in an output heading), then compile and link the subroutines.
2. Using a production version of the ANSYS program, run several analysis problems using LINK8 (and maybe
other elements) to form a base for comparison.
3. Replacing LINK8 with USER101, run the same problem on your custom version of ANSYS.
4. Compare the results from Steps 2 and 3. If they show discrepancies other than the misspelled output
heading, resolve them before you go on to Step 5.
5. Choose the standard ANSYS element that most closely resembles your new custom element, and run
some problems on a production version of ANSYS using that element.
6. Modify the element subroutines to match the element you chose in Step 5. Then, compile and link those
subroutines into a custom version of ANSYS.
7. Again, compare the results from Steps 5 and 6. If they don't match, resolve the discrepancies before
moving on to Step 8.
8. Modify your element subroutines to include the features you want. Then, compile and link the subroutines
into a custom version of ANSYS.
9. Test the changes with a series of increasingly complex problems for which you already know the answers.
1.1.7. Include Decks

In addition to the subroutines and functions described in this chapter, most of the include decks (files with the
extension .inc) used by ANSYS are on your ANSYS distribution medium. These include decks, also called commons,
contain important but relatively small amounts of data. The ANSYS program also handles large amounts of data
using various access routines (GET and PUT), as described elsewhere in this manual.
To insert include decks in a subroutine or function, use the INCLUDE (or an analogous) statement. Do not modify
an include deck under any circumstances. The following table lists some of the more commonly used ANSYS include
files and the definitions they contain:
Include File Description

acelcm.inc Contains accelerations and angular velocities
ansysdef.inc Defines general ANSYS parameters. You must include this common
to retrieve the parameter values of MEM_INTEGER, MEM_DOUBLE,
MEM_COMPLEX, or MEM_REAL.
cmopt.inc Contains optimization variables
echprm.inc Defines parameters for element characteristics
elccmt.inc Defines element characteristics (comments only)
elecom.inc Contains element-specific information
elparm.inc Defines pointers for the element data array
elucom.inc Defines the element degree of freedom pointers
etycom.inc Element type data
impcom.inc Used by all routines and functions in the ANSYS program
Include File Description

outpcm.inc Defines output control information
soptcm.inc Contains solution options and keys
stack.inc Defines stack storage. You must include this common in any routines
that access stack space.
stepcm.inc Contains load step information
usvrcm.inc Defines storage of user-defined variables
1.1.8. Linking User Routines

After you make your changes to the user routines supplied on your ANSYS distribution medium, you can either:
• Link your routines into shared libraries (as discussed starting in Appendix A:, Creating External Commands
in UNIX).
• Compile and link your custom routines into the ANSYS program itself. This is discussed for UNIX systems
in Section 1.1.9: Compiling and Linking UPFs on UNIX Systems and for Windows systems in Section 1.1.10:
Compiling and Linking UPFs on Windows Systems. You may need superuser or root privileges to run the
procedure that does the linking.
1.1.9. Compiling and Linking UPFs on UNIX Systems

As mentioned previously, the source files for the user routines reside in subdirectory /ansys_inc/v100/ansys/cus-
tomize/user/<platform>. If you modify any of these subroutines, select the Relink ANSYS option from
ANS_ADMIN utility to link these changes.
When you run a user-linked version of the ANSYS program, the ANSYS output will include the following:
NOTE: This ANSYS version was linked by Licensee
The Relink ANSYS option compiles all FORTRAN files (files ending with .F) and all C files (files ending with .c) in
the current working directory. The procedure then loads all object files (files ending with .o) along with the default
ANSYS objects and libraries in /ansys_inc/v100/ansys/customize/user/<platform> (where platform is a dir-
ectory that uniquely identifies the hardware platform version). The new executable file created will be named
ansys.e100t and will reside in the current directory.
FORTRAN files are assumed to be FORTRAN 90 (some extensions are allowed), and C files are assumed to be
ANSI C.
When relinking on UNIX systems, you can choose to link a distributed version of ANSYS as well. If you choose to
link a distributed version, the executable must reside in the same directory path on all systems. However, you
need to link it on only one system; you can then copy the executable to the other systems. You cannot link a
distributed version on Windows systems.
Chapter 1 of the ANSYS Installation and Configuration Guide for UNIX lists the compilers you will need to use UPFs.
Creating a Shared Library You can also set up UPFs on some UNIX and Linux systems through a shared library
as an alternative to creating a custom ANSYS executable. Copy the ANSUSERSHARED script from /an-
sys_inc/v100/ansys/customize/user/<platform> into your working directory. All Fortran (*.F) and C (*.c) files
that you want to include in your shared library should also reside in your working directory. To compile all *.F
and *.c routines, issue the following command:
sh ./ANSUSERSHARED
If the compile was successful, you will be asked if a shared file is to be created. Choose Yes to create a shared
library named libansuser.so (or .sl).
To use this library, set the ANS_USER_PATH environment variable to point to the working directory where the
libansuser shared library resides. Use one of the following commands, depending on the UNIX shell you are
using:
setenv ANS_USER_PATH workingdirectory
or
export ANS_USER_PATH=workingdirectory
When you run a user-linked version of the ANSYS program, the ANSYS output will echo the value of
ANS_USER_PATH and will include the following:
NOTE: This ANSYS version was linked by Licensee
To return to the original version of ANSYS, unset the ANS_USER_PATH environment variable.
ANSYS recommends using the ANSUSERSHARED script as a template to try compilers that are not supported
by ANSYS, Inc., such as the GNU compilers. To do so, edit the ANSUSERSHARED script, making changes to the
appropriate platform logic. Note that if you do use compilers other than those listed in the ANSYS Installation
and Configuration Guides, you will need to debug (i.e., find missing libraries, unsatisfied externals, etc.) them
yourself. ANSYS, Inc. does not provide assistance for customers using unsupported compilers or if the resulting
objects are not compatible with the ANSYS executable(s) as distributed.
Note — This shared library method is not available on Windows or IBM platforms, or with a Distributed
ANSYS executable.
1.1.10. Compiling and Linking UPFs on Windows Systems

As mentioned previously, the source files for the user routines reside in subdirectory Program Files\Ansys
Inc\V100\ansys\custom\user\<platform> (where <platform> is a directory that uniquely identifies the hardware
platform version.)
Note — If you intend to modify any of the user routines, make a duplicate copy of the Program
Files\Ansys Inc\V100\ansys\custom\user\<platform> directory to preserve the original files for later
use, if necessary.
If you modify any of these subroutines, select the Relink ANSYS option from the ANS_ADMIN utility to link
these changes into the ANSYS program. This procedure compiles all FORTRAN files (files ending with .F) and all
C files (files ending with .c) in the Program Files\Ansys Inc\V100\ansys\custom\user\<platform> directory.
The procedure then loads all object files (files ending with .obj), along with the default ANSYS objects and libraries.
The executable file created will be named ansys.exe and will reside in Program Files\Ansys Inc\V100\ansys\cus-
tom\user\<platform>.
Note — ANS_ADMIN does not exist on Windows 64-bit systems. In order to relink on Itanium systems,
you must open a command prompt window, set your current directory to Program Files\Ansys
Inc\V100\ansys\custom\user\win64, and run ansys100 with the -custom option.
When relinking on a Windows system, you can choose to link with the small export list (“Do you want to link with
the small export list?”).
• Answer “No” to link ANSYS with all symbols exported (which may be required by third party interfaces).
The link time will be significantly longer. The ANSYS executable provided on the media is linked using
this option, and ANSYS recommends that you select this option.
• Answer “Yes” to link ANSYS with the minimum amount of symbols needed to be exported for ANSYS to
run. Select this option for the fastest link time.
Caution: When creating a custom ANSYS executable, the executable must be named ansys.exe. This
requirement is due to shared library usage.
After relinking the ANSYS executable, the program can be executed by either of the following two methods:
1. To execute the relinked version of the ANSYS program:
• Click Start>Programs>ANSYS 10.0>Configure ANSYS Products

• In the launcher, select the Customization/Preferences tab, then browse to the path which contains
the relinked ansys.exe. Select other desired options then pick Run to execute the customized an-
sys.exe.
2. To execute the relinked ansys.exe from a Command Prompt window, use one of the following commands.
• Interactive:
ansys100 -custom <path> -p <product variable> -g
• Batch:
ansys100 -custom <path> -b -p <product variable>-j jobname -i <input file> -o <output file>
where “path” indicates the full path to the relinked ansys.exe.
Note — Output from a user-linked version will contain the following statement:
This ANSYS version was linked by Licensee
Note — You will need all the compilers specified in Chapter 1 of the ANSYS Installation and Configuration
Guide for Windows to use these user programmable features. The user programmable features are loaded
onto the system only if you perform a custom installation and choose to install the customization tools.
1.1.11. Activating UPFs

The ANSYS program activates many UPFs through a specific user action. This can be through a command option
or a user selection. For example, to activate a user element, all you need to do is select it as one of the element
types in a model (using the ET command). You then set the element attribute pointer (TYPE command), and
define elements using the solid modeling or direct generation method.
UPFs that are not activated by the means described above must be activated by either of the following methods:
• Issuing the USRCAL command

• Choosing menu path Main Menu>Preprocessor>Loads>-Load Step Opts->Other>User Routines or
Main Menu>Solution>-Load Step Opts->Other>User Routines.
To activate or deactivate the routines, issue the command USRCAL,Rnam1, ...Rnam9, where Rnam1 and Rnam9
are the names of specific routines. You can specify up to nine routines with one USRCAL command, or you can
issue multiple USRCAL commands.
Issue the command USRCAL,NONE to deactivate all valid user subroutines. To list the status of the routines, issue
the command USRCAL,STAT.
For a list of the user routines that the USRCAL command (or its equivalent menu paths) affects, see the USRCAL
command description in the ANSYS Commands Reference.
If you do not activate the UPFs in this manner, standard ANSYS logic will be used by default. For instance, when
you apply a convection load, standard ANSYS logic is the default even if you have a user convection routine
linked in. The user convection routine must be activated by the USRCAL command or its menu equivalent.
1.1.12. Running Your Custom Executable

You can run a custom executable from the Customization/Preferences tab of the launcher:
Enter the full pathname to the custom executable in the ANSYS Custom Exe field. Do not include the -custom
flag.
This script resides in the /ansys_inc/v100/ansys/bin/<platform> directory on UNIX or the Program Files\ANSYS
Inc\V100\ANSYS\bin\<platform> directory on Windows. When run, the script searches the current working
directory for the custom ANSYS executable (ansys.e100t by default on UNIX or ansys.exe on Windows). If the
custom ANSYS executable resides in a separate directory (or has a name other than ansys.e100t on UNIX), you
can specify a different path and filename.
Caution: If you are running on a Windows system and you create a custom ANSYS executable, the ex-
ecutable must be named ansys.exe. This requirement is due to shared library usage.
On UNIX, you can also run your custom executable via command line.
ansys100 -custom /pathname/ansys.e100t
1.1.13. Verifying Your Routines

After compiling and linking your new user routine, test and verify it using whatever procedures you think are
adequate. Remember, verifying that your customized version of the ANSYS program works properly is your re-
sponsibility.
Make certain that your custom version of the ANSYS program performs correctly for the combinations of elements,
analysis types, materials, boundary conditions, and so on. that you plan to use. Confirm that the logic you intro-
duced is correct and does not produce any unwanted side effects.
In testing your custom user routines, you also should verify that the changes you have made do not affect
standard, non-customized ANSYS features. To do so, you can compare the results of a set of problems from the
ANSYS Verification Manual run on the standard version and on the customized version. Input for these problems
is also available on your ANSYS distribution medium.
Always remember: your last step, a series of steps, or even your concept may be wrong. Proceed in clear steps,
and verify your work as often as possible. Keep intermediate versions of your modified source code on backup
media.
Note — If you contact your site's ANSYS system support person or any ANSYS, Inc. representative about
the performance of a custom version of ANSYS, always tell him or her explicitly that you are using a user
programmable feature. If you feel that an error exists in an unrelated feature of the ANSYS program,
demonstrate the suspected error in an non-customized, production version of the program before you
report the error to an ANSYS. Inc. representative.
1.1.14. Debugging Commands

To debug errors in your user routines, you can use commands and other features not documented in the ANSYS
Commands Reference. Use these commands only for extremely small models with few solution iterations (otherwise,
they will generate an excessive amount of output). /TRACK and /DEBUG are described in detail below. Two
other useful commands are OUTEQ and /NERR. The command OUTEQ,ON can be used to output results from
all equilibrium iterations. The command /NERR,,,-1 causes errors to be reported as before, but the run continues
anyway, normally terminating with either a) system abort or b) incorrect answers. The /NERR,,,-1 command is
intended for program debugging and may generate erroneous results. You should remove this statement before
generating solutions for production use.
1.1.14.1. Tracking the Path of Program Logic

The /TRACK command issues a message when the program logic enters and leaves some of the higher level
subroutines. Subroutines TrackBegin and TrackEnd (see Chapter 3, “Subroutines for Users' Convenience”) set
up the /TRACK command. Then, issue the command using the format below
/TRACK,MonLevel,PrintLevel,SumLevel
MonLevel
The level for timing monitoring.
PrintLevel
The level for enter/exit printout.
SumLevel
The level at which the timing sum is output.
Each of these arguments can be any value between 0 and 9 (default is 0).
You can use the /TRACK command to identify which section of code is causing the program to abort. For example,
to flag up to eight levels of subroutines to determine when the program logic enters and leaves them, you would
issue the command /TRACK,,8.
1.1.14.2. Debugging Elements and Solutions

The /DEBUG command generates debugging at various points in the output. You can specify one of three formats
for /DEBUG: solution debug format, element debug format, and general debug format.
1.1.14.2.1. Solution Debug Format

Issue the command using this format:
/DEBUG,-1,F1,F2,F3,F4,F5,F6,F7,F8,F9
F1
1 (provides basic solution control debugging)
F2
1 (provides transient debugging using Newmark constants)
2 (provides transient debugging using velocities and accelerations)

F3
1 (provides element matrix debugging and prints matrix + load vectors)
2 (provides element matrix debugging with load vectors only)
3 (provides element matrix debugging with matrix diagonals and load vectors)
F4
1 (provides auto time stepping debugging)
F5
1 (provides multifield debugging)
F6
1 (provides arc-length debugging)
F7
1 (provides basic Newton-Raphson debugging)
2 (provides Newton-Raphson debugging and prints out-of-balance forces or incremental displacement or

each DOF)
3 (provides Newton-Raphson debugging and prints applied loads and n-r restoring force for each DOF)
F8
1,2 (provides displacement vector debugging with displacement pointers)
2 (provides displacement vector debugging with incremental displacement)
3 (provides displacement vector debugging with contact database)

F9
1 (provides temporary programmer debugging)
1.1.14.2.2. Element Debug Format

/DEBUG,-3,G1,G2,G3,G4,G5,G6,G7,G8,G9
G1
1 (provides basic element pass debugging)
G2
1 (provides element displacement and coordinate debugging)
G3
1 (provides element matrix debugging and prints matrix + load vectors)
2 (provides element matrix debugging with load vectors only)
3 (provides element matrix debugging with matrix diagonals and load vectors)
G4
1 (provides element load information debugging)
G5
1 (provides element real constant debugging)
G6
1 (provides element saved variable debugging)
G7
1 (provides element material property debugging with linear material properties)
2 (provides element material property debugging with nonlinear properties)

G8
1,2 (provides element nonlinear debugging with plasticity)
2 (provides element nonlinear debugging with large deformation)
3 (provides element nonlinear debugging with contact database)

G9
1 (provides temporary programmer debugging)
1.1.14.2.3. General Debug Format

/DEBUG,H1,H2,,H4,H5,,,,H9
H1
1 (provides file header record information)
2 (provides input line (character))
3 (provides input line (decoded))

H2
1 (provides wavefront reordering and element checking debugging)
2 (provides meshing debugging)

H4
1 (provides nodal coordinate system transformation debugging)
2 (provides displacement updating debugging)

H5
1 (provides pre-element debugging, element characteristics debugging, and element field load debugging)
H9
-1 (print the progress of the resume (or save) to isolate location of failure)
-99 (resume only the command log information for subsequent LGWRITE command)
1.1.15. Other Useful Commands

Two other ANSYS commands, NSVR and /UCMD, can help you implement UPFs. (Neither command has an
equivalent GUI path.) Use the NSVR command to define the number of extra variables that need to be saved for
user programmable element options, such as user plasticity.
Issue the /UCMD command to make a user routine into a custom command. For more information, see Section 1.9:
Defining Your Own Commands later in this chapter.
1.1.16. Generating Output

You can generate output controlled by the /OUTPUT command by using the FORTRAN write statement. The
output unit for this statement is usually called IOTT. IOTT may be defined with the function wrinqr. See the
discussion on the function wrinqr in Chapter 3, “Subroutines for Users' Convenience” for more details.
1.2. Reading Large Data Files More Rapidly

When files containing ANSYS-related data are large, loading them into the ANSYS program or writing them out
to an external file can be a slow process. For example, consider an ANSYS problem file which contains nearly
462,000 lines, 150,000 of which contain nodal data and 97,383 of them containing data for elements. Because
many of the lines in this file are in command format, the ANSYS program spends a lot of time reading it.
You can shorten the time ANSYS takes to read such files by including two commands in your programs, UPFs,
or macros: EBLOCK and NBLOCK. The NBLOCK command converts nodal data into fixed format data blocks
(which ANSYS can read more quickly than commands). The EBLOCK command places element data into a fixed
format block, one line per element. These commands also compress displacement constraint data to one line
per constraint node. See Chapter 3, “Using CDREAD and CDWRITE” in the Guide to Interfacing with ANSYS for more
information on the use of these commands.
1.3. Routines for Creating New Elements

The next few pages describe the user routines and supporting subroutines you use to create new elements. Using
these routines, you can create new element types, add them to the ANSYS element library, and use them as
"regular" elements. You can create up to six independent element types (names USER100 - USER105). For
demonstration purposes, example copies of the routines for MASS21, the structural mass element, and LINK8,
the 3-D spar element, are included on the ANSYS distribution medium as uel100 and uel101 respectively.
1.3.1. Input and Output Abbreviations

The descriptions of the routines or functions within this chapter describe both the input arguments and output
arguments. Argument information includes the argument's type, size and intent.
• Argument type is one of the following:
int - integer
dp - double precision
log - logical
chr - character
dcp - double precision complex
• Argument size is one of the following:
sc - scalar variable
ar(n) - array variable of length n
func - functional return value
• Argument intent is one of the following:
in - input argument
out - output argument
inout - both an input and an output argument
Section 1.3: Routines for Creating New Elements
1.3.2. User Routines

Routines uec100 through uec105 describe the element characteristics. Routine elccmt (on the distribution
medium) describes the input for these routines in detail. You can use subroutines uex100 through uex105 to
override default logic. Routines uec100 through uec105 define parameters such as:
• 2-D or 3-D geometry

• Degree of freedom set
• Symmetric or unsymmetric matrix
• Number of nodes
• Number of body loads (for example, temperatures)
• Number of surface loads (for example, pressures)
• Number of real constants
• Number of variables to be saved
• Number of rows in element matrices
• Linear or nonlinear element.
Routines uel100 through uel105 calculate the element matrices (stiffness, specific heat, and so on), the element
load vector (force, heat flow, and so on), and any element output quantities. The element printout also is generated,
and the variables to be saved are calculated and stored in the results file.
Other user routines available for manipulating element information include the following:
• Routines uep100 through uep105 provide printed output of line elements. The general ANSYS postpro-
cessor, POST1, calls the subroutines, or you can call them using uel100 through uel105.
• Routine usertr allows access to the nodal transformations.
• Routine userac describes some of the data handling.
1.3.3. Subroutine uec100 (Defining Characteristics of the usr100 Routine)

*deck,uec100
subroutine uec100 (elcdn,ielc,kerr)
c ***** this subroutine defines the characteristics of user100.
c
c *** ansys(r) copyright(c) 2004
c *** ansys, inc.
c *** Notice - This file contains ANSYS Confidential information ***
c
c typ=int,dp,log,chr siz=sc,ar(n) intent=in,out,inout
c
c input arguments:
c variable (typ,siz,intent) description
c ielc (int,ar(IELCSZ),inout) - element characteristics
c
c kerr (int,sc,inout) - error flag up to this point.
c (do not initialize to zero)
c
c output arguments:
c elcdn (chr,sc,out) - name of element
c
c kerr (int,sc,inout) - error flag (set to 1 if error)
c note to programmers: the validity of keyopt values may be checked here
c
1.3.3.1. Subroutines uec101 through uec105

The input and output arguments for subroutines uec101, uec102, uec103, uec104, and uec105 is identical to
the uec100 subroutine listed above.
1.3.4. Subroutine uex100 (Overriding Element Characteristic Defaults)

*deck,uex100
subroutine uex100 (ielc,kerr)
c *** subroutine to override element characteristic defaults ***
c *** hence, this routine is needed only in rare cases.
c
c *** ansys, inc.
c
c *** input and output are the same as for uec100, except that this
c *** logic is called after the defaulting logic is finished.
c *** this defaulting is done in ansys subroutine echdft(not a upf).
c *** as indicated above, this routine is rarely needed, but if it is
c *** desired to see the effect of echdft, you may print out the ielc array
c *** leaving uec100 and print it out again entering this routine.
c
c typ=int,dp,log,chr siz=sc,ar(n) intent=in,out,inout
c
c input arguments:
c
c kerr (int,sc,inout) - error flag up to this point.
c (do not initialize to zero)
c
c output arguments:
c
c kerr (int,sc,inout) - error flag (set to 1 if error)
c *** standard defaults are taken. the final results are given with
c *** the debug accessed with /debug,,, ,,1
c
1.3.4.1. Subroutines uex101 through uex105

The source code for subroutines uex101, uex102, uex103, uex104, and uex105 is identical to the code for
subroutine uex100 listed above.
1.3.5. Subroutine uel100 (Computing Element Matrices, Load Vectors, and

Results)
*deck,uel100
subroutine uel100 (elem,ielc,elmdat,eomask,nodes,locsvrL,kelreq,
x kelfil,nr,xyz,u,kelout,zs,zass,damp,gstif,zsc,zscnr,elvol,elmass,
x center,elener,edindxL,lcerstL)
c --- general lumped mass is demonstrated --------------------------------
c *** primary function:
c 1. compute element matrices, load vectors, and results
c *** secondary functions:
c 2. maintain element solution data
c *** user programmable functions may not be used in parallel processing ***
Section 1.3: Routines for Creating New Elements
c *** ansys, inc.
c input arguments:
c elem (int,sc,in) - element label (number)
c ielc (int,ar(IELCSZ),in) - array of element type characteristics
c (IELCSZ = array size, defined in echprm)
c elmdat (int,ar(10),in) - array of element data
c eomask (int,sc,in) - bit pattern for element output
c (see outpcm)
c nodes (int,ar(nnod),in) - array of element node numbers
c (nnod = number of nodes; 1 in this case)
c locsvrL (int,sc,in) - location of the saved variables
c on file .esav for this element
c kelreq (int,ar(10),in) - matrix and load vector form requests
c (indices for kelreq are given with output
c arguments below)
c kelfil (int,ar(10),in) - keys indicating incoming matrices and
c load vectors (indices for kelfil are the
c same as given for kelreq with output
c arguments below)
c nr (int,sc,in) - matrix and load vector size
c xyz (dp,ar(6,nnod),in) - nodal coordinates (orig) and rotation angle
c u (dp,ar(nr,5),in) - element nodal solution values
c output arguments:
c kelout (int,ar(10),out) - keys indicating created matrices and
c load vectors (indices for kelout
c are the same as for kelreq below,
c as well as kelin and kelout later)
c zs (dp,ar(nr,nr),inout)- stiffness/conductivity matrix (kelreq(1))
c zass (dp,ar(nr,nr),inout)- mass matrix (kelreq(2))
c damp (dp,ar(nr,nr),inout)- damping/specific heat matrix (kelreq(3))
c gstif (dp,ar(nr,nr),inout)- stress stiffness matrix (kelreq(4))
c zsc (dp,ar(nr),out) - applied f vector (kelreq(5))
c zscnr (dp,ar(nr),out) - n-r restoring f vector (kelreq(6))
c or imaginary f vector (kelreq(7))
c elvol (dp,sc,out) - element volume
c elmass (dp,sc,out) - element mass
c center (dp,ar(3),out) - centroid location
c elener (dp,ar(5),out) - element energies
c edindxL(LONG,ar(25),out) - element result data file indexes
c lcerstL(LONG,sc,inout) - position on result file
1.3.6. Subroutines uel101 through uel105

The input and output arguments for subroutines uel101, uel102, uel103, uel104, and uel105 is identical to
subroutine uel100 listed above.
1.3.7. Subroutine uep100 (Printing Output for User Elements)

*deck,uep100
subroutine uep100 (iott,elem,nodes,mat, kept,tem,
x kemn,fluen, kems,force, kens,sig, keel,epel,
x keth,eptho,epswel,epino, kenl,sigepl,sigrat,hpres,epeq,
x kepl,eppl, kecr,epcrp)
c
c *** primary function: produce printed output for user100
c
c *** ansys, inc.
c
c ********** this subroutine is provided for user information *********
c *** user programmable features may not be used in parallel processing ***
c
c input arguments:
c iott (int,sc,in) - output unit number

c elem (int,sc,in) - element number
c nodes (int,ar(2),in) - node numbers
c mat (int,sc,in) - material number
c kept (int,sc,in) - key to print temperatures
c tem (dp,ar(2),in) - nodal temperatures
c kemn (inr,sc,in) - key to print fluences
c fluen (dp,ar(2),in) - neutron fluences
c kems (int,sc,in) - key to print moment forces
c force (int,sc,in) - member force fx
c kens (int,sc,in) - key to print strains
c sig (dp,sc,in) - axial stress
c keel (int,sc,in) - key to print elastic strain
c epel (dp,sc,in) - axial elastic strain
c keth (int,sc,in) - key to print thermal,initial,swelling strai
c eptho (dp,sc,in) - axial thermal strain
c epswel (dp,sc,in) - swelling strain
c epino (dp,sc,in) - initial axial strain
c kenl (int,sc,in) - key set if any nonlinear materials present
c sigepl (dp,sc,in) - stress in stress-strain curve
c sigrat (dp,sc,in) - stress ratio
c hpres (dp,sc,in) - hydrostatic pressure
c epeq (dp,sc,in) - plastic equivalent strain
c kepl (int,sc,in) - key to print plastic strain
c eppl (dp,sc,in) - plastic strain
c kecr (int,sc,in) - key to print creep strain
c epcrp (dp,sc,in) - creep strain
c
c output arguments: none
c
1.3.8. Subroutines uep101 through uep105

The source code for subroutines uep101, uep102, uep103, uep104, and uep105 is identical to subroutine uep100
listed above.
1.3.9. Subroutine usertr (Adjusting the Nodal Orientation Matrix)

*deck,usertr
subroutine usertr (node,tr)
c *** primary function: adjust nodal orientation matrix
c secondary function: study nodal orientation matrix
c accessed with ielc(notran) = -100
c
c *** ansys, inc.
c
c
c typ=int,dp,log,chr,dcp siz=sc,ar(n) intent=in,out,inout
c
c input arguments:
c node (int,sc,in) - node number being acted upon
c tr (dp,ar(32,32),inout) - nodal to global orientation matrix
c
c output arguments:
c tr (dp,ar(32,32),inout) - nodal to global orientation matrix
c
c tr is a matrix that is already defined based on the degrees
c of freedom selected.
c it does not normally need to be changed.
c it may be printed out here to study. its functional size is
c nr by nr, where nr is the number of degrees of freedom in the
c element
c
Section 1.4: Supporting Subroutines for Element Creation
1.3.10. Subroutine userac (Accessing Element Information)

This subroutine is provided for demonstration purposes.
*deck,userac
subroutine userac (elem)
c *** primary function: To demonstrate user access of element information.
c --- Given the element number, all information about the element is avaiable.
c --- Starting with elmdat, one can get the element type, real constant number,
c --- the material number, the element coordinate system number, as well as
c --- the node numbers. Then, one can get more information about any or all
c --- of these things. The below demonstrates getting the element type and
c --- real constants.
c
c *** ansys, inc.
c
c input arguments:
c
c output arguments:
c none
c
1.4. Supporting Subroutines for Element Creation

The subroutines described on the next few pages support the user routines used to create new elements.
1.4.1. Subroutine nminfo (Returning Element Reference Names)

*deck,nminfo
subroutine nminfo (ielc,rname)
c *** primary function: set element reference names
c *** secondary functions: none
c
c
c input arguments:
c ielc (int,ar(*),inout) - element characteristic vector
c rname (chr,sc,in) - 8 character reference name
c
c output arguments:
c ielc (int,ar(*),inout) - element characteristic vector with
c element name encoded
c
1.4.2. Subroutine svgidx (Fetching the Index for Saved Variables)

*deck,svgidx
subroutine svgidx (locsvr,svindx)
c *** primary function: get the index for saved variables
c input arguments:
c locsvr (LONGINT,sc,in) - pointer to location of index
c output arguments:
c svindx (int,ar(20),out) - the 20 word index of svr variables
c 1,2-starting loc of this eles svr sets
c 3- length of eles svr sets
c 4-11-relative starting loc for each set

c 4-structural svrs
c 5-thermal/electric/fluid svrs
c 6-magnetic svrs
c 7-nonlinear svrs
c 8-plasticity svrs
c 9-creep svrs
c 10-coupled svrs
c 11-user svrs
c 12-initial strain svrs
c 13-section data after FiberSIM conversion
c (shell181 only)
c 14-20 spares
1.4.3. Subroutine svrget (Fetching Saved Variable Data for an Element)

*deck,svrget
subroutine svrget (svindx,nset,nsvr,svr)
c *** primary function: get svr data set for an element
c input arguments:
c svindx (int,ar(20),in) - index for svr for this element (see svgidx)
c nset (int,sc,in) - the set number in this index
c = 1 - structural svrs
c = 2 - thermal/electric/fluid svrs
c = 3 - magnetic svrs
c = 4 - nonlinear svrs
c = 5 - plasticity svrs
c = 6 - creep svrs
c = 7 - coupled svrs
c = 8 - user svrs
c = 9 - initial stress svrs
c (2,42,82,45,92,95 only)
c = 10 - section data after FiberSIM conversion
c (shell181 only)
c = 11-17 - spares (note that the first three
c items in svindx are not available)
c nsvr (int,sc,inout) - number of dp words expected in this set
c output arguments:
c nsvr (int,sc,inout) - number of dp words in this set
c svr (dp,ar(nsvr),in) - data in this set
1.4.4. Subroutine svrput (Writing an Element's Saved Variable Set)

*deck,svrput
subroutine svrput (svindx,nset,leng,svr)
c *** primary function: write out a svr data set for an element
c input arguments:
c svindx (int,ar(20),inout)- the index for svr for this element
c (see svgidx)
c nset (int,sc,in) - the set number in this index (same as svrget)
c = 1 - structural svrs
c = 2 - thermal/electric/fluid svrs
c = 3 - magnetic svrs
c = 4 - nonlinear svrs
c = 5 - plasticity svrs
c = 6 - creep svrs
c = 7 - coupled svrs
c = 8 - user svrs
c = 9 - initial stress svrs
c (2,42,82,45,92,95 only)
c = 10 - section data after FiberSIM conversion

c (shell181 only)
c = 11-17 - spares (note that the first three
c items in svindx are not available)
c leng (int,sc,in) - number of dp words in this set
c svr (dp,ar(leng),in) - data in this set
c output arguments:
c svindx (int,ar(10,2),inout)- updated index
1.4.5. Subroutine svpidx (Writing the Saved Variable Element Index to a File)
*deck,svpidx
subroutine svpidx (locsvr,svindx)
c *** primary function: write the svr element index onto file
c *** secondary functions: update the locsvr pointer to next element
c input arguments:
c locsvr (LONGINT,sc,inout) - pointer to start of svr for element
c svindx (int,ar(10,2),in) - index to svr for this element
c low and high parts of 64 bit address
c output arguments:
c locsvr (LONGINT,sc,inout) - pointer to start of svr for next element
1.4.6. Subroutine mreuse (Determining Which Element Matrices Can Be Reused)

*deck,mreuse
subroutine mreuse (kelrqq,kelfil,elem,ielc,kmasrt,knlmg,kconve,
x kpheno,kprop,nprop,prop,propo,krvro,rvr,rvro,amodo,asymo, kelin)
c determine which Matrices can be REUSEd and which must be recomputed
c from iteration to iteration.
c Note: a few special elements have some supplementary logic
c to adjust these results further. No attempt as been made to
c include all such logic in these routines.
c
c Second note: this logic is essentially the same as the old
c sfrm logic. Hopefully, further simplifications and enhancements
c will be made in the future. (Especially in gap elements and in
c multilayer elements)
c the whole idea of kpheno, a holdover from the sfrm routines,
c needs to be looked at and possibly eliminated.
c
c
c input arguments:
c kelrqq (int,ar(10),in) - request keys (needed for this analysis)
c kelfil (int,ar(10),in) - keys indicating matrices on the file
c kmasrt (int,sc,in) - does the mass matrix have rotational DOF?
c 0 - no 1 - yes(with nlgeom, sfrm1n)
c knlmg (int,sc,in) - nonlinear magnetic curve exists in this
c element
c 0 - no 1 - yes
c kconve (int,sc,in) - key indicating existence of convections
c in this element
c 0,1 - no 2 or more - yes
c must be input as 'i' if not used, as is
c changed in this routine(for analyzer).
c i = 0 must be used in calling routine
c if kpheno = 1.
c kpheno (int,sc,in) - key for type of phenomenon/level of check
c 0 - structural like old sfrm1n,1s,3n,3s,fl
c 1 - thermal like old sfrm1c,1t,2t,3t
c 2 - electrical/magnetic like some of old
c sfrmpo
c 3 - general like old sfrmoo
c kprop (int,sc,in) - key indicating which material properties
c in the prop vector that need to be
c checked (see below)
c nprop (int,sc,in) - number of properties
c prop (dp,ar(nprop),in) - current mat props
c propo (dp,ar(nprop),inout)- previous material properties
c krvro (int,sc,in) -
c = 0 - real constants are used by this element, and the old
c values(rvro) have been saved; or the element does not
c use real constants. Any change of real constants
c causes all matrices to be reformed.
c = 1 - real constants are used by this element and the old
c values(rvro) have been saved. However, any change
c of real constants will cause the run to terminate,
c because the results would be too unpredictable.
c (e.g. gap elements)
c = 2 - element is nonlinear, so do not bother to check
c = 3 - real constants are used by this element, and the old
c values(rvro) have been saved. However, no checking is
c done in this routine because of needed customized logic.
c = 4 - real constants are used by this element, but the old
c values(rvro) have not been saved because it was
c decided not to use this much storage. therefore, no check
c can be made to determine if matrices should be reformed.
c (e.g. 100 layer elements)
c = 5 - real constants are used by this element, but the old
c values(rvro) have not been saved because the real
c constants have no effect on matrix formulation.
c (e.g. acoustic elements)
c rvr (dp,ar(*),in) - current real constants
c rvro (dp,ar(*),inout) - previous real constants
c amodo (dp,sc,inout) - previous value of mode
c asymo (dp,sc,inout) - previous value of isym
c
c output arguments:
c propo (dp,ar(nprop),inout)- current material properties
c rvro (dp,ar(*),inout) - current real constants
c amodo (dp,sc,inout) - current value of mode
c asymo (dp,sc,inout) - current value of isym
c kelin (int,ar(10),out) - keys indicating matrices to form
c
1.4.7. Subroutine subrd (Reading Element Load Data for a Substructure Gen-
eration Run)
*deck,subrd
subroutine subrd (iel,key,nd,vect,ka)
c *** primary function: read element load data from file for substructure
c generation run
c input arguments:
c iel (int,sc,in) - element number
c key (int,sc,in) - type of load data
c = 1 temperature
c = 2 fluences
c = 3 heat generation rates
c = 4 current densities
c =10 pressures
c =11 film coefficients
c =12 bulk temperatures
c =13 extra displacement shapes
c =14 thermal strains(eptho in el42)
c =15 thermal flux (as in el55)
c =16 initial strains(epino in el01)
c =17 magnetic virtual displacements
c =18 calculated source field(hsn in el96)

c =20 element load vector
c =30 copy - do not scale(tempev in el42)
c first load step only
c nd (int,sc,in) - number of data items
c output arguments:
c vect (dp,ar(nd),out) - array of load data
c ka (int,sc,out) - load activation key
c = 0 no load for this data
c = 1 load is active
1.4.8. Subroutine subwrt (Writing an Element Load Vector to a File for a Sub-
structure Generation Run)
*deck,subwrt
subroutine subwrt (iel,nvect,key,nd,vect,ref)
c *** primary function: write element load vect to file for substructure
c generation run
c input arguments:
c nvect (int,sc,in) - number of load vectors
c (current load step number)
c key (int,sc,in) - type of load vect
c = 1 temperature
c = 2 fluences
c = 4 current densities
c =10 pressures
c =11 film coefficients
c =12 bulk temperatures
c =13 extra displacement shapes
c =14 thermal strains(eptho in el42)
c =15 thermal flux (as in el55)
c =16 initial strains(epino in el01)
c =17 magnetic virtual displacements
c =18 calculated source field(hsn in el96)
c =20 element load vector
c =30 copy - do not scale(tempev in el42)
c nd (int,sc,in) - number of vect items
c vect (dp,ar(nd),in) - array of load data
c ref (dp,sc,in) - reference value for zero load
1.4.9. Subroutine rvrget (Fetching Real Constants for an Element)

*deck,rvrget
subroutine rvrget (iel,ireal,ielc,nrvr,rvr)
c *** primary function: get the real constants for an element
c typ=int,dp,log,chr,dcp siz=sc,ar(n),func intent=in,out,inout

c ireal (int,sc,in) - real constant set number
c ielc (int,ar(*),in) - elment type characteristics
c output arguments:
c nrvr (int,sc,out) - number of real variables
c rvr (dp,ar(*),out) - element real constants
1.4.10. Subroutine propev (Evaluating a Group of Material Properties)

*deck,propev
subroutine propev (iel,mtr,lp,tem,prop,n)
c *** primary function: to evaluate a group of material properties
c propev is used to pass two or more material property numbers

c thru the lp array to determine which temperature dependent
c material properties are to be evaluated.
c thus, the 3 prope1 calls:
c call prope1 (elem,mat, 1,tem,e(1))

c call prope1 (elem,mat,10,tem,alpha)
c call prope1 (elem,mat,13,tem,dens)
c should be combined as:
c integer lp(3)
c data lp /1,10,13/
c call propev (elem,mat,lp(1),tem,prop(1),3)
c input arguments:
c mtr (int,sc,in) - material number(input quantity mat, mat comma
c lp (int,ar(n),in) - keys for which specific value is requested
c each group must be in ascending
c order (ex,ey,ez, etc)
c if negative, a required property
c if zero, leave prop term unchanged
c ---- MP command labels --------
c EX = 1, EY = 2, EZ = 3, NUXY= 4, NUYZ= 5, NUXZ= 6, GXY = 7, GYZ = 8,
c GXZ = 9, ALPX=10, ALPY=11, ALPZ=12, DENS=13, MU =14, DAMP=15, KXX =16,
c KYY =17, KZZ =18, RSVX=19, RSVY=20, RSVZ=21, C =22, HF =23, VISC=24,
c EMIS=25, ENTH=26, LSST=27, PRXY=28, PRYZ=29, PRXZ=30, MURX=31, MURY=32,
c MURZ=33, PERX=34, PERY=35, PERZ=36, MGXX=37, MGYY=38, MGZZ=39, EGXX=40,
c EGYY=41, EGZZ=42, SBKX=43, SBKY=44, SBKZ=45, SONC=46, SLIM=47, ELIM=48,
c USR1=49, USR2=50, USR3=51, USR4=51, FLUI=53, ORTH=54, CABL=55, RIGI=56,
c HGLS=57, BM =58, QRAT=59, REFT=60, CTEX=61, CTEY=62, CTEZ=63, THSX=64,
c THSY=65, THSZ=66, DMPR=67, =68, =69, =79, =71, =72,
c =73, =74, =75, =76, =77, =78, =79, =80
c (see mpinit for uncommented code)
c (see chapter 2 of the elements volume of the user's manual
c for a detailed description))
c tem (dp,sc,in) - temperature at which to evaluate material

c n (int,sc,in) - number of properties to be evaluated.
c (20 maximum)
c If n = 1, use prope1 instead.
c output arguments:
c prop (dp,ar(n),out) - values of material property
1.4.11. Subroutine prope1 (Evaluating One Material Property)

*deck,prope1
subroutine prope1 (iel,mtr,icon,tem,prop1)
c *** primary function: to evaluate one material property
c (if multiple material properties are to
c be evaluated, use propev)
c *** secondary functions: to ensure that certain required props are present
c input arguments:
c mtr (int,sc,in) - material number
c icon (int,sc,in) - key for which specific value is requested
c (negative if property is required)

c EX = 1, EY = 2, EZ = 3, NUXY= 4, NUYZ= 5, NUXZ= 6, GXY = 7, GYZ = 8,
c GXZ = 9, ALPX=10, ALPY=11, ALPZ=12, DENS=13, MU =14, DAMP=15, KXX =16,
c KYY =17, KZZ =18, RSVX=19, RSVY=20, RSVZ=21, C =22, HF =23, VISC=24,
c EMIS=25, ENTH=26, LSST=27, PRXY=28, PRYZ=29, PRXZ=30, MURX=31, MURY=32,
c MURZ=33, PERX=34, PERY=35, PERZ=36, MGXX=37, MGYY=38, MGZZ=39, EGXX=40,
c EGYY=41, EGZZ=42, SBKX=43, SBKY=44, SBKZ=45, SONC=46, SLIM=47, ELIM=48,
c USR1=49, USR2=50, USR3=51, USR4=51, FLUI=53, ORTH=54, CABL=55, RIGI=56,
c THSY=65, THSZ=66, DMPR=67, =68, =69, =79, =71, =72,
c =73, =74, =75, =76, =77, =78, =79, =80
c (see mpinit for uncommented code)
c tem (dp,sc,in) - temperature at which to evaluate material
c output arguments:
c prop1 (dp,sc,out) - value of material property
1.4.12. Subroutine pstev1 (Evaluating Material Properties for 1-D Elements)

*deck,pstev1
subroutine pstev1 (elem,matin,tem,prop)
c *** primary function: to evaluate material properites for 1-d elements
c
c
c input arguments:
c elem (int,sc,in) - element number (for anserr)
c matin (int,sc,in) - material reference number
c if negative, no required properties
c tem (dp,sc,in) - temperature for evaluation
c
c output arguments:
c prop (dp,ar(5),out) - material properties: ex,nuxy,gxy,alpx,dens
c
1.4.13. Subroutine tbuser (Retrieving User Table Data)

*deck,tbuser
subroutine tbuser (mat,numitm,tbprop)
c *** primary function: return the tb data for the user table
c input arguments:
c mat (int,sc,in) - material property number
c numitm (int,sc,in) - the number of data items requested
c output arguments:
c tbprop (dp,ar(numitm),out) - array of tb data
1.4.14. Subroutine plast1 (Updating an Element's Plastic History)

*deck,plast1
subroutine plast1 (option,elem,intpt,mat,kstartL,tem,dtem,e,
x ktform,dens,flu,dflu,epel,eppl,statev,usvr,
x epeq,plwork,sigepl,sigrat,et)
c *** primary function: to update the plastic history (for 1 component)
c used by: LINK1, LINK8, BEAM23, BEAM24, and
c SOLID65(reinforcing)
c *** secondary functions: to compute the material tangent matrix if requested
c input arguments:
c option (int,sc,in) - plasticity option
c elem (int,sc,in) - element number (label)

c intpt (int,sc,in) - element integration point number
c mat (int,sc,in) - material reference number
c kstartL (intL,sc,in) - virtual starting address of the data table
c tem (dp,sc,in) - temperature at the end of this substep
c dtem (dp,sc,in) - temperature increment over this substep
c e (dp,sc,in) - elastic modulus
c ktform (int,sc,in) - request key for tangent matrix formation
c dens (dp,sc,in) - material density
c flu (dp,sc,in) - fluence at the end of this substep
c dflu (dp,sc,in) - fluence increment over this substep
c epel (dp,sc,inout) - modified total strain (trial strain)
c eppl (dp,sc,inout) - plastic strain at previous substep
c statev (dp,ar(6),inout) - state variables at previous substep
c usvr (dp,ar(*),inout) - user-defined state variables (for userpl)
c epeq (dp,sc,inout) - effective plastic strain at prev substep
c plwork (dp,sc,inout) - accumulated plastic work at prev substep
c output arguments:
c epel (dp,sc,inout) - elastic strain
c eppl (dp,sc,inout) - updated plastic strain
c statev (dp,ar(6),inout) - updated state variables
c usvr (dp,ar(*),inout) - updated user-defined state variables
c epeq (dp,sc,inout) - updated effective plastic strain
c plwork (dp,sc,inout) - updated accumulated plastic work
c sigepl (dp,sc,out) - stress value on stress-strain curve
c sigrat (dp,sc,out) - ratio of trial stress to yield stress
c et (dp,sc,out) - tangent modulus
c internal variables:
c deppl (dp,sc) - equivalent plastic strain increment
1.4.15. Subroutine plast3 (Updating an Element's Plastic History, 4 or 6 com-

ponents)
*deck,plast3
subroutine plast3 (option,elem,intpt,mat,kstartL,ncomp,tem,dtem,
x prop,d,ktform,dens,flu,dflu,epel,eppl,statev,usvr,epeq,plwork,
x sigepl,sigrat,dt,kplst,dtt,cmel)
c *** primary function: to update the plastic history (for 4 or 6 components)
c used by: PLANE02, PLANE13, PIPE20, SHELL43, SHELL51, PIPE60,
c SOLID62, SOLID65, SHELL91, SHELL93, SHELL143, SOLID191
c and by way of plast3creep : PLANE42, SOLID45, PLANE82, SOLID92, SOLID95
c *** secondary functions: to compute the material tangent matrix if requested
c input arguments:
c option (int,sc,in) -
plasticity option
c elem (int,sc,in) -
element number (label)
c intpt (int,sc,in) -
element integration point number
c mat (int,sc,in) -
material reference number
c kstartL (intL,sc,in) -
virtual starting address of the data table
c ncomp (int,sc,in) -
number of stress/strain components (4 or 6)
c tem (dp,sc,in) -
temperature at the end of this substep
c dtem (dp,sc,in) -
temperature increment over this substep
c prop (dp,ar(9),in) -
material property array (ex,ey,ez,
c gxy,gyz,gxz, uxy,uyz,uxz)
c d (dp,ar(ncomp,ncomp),in) - elastic stress-strain matrix
c dens (dp,sc,in) - material density
c epel (dp,ar(ncomp),inout)- modified total strain (trial strain)
c eppl (dp,ar(ncomp),inout)- plastic strain at previous substep
c statev (dp,ar(ncomp,6),inout)- state variables at previous substep
c usvr (dp,ar(*),inout) - user-defined state variables (for pluser)
c epeq (dp,sc,inout) - effective plastic strain at prev substep
c plwork (dp,sc,inout) - accumulated plastic work at prev substep
c kplst (int,sc,in) - plane stress key (form dtt if kplst=1)
c output arguments:
c epel (dp,ar(ncomp),inout)- elastic strain
c eppl (dp,ar(ncomp),inout)- updated plastic strain
c statev (dp,ar(ncomp,6),inout)- updated state variables
c sigepl (dp,sc,out) - stress value on stress-strain curve
c dt (dp,ar(ncomp,ncomp),out)- material modulus modified by dscpar
c dtt (dp,ar(ncomp,ncomp),out)- consistent tangent modulus
c (formed only if kplst=1)
c deppl (dp,sc) - equivalent plastic strain increment
1.4.16. Subroutine creep1 (Updating an Element's Creep History)

*deck,creep1
subroutine creep1 (option,elem,intpt,mat,kstartL,epel,e,epcrp,
x statev,usvr,tem,dtem,fluen,dflu,sig)
c *** primary function: to update the creep history for 1-d elements
c used by: LINK1, LINK8, BEAM23, BEAM24, and
c SOLID65(reinforcing)
c input arguments:
c option (int,sc,in) - creep option
c e (dp,sc,in) - elastic modulus
c epcrp (dp,sc,inout) - creep strain at previous substep
c statev (dp,ar(7),inout) - state variables at previous substep
c usvr (dp,ar(*),inout) - user-defined state variables (for usercr)
c fluen (dp,sc,in) - fluence at the end of this substep
c epel (dp,sc,inout) - elastic strain adjusted for creep increment
c sig (dp,sc,inout) - stress (not really used)
c output arguments:
c epcrp (dp,sc,inout) - updated creep strain
c statev (dp,ar(7),inout) - updated state variables
c sig (dp,sc,inout) - stress (recomputed if requested)
1.4.17. Subroutine creep3 (Updating an Element's Creep History, 3-D Elements)

*deck,creep3
subroutine creep3 (option,elem,intpt,mat,kstartL,ncomp,epel,e,
x posn,d,epcrp,statev,usvr,tem,dtem,fluen,dflu,kplst,sig,hsig)
c *** primary function: to update the creep history for 3-d elements
c used by: PLANE02, PLANE13, PIPE20, PLANE42, SHELL43, SOLID45,
c SHELL51, PIPE60, SOLID62, SOLID65, PLANE82, SHELL91,
c SOLID92, SHELL93, SOLID95, SHELL143, SOLID191
c input arguments:
c option (int,sc,in) - creep option

c ncomp (int,sc,in) - number of stress/strain components (4 or 6)
c e (dp,sc,in) - elastic young'S MODULUS
c posn (dp,sc,in) - poisson'S RATIO
c d (dp,ar(ncomp,ncomp),in) - elastic stress-strain matrix
c epcrp (dp,ar(ncomp),inout)- creep strain at previous substep
c statev (dp,ar(ncomp*5+2),inout)- state variables at previous substep
c usvr (dp,ar(*),inout) - user-defined state variables (for usercr)
c kplst (int,sc,in) - plane stress/plane strain key
c sig (dp,ar(ncomp),inout)- stresses (not used in input)
c hsig (dp,ar(1),inout) - hydrostatic stress (not used in input)
c output arguments:
c epel (dp,ar(ncomp),inout)- elastic strain adjusted for creep increment
c epcrp (dp,ar(ncomp),inout)- updated creep strain
c statev (dp,ar(ncomp*5+2),inout)- updated state variables
c sig (dp,ar(ncomp),inout)- stresses (redefined if c13 > 0)
c hsig (dp,sc,inout) - hydrostatic stress (redefined if c13 > 0)
1.4.18. Subroutine swell1 (Updating an Element's Swelling History)

*deck,swell1
subroutine swell1 (option,elem,intpt,mat,kstartL,epswel,epel,e,
x fluen,dfluen,tem,dtem,usvr)
c *** primary function: to update the swelling history for 1-d elements
c used by: LINK1, LINK8, BEAM23, and BEAM24
c input arguments:
c option (int,sc,in) - swelling option
c epswel (dp,sc,inout) - swell strain at previous substep
c dfluen (dp,sc,in) - fluence increment over this substep
c usvr (dp,ar(*),inout) - user-defined state variables (for usersw)
c output arguments:
c epel (dp,sc,inout) - elastic strain adjusted for swelling inc
c epswel (dp,sc,inout) - updated swelling strain
1.4.19. Subroutine swell3 (Updating an Element's Swelling History, 3-D Ele-

ments)
*deck,swell3
subroutine swell3 (option,elem,intpt,mat,kstartL,ncomp,epswel,
x epel,e,nuxy,fluen,dfluen,tem,dtem,usvr)
c *** primary function: to update the swelling history for 3-d elements
c used by: PLANE02, PLANE13, PIPE20, PLANE42, SHELL43, SOLID45,
c SHELL51, PIPE60, SOLID62, PLANE82, SHELL91, SOLID92,
c SHELL93, SOLID95, SHELL143, SOLID191
c input arguments:
c option (int,sc,in) - swelling option
c ncomp (int,sc,in) - number of stress/strain components (4 or 6)
c epswel (dp,sc,inout) - swell strain at previous substep
c nuxy (dp,sc,in) - poisson'S RATIO
c usvr (dp,ar(*),inout) - user-defined state variables (for usersw)
c output arguments:
c epel (dp,ar(ncomp),inout)- elastic strain adjusted for swelling inc
c epswel (dp,sc,inout) - updated swelling strain
1.4.20. Function elLenPsvrBuf (Determining additional ESAV Record for

Plasticity)
*deck,elLenPsvrBuf
function elLenPsvrBuf (mat, plOpt, ncomp)
c************************************************************************

c determine additional esave record for plasticity
c input arguments
c ===============
c mat (int,sc,in) - material ID
c plOpt (int,sc,in) - plasticity option
c ncomp (int,sc,in) - number of strain components (1,4, or 6)
c output arguments
c ================
c elLenPsvrBuf (int,sc,out) - number of extra data items saved
c local variables
c ===============
c************************************************************************
1.4.21. Function nlget (Retrieving Material Nonlinear Property Information)

*deck,nlget
function nlget (mat,iprop,prop)
c *** primary function: get a material non-linear property (TB) table.
c input arguments:
c iprop (int,sc,in) - property number (tbpnum in tblecm)
c use 13 for tb,user
c use 14 for tb,nl
c output arguments:
c nlget (int,sc,out) - number of property values
c prop (dp,ar(nlget),out) - vector of the property values
c (the first 15(tbhdsz) items are a header,

c given below. The terms are defined in
c tblecm.inc)
c --- terms of the descriptor record:
c header(1) = tbtyp
c header(2) = tbtems
c header(3) = temloc
c header(4) = dprtem
c header(5) = tbrow
c header(6) = tbcol
c header(7) = rowkey
c header(8) = nxtloc
c header(9) = nxttem
c header(10) = temptr
c header(11) = tbpt
c header(12) = tbsiz
c header(13) = tbopt
c header(14) = hypopt
c header(15) = tbnpts
1.4.22. Subroutine usereo (Storing Data in the nmisc Record)

*deck,usereo
subroutine usereo (elem,iout,nbsvr,bsvr,nnrsvr,nrsvr,npsvr,psvr,
x ncsvr,csvr,nusvr,usvr,nnode,nodes,xyz,vol,leng,time,
x timinc,nutot,utot,maxdat,numdat,udbdat)
c
c *** primary function: to call userou, which allows user to store
c data in nmisc record
c
c
c input arguments:
c iout (int,sc,in) - output unit number
c nbsvr (int,sc,in) - number of basic element variables
c bsvr (dp,ar(nbsvr),in) - basic element variables
c nnrsvr (int,sc,in) - number of nonlinear element variables
c nrsvr (dp,ar(nnrsvr),in) - nonlinear element variables
c npsvr (int,sc,in) - number of plasticity element variables
c psvr (dp,ar(npsvr),in) - plasticity element variables
c ncsvr (int,sc,in) - number of creep element variables
c csvr (dp,ar(ncsvr),in) - creep element variables
c nusvr (int,sc,in) - number of user-supplied element variables
c usvr (dp,ar(nusvr),in) - user-supplied element variables
c nnode (int,sc,in) - number of nodes
c nodes (int,ar(nnode),in) - node numbers
c xyz (dp,ar(6,nnode),in) - nodal coordinates and rotations (virgin)
c vol (dp,sc,in) - element volume (or area if 2-d)
c leng (dp,sc,in) - element length (beams,spars,etc)
c time (dp,sc,in) - current time
c timinc (dp,sc,in) - current sub step time increment
c nutot (int,sc,in) - length of dof solution vector utot
c utot (dp,ar(nutot),in) - solution vector
c maxdat (int,sc,in) - size of user output array (3 x nnode)
c actually, = ielc(nmnmup)
c
c output arguments:
c numdat (int,sc,out) - number of user output items in array udbdat
c udbdat (dp,ar(maxdat),out) - user output items to be placed at the end
c of the nmisc record
c
1.4.23. Subroutine eldwrtL (Writing Element Data to a File)

*deck,eldwrtL
subroutine eldwrtL (ielem,edtype,lcerstL,edindxL,nval,value)
c *** primary function: output element data to result file.
c input arguments:
c ielem (int,sc,in) - element number
c edtype (int,sc,in) - element data type (see elparm)
c lcerstL (LONG,sc,inout) - pointer to results file position
c edindxL (LONG,ar(25),inout)- index to results file data
c nval (int,sc,in) - the total number of values
c if edtype = EDEMS,
c this should -always- be ielc(nmsmis),
c unless there is a variable number, as
c in the layered shell elements.
c value (dp,ar(nval),in) - output values (real)
1.4.24. Subroutine eldwrnL (Writing Element Nonsummable Miscellaneous

Data to the Results File)
*deck,eldwrnL
subroutine eldwrnL (elem,ielc,lcerstL,edindxL,nudb,udbdat,
x nval,value,ndval)
c *** primary function: output element nonsummable miscellaneous data
c to result file
c input arguments:
c ielc (int,ar(IELCSZ),in) - element characteristic vector
c defined in elccmt
c lcerstL (LONG,sc,inout) - pointer to results file position
c edindxL (LONG,ar(25),inout)- index to results file data
c nudb (in,sc,inout) - size of what the user wants to add
c udbdat (dp,ar(*),in) - what the user wants to add
c nval (int,sc,in) - the total number of values to
c be output(does not include nudb)
c this should -always- be ielc(NMNMIS),
c unless there is a variable number, as
c in the layered shell elements.
c value (dp,ar(ndval),in) - output values
c ndval (int,sc,in) - dimension of value - must be no less than
c ielc(NMNMIS) + ielc(NMNMUP)
1.4.25. Subroutine trrot (Computing the Rotation Vector)

*deck,trrot
subroutine trrot (tr,rot)
c *** primary function: get the rotation vector from a transformation matrix
c
c
c input arguments:
c tr (dp,ar(3,3),in) - transformation matrix
c
c output arguments:
c rot (dp,ar(3),out) - rotation vector
c
1.4.26. Subroutine rottr (Computing the Transformation Matrix)

*deck,rottr
subroutine rottr (rot,tr)
c primary function: compute transformation matrix from rotation vector *****
c
c ref(old): eqn. 20(transposed),rankin and brogan, jpvt,108(1986)165-174.
c ref(new): eqn. (b.4), simo and vu-quoc, cmame, 58 (1986), 79-116

c (removes singularities at pi and 2*pi)
c
c input arguments:
c rot (dp,ar(4),in) - rotation parameter in radians
c
c output arguments:
c tr (dp,ar(3,3),out) - transformation matrix corresponding to rot
1.4.27. Subroutine xyzup3 (Updating an Element's 3-D Nodal Coordinates)

*deck,xyzup3
subroutine xyzup3 (nnod,u,nr,xyz,nx,xyzup)
c *** primary function: update a 3-d ele nodal coords for large deformation
c
c
c input arguments:
c nnod (int,sc,in) - number of nodes
c u (dp,ar(nr),in) - displacement vector
c nr (int,sc,in) - size of the u vector
c xyz (dp,ar(nx,nnod),in) - coordinates to be updated
c nx (int,sc,in) - row size of xy
c
c output arguments:
c xyzup (dp,ar(3,nnod),out) - updated coordinates
c
1.4.28. Subroutine updrot (Updating the Rotation Pseudovector)

*deck,updrot
subroutine updrot (v2,w1)
c primary function: update the rotation pseudovector for 3-d large rotations *****
c
c
c The updating of the pseudovector uses the mathematics of quarternions
c (ref: eqn. a5 of J. H. Argyris, CMAME, 32(1982)85-155). The
c pseudovector uses the nomalization proposed by Rankin and Brogan (ref:
c eqn. 15, JPVT, 108(1986)165-174).
c CMAME = Computer Methods in Applied Mechanics and Engineering
c JPVT = Journal of Presssure Vessel Technology (ASME)
c
c variable descriptions:
c input:
c v2 - rotation increment
c w1 - previous rotation pseudovector
c output:
c w1 - updated pseudovector
c
c v1 = cos(v1/2) + 1/2*w1, w1 = 2*sin(v1/2)*e1
c v2 = cos(v2/2) + 1/2*w2, w2 = 2*sin(v2/2)*e2
c v21 = v2*v1 = cos(v21/2) + 1/2*w21 (quarternion multiplication)
c w1 =: v21 (w1 is updated)
c
1.4.29. Subroutine tmpget (Defining Current Temperature Loads)

*deck,tmpget
subroutine tmpget (iel,ielc,nnod,nodes,ref,ndat0,begdat,dat,
x enddat,tlvf)
c primary function: define the current temperature loads
c
c

c
c input arguments:
c nnod (int,sc,in) - number of nodes in the nodes array
c nodes (int,ar(nnod),in) - list of nodes
c ref (dp,sc,in) - reference temperature
c ndat (int,sc,in) - number of data items to get
c begdat (dp,ar(ndat),in) - data at the beginning of this load step
c
c output arguments:
c dat (dp,ar(ndat),out) - data at this time point
c enddat (dp,ar(ndat),out) - data at end of this load step
c tlvf (int,sc,out) - thermal load vector flag
c Should the thermal load vector be computed
c = 0 - no, temperatures match tref
c = 1 - yes, temperatures do not match tref
c Note, that even if tlvf = 0, temperatures may be used to
c compute temperature-dependent material properties.
c
1.4.30. Subroutine prsget (Defining Current Pressure Loads)

*deck,prsget
subroutine prsget (iel,ielc,nfac,ndat,begdat,dat,enddat,iexist)
c primary function: define the current pressure loads

c See also: PrsRIGet
c input arguments:
c nfac (int,sc,in) - number of pressure faces
c ndat (int,sc,in) - number of pressure values
c begdat (dp,ar(ndat),in) - pressure at the beginning of load step
c output arguments:
c dat (dp,ar(ndat),out) - pressures at this iteration
c enddat (dp,ar(ndat),out) - pressure at end of this load step
c iexist (int,sc,out) - flag if pressure exist
c = 0 - no pressure
c = 1 - yes pressure
1.4.31. Subroutine cnvget (Defining Current Convection Loads)

*deck,cnvget
subroutine cnvget (iel,ielc,nr,u,nfac,ndat,beghc,begtb,
x hc,tb,endhc,endtb,iexist)
c primary function: define the current convection loads
c input arguments:
c nr (int,sc,in) - dimension of u (temperature) vector
c u (dp,ar(nr),in) - most current temperatures
c nfac (int,sc,in) - number of convection faces
c ndat (int,sc,in) - number of convection values
c beghc (dp,ar(ndat),in) - hcoef at the beginning of load step
c begtb (dp,ar(ndat),in) - tbulk at the beginning of load step
c output arguments:
c hc (dp,ar(ndat),out) - hcoef at this substep
c tb (dp,ar(ndat),out) - tbulk at this substep
c endhc (dp,ar(ndat),in) - hcoef at the end of this load step

c endtb (dp,ar(ndat),in) - tbulk at the end of this load step
c iexist (int,sc,out) - flag if convection exist
c = 0 - no convection
c = 1 - constant convection (with time)
c does not require new element matrix
c = 2 - changing convection (with time)
c or deleted convection
c requires new element matrix
1.4.32. Subroutine hgnget (Defining Current Heat Generation Loads)

*deck,hgnget
subroutine hgnget (iel,ielc,nnod,nodes,ndat,begdat,dat,enddat,
x iexist)
c primary function: define the current heat generation loads
c
c
c
c input arguments:
c nnod (int,sc,in) - number of nodes in the nodes array
c ndat (int,sc,in) - number of data items to get
c begdat (dp,ar(ndat),in) - data at the beginning of this load step
c
c output arguments:
c dat (dp,ar(ndat),out) - data at this time point
c enddat (dp,ar(ndat),out) - data at end of this load step
c iexist (int,sc,out) - flag if heat generation exist
c = 0 - no heat generation
c = 1 - yes heat generation
c
1.5. Routines for Modifying and Monitoring Existing Elements

The next few pages describe the user routines you use to modify or monitor existing ANSYS elements. These
routines enable you to perform tasks including:
• Computing load vectors for frequency domain logic

• Storing element output that users supply
• Modifying the orientation of material properties and stresses
• Modifying the orientation of material properties and stresses of layers within an element
• Performing a user-defined operation on a parameter for the COMBIN7 and COMBIN37 elements
• Providing a user-defined initial thickness for SHELL181
• Providing a user-defined initial stress for PLANE2, PLANE42, SOLID45, PLANE82, SOLID92, SOLID95, LINK180,
SHELL181, PLANE182, PLANE183, SOLID185, SOLID186, SOLID187, SOLSH190, BEAM188, BEAM189,
SHELL208, and SHELL209
• Providing a user-defined fictive temperature relationship for VISCO88 and VISCO89
• Provides viscoelastic computation in the stiffness pass for VISCO88 and VISCO89
Section 1.5: Routines for Modifying and Monitoring Existing Elements
1.5.1. Subroutine userfd (Computing the Complex Load Vector for Frequency
Domain Logic)
*deck,userfd
subroutine userfd (nr,kpeak,kcbrm,kpfor,ktrsur,isur,
x cd,cm,ct,cb,do,doext,aread,alenv,nuxy,faclen,conac,fluidt,visc,
x dprtem,watmot,xyzup,tr,accel,puvel,u,zass,
x forl,zsc,zsc2,pdyn,holdwv)
c *** primary function: compute complex load vector for frequency domain logic
c for pipe59
c -- accessed with keyopt(12) = 2
c
c *** ansys, inc.
c
c input arguments:
c nr (int,sc,in) - matrix size
c kpeak (int,sc,in) - keyopt for wave combinations
c kcbrm (int,sc,in) - key for reduced matrices/cable option
c kpfor (int,sc,in) - keyopt for wave printout
c ktrsur (int,sc,in) - keyopt for surface treatment(unfinished)
c isur (int,sc,in) - surface flag
c cd (dp,sc,in) - normal drag coefficient (real constant)
c cm (dp,sc,in) - inertial coefficient (real constant)
c ct (dp,sc,in) - tangential drag coefficient (real constant)
c cb (dp,sc,in) - buoyancy coefficient (real constant)
c do (dp,sc,in) - outside diameter of pipe
c doext (dp,sc,in) - outside diameter of insulation
c aread (dp,sc,in) - area of displaced water
c alenv (dp,sc,in) - length of element
c nuxy (dp,sc,in) - poisson's ratio
c faclen (dp,sc,in) - wetted fraction of pipe
c conac (dp,sc,in) - added mass per unit length
c fluidt (dp,sc,in) - fluid temperature
c visc (dp,sc,in) - viscosity
c dprtem (int,sc,in) - size of water motion table
c watmot (dp,ar(1278),in) - water motion table
c xyzup (dp,ar(3,2),in) - updated coordinates
c tr (dp,ar(3,3),in) - local to global transformation matrix
c accel (dp,ar(3),in) - acceleration vector
c puvel (int,sc,in) - index for velocities in u matrix
c u (dp,ar(nr,5),in - displacements and velocities
c zass (dp,ar(nr,nr),in) - mass matrix
c forl (dp,ar(12),inout) - force vector in element coordinates
c zsc (dp,ar(nr),inout) - real load vector for frequency domain
c zsc2 (dp,ar(nr),inout) - complex load vector for frequency domain
c
c output arguments:
c forl (dp,ar(12),inout) - force vector in element coordinates
c zsc (dp,ar(nr),inout) - real load vector for frequency domain
c zsc2 (dp,ar(nr),inout) - complex load vector for frequency domain
c pdyn (dp,ar(2),out) - dynamic pressure
c holdwv (dp,ar(60),out) - wave information held for printout
c
1.5.2. Subroutine userou (Storing User-Supplied Element Output)

*deck,userou
subroutine userou (elem,iout,nbsvr,bsvr,nnrsvr,nrsvr,npsvr,psvr,
x ncsvr,csvr,nusvr,usvr,nnode,nodes,xyz,vol,leng,time,
x timinc,nutot,utot,maxdat,numdat,udbdat)
c
c *** primary function: store user supplied element output
c in nmisc record
c
c in order to activate this user programmable feature,
c the user must enter the usrcal command.

c
c
c *** ansys, inc.
c
c this routine is called by almost every element
c the data is stored on the nmisc record.
c warning: other data may be stored between the
c documented data and this data.
c in order to see the actual information on the nmisc
c record, insert the command:
c dblist,elp,elnum1,elnum2,elinc,11
c where elnum1 = the first element
c elnum2 = the last element
c elinc = the element increment number
c after a set command in post1.
c
c input arguments:
c iout (int,sc,in) - output unit number
c nbsvr (int,sc,in) - number of basic element variables
c bsvr (dp,ar(nbsvr),in) - basic element variables
c nnrsvr (int,sc,in) - number of nonlinear element variables
c nrsvr (dp,ar(nnrsvr),in) - nonlinear element variables
c npsvr (int,sc,in) - number of plasticity element variables
c psvr (dp,ar(npsvr),in) - plasticity element variables
c ncsvr (int,sc,in) - number of creep element variables
c csvr (dp,ar(ncsvr),in) - creep element variables
c (= nstv on the nsvr command)
c usvr (dp,ar(nusvr),in) - user-supplied element variables
c nnode (int,sc,in) - number of nodes
c nodes (int,ar(nnode),in) - node numbers
c xyz (dp,ar(6,nnode),in) - nodal coordinates and rotations (virgin)
c vol (dp,sc,in) - element volume (or area if 2-d)
c leng (dp,sc,in) - element length (beams,spars,etc)
c time (dp,sc,in) - current time
c timinc (dp,sc,in) - current sub step time increment
c nutot (int,sc,in) - length of dof solution vector utot
c utot (dp,ar(nutot),in) - solution vector
c maxdat (int,sc,in) - size of user output array (3 x nnode)
c
c output arguments:
c numdat (int,sc,out) - number of user output items in array udbdat
c (maximum size of numdat is ielc(NMNMUP)
c which is usually three times the number
c of nodes.
c udbdat (dp,ar(maxdat),out) - user output items to be placed at the end
c of the nmisc record
c
1.5.3. Subroutine useran (Modifying Orientation of Material Properties)

*deck,useran
subroutine useran (vn,vref,elem,thick,xyzctr,bsangl)
c user written routine to modify orientation of material properties
c and stresses ***************************
c applicable to: shell43,63,91,93,99, solid46,64,191
c accessed by keyopt
c
c *** ansys, inc.
c
c **** warning *** do not change any arguments other than bsangl.
c if you do, your results are probably wrong.
c
c input(do not change)---
c vn = vector normal to element
c vref = unit vector orienting element, essentially edge i-j
c elem = element number
c thick = total thickness of element at this point (see note below)
c xyzctr = location of element centroid or integration point
c
c output---
c bsangl = output from this subroutine. it represents the angle(s)
c between vref and the desired orientation. it may have
c the default orientation coming in to useran.
c This will be combined with the angles derived from
c the ESYS command.
c use 1 angle for 2-d elements and shells
c use 3 angles for 3-d solids
c
1.5.4. Subroutine usanly (Modifying Orientation of Material Properties and

Stresses of Layers)
*deck,usanly
subroutine usanly (vn,vref,elem,thick,xyzctr,ln,bsangl)
c
c user written routine to modify orientation of material properties
c and stresses of layers within an element **************************
c applicable to shell91,99, and solid46,191
c accessed with keyopt(4)
c
c *** ansys, inc.
c
c **** warning *** do not change any arguments other than bsangl.
c if you do, your results are probably wrong.
c input(do not change)---
c vn = vector normal to element
c vref = unit vector orienting element, essentially edge i-j
c elem = element number
c thick = thickness of layer ln at this point (see note below)
c xyzctr = location of element centroid or integration point
c ln = layer number
c
c output---
c bsangl = output from this subroutine. it represents the angle(s)
c between vref and the desired orientation of the layer.
c it may have the default orientation coming in to useran.
c
c this angle does not affect the angle given in the printout.
c users may want to add their own angle printout in usanly.
c
c also, this angle does not affect the angle shown using the
c layplot or laylist commands
c
c use 1 angle for 2-d elements and shells
c use 3 angles for 3-d solids
c
c the programmer of usanly can base their logic on the location
c of the point in space, or an element attributes, such as thick
c
1.5.5. Subroutine userrc (Performing User Operations on COMBIN7 and

COMBIN37 Parameters)
*deck,userrc
subroutine userrc (elem,ireal,type,nusvr,usvr,parm,parmld,
x c1,c2,c3,c4,fcon)
c primary function: user operation on parameter for combin7 and combin37

c accessed with keyopt(9) = 1
c
c *** ansys, inc.
c
c input arguments:
c ireal (int,sc,in) - element real constant number
c type (int,sc,in) - element type number
c usvr (dp,ar(nusvr),inout) - user-supplied element variables
c parm (dp,sc,in) - current value of the paramater
c parmld (dp,sc,in) - value of the parameter at previous time ste
c c1 (dp,sc,in) - real constant c1
c
c output arguments:
c usvr (dp,ar(nusvr),inout) - user-supplied element variables
c may be sent .rst file with usereo
c fcon (dp,sc,out) - result of calculation
c
c either c1 or c3 must be nonzero for this logic to be accessed,
c
1.5.6. Function userpe (Calculating Rotation Caused by Internal Pressure)

*deck,userpe
function userpe (prs,rvrp,angle,ex,nuxy)
c primary function: calculate the rotation caused by internal pressure

c on an elbow element
c This function is only called by el18(pipe18)
c if keyopt(5) = 1

c *** ansys, inc.
1.5.7. Subroutine UElMatx (Accessing Element Matrices and Load Vectors)

*deck,UElMatx
subroutine UElMatx (elem,nr,ls,zs,zsc,uelm,ielc,nodes,edof,
x elmdat,xyzang,lenu)
c primary function: User routine to access element matrices and load vectors.
c Needs to have USRCAL,UELMATX to be accessed.
c Called after the call to the element routine and
c before the solver.
c May be used to monitor and/or modify the element matrices
c and load vectors.

c *** ansys, inc.
c input arguments:
c elem (int,sc,in) - User element number
c nr (int,sc,in) - number of rows in element matrix
c ls (int,ar(nr),in) - Dof Index vector for this element matrix
c zs (dp,ar(nr,nr,4),inout)- K,M,C,SS matrices for this element
c zsc (dp,ar(nr,2),inout) - Element load vector and N-R correction vec

c uelm (dp,ar(nr,5),in) - Nodal displacements for this element
c ielc (int,ar(*),in) - Element type characteristics
c nodes (int,ar(*),in) - Nodes for this element
c edof (int,ar(*),in) - Dofs per node for this element
c elmdat (int,ar(10),in) - Element data for this element
c xyzang (dp,ar(6,*),in) - X,Y,Z,THXY,THYZ,THZX for each element node
c lenu (int,sc,in) - Length of global displacement vector
c output arguments:
c zs (dp,ar(nr,nr,4),inout)- K,M,C,SS matrices for this element
c zsc (dp,ar(nr,2),inout) - Element load vector and N-R correction vec
c WARNING: any CHANGES to these (or any other) arguments will have a direc
c impact on the solution, possibly giving meaningless results. The normal
c usage of this routine is simply monitor what is happening.
1.5.8. Subroutine UTHICK (Getting User-defined Initial Thickness)
*deck,uthick
SUBROUTINE uthick (elemId, elemType, matId, realId,
$ numDomIntPts, curCoords, thickness)
ccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc
c
c *** primary function: get the user defined thickness
c
c *** ansys, inc.
c
c input arguments
c ===============
c Variable (type,sz,i/o) description
c elemId (int,sc,i) element number
c elemType (int,sc,i) element TYPE (181 etc.)
c matId (int,sc,i) material number
c realId (int,sc,i) real constant set number
c numDomIntPts (int,sc,i) number of integration points
c curCoords (dp,ar(3,numDomIntPts),i)
c current coordinates
c
c output arguments
c ================
c thickness (dp,ar(3,numDomIntPts),o)
c thickness at the integration points
c
c
c --- parameters
c
1.5.9. Subroutine USTRESS (Getting User-defined Initial Stress)

*deck,ustress
SUBROUTINE ustress (elemId, elemType, matId, basis,
$ curIntPt, curLayer, curSecPt,
$ numDirect, numShear, curCoords,
$ tLocation, iniData)
c
c *** primary function: get the user supplied stress state for
c initial stress analysis
c
c *** ansys, inc.
c
c input arguments
c ===============
c Variable (type,sz,i/o) description
c elemId (int,sc,i) element number
c elemType (int,sc,i) element TYPE (42, 181 etc.)
c matId (int,sc,i) material number
c basis (dp,ar(3,3),i) basis directions (for the element)
c curIntPt (int,sc,i) current Integration point
c curLayer (int,sc,i) current Layer number (for shell
c and layered solids)
c curSecPt (int,sc,i) current point through the thickness in the
c current layer
c numDirect (int,sc,i) number of direct stress comp
c (s_xx,s_yy,s_zz)
c numShear (int,sc,i) number of shear stress comp
c (s_xy,s_yz,s_zx)
c curCoords (dp,ar(3),i) current coordinates
c tLocation (dp,sc,i) normalized thickness location
c (shell elements only)
c -1 = bottom or first sec pt
c +1 = top or last sec pt
c 0 = mid surface
c
c output arguments
c ================
c iniData (dp,ar(numDirect+numShear),o)
c user input stress values
c
c
c --- parameters
c
1.5.10. Subroutine UsrFictive (Providing User-defined Fictive Temperature

Relationship)
*deck,UsrFictive
subroutine UsrFictive (tref,toffst,tem,ftl, veinpt, ftc)
c *** primary function: allow users to write their own
c fictive temperature relationship
c this logic is accessed with c5 = 11 on the tb,evisc table
c *** secondary function: demonstrate the use of a user-written
c fictive temperature relationship
c this routine could also be used to modify the viscoelastic
c data during solution, i.e., to make the viscoelastic
c coefficients themselves time-dependent.
c
c *** notice- this routine contains ansys,inc. confidential information ***
c
c *** ansys, inc.
c
c input arguments:
c variable (type,sze,intent) description
c tref (dp,sc,in) - reference temperature
c toffst (dp,sc,in) - temperature offset from absolute zero
c ftl (dp,sc,in) - previous fictive temperature
c veinpt (dp,ar(95),inout) - table from tb,evisc
c
c output arguments:
c veinpt (dp,ar(95),inout) - table from tb,evisc
c ftc (dp,sc,in) - fictive temperature
c
1.5.11. Subroutine UsrViscEl (Performs Viscoelastic Computation)

*deck,UsrViscEl
Section 1.6: Routines for Customizing Material Behavior
subroutine UsrViscEl (veinpt,ncomp,tem,dtem,ex,gxy,eex,egxy,phil,

x zil,g1l,g2l,hsm,hbm,smcm,bmcm,epsl,epst,ftl,dftl,tref,tvc,dvc,
x dsig,rsig,cm,kerr,cml)
c ****** perform visco-elastic computation - stiffness pass
c
c ***** notice- this routine contains ansys, inc. confidential information ****
c
c *** ansys, inc.
c
c input arguments:
c veinpt (dp,ar(95),in) - viscoelastic input data
c ncomp (int,sc,in) - number of components (4 or 6)
c tem (dp,sc,in) - temperature
c dtem (dp,sc,in) - incremental temperature
c ex (dp,sc,in) - bulk modulus at infinite time
c gxy (dp,sc,in) - shear modulus at infinite time
c smcm (dp,ar(ncomp,ncomp),in) - material matrix for shear modulus
c bmcm (dp,ar(ncomp,ncomp),in) - material matrix for bulk modulus
c epsl (dp,ar(ncomp),in) - strain for previous iteration
c epst (dp,ar(ncomp),in) - total strain for current iteration
c tref (dp,sc,in) - reference temperature
c
c output arguments:
c eex (dp,sc,out) - effective bulk modulus
c egxy (dp,sc,out) - effective shear modulus
c phil (dp,sc,inout) - previous shift factor
c zil (dp,sc,inout) - previous pseudo time
c g1l (dp,ar(ncomp,10),out) - recursive shear relaxation
c g2l (dp,ar(ncomp,10),out) - recursive bulk relaxation
c hsm (dp,ar(10),out) - recursive shear relaxation
c hbm (dp,ar(10),out) - recursive bulk relaxation
c ftl (dp,sc,inout) - previous fictive temperature
c dftl (dp,ar(10),out) - incremental fictive temperature
c tvc (dp,sc,inout) - total volume change
c dvc (dp,sc,out) - incremental volume change
c dsig (dp,ar(ncomp),out) - stress change
c rsig (dp,ar(ncomp),out) - stress relaxation
c cm (dp,ar(ncomp,ncomp),out)- total material matrix
c kerr (int,sc,out) - error key
c
c argument of convenience:
c cml (dp,ar(ncomp,ncomp),none)- no value (used only to avoid simplify
c logic due to variable array sizes)
c
c
1.6. Routines for Customizing Material Behavior

This section describes the user routines you use to modify or monitor how materials behave. These routines
enable you to perform tasks including:
• Writing your own material constitutive models

• Writing your own plasticity, creep, or swelling laws
• Writing your own hyperelasticity laws
• Updating the nonlinear strain history for a user-defined material
• Checking material data you have defined
• Computing the derivatives of the strain energy density "W" with respect to its invariants
• Controlling hygrothermal growth.
Note — If you write a material behavior routine using any of the ANSYS commands MPDATA, MPDELE,
TB, or TBDELE, be aware that these commands interpret the string "_MATL" to mean the current active
material when it appears in their MAT field. The "_MATL" is used in conjunction with the library (LIB) option
of the MPREAD and MPWRITE commands. MPWRITE inserts "_MATL" in lieu of the specified material
number as these commands are written to the material library file. This occurs only when you use the
LIB option. When ANSYS reads a material library file written in this format, it interprets "_MATL" to mean
the currently active material (as defined by the MAT,MAT command). Do not use the "_MATL" string
outside the scope of the MPREAD command.
1.6.1. Subroutine usermat (Writing Your Own Material Models)

This subroutine is applicable to the following elements: LINK180, SHELL181, PLANE182, PLANE183, SOLID185,
SOLID186, SOLID187, SOLSH190, BEAM188, BEAM189, SHELL208, and SHELL209.
*deck,usermat
subroutine usermat(
& matId, elemId,kDomIntPt, kLayer, kSectPt,
& ldstep,isubst,keycut,
& nDirect,nShear,ncomp,nStatev,nProp,
& Time,dTime,Temp,dTemp,
& stress,ustatev,dsdePl,sedEl,sedPl,epseq,
& Strain,dStrain, epsPl, prop, coords,
& rotateM, defGrad_t, defGrad,
& tsstif, epsZZ,
& var1, var2, var3, var4, var5,
& var6, var7, var8)
c*************************************************************************
c *** primary function ***
c
c user defined material constitutive model
c
c Attention:
c User must define material constitutive law properly
c according to the stress state such as 3D, plain strain
c and axisymmetry, plane stress and 3D/1D beam.
c
c a 3D material constitutive model can use for
c plain strain and axisymmetry cases.
c
c When using shell elements, a plane stress algorithm
c must be use.
c
c gal July, 1999
c
c The following demonstrates a USERMAT subroutine for
c a plasticity model, which is the same as TB, BISO,
c for different stress states.
c See "ANSYS user material subroutine USERMAT" for detailed
c description of how to write a USERMAT routine.
c
c This routine calls four routines,
c usermat3d.F, usermatps.F usermatbm.F and usermat1d.F, w.r.t.
c the corresponding stress states.
c Each routine can be also a usermat routine for the specific
c element.
c
c*************************************************************************
c
c input arguments
c ===============
c matId (int,sc,i) material #
c elemId (int,sc,i) element #
c kDomIntPt (int,sc,i) "k"th domain integration point
c kLayer (int,sc,i) "k"th layer
c kSectPt (int,sc,i) "k"th Section point
c ldstep (int,sc,i) load step number
c isubst (int,sc,i) substep number

c nDirect (int,sc,in) # of direct components
c nShear (int,sc,in) # of shear components
c ncomp (int,sc,in) nDirect + nShear
c nstatev (int,sc,l) Number of state variables
c nProp (int,sc,l) Number of material ocnstants
c
c Temp (dp,sc,in) temperature at beginning of
c time increment
c dTemp (dp,sc,in) temperature increment
c Time (dp,sc,in) time at beginning of increment (t)
c dTime (dp,sc,in) current time increment (dt)
c
c Strain (dp,ar(ncomp),i) Strain at beginning of time increment
c dStrain (dp,ar(ncomp),i) Strain increment
c prop (dp,ar(nprop),i) Material constants defined by TB,USER
c coords (dp,ar(3),i) current coordinates
c rotateM (dp,ar(3,3),i) Rotation matrix for finite deformation update
c Used only in 5.6 and 5.7
c Unit matrix in 6.0 and late version
c defGrad_t(dp,ar(3,3),i) Deformation gradient at time t
c defGrad (dp,ar(3,3),i) Deformation gradient at time t+dt
c
c input output arguments
c ======================
c stress (dp,ar(nTesn),io) stress
c ustatev (dp,ar(nstatev),io) user state variables
c sedEl (dp,sc,io) elastic work
c sedPl (dp,sc,io) plastic work
c epseq (dp,sc,io) equivalent plastic strain
c tsstif (dp,ar(2),io) transverse shear stiffness
c tsstif(1) - Gxz
c tsstif(2) - Gyz
c tsstif(1) is also used to calculate hourglass
c stiffness, this value must be defined when low
c order element, such as 181, 182, 185 with uniform
c integration is used.
c var? (dp,sc,io) not used, they are reserved arguments
c for further development
c
c output arguments
c ================
c keycut (int,sc,io) loading bisect/cut control
c 0 - no bisect/cut
c 1 - bisect/cut
c (factor will be determined by ANSYS solution control)
c dsdePl (dp,ar(ncomp,ncomp),io) material jacobian matrix
c epsZZ (dp,sc,o) strain epsZZ for plane stress,
c define it when accounting for thickness change
c in shell and plane stress states
c
c*************************************************************************
c
c ncomp 6 for 3D (nshear=3)
c ncomp 4 for plane strain or axisymmetric (nShear = 1)
c ncomp 3 for plane stress (nShear = 1)
c ncomp 3 for 3d beam (nShear = 2)
c ncomp 1 for 1D (nShear = 0)
c
c stresss and strains, plastic strain vectors
c 11, 22, 33, 12, 23, 13 for 3D
c 11, 22, 33, 12 for plane strain or axisymmetry
c 11, 22, 12 for plane stress
c 11, 13, 12 for 3d beam
c 11 for 1D
c
c material jacobian matrix
c 3D
c dsdePl | 1111 1122 1133 1112 1123 1113 |
c dsdePl | 2211 2222 2233 2212 2223 2213 |
c dsdePl | 3311 3322 3333 3312 3323 3313 |
c dsdePl | 1211 1222 1233 1212 1223 1213 |
c dsdePl | 2311 2322 2333 2312 2323 2313 |

c dsdePl | 1311 1322 1333 1312 1323 1313 |
c plane strain or axisymmetric (11, 22, 33, 12)
c dsdePl | 1111 1122 1133 1112 |
c dsdePl | 2211 2222 2233 2212 |
c dsdePl | 3311 3322 3333 3312 |
c dsdePl | 1211 1222 1233 1212 |
c plane stress (11, 22, 12)
c dsdePl | 1111 1122 1112 |
c dsdePl | 2211 2222 2212 |
c dsdePl | 1211 1222 1212 |
c 3d beam (11, 13, 12)
c dsdePl | 1111 1113 1112 |
c dsdePl | 1311 1313 1312 |
c dsdePl | 1211 1213 1212 |
c 1d
c dsdePl | 1111 |
c
1.6.2. Subroutine userpl (Writing Your Own Plasticity Laws)

This subroutine is applicable to the following elements: LINK1, PLANE2, LINK8, PIPE20, BEAM23, BEAM24, PLANE42,
SHELL43, SOLID45, SHELL51, PIPE60, SOLID62, SOLID65, PLANE82, SHELL91, SOLID92, SHELL93, SOLID95.
*deck,userpl
subroutine userpl (elem,intpt,mat,ncomp,kfirst,kfsteq,e,nu,dens,
x prop,d,ktform,timval,timinc,tem,dtem,toffst,flu,dflu,epel,eppl,
x statev,usvr,epeq,plwork,sigepl,sigrat,depeq,dt)
c
c *** primary function: allow users to write their own plasticity laws.
c this logic is accessed with tb,user.
c the below demonstration logic is the same as using
c tb,bkin, without adaptive descent (nropt,,,off).
c Other plasticity rules may require internal
c iterations and/or the more general definition of
c plasticity theory, discussed in the Theory
c Manual.
c *** secondary function: demonstrate the use of user-written plasticity laws
c in this routine:
c a. update the nonlinear strain history
c b. compute the material tangent matrix if requested
c
c
c
c *** ansys, inc.
c
c input arguments:
c
c ncomp (int,sc,in) - no. of stress/strain components (1,4 or 6)
c 1 - x
c 4 - x,y,z,xy
c 6 - x,y,z,xy,yz,xz
c kfirst (int,sc,in) - 1 if first time through, 0 otherwise
c (useful for initializing state variables
c to a non-zero value)
c kfsteq (int,sc,in) - 1 if first equilibrium iteration of a
c substep, 0 otherwise
c
c e (dp,sc,in) - average elastic modulus
c nu (dp,sc,in) - average poisson ratio
c dens (dp,sc,in) - current material density (mass/volume)
c prop - linear material property array
c (dp,ar(9),in) (ex,ey,ez, gxy,gyz,gxz, nuxy,nuyz,nuxz)
c (dp,ar(1),in) if ncomp=1 (ex)
c d (dp,ar(ncomp,ncomp),in)- elastic stress-strain matrix

c (=1, form tangent .ne.1, do not form)
c
c timval (dp,sc,in) - current time value
c timinc (dp,sc,in) - time increment over this substep
c
c
c epel (dp,ar(ncomp),inout)- modified total strain (trial strain)
c epel = eptot - eppl - eptherm - ...
c if a large strain analysis, epel is
c rotation neutralized and is the hencky
c (i.e. log) strain
c eppl (dp,ar(ncomp),inout)- plastic strain from previous substep
c
c statev (dp,ar(ncomp,6),inout)- state variables from previous substep
c usvr (dp,ar(nuval,nintp),inout)- additional state variables from
c previous equilibrium iteration (saved
c if the nsvr command is used)
c
c epeq (dp,sc,inout) - effective plastic strain from prev substep
c plwork (dp,sc,inout) - accumulated plastic work from prev substep
c
c output arguments:
c
c eppl (dp,ar(ncomp),inout)- updated plastic strain
c
c statev (dp,ar(ncomp,6),inout)- updated state variables
c usvr (dp,ar(nuval,nintp),inout)- updated additional state variables
c
c
c sigepl (dp,sc,out) - stress value on stress-strain curve at epeq
c depeq (dp,sc,out) - increment in plastic strain (equivalent)
c (used for auto time stepping - time step
c is reduced if it exceeds .05)
c
c dt (dp,ar(ncomp,ncomp),out)- material tangent modulus
c
c fortran parameters (to be defined by the user):
c variable (type) description
c numinp (int) - number of data items in the user-defined
c data table (tbdat commands)
c nuval (int) - number of additional state variables per
c integration point
c nintp (int) - maximum number of integration points of
c an element to be used with this routine
c (14 is the maximum)
c note: nuval x nintp = nstv(on nsvr command); cannot exceed 840!
c
c variable (type,sze) description
c b (dp,ar(6,6)) - 2nd derivative of the yield function
c c (dp,ar(6,12)) - part of deff
c con (dp,sc) - temporary variable
c deppl (dp,ar(6)) - plastic strain increment
c dfds (dp,ar(6)) - derivative of the yield function (normal)
c dlamb (dp,sc) - plastic multiplier
c ep (dp,ar(6)) - shifted strain
c epshfo (dp,ar(6)) - initial shift strain (center of the yield surf)
c epshft (dp,ar(6)) - shift strain (center of the yield surface)
c et (dp,sc) - tangent modulus (stress/total strain)
c h (dp,sc) - plastic tangent modulus (stress/plastic strain)
c n2 (int,sc) - ncomp squared, ncomp*ncomp

c seqtr (dp,sc) - equivalent (von mises) trial stress
c sigtr (dp,ar(6)) - trial stress
c sigy (dp,sc) - yield stress
c vect (dp,ar(6)) - temporary vector
c
1.6.3. Subroutines usercreep and usercr (Defining Viscoplastic/Creep Material

Behavior)
ANSYS provides two subroutines to allow you to specify your own creep equations to define the time-dependent
viscoplastic/creep behavior of materials. The two subroutines are usercreep and usercr. Use the subroutine
usercreep when you issue the TB command with the CREEP option, and with TBOPT = 100. Use the subroutine
usercr when you issue the TB command with the CREEP option, with TBOPT = 0, and data constant C6 = 100.
Subroutine usercreep is incorporated with an implicit time integration algorithm, while subroutine usercr is
incorporated with an explicit time integration algorithm. In general, the implicit time integration algorithm is
more effective for long time periods. The explicit creep algorithm is more effective for short time periods such
as transient analyses with very small time increments, or when the creep behavior of materials is not that signi-
ficant. In the finite deformation analysis, you should interpret the strain variables in the subroutines as logarithmic
strains, and you should interpret the stresses as true stresses.
1.6.3.1. Creep Subroutine usercreep

Use the subroutine usercreep to define viscoplastic/creep behavior of materials when you issue the TB command
with the CREEP option, and with TBOPT = 100. The subroutine will be called at all integration points of elements
for which the material is defined by this command. ANSYS always uses implicit time integration for this creep
option. You can use plasticity options (BISO, MISO, NLISO) to define the plastic behavior of materials. Creep and
plastic strain will be calculated simultaneously when both creep and plasticity are defined for a material. Through
this subroutine, you can specify a "uniaxial" creep law that will be generalized to the multi-axial state by the
general time-dependent viscoplastic material formulation implemented in ANSYS. You can use and update in-
ternal state variables in the subroutine. The number of state variables has to be defined by TB,STATE.
Please see the TB command description for more information.
*deck,usercreep
SUBROUTINE usercreep (impflg, ldstep, isubst, matId , elemId,
& kDInPt, kLayer, kSecPt, nstatv, nprop,
& prop , time , dtime , temp , dtemp ,
& toffst, Ustatev, creqv , pres , seqv ,
& delcr , dcrda)
c*************************************************************************
c *** primary function ***
c Define creep laws when creep table options are
c TB,CREEP with TBOPT=100.
c Demonstrate how to implement usercreep subroutine
c
c Creep equation is
c dotcreq := k0 * seqv ^ n * creqv ^ m * exp (-b/T)
c
c seqv is equivalent effective stress (Von-Mises stress)
c creqv is equivalent effective creep strain
c T is the temperature
c k0, m, n, b are materials constants,
c
c This model corresponds to primary creep function TBOPT = 1
c
c gal 10.01.1998
c
c*************************************************************************
c
c input arguments
c ===============
c impflg (in ,sc ,i) Explicit/implicit integration
c flag (currently not used)
c ldstep (in ,sc ,i) Current load step
c isubst (in ,sc ,i) Current sub step
c matId (in ,sc ,i) number of material index
c elemId (in ,sc ,i) Element number
c kDInPt (in ,sc ,i) Material integration point
c kLayer (in ,sc ,i) Layer number
c kSecPt (in ,sc ,i) Section point
c nstatv (in ,sc ,i) Number of state variables
c nprop (in ,sc ,i) size of mat properties array
c
c prop (dp ,ar(*),i) mat properties array
c This array is passed all the creep
c constants defined by command
c TBDATA associated with TB,CREEP
c (do not use prop(13), as it is used
c elsewhere)
c at temperature temp.
c time Current time
c dtime Current time increment
c temp Current temperature
c dtemp Current temperature increment
c toffst (dp, sc, i) temperature offset from absolute zero
c seqv (dp ,sc , i) equivalent effective stress
c creqv (dp ,sc , i) equivalent effective creep strain
c pres (dp ,sc , i) hydrostatic pressure stress, -(Sxx+Syy+Szz)/3
c
c input output arguments input desc / output desc
c ====================== ========== ===========
c Ustatev (dp,ar(*), i/o) user defined iinternal state variables at
c time 't' / 't+dt'.
c This array will be passed in containing the
c values of these variables at start of the
c time increment. They must be updated in this
c subroutine to their values at the end of
c time increment, if any of these internal
c state variables are associated with the
c creep behavior.
c
c output arguments
c ================
c delcr (dp ,sc , o) incremental creep strain
c dcrda (dp,ar(*), o) output array
c dcrda(1) - derivitive of incremental creep
c strain to effective stress
c dcrda(2) - derivitive of incremental creep
c strain to creep strain
c
c local variables
c ===============
c c1,c2,c3,c4 (dp, sc, l) temporary variables as creep constants
c con1 (dp ,sc, l) temporary variable
c t (dp ,sc, l) temporary variable
c
1.6.3.2. Creep Subroutine usercr

In contrast to the usercreep subroutine, for the usercr subroutine, you need to specify the creep strain tensor.
A detailed explanation of this subroutine follows.
*deck,usercr
subroutine usercr (elem,intpt,mat,ncomp,kfirst,kfsteq,e,posn,d,
x proptb,timval,timinc,tem,dtem,toffst,fluen,dfluen,epel,epcrp,
x statev,usvr,delcr)
c
c *** primary function: allow users to write their own creep laws.
c this logic is accessed with c6 = 100
c *** secondary function: demonstrate the use of user-written creep laws
c
c
c
c *** ansys, inc.
c
c input arguments:
c
c ncomp (int,sc,in) - no. of stress/strain components (1,4 or 6)
c 1 - x
c 4 - x,y,z,xy
c 6 - x,y,z,xy,yz,xz
c
c
c posn (dp,sc,in) - poisson'S RATIO
c d (dp,ar(ncomp,ncomp),in)- elastic stress-strain matrix
c proptb (dp,ar(72),in) - material properties input on tb commands
c (do not use proptb(13), as it is used elsewhere)
c
c epcrp (dp,ar(ncomp),inout)- creep strain from previous substep
c statev (dp,ar(ncomp*5+2),inout)- state variables from previous
c (converged) substep. This variable is for
c explicit creep only and refers to a
c different internal variable than that
c defined by TB,stat which is used by
c implicit creep (usercreep) and usermat.
c usvr (dp,ar(nuval,nintp),inout)- additional state variables from
c previous equilibrium iteration (saved
c if the nsvr command is used)
c
c
c output arguments:
c
c epel (dp,ar(ncomp),inout)- elastic strain adjusted for creep increment
c epcrp (dp,ar(ncomp),inout)- updated creep strain
c statev (dp,ar(ncomp*5+2),inout)- updated state variables
c usvr (dp,ar(nuval,nintp),inout)- updated additional state variables
c delcr (dp,sc,out) - equivalent creep strain increment (used
c for creep ratio calculation)
c
c fortran parameters (to be defined by the user):
c integration point
c note: nuval x nintp = nstv(on nsvr command); cannot exceed 840!
c
c variable (type,sze) description
c con (dp,sc) - temporary variable
c del (dp,ar(6)) - creep strain increments

c epet (dp,sc) - equivalent elastic strain (before creep)
c ept (dp,ar(6)) - total strain
c eptot (dp,sc) - equivalent total strain, elastic + creep
c sigen (dp,sc) - equivalent stress (before creep)
c temabs (dp,sc) - temperature on the absolute scale
c
1.6.4. Subroutine usersw (Writing Your Own Swelling Laws)

*deck,usersw
subroutine usersw (option,elem,intpt,mat,proptb,ncomp,epswel,
x epel,e,nuxy,fluen,dfluen,tem,dtem,toffst,timvll,timvnc,usvr)
c
c *** primary function: allow users to write their own swelling laws.
c this logic is accessed with c72 = 10
c *** secondary function: demonstrate the use of user-written swelling laws
c
c
c *** ansys, inc.
c
c input arguments:
c option (int,sc,in) swelling option
c elem (int,sc,in) element number (label)
c intpt (int,sc,in) element integration point number
c mat (int,sc,in) material reference number
c proptb (dp,ar(*),in) nonlinear material table (tb commands)
c ncomp (int,sc,in) number of strain components (=1, 4, or 6)
c 1 - truss or beam elements
c 4 - 2-d solids and pipe elements
c 6 - 3-d solids and most shells
c epswel (dp,sc,inout) total accumulated swelling strain
c before this substep
c epel (dp,ar(ncomp),inout) elastic strain
c e (dp,sc,in) elastic modulus
c nuxy (dp,sc,in) poisson'S RATIO
c fluen (dp,sc,in) total fluence (bf or bfe commands)
c dfluen (dp,sc,in) increment in fluence for this substep
c tem (dp,sc,in) temperature (bf or bfe commands)
c dtem (dp,sc,in) increment in temperature for this substep
c toffst (dp,sc,in) offset of temperature scale from absolute zero
c (toffst command)
c timvll (dp,sc,in) time at the end of this substep
c timvnc (dp,sc,in) the increment of time this substep
c usvr (dp,ar(*),inout) user-defined state variables(optional)
c
c output arguments:
c epswel (dp,sc,inout) total accumulated swelling strain
c after this substep
c epel (dp,ar(ncomp),inout) elastic strain adjusted
c for swelling increment
c usvr (dp,ar(*),inout) updated user-defined state variables
c
1.6.5. Subroutine UserHyper (Writing Your Own Hyperelasticity Laws)

*deck,UserHyper
subroutine UserHyper(
& prophy, incomp, nprophy, invar,
& potential, pInvDer)
c************************************************************************
c
c *** Example of user hyperelastic routine
c
c This example uses Arruda hyperelasticity model
c which is the same ANSYS TB,BOYCE
c
c input arguments
c ===============
c prophy (dp,ar(*),i) material property array
c nprophy (int,sc,i) # of material constants
c invar dp,ar(3) invariants
c
c output arguments
c ================
c incomp (log,sc,i) fully incompressible or compressible
c potential dp,sc value of potential
c pInvDer dp,ar(9) der of potential wrt i1,i2,j
c 1 - der of potential wrt i1
c 2 - der of potential wrt i2
c 3 - der of potential wrt i1i1
c 6 - der of potential wrt i1j
c 7 - der of potential wrt i2j
c 8 - der of potential wrt j
c 9 - der of potential wrt jj
1.6.6. Subroutine uservp (Updating Nonlinear Strain History for Materials)

*deck,uservp
subroutine uservp (elem,mat,kfirst,kfsteq,g,prop,timval,timinc,
x tem,toffst,delepn,svrn,svri,usvr,epeln,epeli,strn,stri,depdt,
x cee,eta,norm)
c
c *** primary function: update the nonlinear strain history for a
c user-defined material for the viscoxxx elements
c *** secondary functions: compute the material tangent terms
c accessed with tb,user and keyopt(1) = 1
c
c
c
c *** ansys, inc.
c
c input arguments:
c
c
c g (dp,sc,in) - shear modulus
c prop (dp,ar(13),in) - linear material property array
c (ex,ey,ez, gxy,gyz,gxz, nuxy,nuyz,nuxz,
c alpx,alpy,alpz, dens)
c
c
c
c delepn (dp,ar(3,3),in) - hencky strain increment over the substep
c
c svrn (dp,sc,in) - state variable from previous substep
c svri (dp,sc,inout) - state variable from previous iteration
c usvr (dp,ar(*),inout) - additional state variables from previous
c iteration (saved if the nsvr command is
c used)
c
c epeln (dp,ar(3,3),in) - elastic strain from previous substep
c epeli (dp,ar(3,3),inout) - elastic strain from previous iteration

c
c strn (dp,ar(3,3),in) - stress from previous substep
c stri (dp,ar(3,3),inout) - stress from previous iteration
c
c depdt (dp,sc,inout) - effective inelastic deformation rate
c (d(deppl)/dt) from previous iteration
c
c output arguments:
c
c svri (dp,sc,inout) - updated state variable
c usvr (dp,ar(*),inout) - updated additional state variables
c
c epeli (dp,ar(3,3),inout) - updated elastic strain
c stri (dp,ar(3,3),inout) - updated stress
c
c depdt (dp,sc,inout) - effective inelastic deformation rate
c
c cee (dp,sc,out) - scalar linearization modulus (see below)
c eta (dp,sc,out) - radial return factor (see below)
c norm (dp,ar(3,3),out) - direction of plastic flow
c
c fortran parameters (to be defined by the author):
c numinp (int) - number of data items in the user-defined
c data table (tbdat commands)
c integration point
c note: nuval x nintp cannot exceed 840!
c
1.6.7. Subroutine userck (Checking User-Defined Material Data)

*deck,userck
subroutine userck (curmat,ntb,tb)
c *** primary function: check the user-defined material data,
c input with the TB,user command.
c
c *** ansys, inc.
c
c input arguments:
c curmat (int,sc,in) - current material number
c ntb (int,sc,in) - dimension of tb
c tb (dp,ar(ntb),in) - input table
c
c output arguments:
c none
c
1.6.8. Subroutine usermc (Controlling Hygrothermal Growth)

*deck,usermc
subroutine usermc (elem,time,msci,dmsci,mscr,mscra)
c *** primary function: user control of hygrothermal growth
c presently, called only by shell91
c
c
c *** ansys, inc.

c
c input arguments:
c time (dp,sc,in) - time
c msci (dp,sc,in) - moisture content
c dmsci (dp,sc,in) - change of moisture content
c mscr (dp,ar(3),in) - input material properties for growth
c
c output arguments:
c mscra (dp,ar(3),out) - output material properties for growth
c
1.6.9. Subroutine usrfc6 (Defining Custom Failure Criteria)

*deck,usrfc6
subroutine usrfc6 (elem,matlay,iott,keyer,tem,elim,slim,eps,sig,
x fc6)
c primary function: user subroutine for defining your own failure criterion
c --- accessed with c6 = -1
c *** user programmable functions may not be used in parallel processing ***
c this is currently only available with
c solid46, the multilayer solid element
c shell91, the multilayer shell element
c shell99, the multilayer shell element
c solid191, the multilayer solid element
c
c *** ansys, inc.
c
c
c input arguments:
c elim (dp,ar(9),in) - failure strains at the current temperature
c (tbdata items 1-9)
c slim (dp,ar(12),in) - failure stresses and coupling coefficients
c at the current temperature
c (tbdata items 10-21)
c eps (dp,ar(6),in) - vector of strains
c sig (dp,ar(6),in) - vector of stresses
c tem (dp,sc,in) - temperature at this point in the model
c matlay (int,sc,in) - material number
c iott (int,sc,in) - unit number for writing
c keyer (int,sc,in) - error flag (0 = ok, 1 = error)
c
c output arguments:
c fc6 (dp,sc,out) - failure criterion to be processed by solid46,
c shell91, shell99, or solid191
c
1.6.10. Subroutines usrfc1 through usrfc5

The source code for subroutines usrfc1, usrfc2, usrfc3, usrfc4, and usrfc5 is identical to subroutine usrfc6
shown above.
1.6.11. Subroutine UserVisLaw (Defining Viscosity Laws)

*deck,UserVisLaw
subroutine UserVisLaw
x (dudx,dudy,dudz,
x dvdx,dvdy,dvdz,
x dwdx,dwdy,dwdz,
x u,v,w,x,y,z,kGeom,
x Vis,Temp,Tref,Pres,Pref,Cf,
x MFrac,DfNSpec,Time,VisNew,toffst)
C Primary function: to provide a user defined viscosity

C relationship in terms of the following:
C pressure, temperature, position, time,
C velocity, & velocity-gradient
C This routine is for use with the FLOTRAN
C elements, Fluid141 and Fluid142 only.
C
C In order to activate this subroutine the user must issue
C FLDA,PROT,VISC,USRV command.
C
C In addition the initial value of viscosity must be specified via
C FLDA,PROP,IVIS,value. This value is not available in this routine.
C
C Optionally the user may specify 4 additional coefficients
C which are available in this routine by the commands:
C FLDA,NOMI,VISC,value1
C FLDA,COF1,VISC,value1
C
c *** ansys, inc.
C
C input arguments:
C variable (typ,siz,intent) description
C dudx (dp,sc,in) velocity gradient component
C dudy (dp,sc,in) velocity gradient component
C dudz (dp,sc,in) velocity gradient component
C dvdx (dp,sc,in) velocity gradient component
C dvdy (dp,sc,in) velocity gradient component
C dvdz (dp,sc,in) velocity gradient component
C dwdx (dp,sc,in) velocity gradient component
C dwdy (dp,sc,in) velocity gradient component
C dwdz (dp,sc,in) velocity gradient component
C u (dp,sc,in) velocity component
C v (dp,sc,in) velocity component
C w (dp,sc,in) velocity component
C x (dp,sc,in) position component
C y (dp,sc,in) position component
C z (dp,sc,in) position component
C kGeom (int,sc,in) analysis type
C Vis (dp,sc,in) old viscosity
C Temp (dp,sc,in) absolute temperature
C Tref (dp,sc,in) reference temperature (Absolute also)
C Pres (dp,sc,in) pressure
C Pref (dp,sc,in) reference pressure
C Cf (dp,ar(4),in) input coefficients
C Mfrac (dp,ar(6),in) species mass fractions
C DfNSpec (int,sc,in) defined number of species
C Time (dp,sc,in) time
C toffst (dp,sc,in) Temperature offset for absolute scale.
C output arguments:
C variable (typ,siz,intent) description
C VisNew (dp,sc,out) new viscosity
C
1.6.12. Supporting Function egen

The function egen (kcomp,ep,nuxy) (function) combines kcomp strain components (ep) per:
*deck,egen
function egen (kcomp,ep,posn)
c primary function: combines strain components to give an "overall" strain
c used in creep and plasticity calculations
c secondary functions: none
c formulation of overall value is by:
c ___________________________________________________________________
c /1 2 2 2 1 2 2 2
c \ / -*((ep - ep ) + (ep - ep ) + (ep - ep ) + -*(ep + ep + ep ))
c \/ 2 1 2 2 3 3 1 2 4 5 6
c ------------------------------------------------------------------------
c (1 + posn)
c input arguments:
c kcomp (int,sc,in) - number of components of strain
c ep (dp,ar(6),in) - the strain components
c posn (dp,sc,in) - poisson's ratio
c output arguments:
c egen (dp,func,out) - the combined strain value
c
1.7. Routines for Customizing Loads

This section describes the user routines you use to modify or monitor existing ANSYS elements. These routines
enable you to perform tasks including:
• Setting custom values for scalar fields (temperatures, heat fluxes, etc.)
• Changing element pressure information
• Changing information about element face convection surfaces
• Changing information about element face heat flux surfaces
• Changing information about element face charge density surfaces
• Changing information about element acceleration/angular velocity.
Activate these routines by issuing the USRCAL command or by choosing an equivalent menu path.
1.7.1. Subroutine usrefl (Changing Scalar Fields to User-Defined Values)

*deck,usrefl
subroutine usrefl (key,iel,ielc,nnod,nodes,time,defalt,nd,dat)
c *** primary function: change the scalar fields (temperatures, fluences,
c heat generation, etc.) to what user desires.
c
c
c this routine is called at each substep of each load step
c for which element or nodal temperatures(etc) are used.
c it is called for each equilibrium iteration.
c the call to get the standard ansys input element or nodal values
c is made just before entering this routine.
c
c *** ansys, inc.
c
c
c
c input arguments:
c key (int,sc,in) - type of data desired
Section 1.7: Routines for Customizing Loads
c = 1 temperatures
c = 2 fluences
c = 4 moisture contents
c = 5 magnetic virtual displacements
c nnod (int,sc,in) - number of nodes
c time (dp,sc,in) - time of current substep
c defalt (dp,sc,in) - default value (e.g. tunif)
c nd (int,sc,in) - size of dat array
c dat (dp,ar(nd),inout) - array of data as normally computed by element
c as selected by key
c
c output arguments:
c dat (dp,ar(nd),inout) - array of data passed back to element
c this data represents values at the end
c of the load step
c
c the input argument dat may be used in one of three ways:
c 1. it may be simply passed thru
c 2. it may be used as a flag(e.g. if dat(1) = -3.0, use
c a certain set of logic)
c 3. it may be completely ignored and instead defined with new logic
c
1.7.2. Subroutine userpr (Changing Element Pressure Information)

*deck,userpr
subroutine userpr (ielc,elem,time,ndat,dat)
c *** primary function: change element pressure information.

c *** ansys, inc.

c the user must enter the 'usrcal,userpr' command.
c this routine is called at each substep of each load step for which
c pressures are used. it is called for each equilibrium iteration.
c it is called once per element.
c the call to get the standard ansys input pressures is made just before
c entering this routine.
c input arguments:
c elem (int,sc,in) - element number for operation.
c ndat (int,sc,in) - number of pressure items for this element
c dat (dp,ar(ndat,2),inout) - the element pressure vector
c (has input values for each corner
c of each face)
c output arguments:
c dat (dp,ar(ndat,2),inout) - the element pressure vector
c (defines input values for each corner
c of each face)
c dat(1:ndat,1) - real pressures
c dat(1:ndat,2) - complex pressures
c (surface elements only)
c the input array dat may be used in one of three ways:

c 1. it may be simply passed thru
c 2. it may be used as a flag(e.g. if dat(1) = -3.0, use
c a certain set of logic)

c 3. it may be completely ignored and instead defined with new logic
1.7.3. Subroutine usercv (Changing Element Face Convection Surface Inform-

ation)
*deck,usercv
subroutine usercv (elem,ielc,time,nr,u, ndat,hc,tb)
c *** primary function: change element face convection surface info
c
c *** ansys, inc.
c
c the user must enter the 'usrcal,usercv' command.
c
c the input arguments hc and tb may be used in one of three ways:
c 1. they may be simply passed thru.
c 2. they may be used as a flag(e.g. if hc(2) = -3.0, use
c a certain set of logic).
c 3. they may be completely ignored.
c and instead redefined with new logic
c this routine is called during each substep of each load step.

c it is called once per element. it is called only during the heat
c flow load vector formulation stage, and not during the heat flow
c evaluation stage.
c the call to get the standard ansys input convection surfaces
c is made just before entering this routine, so this information is
c available to be modified, if desired.
c
c velocity-dependent film coefficients can be computed by inputting the
c velocity as the input film coefficient or bulk temperature or
c by inputting the velocity as a function of location in space. this
c routine could then compute the effective film coefficient.
c
c input arguments:
c nr (int,sc,in) - number of nodal temperatures
c of the element
c u (dp,ar(nr),in) - vector of most recent values of the
c temperatures
c ndat (int,sc,in) - number of data points per element
c for example, for solid70, ndat = 24 = 6*4
c where 6 = faces per element
c 4 = corners per face
c hc (dp,ar(ndat),inout) - film coefficients
c of each face)
c tb (dp,ar(ndat),inout) - bulk temperature
c of each face)
c
c output arguments:
c hc (dp,ar(ndat),inout) - film coefficients
c of each face)
c tb (dp,ar(ndat),inout) - bulk temperature
c of each face)
c
Section 1.7: Routines for Customizing Loads
1.7.4. Subroutine userfx (Changing Element Face Heat Flux Surface Informa-
tion)
*deck,userfx
subroutine userfx (ielc,elem,time,nr,u, ndat,dat)
c *** primary function: change element face heat flux surface info
c
c *** ansys, inc.
c
c the user must enter the 'usrcal,userfx' command.
c
c evaluation stage.
c the call to get the standard ansys input heat flux surfaces
c
c input arguments:
c nr (int,sc,in) - number of nodal temperatures
c of the element
c temperatures
c for example, for solid70, ndat = 24 = 6*4
c where 6 = faces per element
c 4 = corners per face
c dat (dp,ar(ndat),inout) - fluxes
c of each face)
c
c output arguments:
c of each face)
c
1.7.5. Subroutine userch (Changing Element Face Charge Density Surface In-
formation)
*deck,userch
subroutine userch (ielc,ielem,time,nr,u, ndat,dat)
c *** primary function: change element face charge density surface info
c
c
c evaluation stage.
c the call to get the standard ansys input charge densities of surfaces
c
c *** ansys, inc.
c
c input arguments:
c ielc (int,ar(IELCSZ),in) -
array of element type characteristics
c ielem (int,sc,in) -
element number for operation.
c time (dp,sc,in) -
time of current substep
c nr (int,sc,in) -
number of nodal temperatures
c of the element
c temperatures
c
c output arguments:
c
c the input argument dat may be used in one of three ways:
c 1. they may be simply passed thru.
c 2. they may be used as a flag(e.g. if dat(2) = -3.0, use
c a certain set of logic).
c 3. they may be completely ignored.
c and instead redefined with new logic
c
1.8. Running ANSYS as a Subroutine

To call the ANSYS program, use the following:
program ansys
If you are running ANSYS on a UNIX system (but not under Windows), you also can call the ANSYS program as a
subroutine in a program you've written. To do so, use the following:
subroutine ansys
For multiple calls to subroutine ANSYS, you must open and close standard input in the calling routine. (Usually,
input and output are FORTRAN units 5 and 6, respectively.) The calling routine can't use the database access
routines. But, other user programmable features can use the database access routines freely.
There may be times when ANSYS exits abnormally. Check the file.err file to see if ANSYS wrote an exit code to
the file before ending. These error codes may help you to understand the problem ANSYS had:
Table 1.1 ANSYS Exit Codes

Code Explanation Code Explanation
0 Normal Exit 14 XOX Error
1 Stack Error 15 Fatal Error
2 Stack Error 16 Possible Full Disk
3 Stack Error 17 Possible Corrupted or Missing File
4 Stack Error 18 Possible Corrupted DB File
5 Command Line Argument Error 21 Authorized Code Section Entered
6 Accounting File Error 25 Unable to Open X11 Server
7 Auth File Verification Error 30 Quit Signal
8 Error in ANSYS or End-of-run 31 Failure to Get Signal
11 User Routine Error >32 System-dependent Error
12 Macro STOP Command
Section 1.9: Defining Your Own Commands
1.9. Defining Your Own Commands

ANSYS, Inc. supplies a set of user routines, named user01 through user10, which you can use to define custom
ANSYS commands. To do so, follow these steps:
1. Insert the code for the functions you want to perform into routine user01 (or user02, etc.).
2. Link the routine into the ANSYS program.
3. Issue the ANSYS command /UCMD to define a name for a custom command that calls and executes your
routine. Use the command format shown below:
/UCMD,Cmd,SRNUM
Cmd
The name for your new command. It can contain any number of characters, but only the first four are signi-
ficant. The name you specify can not conflict with the name of any ANSYS command or the names of any
other commands or macros.
SRNUM
The number of the routine your command should call; that is, a value between 01 and 10. For example,
suppose that you create and link in a user routine for a parabolic distribution of pressure, and you name that
routine user01. Issuing the command shown below creates a new command, PARB, that when issued calls
your parabolic pressure distribution routine:
/UCMD,PARB,1
To make these "custom command" routines available in all your ANSYS sessions, include the /UCMD commands
in your start-up file (START.ANS).
You also can use /UCMD to remove a custom command. To do so, simply use a blank value for Cmd, as shown
below:
/UCMD,,1
This command removes the PARB command. To list all user-defined command names, issue the command
/UCMD,STAT.
1.9.1. Function user01

*deck,user01
function user01()
c *** primary function: user routine number 01

c *** ansys, inc.
c /*******************************************************************\
c | this is a user routine that may be used by users to include their |
c | special coding. accesss to this routine is by the command usr1. |
c | usr1 may be changed by the user using the command /ucmd. the |
c | user may then use this routine to call his/her special routines. |
c | ansys routines to access information in the ansys database may be |
c | found in the "ansys programmer's manual", available from ansys,inc|
c | see user02 for a simple example usage. |
C | routines user03 to user10 are also available. |
C \*******************************************************************/
c input arguments: none
c output arguments:
c user01 (int,sc,out) - result code (should be zero)

c (which is ignored for now)
c **************************************************************
c Functions for accessing data on the command line
c integer function intinfun(iField) - gets an integer from field iField
c double precision function dpinfun(iField) - gets double precision
c character*4 ch4infun(iField) - gets (upper case) 4 characters
c character*8 ch8infun(iField) - gets (mixed case) 8 characters
c **************************************************************
external wrinqr
integer wrinqr
integer user01, iott
iott = wrinqr(2)
c ***** USER'S CODE IS INSERTED HERE *****

write (iott,2000)
2000 format (//' ***** CALL TO ANSYS,INC DUMMY USER01 *****'//)
c ***** do not return this result code in a real user routine

user01 = -654321
c ***** instead return a zero *****
c user01 = 0
return
end
1.9.2. Function user02 (Demonstrates Offsetting Selected Nodes)

*deck,user02
function user02()
c *** primary function: user routine number 02
c --- This demonstration offsets selected nodes with the command:
c usr2,dx,dy,dz

c *** ansys, inc.
c /*******************************************************************\
c | see user01 for additional information on user routines |
c \*******************************************************************/
c output arguments:
c **************************************************************
c **************************************************************
external TrackBegin, TrackEnd

external wrinqr,ndinqr,ndgxyz,ndpxyz,erhandler, dpinfun
integer wrinqr,ndinqr,ndgxyz
double precision dpinfun
integer user02, iott, maxnp, i ,ksel

double precision xyz(3), offset(3)
#include "ansysdef.inc"
c ***** start timing check *****

call TrackBegin ('user02')
maxnp = ndinqr(0,DB_MAXDEFINED)
c ***** get the desired offsets from the command line *****
offset(1) = dpinfun(2)
do i = 1,maxnp
ksel = ndgxyz (i,xyz(1))
if (ksel .eq. 1) then
xyz(1) = xyz(1) + offset(1)
call ndpxyz (i,xyz(1))
endif
enddo
c ***** write to output file *****

iott = wrinqr(WR_OUTPUT)
write (iott,2000)
2000 format (/' NODE OFFSET COMPLETE '/)
c ***** write to GUI window *****

call erhandler ('user02',3000,
x 2,'NODE OFFSET COMPLETE',0.0d0,' ')
c ***** required return value *****

user02 = 0
c ***** end timing check *****

call TrackEnd ('user02')
return
end
1.9.3. Function user03 (Demonstrates Using ANSYS Memory)

*deck,user03
function user03()
c *** primary function: user routine number 03. Gives example of
c ANSYS Memory usage

c *** ansys, inc.
c /*******************************************************************\
c \*******************************************************************/
c output arguments:
c **************************************************************
c **************************************************************
#include "impcom.inc"
external TrackBegin, TrackEnd

external wrinqr, ndinqr, ndgxyz, ndnext, fAnsMemAlloc,
x fAnsMemFree,erhandler, parreturn, parstatus
integer wrinqr, ndinqr, ndgxyz, ndnext
PTRFTN fAnsMemAlloc
integer user03, iott, i, ksel, numnp, node, istat

double precision xyz(3), xmean, ymean, zmean, stdxyz(3),
x sodx, sody, sodz
c pointers:
pointer (pdXnodeL,Xnode)
pointer (pdYnodeL,Ynode)
pointer (pdZnodeL,Znode)
double precision Xnode(*), Ynode(*), Znode(*)
c ***** call to start timing *****

call TrackBegin ('user03')
c Get nodal xyz locations and calculate standard deviation of

c x coordinates, y coordinates, & z coordinates
c get number of currently selected nodes

numnp = ndinqr(0,DB_NUMSELECTED)
istat = 1
if (numnp .le. 0) go to 999
c allocate memory for x, y, & z coordinates of nodes

pdXnodeL = fAnsMemAlloc(numnp,MEM_DOUBLE,'XCoords ')
pdYnodeL = fAnsMemAlloc(numnp,MEM_DOUBLE,'YCoords ')
pdZnodeL = fAnsMemAlloc(numnp,MEM_DOUBLE,'ZCoords ')
c loop through all selected nodes

i = 1
node = 0
xmean = 0.0d0
ymean = 0.0d0
zmean = 0.0d0
10 node = ndnext(node)
if (node .gt. 0) then
c get xyz coordinates

ksel = ndgxyz(node,xyz(1))
c store this node's xyz coordinates

Xnode(i) = xyz(1)
Ynode(i) = xyz(2)
Znode(i) = xyz(3)
c while we're looping, accumulate sums to calculate means

xmean = xmean + xyz(1)
ymean = ymean + xyz(2)
zmean = zmean + xyz(3)
c increment index
i = i + 1
c loop back up for next selected node

goto 10
endif
c node = 0, at the end of node list
c calculate mean of xyz coordinates
xmean = xmean / numnp

ymean = ymean / numnp
zmean = zmean / numnp
c calculate standard deviation for xyz coordinates

sodx = 0
sody = 0
sodz = 0
do i = 1, numnp
sodx = sodx + (Xnode(i) - xmean)**2
sody = sody + (Ynode(i) - ymean)**2
sodz = sodz + (Znode(i) - zmean)**2
enddo
stdxyz(1) = sqrt(sodx / (numnp-1))

stdxyz(2) = sqrt(sody / (numnp-1))
stdxyz(3) = sqrt(sodz / (numnp-1))
c ***** write to output file *****

iott = wrinqr(WR_OUTPUT)
write (iott,2000) xmean,ymean,zmean,
x stdxyz(1),stdxyz(2),stdxyz(3)
2000 format (/' MEAN FOR X COORDINATES:',G12.5/
x ' MEAN FOR Y COORDINATES:',G12.5/
x ' MEAN FOR Z COORDINATES:',G12.5/
x ' STD FOR X COORDINATES:',G12.5/
x ' STD FOR Y COORDINATES:',G12.5/
x ' STD FOR Z COORDINATES:',G12.5)
c ***** write to GUI window *****

call erhandler ('user03',5000,2,
x 'STD FOR X COORDINATES: %G %/
x STD FOR Y COORDINATES: %G %/
x STD FOR Z COORDINATES: %G',stdxyz(1),' ')
c ***** set _STATUS to 0 for success *****

istat = 0
c release dynamically allocated memory

call fAnsMemFree (pdZnodeL)
call fAnsMemFree (pdYnodeL)
call fAnsMemFree (pdXnodeL)
c ***** required return value *****

999 user03 = 0
c ***** set _RETURN to number of nodes processed *****

call parreturn (dble(numnp))
c ***** set _STATUS for success (0) or no nodes (1) *****

call parstatus (istat)
c ***** call to end timing *****

call TrackEnd ('user03')
return
end
1.9.4. Function user04

*deck,user04
function user04()
c *** primary function: user routine number 04; demonstrates gettting a
c list of nodes attached to a keypoint, line, or area

c *** ansys, inc.
c /*******************************************************************\
c \*******************************************************************/
c output arguments:
c **************************************************************
c **************************************************************
external wrinqr, ndkpnt, ndline, ndarea, ch4infun, intinfun

integer wrinqr, ndkpnt, ndline, ndarea, intinfun
character*4 ch4infun
integer user04, iott, listk(20),listl(20),lista(20),

x i, num,ktype, nkpnts, nlines, nareas
character*4 type, lab2
iott = wrinqr (WR_OUTPUT)
c --- setup with: /UCMD,GNSME,4

c !gnsme,group,num,type
c ! group = kp, ln, or ar
c ! num = entity number of kp, ln, or ar
c ! type = interior, or all
c
lab2 = ch4infun(2)
write (iott,2010) lab2
2010 format(/' group name (type of entity) = ',a4)
num = intinfun(3)
write (iott,2020) num
2020 format (' entity number =',i4)
if (lab2 .ne. 'KP ' ) then

type = ch4infun(4)
if (type .eq. 'INTE') then
write (iott,2030)
2030 format (' interior nodes only ')
ktype = 0
elseif (type .eq. 'ALL ') then
write (iott,2040)
2040 format (' all (interior and edge/end) nodes ')
ktype = 1
else
write (iott,2050)
2050 format ('Only INTE or ALL are acceptable in last field',
x ' on user-written gnsme command')
endif
endif
if (lab2 .eq. 'KP ' ) then

nkpnts = ndkpnt (num, listk(1))
write (iott,2110) nkpnts
2110 format (' number of nodes on keypoint = ',i4)
write (iott,2115) (listk(i),i=1,nkpnts)
2115 format (' node on keypoint = ',i4)
elseif (lab2 .eq. 'LN ' ) then

nlines = ndline (num,ktype,listl(1))
write (iott,2120) nlines
Section 1.10: Supporting Subroutines
2120 format (' number of nodes on line = ',i4)

write (iott,2125) (listl(i),i=1,nlines)
2125 format (' list of nodes on line'/(3x,i4))
elseif (lab2 .eq. 'AR ' ) then

nareas = ndarea (num,ktype,lista(1))
write (iott,2130) nareas
2130 format (' number of nodes on area = ',i4)
write (iott,2135) (lista(i),i=1,nareas)
2135 format (' list of nodes on area'/(3x,i4))
else
write (iott,2150)
2150 format (' Only KP, LN, or AR are acceptable on user-written ',
x 'gnsme command')
endif
user04 = 0
return
end
1.9.5. Functions user05 through user10

The source code for user routines user05, user06, user07, user08, user09, and user10 is identical to function
user01 shown above.
1.10. Supporting Subroutines

1.10.1. Function GetRForce (Getting Nodal Reaction Force values)
*deck,GetRForce
function GetRForce (Node,Label,Value)
c primary function: Get the K * u - F at a node from the rfsum vector.
c warning: This routine is called after the elements
c are formed, but before solution. Therefore,
c F is from the current iteration, but
c u is from the previous iteration. At convergence,
c this difference will have little effect.
c The computations are done immediately after the
c call to UElMatx.
c Use the RFSUM command to ask for the summation.
c Use *GET,Parm,NODE,num,RF,DOFLAB to access the reaction
c sum from the command line.
c secondary functions: Return pointer for fast access
c object/library: usr

c Prolog is not CONFIDENTIAL INFORMATION
c input arguments:
c Node (int,sc,in) - Node Number (User)
c Label (ch*4,sc,in) - DOF Label (Upper Case)
c 'UX ','UY ','TEMP','VOLT','ROTY', etc
c output arguments:
c GetRForce (int,func,out) - status/pointer
c = 0 - data not valid
c > 0 - Rfsum pointer to data for fast access
c see comments below
c Value (dp,sc,out) - Solution value for Node,Label
c All results are in the nodal coordinate
c system
c example usage:
c external GetRForce
c integer GetRForce, ptr, Node2
c double precision Value
c #include "handlecom.inc" (if Value = Rfsum(ptr) form is to be used)
c ptr = GetRForce (Node2,'UY ',Value)
c later...
c Value = Rfsum(ptr)
1.10.2. Function GetStackDisp (Getting Current Displacement Values)

*deck,GetStackDisp
function GetStackDisp (Node,Label,Value)
c primary function: Get the displacement at a node from the disp vector
c secondary functions: Return pointer for fast access
c object/library: usr
c Prolog is not CONFIDENTIAL INFORMATION
c input arguments:
c Node (int,sc,in) - Node Number (User)
c Label (ch*4,sc,in) - DOF Label (Upper Case)
c 'UX ','UY ','TEMP','VOLT','ROTY', etc
c output arguments:
c GetStackDisp (int,sc,out) - status/pointer
c = 0 - data not valid
c > 0 - UDisp pointer to data for fast access
c see comments below
c Value (dp,sc,out) - Solution value for Node,Label
c example usage:
c external GetStackDisp
c#include "handlecom.inc" (only if UDisp(ptr) form is used
c integer GetStackDisp, ptr, Node2
c double precision Value
c ptr = GetStackDisp (Node2,'UY ',Value)
c later...
c Value = UDisp(ptr)
1.10.3. Subroutine ElResultStrt (Getting Load Data from Analysis Results)

*deck,ElResultStrt
subroutine ElResultStrt (Label,Comp,LabAvg,TypeData,nVal,iLoc)
c *** primary function: (post1) Load data for later ElResultGet

c (prolog is not confidential)
c input arguments:
c Label (ch*4,sc,in) - Result Type
c Comp (ch*4,sc,in) - Result Component (8 char for ESTR)
c LabAvg (ch*4,sc,in) - 'AVG ' or 'NOAV' ('AVG ' default)
c output arguments:
c TypeData (int,sc,out) - Code for data type
c nVal (int,sc,out) - Number of values per point
Section 1.11: Access at the Beginning and End of Various Operations
c If 0, no data
c iLoc (int,sc,out) - Location of Comp in values
1.10.4. Subroutine ElResultGet (Getting Results Values at Selected Points)

*deck,ElResultGet
subroutine ElResultGet (nPoints,ebest,elcord,TypeData,iLoc,
x nVal,result)
c *** primary function: (post1) Get results at selected points

c (prolog is not confidential)
c input arguments:
c nPoints (int,sc,in) - Number of evaluation points
c *** from ElInterp ***
c ebest (int,ar(nPoints),in) - Element(s) containing points
c elcord (dp,ar(3,nPoints),in) - Element coordinates
c *** from ElResultStrt ***
c TypeData (int,sc,in) - Data type code
c iLoc (int,sc,in) - Start of selected data
c nVal (int,sc,in) - Number of results per point
c output arguments:
c Result (dp,ar(nvar,nPoints),out) - Array of results
1.10.5. Subroutine ElInterp (Finding Element Coordinates)

*deck,ElInterp
subroutine ElInterp (piFEML,nPoints,xyzPoints,tolInsidein,
x tolOutsidein,MoveTol,ebest,elcord)
c primary function: Find element numbers containing xyz points

c secondary functions: Find element coordinates of these points
c object/library: upf

c (Prolog is not CONFIDENTIAL INFORMATION)
c input arguments:
c piFEML (ptr,sc,in) - If non 0, pointer of a FEM Object
c nPoints (int,sc,in) - Number of points to find (do in one group)
c xyzPoints(dp,ar(3,nPoints),in)- XYZ coordinates of each point
c tolInsidein(dp,sc,in) - Tolerance for point inside element
c (0.0d0 defaults to 1.0d-4)
c tolOutsidein(dp,sc,in) - Maximum distance outside to be associated
c with an element (0.0d0 defaults to 0.25)
c MoveTol (dp,sc,in) - Node move tolerance (0.0d0, no move)
c output arguments:
c ebest (int,ar(nPoints),out) - Best element number for each point
c elcord (dp,ar(3,nPoints),out) - Element coordinates of the point
1.11. Access at the Beginning and End of Various Operations

You can access the logic just before an ANSYS run begins or just after a run ends, and at many other intermediate
points, by using the ANSYS routines listed below. These routines can perform actions such as evaluating results
or performing calculations. (None of the routines have input or output arguments.)
Issue the USRCAL command (or use an equivalent menu path) to activate or deactivate these routines.
User Subroutine Is Called

UAnBeg At ANSYS start-up
User Subroutine Is Called

USolBeg Before solution
ULdBeg Before a load step
USsBeg Before a substep
UItBeg Before an iteration
UItFin After an iteration
USsFin After a substep
ULdFin After a load step
USolFin After solution
UAnFin At the end of an ANSYS run
Subroutines USSBeg, UItBeg, UItFin and USSFin default to reading a command macro file from the current
working directory whose name is subroutine.mac (that is, ussfin.mac is read by USSFin.F). No user action to
relink the ANSYS program is required for the command macro to be read except that the calling subroutine must
be activated by the USRCAL command. The design of the command reading ability of these subroutines is limited
to APDL parameter setting commands (*GET, *SET, a = value, etc) and testing for general ANSYS commands is
limited. Commands which are known to work include *DIM, *STATUS. Commands which require another line
(*MSG, *VWRITE) are not allowed. Other commands which are known to not work are the solution loading
commands (D, F, SFE, and so on). If these capabilties are required, the user will need to create a Fortran subroutine
and link this subroutine into ANSYS, as described in Section 1.1: Introduction to UPFs.
While parameter substitution into commands is not permitted, USSBeg, and so on were designed to be used in
conjunction with dynamic tables and parameter substitution from the user subroutine. As an example, consider
an ANSYS table defined as d5 = f(par1), If d5 contains values of displacement as a function of PAR1, then d5 may
be used as a constraint, as
*dim,d5,table,10,1,1,PAR1
d5(1)=0,.1,.25,
/solu
d,5,ux,%d5%
Modify the value of PAR1 in USSBeg.MAC and the constraint on node 5, ux can then be modified in the middle
of a load step.
The following is an example of a valid input that may be read by USSBeg, UItBeg, UItFin and USSFin.
/COM, SAMPLE ussfin.mac
a=5
b=nx(1) ! *get function is ok
*get,c,active,solu,Time,cpu ! *get is ok
*dim,array,,6 ! array parameters are ok
array(1) = 1
array(2) = 2
array(3) = 3
array(4) = 4
array(5) = 5
array(6) = 6
*vleng,3 ! vector operations are ok
*vfun,array(4),copy,array(1)
*stat
*stat,array(1)
array(1)=
nnode = ndinqr(0,14)
*dim,array,,nnode
*vget,array(1),NODE,1,NSEL
*stat,array(1)
array(1)=
/eof
Section 1.12: Creating Your Own Optimization Routine
/COM, COMMANDS BELOW THIS LINE ARE KNOWN TO NOT WORK
p,1,6,2000 ! commands DO NOT work

d,1,uy,.1
*msg,note
THIS IS A TEST MESSAGE
*vwrite,array(1)
(/ b = ,f10.4)
1.12. Creating Your Own Optimization Routine

One way to customize the ANSYS program for your site's specific needs is to substitute your own external optim-
ization for the standard ANSYS optimization algorithm. You can do so using either of these methods:
• Link a user routine within the ANSYS program.

• Run a stand-alone optimization program using the ANSYS optimization "save" file, Jobname.OPT.
This chapter describes both methods. You can find additional information on design optimization techniques
and procedures in the ANSYS Advanced Analysis Techniques Guide.
1.12.1. Linking a Custom Optimization Program to ANSYS

If you are performing iterative analyses for design optimization, and you wish to use the standard ANSYS optimizer,
you simply choose GUI path Main Menu>Design Opt or issue the ANSYS command /OPT.
However, if you plan to use an optimization routine of your own design, you must do the following:
1. Define parameters for your external optimization routine, using either the OPUSER command or GUI
path Main Menu>Design Opt>Method/Tool. (For more information about OPUSER, see the ANSYS
Commands Reference.)
2. Either issue the OPTYPE,USER command or choose menu path Main Menu>Design Opt>Method/Tool
and specify User Optimizer.
3. Issue the OPEXE command or choose GUI path Main Menu>Design Opt>Run.
Issuing the OPTYPE,USER command (or its GUI equivalent) instructs the ANSYS program to bypass the standard
ANSYS design optimizer logic and instead execute your custom optimization routine.
Below is a simplified flow chart showing how a user-defined optimization routine interacts with the ANSYS pro-
gram:

% '&)(+*-, /.0
IJ
C 2/0 3-D8EGF

. . 1 % 0 23 8 5
23 4 5
6 7 % /7 % : 9 ;=<>(+* 0
$

HG @2 G2
7 F

!8E$

!#"$
? 23 8 5
4 0

@A2 @ + B ? %
For information about the kopusr variable and the userop routine, see the next section.
1.12.2. Subroutine userop (Defining a Custom Optimization Routine)

Instead of creating your custom design optimization routine from scratch, you can simply tailor the userop
routine available on your ANSYS distribution medium. Defined within this routine are a number of variables to
which you assign the values you want.
Below is a listing of the inputs and outputs for userop and the comments of common block cmopt:
*deck,userop
subroutine userop (iott,nterm,maxparm,optvar)
c primary purpose: user-supplied optimization routine
c accessed with optype,user
c other input comes from the opuser command
c
c *** ansys, inc.
c
c****************************************************************************
c *
c incoming arguments: *
c *
c *
c iott is the ansys output unit *
c *
c nterm is passed back to routine opterm. this variable should be set *
c as follows: *
c nterm = 0 if optimization looping should stop *
c nterm = 1 if optimization looping should continue *
Section 1.12: Creating Your Own Optimization Routine
c *
c****************************************************************************
c contents of optimization common block cmopt:

c ( only those variables of interest or use are documented)
c
c cmopt variable descriptions
c ---------------------------
c
c dopspr - (not used - spares)
c dv(i) - design vector , i = 1 to maxdv
c iopspr - (not used - spares)
c kconv - convergence flag (kconv = 0 indicates convergence)
c kopusr - flag choosing optimizer (0 = ansys, 1 = user-supplied opt)
c (issuing [the command optype,user sets kopusr = 1)
c lopt - incrementing lopt iteration counter
c maxdv - maximum number of design variables allowed in ansys
c optimization (=60)
c maxparm - maximum number of parameters allowed in ansys
c optimization (=MAXPARAMETER)
c maxopt - maximum number of design sets allowed in optimization
c (=130)
c nobj - flag for objective function defined (0=no, 1=yes)
c ntdv - total number of design variables
c ntsv - total number of state variables
c numopt - total number of design sets
c nsets - highest design set number
c setnum(i) - the actual design set number of the ith design set
c oplim(j,i) - lower limit (j=1) and upper limit (j=2) of ith
c optimization parameter [opvar] (i = 1 to 160)
c the state variables are stored first, then the
c design variables, and then the objective function
c optol(i) - tolerance of ith optimization parameter [opvar]
c (i = 1 to 160)
c the state variables are stored first, and then the
c design variables
c optvar(i,j) - the ith parameter of the jth design set
c (i = 1 to maxpar, j = 1 to maxopt)
c the state variables are stored first, then the
c design variables, then the objective function,
c and then all remaining scalar parameter values
c maxusr - user-specified, maximum allowed optimization
c iterations on the opuser command
c opus(i) - user-specified, double precision parameters on the
c opuser command (i=1,8)
c objtol - objective function tolerance
c
When you finish customizing the userop routine, you relink it using either of the methods described in Sec-
tion 1.1.8: Linking User Routines and in the ANSYS Installation and Configuration Guide for UNIX or in the ANSYS
Installation and Configuration Guide for Windows. You must include the cmopt common block in your routine,
to allow it to pass common data (such as design variables, state variables, and objective function values) to and
from the ANSYS program.
1.12.3. Structuring Your Input

When your userop optimization routine finishes executing, program control returns to the ANSYS design optim-
izer, so that the ANSYS commands on Jobname.LOOP can execute for the next optimization loop. To use your
own customization routine, you should issue the following ANSYS commands (in the order shown):
/OPT
OPTYPE,USER ! ANSYS optimization logic bypassed
OPUSER, ! user-defined optimization to be done
OPVAR ! design and state variables & objective function values defined
.
.
.
OPEXE ! looping begins
1.12.3.1. Example of User Input for Optimization

The commented example below shows you sample ANSYS command input for design optimization, done with
a user-customized version of the userop routine:
c!!!---- minimize y = x1**2 + x2**2
c!!! --- subject to: 1 < x1 < 10
c!!! --- 1 < x2 < 10
c!!! --- g = x1 - x2 > 1
c /batch,list ! use batch mode

c x1=5 ! initial value for dv x1
c x2=5 ! initial value for dv x2
c /prep7 ! enter the ANSYS preprocessor
c y = x1*x1 + x2*x2 ! define function y
c g = x1 - x2 ! define function g
c finish ! finish prep
c /opt ! finish preprocessing
c opvar,x1,dv,1,10 ! define first dv (range 1 to 10)
c opvar,x2,dv,1,10 ! define second dv (range 1 to 10)
c opvar,y,obj,,,1 ! define objective function (tol = 1)
c opvar,g,sv,1 ! define state variable (lower limit 1)
c optype,user ! user user-defined optimization logic
c opuser,10,1.1,2.0 ! define user opt. Modifiers (max iterations=10)
c opexe ! execute userop routine
c oplist,all ! list results
c finish
1.13. Memory Management Routines

ANSYS provides UPF routines you can use for memory management.
1.13.1. Using the Memory Management Routines

ANSYS uses a dynamic memory manager that overlays the system malloc and free functions and provides a
mechanism for accessing the memory from FORTRAN as well as c and c++. Since the UPF routines are provided
in FORTRAN, we will be discussing the FORTRAN access routines.
You may certainly use the system malloc and free functions or, for FORTRAN, the allocate system function. However,
you may end up competing with ANSYS for memory, and for large problems there may be insufficient system
memory to perform the function.
Dynamic memory is done through Cray-style pointers, where a dynamically allocated array is defined via the
construct
pointer (piArray,Array)
integer Array(*)
and memory space for the array is allocated by assigning the pointer, in this case piArray, to the allocated memory
space:
piArray = fAnsMemAlloc (size,...)
To use the ANSYS memory manager in a UPF, follow these steps:
1. 1. Define the dynamically allocated arrays:

pointer (piArray,Array), (pdData,Data)
integer Array(*)
double precision Data(*)
2. Initialize the pointers as follows:
Section 1.13: Memory Management Routines
piArray = PTRFTNNULL
pdData = PTRFTNNULL
3. Allocate space for an array or arrays, as follows:
For integer numbers:

piArray = fAnsMemAlloc(ileng,MEM_INTEGER,C16Label)
For double precision numbers:

pdArray = fAnsMemAlloc(dleng,MEM_DOUBLE,C16Label)
For complex numbers:

pcArray = fAnsMemAlloc(cleng,MEM_COMPLEX,C16Label)
For real numbers:

prArray = fAnsMemAlloc(rleng,MEM_REAL,C16Label)
Where the arguments are:
• xleng is the desired size of the array

• MEM_xxx is the keyword indicating the type of data
• C16Label is a character*16 name of the memory block
You must include the ansysdef.inc include file to get the parameter values of MEM_INTEGER,
MEM_DOUBLE, MEM_COMPLEX, and MEM_REAL.
Note — If there is insufficient memory, fAnsMemAlloc returns “PTRFTNNULL”.
4. Use the arrays.

5. Deallocate the space using the fAnsMemFree subroutine, as follows:
call fAnsMemFree (piArray)
The next two sections provide input and output listings for the memory management routines.
For an example, see Section 1.9.3: Function user03 (Demonstrates Using ANSYS Memory), which appears earlier
in this chapter.
1.13.2. Function fAnsMemAlloc (Allocating Space and Returning a Pointer)

*deck,fAnsMemAlloc
function fAnsMemAlloc (iLen, key, c16Label)
c primary function: Get A Block of Space from mem manager and Return Pointer
c keywords: integer function for mem allocate
c object/library: mem
c input arguments:
c iLen (int,sc,in) - length of the block (in data elements)
c c16Label (chr*16,sc,in) - 16 character name for the Block
c key (int,sc,in) - type of data for this block (see ansysdef)
c output arguments:
c fAnsMemAlloc (PTRFTN,sc,out) - Pointer to this data block -- needs to be
c tied to a local variable in the calling
c routine
1.13.3. Subroutine fAnsMemFree (Deallocating Space)

*deck,fAnsMemFree
subroutine fAnsMemFree (memPtr)
c primary function: Free a Data Block, given a pointer
c keywords: subroutine to free a mem block
c object/library: mem
c input arguments:
c ptr (PTRFTN,sc,inout) - pointer for this block
c output arguments:
c ptr (PTRFTN,sc,inout) - pointer will be set to zero
1.14. Parameter Processing Routines

The ANSYS distribution medium contains three routines you can use for parameter processing: pardim, parevl,
and pardef.
1.14.1. Subroutine pardim (Creating a Dimensioned Parameter)

*deck,pardim
subroutine pardim (cName,labl4,nDim,nxyz,cLabels)
c *** primary function: create a dimensioned parameter
c *dim,parm32,type,d1,d2,d3,cName1,cName2,cName3
c *dim,parm32,type,d1,cName1
c *dim,parm32,type,d1,d2,d3,d4,d5,cName1,cName2,cName3,cName4,cName5
c input arguments:
c cName (chr*32,sc,in) - the name of the parameter to create
c labl4 (chr*4,sc,in) - 'TABL' or 'ARRA' or 'CHAR' or 'STRI'
c nDim (int,sc,in) - Dimension of array
c nxyz (int,ar(nDim),in) - the dimensions of the array
c cLabels (chr*32,ar(nDim),in) - Names for the directions in table
1.14.2. Function parevl (Finding and Evaluating a Parameter)

*deck,parevl
subroutine parevl (ParName,nDim,subc,lvl,dpValue,chValue,kerr)
c *** primary function: find and evaluate a parameter
c
c
c input arguments:
c ParName (chr*(PARMSIZE),sc,in) - the name of the parameter
c (must be upper case, left justified)
c nDim (int,sc,in) - the number of subscripts (0,scaler)
c subc (dp,ar(*),in) - values for the subscripts (if any)
c lvl (int,sc,in) - 0,1 no error output 2, report error
c -1, set kerr flag with no anserr call
Section 1.14: Parameter Processing Routines
c
c output arguments:
c dpValue (dp,sc,out) - the value of the parameter (may be a
c packed character*8
c chValue (ch*128,sc,out) - character output
c kerr (int,sc,out) - error flag (0,ok -1,output is packed
c 0=ok, 1=error, 2=error but TINY is used
c -2, output is string in chValue
c
c
1.14.3. Subroutine pardef (Adding a Parameter)

*deck,pardef
subroutine pardef (label,ctype,nval,subc,valuein,kerr,string)
c *** primary function: add a parameter to parameter list
c
c
c input arguments:
c label (chr*(PARMSIZE),sc,in) - name of parameter
c label is a character variable that
c contains the name of the parameter that
c is to be defined. (Length = PARMSIZE characters)
c
c ctype (int,sc,in) - 0, dp 1,character 2,string
c ctype is an integer key which describes
c the type of data that the parameter data
c holds. This would also indicate the
c contents of "value" (arg 5).
c 0=double precision data
c 1=character data packed in value
c 2=character data in string
c
c nval (int,sc,in) - number of subscripts
c nval is the number of subscripts that the
c "label" (arg 1) contains.
c 1=single dimensioned variable (ex. x(10))
c 2=double dimensioned variable (ex. y(10,3))
c 3=triple dimensioned variable (ex. z(10,3,2))
c -1=delete this parameter from the internal
c tables.
c
c subc (dp,ar(*),in) - values of subscripts
c subc is a double precision vector that
c contains the subscripts of "label" (arg 1).
c There should be enough values defined to
c match "nval" (arg 3). For example if "x"
c was dimensioned as "x(10,3,2)" and you wanted
c to set "x(5,1,1)=123.0", then "nval" (arg 3)
c should be set to 3, and "subc" should be set
c to 5.0, 1.0, 1.0, and "value" (arg 5) should
c be 123.0. Another example is if "y" was
c dimensioned to as "y(20,20)" and you were
c setting "y(5,8)=987", then "nval" (arg 3) should
c be set to 2 and "subc" should be set to 5.0,
c 8.0, 0.0, and "value" (arg 5) should be 987.0.
c
c Remember subroutine "pardef" is only storing
c a data value of "label" or "label(x,y,z)". The
c proper dimensions were set by a "*dim" command.
c
c Please note that although the values of "subc"
c should be double precision, subroutine "pardef"
c uses the intrinsic "nint" (nearest integer)
c function to get and use the integer equivalent.
c
c You should also note the "nval" (arg 3) and
c "subc" (arg 4) must fall within the range that was
c set with a "*dim" or "*set" command or an error
c will occur.
c
c valuein(dp,sc,in) - the value for this parameter
c (should be a packed character*8 if
c ctype=1. To pack a char into a dp
c variable use "call chtodp(ch8,dp)".
c To unpack a dp variable into a char
c use "call dptoch(dp,ch8)" )
c Value is the data value that is to be stored for
c "label" (arg 1). If "ctype=1" (arg 2) then this
c value would be a "packed character" data from the
c "chtodp" Ansys function.
c
c output arguments:
c kerr (int,sc,out) - error flag (0=ok, 1=error)
c kerr is an integer error flag that is
c returned to the calling subroutine. Any
c non zero number would indicate an error
c was detected in subroutine "pardef"
c
c
1.15. Miscellaneous Useful Functions

The ANSYS program has several miscellaneous functions you may find useful for working with UPFs:
• The erhandler routine displays output messages (notes, warnings, and errors).
• The RunCommand function lets you issue an ANSYS command from within a user routine.
• The GetStackDisp routine retrieves current displacement values.
• The /UNDO command writes an "undo" file at critical points as a user routine executes.
• The/HOLD command allows you to synchronize multiple tasks in ANSYS.
• The /TRACK command enables you to do program tracing and timing.
For further descriptions of erhandler and /TRACK, see Chapter 3, “Subroutines for Users' Convenience”. For
details about the GetStackDisp function, see Section 1.10.2: Function GetStackDisp (Getting Current Displace-
ment Values).
1.15.1. Using Function RunCommand

This function enables you to execute an ANSYS command from within a user routine. Inputs and outputs for
RunCommand are as follows:
*deck,RunCommand
function RunCommand (nChar,command)
c primary function: Execute an ansys command
c object/library: upf
c input arguments:
c nChar (int,sc,in) - Length of the command string (8 min)
c command (ch*(nChar),sc,in) - A character string containing a
c valid ANSYS command
c output arguments:
c RunCommand (int,sc,out) - An internally defined value, ignore
Section 1.15: Miscellaneous Useful Functions
1.15.2. Using the /UNDO Command

The "undo" file you create by issuing the /UNDO command is similar to the File.DB file created when you issue
the SAVE command. The /UNDO command format is:
/UNDO,Action
Action
ON, to write the undo file

OFF, to prevent the undo file from being written
PROMPT, to have ANSYS ask permission before writing the file
STATUS, to restore the file as it existed after executing the last command issued before the /UNDO command.
1.15.3. Using the /HOLD command

Issue the /HOLD command to synchronize tasks in ANSYS. The ANSYS program can synchronize tasks at the end
of each results file set.
/HOLD,Filename,TimeInterval,Timeout
Filename
The eight-character name of a message file. If the named file exists, the ANSYS program reads a command
from the file and then deletes the file.
TimeInterval
The length of time, in seconds, that ANSYS waits before trying to read the message file again.
Timeout
The maximum length of time, in seconds, that ANSYS can wait between attempts to read the file.
1–76
Chapter 2: Accessing the ANSYS Database
2.1. What This Chapter Covers
This chapter describes how you can retrieve information in the ANSYS database (or store information in the
database) by linking subroutines you create into the ANSYS program.
You can use the database access routines with any of the user-programmable features. For example, you can
create your own ANSYS commands and use them to execute database access routines (or have a database access
routine call a user-defined command).
2.2. Inputs and Outputs for Database Access Routines

The descriptions of the database access routines or functions within this chapter describe both the input arguments
and output arguments. Argument information includes the argument's type, size and intent.
int - integer
log - logical
chr - character
in - input argument
2.3. Types of Database Access Routines

The rest of this chapter describes the functions and subroutines available for accessing information in the ANSYS
database. The function and subroutine descriptions are grouped into sets: nodal information functions, element
attribute information functions, and so on.
2.4. Routines for Selecting and Retrieving Nodes and Elements

2.4.1. ndnext Function (Getting the Next Node Number)
*deck,ndnext
function ndnext (next)
c *** primary function: get the number of the next selected node
c input arguments:
c next (int,sc,in) - the last node number used
c = 0 - use for initial value
c output arguments:
c ndnext (int,func,out) - the next selected node number
c = 0 - no more nodes
2.4.2. ndprev Function (Getting the Number of the Previous Selected Node)
*deck,ndprev
function ndprev (next)
c *** primary function: get the number of the previous selected node
c
c
c
c input arguments:
c next (int,sc,in) - the next node number used
c
c output arguments:
c ndprev (int,func,out) - the previous selected node number
c
2.4.3. ndnxdf Function (Getting the Number of the Next Defined Node)
*deck,ndnxdf
function ndnxdf (next)
c *** primary function: get the number of the next defined node
c
c
c
c input arguments:
c next (int,sc,in) - the last node number used
c
c output arguments:
c ndnxdf (int,func,out) - the next defined node number
c
c
2.4.4. ndsel Function (Selecting, Unselecting, Deleting, or Inverting a Node)

*deck,ndsel
subroutine ndsel (ndmi,ksel)
c *** primary function: to select, unselect, delete, or invert a node.
c *** secondary functions: none.
c
c
c
c input arguments:
c ndmi (int,sc,in) - node number
c = 0 - all nodes
c < 0 - do not delete CPs and CEQNs
c (merge/offset/compress)
c ksel (int,sc,in) - type of operation to be performed.
c ksel = 0 - delete node.
c = 1 - select node.
Section 2.4: Routines for Selecting and Retrieving Nodes and Elements
c =-1 - unselect node.

c = 2 - invert select status of node.
c
c output arguments:
c none.
c
2.4.5. elnext Function (Getting the Number of the Next Element)

*deck,elnext
function elnext (next)
c *** primary function: get the number of the next selected element
c input arguments:
c next (int,sc,in) - the last element number used
c output arguments:
c elnext (int,func,out) - the next selected element
c = 0 - no more elements
2.4.6. elprev Function (Getting the Number of the Previous Selected Element)
*deck,elprev
function elprev (prev)
c *** primary function: get the number of the previous selected element
c
c
c
c input arguments:
c prev (int,sc,in) - the last element used
c
c output arguments:
c elprev (int,func,out) - the previous selected element
c
2.4.7. elnxdf Function (Getting the Number of the Next Defined Element)
*deck,elnxdf
function elnxdf (next)
c *** primary function: get the number of the next defined element
c
c
c
c input arguments:
c next (int,sc,in) - the last element used
c
c output arguments:
c elnxdf (int,func,out) - the next defined element
c
2.4.8. elsel Subroutine (Selecting, Unselecting, Deleting, or Inverting an Ele-

ment)
*deck,elsel
subroutine elsel (ielei,ksel)
c *** primary function: to select, unselect, delete, or invert an element.
c input arguments:
c ielei (int,sc,in) - element number
c = 0 - all elements
c = 0 - delete element.
c = 1 - select element.
c =-1 - unselect element.
c = 2 - invert select status for element
2.5. Node Information Routines

2.5.1. ndinqr Function (Getting Information About a Node)
The primary function of ndinqr is getting information about a node. You can also use this function to set the
current node pointer to this node.
*deck,ndinqr
function ndinqr (node,key)
c *** primary function: get information about a node.
c *** secondary functions: set current node pointer to this node.
c input arguments:
c node (int,sc,in) - node number
c Should be 0 for key=11, DB_NUMDEFINED,
c DB_NUMSELECTED, DB_MAXDEFINED, and
c DB_MAXRECLENG
c key (dp,sc,in) - key as to information needed about
c the node.
c = DB_SELECTED - return select status:
c ndinqr = 0 - node is undefined.
c =-1 - node is unselected.
c = 1 - node is selected.
c = DB_NUMDEFINED - return number of defined nodes
c = DB_NUMSELECTED - return number of selected nodes
c = DB_MAXDEFINED - return highest node number defined
c = DB_MAXRECLENG - return maximum record length (dp words)
c = 2, return length (dp words)
c = 3,
c = 4, pointer to first data word
c = 11, return void percent (integer)
c = 17, pointer to start of index
c = -1,
c = -2, superelement flag
c = -3, master dof bit pattern
c = -4, active dof bit pattern
c = -5, solid model attachment
c = -6, pack nodal line parametric value
c = -7, constraint bit pattern
c = -8, force bit pattern
c = -9, body force bit pattern
c = -10, internal node flag
c = -11, orientation node flag =1 is =0 isnot
c = -11, contact node flag <0
Section 2.5: Node Information Routines
c = -12, constraint bit pattern (for DSYM)

c = -13, if dof constraint written to file.k (for LSDYNA only)
c = -14, nodal coordinate system number (set by NROTATE)
c =-101, pointer to node data record
c =-102, pointer to angle record
c =-103,
c =-104, pointer to attached couplings
c =-105, pointer to attacted constraint equations
c =-106, pointer to nodal stresses
c =-107, pointer to specified disp'S
c =-108, pointer to specified forces
c =-109, pointer to x/y/z record
c =-110,
c =-111,
c =-112, pointer to nodal temperatures
c =-113, pointer to nodal heat generations
c =-114,
c =-115, pointer to calculated displacements
c =-116,
c output arguments:
c ndinqr (int,func,out) - the returned value of ndinqr is based on
c setting of key.
2.5.2. getnod Function (Getting a Nodal Point)

*deck,getnod
subroutine getnod (node,v,kerr,kcrot)
c *** primary function: get a nodal point
c input arguments:
c kerr (int,sc,inout) - message flag
c = 0 - print no message if node is unselected
c or undefined
c = 1 - print message if node is undefined
c = 2 - print message if node is undefined
c or unselected
c kcrot (int,sc,in) - output coordinates in this coordinate system.
c if kcrot is negative, output theta and
c phi coordinates in radians
c output arguments:
c v (dp,ar(6),out) - Coordinates (first 3 values) and rotation
c angles (last 3 values)
c kerr (int,sc,inout) - select status
c = 0 - node is selected
c = 1 - node is not defined
c =-1 - node is unselected
2.5.3. putnod Function (Storing a Node)

*deck,putnod
subroutine putnod (node,vctn,kcrot)
c *** primary function: store a node
c *** secondary functions: display node if in immediate mode.
c input arguments:
c vctn (dp,ar(6),in) - array of 3 nodal coordinates and
c 3 nodal rotation angles.
c kcrot (int,sc,in) - local coordinate system in which the nodal
c coordinates and angles are defined
c output arguments: none.
2.5.4. ndgall Function (Getting the XYZ/Rotation Coordinates Vector for a

Node)
*deck,ndgall
function ndgall (node,xyz)
c *** primary function: get x,y,z,rotx,roty,rotz vector for a node.
c input arguments:
c node (int,sc,in) - node number for operation.
c output arguments:
c ndgall (int,sc,out) - status of node.
c 0=node is undefined.
c -1=node is unselected.
c 1=node is selected.
c xyz (dp,ar(6),out) - vector containing x,y,z,rotx,roty,rotz
2.5.5. ndspgt Subroutine (Getting the Nodal Solution for a Node of an Element)
*deck,ndspgt
subroutine ndspgt (node,dofs,ndof,nrot,xyzang,nuvect,unode)
c *** primary function: get the nodal solution for a node of an element
c input arguments:
c node (int,sc,in) - The node number
c dofs (int,ar(DOFBITLENG),in) - The dofs to retrieve for the node.
c dof = degree of freedom
c The dofs array should be zeroed out,
c except for the needed parts.
c dofs is a bit pattern with true bits
c representing the GLOBAL Dof set desired.
c That is, dofs(1) is used for UX to SP06,
c and dofs(2) is used for TBOT to TTOP.
c See ECHPRM for details. For example,
c dofs(1) = UX + TEMP
c dofs(2) = TE3
c TTOP is a special case. If you want
c TTOP alone, use:
c dofs(2) = ibset(0,TTOP)
c If TBOT and TTOP are desired, you must use:
c dofs(2) = TBOT
c dofs(2) = ibset(dofs(2),TTOP)
c ndof (int,sc,in) - The number of node dofs (1, 2 or 3).
c nrot (int,sc,in) - Key to rotate dofs from nodal to global
c coordinate systems.
c if 0, none. if 2, 2-d. if 3, 3-d
c if > 0, dof set must include and only
c include all terms of the vector (e.g.
c UX,UY,UZ, or AX,AY,AZ).
c xyzang (dp,ar(6),in) - The xyz virgin node coordinates
c (including angles). Not used if
c nrot = 0 or ndof < 2.
c nuvect (int,sc,in) - Number of vectors to retrieve. Can vary
c between 1 and 5. Normally 1 is what is
c wanted. Other vectors include previous
c values and/or velocities. See elucom for
c all possibilites. Contents are analysis
c type dependent.
c output arguments:
c unode (dp,ar(ndof,nuvect),out) - Element nodal solution vectors in
c the global coordinate system.
Section 2.6: Element Attribute Routines
2.6. Element Attribute Routines

2.6.1. elmiqr Function (Getting Information About an Element)
*deck,elmiqr
function elmiqr (ielem,key)
c *** primary function: get information about an element.
c *** secondary functions: set current element pointer to this element.
c input arguments:
c should be zero for key=11, DB_NUMDEFINED,
c DB_NUMSELECTED, or DB_MAXDEFINED
c key (int,sc,in) - information flag.
c = DB_SELECTED - return select status: (1)
c elmiqr = 0 - element is undefined.
c =-1 - element is unselected.
c = 1 - element is selected.
c = DB_NUMDEFINED - return number of defined elements (12)
c = DB_NUMSELECTED - return number of selected elements (13)
c = DB_MAXDEFINED - return maximum element number used (14)
c = DB_MAXRECLENG - return maximum record length (15)
c (int words)
c = 2 - return length (int words)
c = 3 - return layer number
c (for cross reference files return number of entities)
c = 4 - return address of first data word
c = 5 - return length (in record type units)
c = 6 - return compressed record number.
c = 11 - return void percent (integer)
c = 16 - return location of next record
c (this increments the next record count)
c = 17 - pointer to start of index
c = 18 - return type of file.
c elmiqr = 0 - integer
c = 1 - double precision
c = 2 - real
c = 3 - complex
c = 4 - character*8
c = 7 - index
c = 19 - return virtual type of file.
c elmiqr = 0 - fixed length (4.4 form)
c = 1 - indexed variable length (layer data)
c = 2 - xref data tables
c = 3 - bitmap data (for 32 data item packed records)
c = 4 - data tables (three dimensional arrays)
c = -1 - material number etc. (see elmcmx)
c =-101 - pointer to element integers etc.
c (see elmcmx with elmilg and 1 instead of -101)
c
c output arguments:
c elmiqr (int,sc,out) - the returned value of elmiqr is based on
c setting of key.
2.6.2. elmget Function (Getting an Element's Attributes and Nodes)

*deck,elmget
function elmget (ielem,elmdat,nodes)
c *** primary function: get element attributes and nodes.
c input arguments:
c output arguments:
c elmget (int,func,out) - status of element.
c = 0 - element undefined
c < 0 - number of nodes on unselected
c element
c > 0 - number of nodes on selected element
c elmdat (int,ar(EL_DIM),in) - element attributes.
c elmdat(EL_MAT) - material number
c (EL_TYPE) - element type
c (EL_REAL) - real constant number
c (EL_SECT) - section number
c (EL_CSYS) - coordinate system number
c (EL_DEAD) - death flag (bit 0)
c if clear - alive
c if set - dead
c (EL_SOLID) - solid model reference
c (EL_SHAPE) - 100*shape + specific shape
c (EL_OBJOPTIONS) - reserved
c (EL_PEXCLUDE) - p element include flag
c (bit 0)
c if clear - include
c if set - exclude
c nodes (int,ar(*),out) - node numbers for element.
2.6.3. elmput Subroutine (Storing an Element)

*deck,elmput
subroutine elmput (ielem,elmdat,nnod,nodes)
c *** primary function: store element attributes and node numbers.
c *** secondary functions: set current element pointer to this element.
c *** NOTICE - The user is also responsible for defining the centroid for the
c element using the elmpct subroutine. Calling the elmput
c subroutine will NULL the element centroid previously defined.
c input arguments:
c elmdat (int,ar(EL_DIM),in) - element attributes.
c elmdat(EL_MAT) - material number
c (EL_TYPE) - element type
c (EL_REAL) - real constant number
c (EL_SECT) - section number
c (EL_CSYS) - coordinate system number
c (EL_DEAD) - death flag (bit 0)
c if clear - alive
c if set - dead
c (EL_SOLID) - solid model reference
c (EL_SHAPE) - 100*shape + specific shape
c (EL_OBJOPTIONS) - reserved
c (EL_PEXCLUDE) - p element include flag
c (bit 0)
c if clear - include
c if set - exclude
c For LSDYNA, it means part ID
c in reqular ANSYS, it is never part ID
c nnod (int,sc,in) - number of nodes for this element.
c nodes (int,ar(*),in) - node numbers for this element.
2.6.4. etyiqr Function (Getting a Data Item About an Element Type)

*deck,etyiqr
function etyiqr (itype,key)
c *** primary function: get information about an element type.
c input arguments:
c itype (int,sc,in) - element type number
c DB_MAXRECLENG
c = DB_SELECTED - return select status:
c etyiqr = 0 - element type is undefined.
c =-1 - element type is unselected.
c = 1 - element type is selected.
c = DB_NUMDEFINED - return number of defined element types
c = DB_NUMSELECTED - return number of selected element types
c = DB_MAXDEFINED - return highest element type number defined
c = DB_MAXRECLENG - return maximum record length (int words)
c = -n, return element characteristic n from etycom for element
c type itype.
c n is correlated to the parameter names in echprm.
c see elccmt for definitions of element characteristics.
c note- this will not overwrite the current setting of
c etycom.
c output arguments:
c etyiqr (int,func,out) - the returned value of etyiqr is based on
c setting of key.
2.6.5. etyget Function (Getting Information About an Element Type)

*deck,etyget
function etyget (itype,ielx)
c *** primary function: get element type data.
c input arguments:
c itype (int,sc,in) - element type number
c output arguments:
c etyget (int,func,out) - status of element type.
c = 0 - element type is undefined.
c < 0 - number of data items on unselected
c element type.
c > 0 - number of data items on selected
c element type.
c ielx (int,ar(*),out) - element type data. see elccmt for
c description of data.
2.6.6. etyput Subroutine (Storing Element Type Data)

*deck,etyput
subroutine etyput (itype,n,ielx)
c *** primary function: store element type data.
c input arguments:
c itype (int,sc,in) - element type number for operation.
c n (int,sc,in) - length of data vector to store.
c ielx (int,ar(*),in) - element type data. see elccmt for
c description.
2.6.7. echrtr Subroutine (Getting Information About Element Characteristics)

*deck
subroutine echrtr (iott,elcdn,ielc,kerr)

c primary function: collect all element characteristics based on
c ityp,jtyp, and keyopts

c
c
c input arguments:
c iott (int,sc,in) - printout file
c ielc (int,ar(IELCSZ),inout) - input element characteristics
c in positions 1 to 20.
c (itype, jstif, keyopts, etc.)
c
c output arguments:
c elcdn (chr,sc,out) - element descriptive name as character
c string
c ielc (int,ar(IELCSZ),inout) - input element characteristics
c in positions 21 to 150.
c (kdim, ishap, idegen, etc.)
c see elccmt for a full list
c kerr (int,sc,out) - error flag
c = 0 - no errors
c = 1 - errors
2.6.8. etysel Subroutine (Selecting, Unselecting, Deleting, or Inverting an

Element Type)
*deck,etysel
subroutine etysel (itypi,ksel)
c *** primary function: to select, unselect, delete, or invert an
c element type.
c
c
c
c input arguments:
c itypi (int,sc,in) - element type number
c = 0 - all element types
c = 0 - delete element type.
c = 1 - select element type.
c =-1 - unselect element type.
c = 2 - invert element type.
c
c output arguments:
c none.
c
2.6.9. mpinqr Function (Getting Information About a Material Property)

*deck,mpinqr
function mpinqr (mat,iprop,key)
c *** primary function: get information about a material property.
c input arguments:
c should be 0 for key=11,
c DB_NUMDEFINED(12),
c DB_MAXDEFINED(14), and
c DB_MAXRECLENG(15)
c iprop (int,sc,in) - property reference number:

c if iprop = 0, test for existence of any material property with this
c material number (with key = DB_SELECTED(1))
c
c EX = 1, EY = 2, EZ = 3, NUXY= 4, NUYZ= 5, NUXZ= 6, GXY = 7, GYZ = 8
c GXZ = 9, ALPX=10, ALPY=11, ALPZ=12, DENS=13, MU =14, DAMP=15, KXX =16
c KYY =17, KZZ =18, RSVX=19, RSVY=20, RSVZ=21, C =22, HF =23, VISC=24
c EMIS=25, ENTH=26, LSST=27, PRXY=28, PRYZ=29, PRXZ=30, MURX=31, MURY=32
c MURZ=33, PERX=34, PERY=35, PERZ=36, MGXX=37, MGYY=38, MGZZ=39, EGXX=40
c EGYY=41, EGZZ=42, SBKX=43, SBKY=44, SBKZ=45, SONC=46, SLIM=47, ELIM=48
c USR1=49, USR2=50, USR3=51, USR4=51, FLUI=53, ORTH=54, CABL=55, RIGI=56
c THSY=65, THSZ=66, DMPR=67, =68, =69, =79, =71, =72,
c =73, =74, =75, =76, =77, =78, =79, =80
c
c (see mpinit for uncommented code and for TB command information)
c key (int,sc,in) - key as to the information needed

c about material property.
c = DB_SELECTED(1)- return select status:
c mpinqr = 0 - material prop is undefined.
c = 1 - material prop is selected.
c = DB_NUMDEFINED(12) - number of defined material properties
c = DB_MAXDEFINED(14) - highest material property number defined
c = DB_MAXRECLENG(15) - maximum record length (dp words)
c = 2 - return length (dp words)
c = 3 - return number of temp. values
c output arguments:
c mpinqr (int,func,out) - returned value of mpinqr is based on
c setting of key.
2.6.10. mpget Function (Getting a Material Property Table)

*deck,mpget
function mpget (mat,iprop,temp,prop)
c *** primary function: get a material property table.
c input arguments:
c THSY=65, THSZ=66, DMPR=67, =68, =69, =79, =71, =72,
c =73, =74, =75, =76, =77, =78, =79, =80
c
c (see mpinit for uncommented code and TB command information)
c output arguments:
c mpget (int,func,out) - number of temperature values
c temp (dp,ar(mpget),out) - vector of the temperature values
c prop (dp,ar(mpget),out) - vector of the property values
2.6.11. mpput Subroutine (Storing a Material Property Table)

*deck,mpput
subroutine mpput (mat,iprop,ntab,temp,prop)
c *** primary function: store material property tables.
c input arguments:
c mat (int,sc,in) - material number.
c THSY=65, THSZ=66, DMPR=67, =68, =69, =79, =71, =72,
c =73, =74, =75, =76, =77, =78, =79, =80
c
c (see mpinit for uncommented code and TB command information)
c ntab (int,sc,in) - number of entries in the table

c (1 to 100)
c tem (dp,ar(ntab),in) - temperature vector (ascending)
c prp (dp,ar(ntab),in) - property vector
c output arguments:
c none.
2.6.12. mpdel Subroutine (Deleting a Material Property Table)

*deck,mpdel
subroutine mpdel (mat,iprop)
c *** primary function: delete material property tables.
c input arguments:
c mat (int,sc,in) - material number.
c (0 = all properties)
c THSY=65, THSZ=66, DMPR=67, =68, =69, =79, =71, =72,
c =73, =74, =75, =76, =77, =78, =79, =80
c
c (see mpinit for uncommented code and for TB command information)
2.6.13. rlinqr Function (Getting Information About a Real Constant Set)

*deck,rlinqr
function rlinqr (nreal,key)
c *** primary function: get information about a real constant set
c input arguments:
c nreal (int,sc,in) - real constant table number
c should be 0 for key=11, DB_NUMDEFINED,
c DB_MAXRECLENG
c = 5 - return number of values stored for nreal
c = DB_SELECTED - return select status
c rlinqr = 0 - real constant table is undefined.
c =-1 - real constant table is unselected.
c = 1 - real constant table is selected
c = DB_NUMDEFINED - return number of defined real constant tables
c = DB_NUMSELECTED - return number of selected real constant tables
c = DB_MAXDEFINED - return highest real constant table defined
c = DB_MAXRECLENG - return maximum record length (dp words)
c output arguments:
c rlinqr (int,func,out) - the returned value of rlinqr is based on
c setting of key.
2.6.14. rlget Function (Getting Real Constant Data)

*deck,rlget
function rlget (nreal,rtable)
c *** primary function: get real constant data
c input arguments:
c nreal (int,sc,in) - real constant table number
c output arguments:
c rlget (int,func,out) - number of real constant data obtained
c rtable (dp,ar(*),out) - real constant data obtained
2.6.15. rlsel Subroutine (Selecting or Deleting a Real Constant Set)

*deck,rlsel
subroutine rlsel (nreai,ksel)
c *** primary function: select or delete a real constant set
c
c
c
c input arguments:
c nreai (int,sc,in) - real constant table
c = 0 - all real constant tables
c = 0 - delete real constant table.
c = 1 - select real constant table.
c =-1 - unselect real constant table.
c = 2 - invert real constant table.
c
c output arguments:
c none
c
2.6.16. csyiqr Function (Getting Information About a Coordinate System)

*deck,csyiqr
function csyiqr (ncsy,key)
c *** primary function: get information about a coordinate system
c input arguments:
c ncsy (int,sc,in) - coordinate system reference number
c should be zero for key= DB_NUMDEFINED
c or DB_MAXDEFINED
c = DB_SELECTED - return status:
c csyiqr = 0 - coordinate system is not defined
c -1 - coordinate system is not selected
c 1 - coordinate system is selected
c = DB_NUMDEFINED - number of defined coordinate systems
c = DB_MAXDEFINED - maximum coordinate system reference
c number used.
c output arguments:
c csyiqr (int,func,out) - the returned value of csyiqr is based on
c setting of key.
2.6.17. csyget Function (Getting a Coordinate System)

*deck,csyget
function csyget (ncsy,csydpx,csyinx)
c *** primary function: get a coordinate system
c NOTE: As a time-saving device, this routine will not fetch the coordinate
c system data from the database (an expensive operation)
c if ncsy = csyinx(4), as this would indicate that the data is current.
c If you wish to force this routine to fetch coordinate system data (in
c the case of loading a local array, for example), you MUST set
c ncsy != csyinx(4) before function call.
c input arguments:
c variable (typ,siz,intent) description csycom name
c ncsy (int,sc,in) - coordinate system number
c csyinx(4) (int,sc,inout) - coordinate system number csyact
c output arguments:
c csydpx (dp,ar(18),out)
c csydpx(1-9) - transformation matrix
c (10-12) - origin (XC, YC, ZC)
c (13-14) - coordinate system parameters cparm
c cparm2
c (15) - spare
c (16-18) - defining angles
c csyinx (int,ar(6),out)
c csyinx(1-2) - theta, phi singularity keys
c (3) - coordinate system type icdsys
c (csyinx(4) is inout) (4) - coordinate system number csyact
c (5) - spare
c (6) - spare
c csyget (int,func,out) - status of coordinate system
c = 0 - coordinate system exists
c = 1 - coordinate system doesn't exist
Section 2.7: Coupling and Constraint Routines
2.6.18. csyput Subroutine (Storing a Coordinate System)

*deck,csyput
subroutine csyput (ncsy,csydpx,csyinx)
c *** primary function: store a coordinate system
c input arguments:
c csydpx (dp,ar(18),out)
c csydpx(1-9) - transformation matrix
c (10-12) - origin (XC, YC, ZC)
c (13-14) - coordinate system parameters cparm
c cparm2
c (15) - spare
c (16-18) - defining angles
c csyinx (int,ar(6),out)
c csyinx(1-2) - theta, phi singularity keys
c (3) - coordinate system type icdsys
c (4) - coordinate system number csyact
c (5) - spare
c (6) - spare
2.6.19. csydel Subroutine (Deleting a Coordinate System)

*deck,csydel
subroutine csydel (ncsy)
c *** primary function: delete a coordinate system
c
c
c
c input arguments:
c
c output arguments:
c none
c
2.6.20. userac Subroutine (Demonstrates Use of Element Attribute Routines)

See Section 1.3.10: Subroutine userac (Accessing Element Information) for an example that demonstrates how
to use the userac subroutine to extract information about an element type and element real constants from
the ANSYS database. You can find this subroutine on your ANSYS distribution media.
2.7. Coupling and Constraint Routines

2.7.1. cpinqr Function (Getting Information About a Coupled Set)
*deck,cpinqr
function cpinqr (nce,key)
c *** primary function: get information about a coupled set
c
c

c
c input arguments:
c nce (int,sc,in) - coupled set number
c key (int,sc,in) - inquiry key:
c DB_MAXRECLENG
c cpinqr = 1 - coupled set is selected
c = 0 - coupled set in undefined
c =-1 - coupled set in unseleted
c = DB_NUMDEFINED - return number of defined coupled sets
c = DB_NUMSELECTED - return number of selected coupled sets
c = DB_MAXDEFINED - return the number of the highest numbered
c coupled set
c = DB_MAXRECLENG - return length of largest coupled set record
c (max record length)
c = 2 - return length (data units)
c = -1 - return master node for this eqn (this is
c currently only used by solution DB object)
c
c output arguments:
c cpinqr (int,func,out) - the returned value of cpinqr is based on
c setting of key
c
2.7.2. cpget Function (Getting a Coupled Set)

*deck,cpget
function cpget (ncp,ieqn)
c *** primary function: get a coupled set
c input arguments:
c ncp (int,sc,in) - coupled set number
c
c output arguments:
c cpget (int,func,out) - number of nodes in list
c ieqn (int,ar(cpget+2),out) - coupled set info:
c ieqn(1:cpget) - list of coupled nodes
c ieqn(cpget+1) - set degree of freedom
c ieqn(cpget+2) - number of nodes in list
c (copy of return value)
2.7.3. cpput Subroutine (Storing a Coupled Set)

*deck,cpput
subroutine cpput (ncp,n,ieqn)
c *** primary function: store a coupling set
c input arguments:
c ncp (int,sc,in) - coupled set number
c n (int,sc,in) - number of nodes in coupled set
c ieqn (int,ar(n+2),in) - info for storage
c ieqn(1:n) - list of coupled nodes
c ieqn(n+1) - degree of freedom label for set
c (ieqn(n+2) is inout) ieqn(n+2) - number of nodes in coupled set
c (copy of n)
c output arguments:
Section 2.7: Coupling and Constraint Routines
c ieqn(n+2) (int,sc,inout) - number of nodes in coupled set

c (another copy of n)
2.7.4. cpsel Subroutine (Selecting or Deleting a Coupled Set)

*deck,cpsel
subroutine cpsel (ncpi,ksel)
c *** primary function: select or delete a coupled set
c
c
c
c input arguments:
c ncpi (int,sc,in) - coupled set number
c ksel (int,sc,in) - select/delete flag
c = 0 - delete coupled set
c = 1 - select coupled set
c output arguments:
c none
c
2.7.5. ceinqr Function (Getting Information About a Constraint Equation Set)

*deck,ceinqr
function ceinqr (nce,key)
c *** primary function: get information about a constraint equation set
c input arguments:
c nce (int,sc,in) - constraint equation number
c key (int,sc,in) - inquiry key:
c DB_MAXRECLENG
c ceinqr = 1 - equation is selected
c = 0 - equation is undefined
c =-1 - equation is unselected
c = DB_NUMDEFINED - return number of defined contraint equations
c = DB_NUMSELECTED - return number of selected contraint equations
c = DB_MAXDEFINED - return number of highest numbered constraint
c equation defined
c = DB_MAXRECLENG - return length of longest contraint equation set
c = 2 - return length (data units)
c = 4 - address of first data word
c = -1 - return master dof for this eqn
c output arguments:
c ceinqr (int,func,out) - the returned value of ceinqr is based on
c setting of key
2.7.6. ceget Function (Getting an Constraint Equation)

*deck,ceget
function ceget (nce,ieqn,deqn)
c *** primary function: get a constraint equation
c input arguments:
c nce (int,sc,in) - constraint equation number
c output arguments:
c ceget (int,func,out) - number of dof in equation
c ieqn (int,ar(ceget+1),out) - integer info
c ieqn(1:ceget) - list of node*32+dof
c ieqn(ceget+1) - number of dof in equation
c (copy of return value)
c - negative means internal CE
c deqn (dp,ar(ceget+1),out) - dp info
c deqn(1:ceget) - list of coefficients
c deqn(ceget+1) - constant term
2.7.7. ceput Subroutine (Storing a Constraint Equation)

*deck,ceput
subroutine ceput (nce,n,ieqn,deqn)
c *** primary function: store a constraint equation
c input arguments:
c nce (int,sc,in) - constraint equation set number
c n (int,sc,in) - number of degrees of freedom in set
c ieqn (int,ar(n+1),in) - integer info
c ieqn(1:n) - node*32+dof for each dof in set
c ieqn(n+1) - number of dof in set (copy of n above)
c - negative means internal CE
c deqn (dp,ar(n+1),in) - dp info
c deqn(1:n) - coefficients of each dof in set
c deqn(n+1) - constant term
c
2.7.8. cesel Subroutine (Deleting or Selecting a Constraint Equation)

*deck,cesel
subroutine cesel (ncei,ksel)
c *** primary function: select or delete a constraint equation
c input arguments:
c ncei (int,sc,in) - constraint equation number
c ksel (int,sc,in) - select/delete flag
c = 0 - delete equation
c = 1 - select equation
2.8. Nodal Loading Routines

2.8.1. disiqr Function (Getting a Information About Constraints)
*deck,disiqr
function disiqr (node,key)
c *** primary function: get information about constraints
c input arguments:
c node (int,sc,in) - node number for inquire.
c = 1 - return constraint mask
c = DB_MAXDEFINED,
Section 2.8: Nodal Loading Routines
c DB_NUMDEFINED - return number of nodal constraints

c NOTE: both DB_MAXDEFINED and
c DB_NUMDEFINED produce the same
c functionality
c output arguments:
c disiqr (int,func,out) - the returned value of disiqr is based on
c setting of key.
2.8.2. disget Function (Getting a Constraint from the Database)

*deck,disget
function disget (inode,idf,value)
c *** primary function: get a constraint from the data base (in raw form)

c input arguments:
c inode (int,sc,in) - node number (negative value for no
c partabeval)
c idf (int,sc,in) - reference number for the DOF: (1-32)
c UX = 1, UY = 2, UZ = 3, ROTX= 4, ROTY= 5, ROTZ= 6, AX = 7, AY = 8
c AZ = 9, VX =10, VY =11, VZ =12
c PRES=19, TEMP=20, VOLT=21, MAG =22, ENKE=23, ENDS=24
c EMF =25, CURR=26 SP01=27, SP02=28, SP03=29, SP04=30, SP05=31, SP06=32
c (missing entries are spares)
c output arguments:
c disget (int,func,out) - status of constraint.
c = 0 - no constraint on this node
c for this DOF
c = 4 - this node has a constraint
c defined for this DOF
c value (dp,ar(4),out) - constraint values
c value(1-2) - (real,imag) values of present settings
c value(3-4) - (real,imag) values of previous settings
2.8.3. disput Subroutine (Storing a Constraint at a Node)

*deck,disput
subroutine disput (node,idf,value)
c *** primary function: store a constraint at a node.
c input arguments:
c idf (int,sc,in) - reference number of DOF: (1-32)
c AZ = 9, VX =10, VY =11, VZ =12
c EMF =25, CURR=26 (missing entries are spares)
c value (dp,ar(2),in) - (real,imag) values for constraint
2.8.4. disdel Subroutine (Deleting a Constraint at a Node)

*deck,disdel
subroutine disdel (node,idf)
c *** primary function: delete a constraint at a node
c input arguments:
c node (int,sc,in) - node number.
c idf (int,sc,in) - reference number of DOF: (1-32)

c AZ = 9, VX =10, VY =11, VZ =12
2.8.5. foriqr Function (Getting Information About Nodal Loads)

*deck,foriqr
function foriqr (node,key)
c *** primary function: get information about nodal loads.
c input arguments:
c node (int,sc,in) - number of node being inquired about.
c should be 0 for key=DB_MAXDEFINED or
c DB_NUMDEFINED
c key (dp,sc,in) - key as to information needed
c = 1 - return force mask for node
c = DB_MAXDEFINED,
c DB_NUMDEFINED - return number of nodal loadings
c in model
c NOTE: both DB_MAXDEFINED and DB_NUMDEFINED
c produce the same functionality
c output arguments:
c foriqr (int,func,out) - the returned value of foriqr is based on
c setting of key.
2.8.6. forget Function (Getting a Constraint from the Database)

*deck,forget
function forget (inode,idf,value)
c *** primary function: get a force from the data base (in raw form)
c input arguments:
c inode (int,sc,in) - node number (negative value for no
c partabeval)
c (see echprm.inc)
c output arguments:
c forget (int,func,out) - status of constraint.
c = 0 - no loading on this node for this DOF
c = 4 - this node has a loading for this DOF
c value (dp,ar(4),out)
c value(1-2) - (real,imag) values of present settings
c value(3-4) - (real,imag) values of previous settings
2.8.7. forput Subroutine (Storing a Nodal Load at a Node)

*deck,forput
subroutine forput (node,idf,value)
c *** primary function: store a nodal load at a node
c input arguments:
c FX = 1, FY = 2, FZ = 3, MX = 4, MY = 5, MZ = 6, CSGX= 7, CSGY= 8
c CSGZ= 9, VFX =10, VFY =11, VFZ =12
c FLOW=19, HEAT=20, AMPS=21, FLUX=22, NPKE=23, NPDS=24

c CURT=25, VLTG=26 (missing entries are spares)
c value (dp,ar(2),in) - (real,imag) values of force
2.8.8. fordel Subroutine (Deleting a Nodal Load at a Node)

*deck,fordel
subroutine fordel (node,idf)
c *** primary function: delete a nodal load at a node
c input arguments:
c FX = 1, FY = 2, FZ = 3, MX = 4, MY = 5, MZ = 6, CSGX= 7, CSGY= 8
c CSGZ= 9, VFX =10, VFY =11, VFZ =12
c FLOW=19, HEAT=20, AMPS=21, FLUX=22, NPKE=23, NPDS=24
c CURT=25, VLTG=26 (missing entries are spares)
c output arguments:
c none.
2.8.9. ntpiqr Function (Getting Information About a Nodal Temperature)

*deck,ntpiqr
function ntpiqr (node,key)
c *** primary function: get information about a nodal temperature
c input arguments:
c should be zero for key=2
c key (int,sc,in) - key for operation
c = 1 - return temperature status
c ntpiqr = 0 - node has no temperature
c constraint defined
c = 1 - node has a temperature
c constraint defined
c = 2 - return total number of nodal
c temperatures defined in model
c output arguments:
c ndinqr (int,func,out) - the returned value of ndinqr is based on
c setting of key.
2.8.10. ntpget Function (Getting a Specified Nodal Temperature)

*deck,ntpget
function ntpget (node,tmp)
c *** primary function: get specified nodal heat generation (in raw form)
c input arguments:
c output arguments:
c ntpget (int,func,out) - heat generation status of node.
c = 0 - nodal heat generation undefined
c = 1 - nodal heat generation is defined
c tmp (dp,ar(2),out) - the nodal heat generation (new,old).
2.8.11. ntpput Subroutine (Storing a Nodal Temperature)

*deck,ntpput
subroutine ntpput (node,temp)
c *** primary function: store nodal temperature.
c input arguments:
c temp (dp ,sc,in) - nodal temperature
2.8.12. ntpdel Subroutine (Deleting a Nodal Temperature)

*deck,ntpdel
subroutine ntpdel (node)
c *** primary function: delete node temperatures.

c
c
c input arguments:
c
c output arguments:
c none.
2.8.13. nhgiqr Function (Getting Information About Nodal Heat Generations)

*deck,nhgiqr
function nhgiqr (node,key)
c *** primary function: get information about nodal heat generations
c input arguments:
c should be 0 for key=2
c = 1 - return whether node has a heat generation rate
c defined
c nhgiqr = 0 - no heat generation defined for node
c = 1 - heat generation is defined for node
c = 2 - return total number of nodal heat generation
c rates defined in model
c output arguments:
c nhgiqr (int,func,out) - the returned value of nhgiqr is based on
c setting of key.
2.8.14. nhgget Function (Getting a Nodal Heat Generation)

*deck,nhgget
function nhgget (node,hg)
c *** primary function: get specified nodal heat generation (in raw form)
c input arguments:
c output arguments:
c nhgget (int,func,out) - heat generation status of node.
c = 0 - nodal heat generation undefined
c = 1 - nodal heat generation is defined
c hg (dp,ar(2),out) - the nodal heat generation (new,old).
2.8.15. nhgput Subroutine (Storing Nodal Heat Generation)

*deck,nhgput
subroutine nhgput (node,hg)
c *** primary function: store nodal heat generation.
c input arguments:
c hg (dp ,sc,in) - nodal heat generation
2.8.16. nhgdel Subroutine (Deleting a Nodal Heat Generation)

*deck,nhgdel
subroutine nhgdel (node)
c *** primary function: delete nodal heat generations.

c
c
c input arguments:
c output arguments:
c none.
2.8.17. nfuiqr Function (Getting Information About Nodal Fluences)

*deck,nfuiqr
function nfuiqr (node,key)
c *** primary function: get information about nodal fluences
c input arguments:

c = 1 - return status:
c nfuiqr = 0 - node does not have a fluence constraint
c = 1 - node has a fluence constraint
c = 2 - return total number of nodal fluences defined on
c model
c output arguments:
c nfuiqr (int,func,out) - the returned value of nfuiqr is based on
c setting of key.
2.8.18. nfuget Function (Getting a Nodal Fluence)

*deck,nfuget
function nfuget (node,fluen)
c *** primary function: get specified nodal fluence.
c input arguments:
c output arguments:
c nfuget (int,func,out) - fluence status of node.
c = 0 - node has no fluence constraint
c = 1 - node has a fluence constaint
c fluen (dp ,ar(2),out) - the nodal fluences (new,old).
2.8.19. nfuput Subroutine (Storing a Nodal Fluence)

*deck,nfuput
subroutine nfuput (node,fluen)
c *** primary function: store nodal fluence.
c input arguments:
c fluen (dp ,sc,in) - nodal fluence
2.8.20. nfudel Subroutine (Deleting a Nodal Fluence)

*deck,nfudel
subroutine nfudel (node)
c *** primary function: delete node fluences.
c
c
c
c input arguments:
c
c output arguments:
c none.
c
2.8.21. ndciqr Function (Getting Information About Nodal Current Densities)

*deck,ndciqr
function ndciqr (node,key)
c *** primary function: get information about nodel current densities
c input arguments:
c = 1 - return nodal current status:
c ndciqr = 0 - no current density defined for this node
c = 1 - node has a current density defined
c = 2 - total number of nodal current densities defined
c on model
c output arguments:
c ndciqr (int,func,out) - the returned value of ndciqr is based on
c setting of key.
2.8.22. ndcget Function (Getting a Nodal Current Density)

*deck,ndcget
function ndcget (node,currd)
c *** primary function: get specified nodal current density.
c input arguments:
c output arguments:
c ndcget (int,func,out) - current density status of node.
c = 0 - node has no current density defined
c = 1 - node has a current density defined
c currd (dp,ar(4,2),out) - the node current density (new,old).
2.8.23. ndcput Subroutine (Storing a Nodal Current Density)

*deck,ndcput
subroutine ndcput (node,currd)
c *** primary function: store nodal current density.
c input arguments:
c currd (dp ,ar(4),in) - nodal current densities
2.8.24. ndcdel Subroutine (Deleting a Nodal Current Density)

*deck,ndcdel
subroutine ndcdel (node)
c *** primary function: delete nodal current densities

c
c
c input arguments:
c
c output arguments:
c none.
2.8.25. nvdiqr Function (Getting Information About Nodal Magnetic Virtual

Displacements)
*deck,nvdiqr
function nvdiqr (node,key)
c *** primary function: get information about nodal mag virtual disps
c input arguments:
c = 1 - return magnetic virtual displacement status
c nvdiqr = 0 - no mag. virt. disps defined for this node
c = 1 - node has mag. virt. disps defined
c = 2 - return total number of nodal magnetic virtual
c displacements defined on model
c output arguments
c nvdiqr (int,func,out) - the returned value of nvdiqr is based on
c setting of key.
2.8.26. nvdget Function (Getting a Nodal Magnetic Virtual Displacement)

*deck,nvdget
function nvdget (node,virtd)
c *** primary function: get specified nodal magnetic virtual displacement
c input arguments:
c output arguments:
c nvdget (int,func,out) - virtual disp status of node.
c = 0 - node has no magnetic virtual
c displacement
c = 1 - node has a magnetic virtual
c displacement
c virtd (dp ,sc,out) - the nodal virtual displacement value
2.8.27. nvdput Subroutine (Storing a Nodal Virtual Displacement)

*deck,nvdput
subroutine nvdput (node,virtd)
c *** primary function: store nodal virtual displacement
c input arguments:
c virtd (dp ,sc,in) - nodal virtual displacement
Section 2.9: Element Loading Routines
2.8.28. nvddel Subroutine (Deleting a Nodal Virtual Displacement)

*deck,nvddel
subroutine nvddel (node)
c *** primary function: delete nodal virtual displacements.

c
c
c input arguments:
c
c output arguments:
c none.
2.9. Element Loading Routines

2.9.1. epriqr Function (Getting Information About Element Pressure/Convec-
tion)
*deck,epriqr
function epriqr (ielem,iface,key)
c *** primary function: get information about element pressure/convection
c input arguments:
c should be zero for key=DB_NUMDEFINED or
c DB_MAXRECLENG
c iface (int,sc,in) - face number for inquire (0-6)
c face number is needed for key=5. for
c other values of key, iface has different
c meaning (see below)
c = 1 - return pressure mask for element
c = 5 - return number of pressures for this
c element face
c = DB_NUMDEFINED,
c = DB_MAXDEFINED - return value is based on setting of iface
c NOTE: both DB_NUMDEFINED and
c DB_MAXDEFINED produce the same
c functionality
c iface = 0 - return number of surface loads defined
c = 1-6 - return number of pressure loads
c defined for this element.
c NOTE: only 1-6 is valid, but this
c routine simply checks that iface is in
c the range. The actual value of iface
c does not matter in this case.
c = DB_MAXRECLENG - return the maximum number of element
c pressures on any element (max record
c length)
c output arguments:
c epriqr (int,func,out) - the returned value of epriqr is based on
c setting of key.
2.9.2. eprget Function (Getting an Element Face Pressure)

*deck,eprget
function eprget (elem,iface,value)
c *** primary function: get an element face pressure
c input arguments:
c elem (int,sc,in) - element number (negative value for
c no partabeval)
c iface (int,sc,in) - face number (1-6)
c output arguments:
c eprget (int,func,out) - status of element.
c =-1 - element has no pressures
c = 0 - this element face has no pressures
c > 0 - number of values defined
c value (dp ,ar(*),out) - the element pressures (real,imag) at each
c face
2.9.3. eprput Subroutine (Storing an Element Face Pressure)

*deck,eprput
subroutine eprput (ielem,iface,nval,value)
c *** primary function: store an element face pressure.
c input arguments:
c ielem (int,sc,in) - element number for operation.
c nval (int,sc,in) - number of values to put
c value (dp ,ar(nval),in) - the element pressures (real,imag) at each
c face
2.9.4. eprdel Subroutine (Deleting an Element Pressure/Convection)

*deck,eprdel
subroutine eprdel (ielem,iface)
c *** primary function: delete a pressure/convection on an element
c input arguments:
c iface (int,sc,in) - face number
c = 0 - delete all pressures on this
c element
c = 1-6 - delete pressure on this face
2.9.5. ecviqr Function (Getting Information About Element Convections)

*deck,ecviqr
function ecviqr (ielem,iface,key)
c *** primary function: get information about element convections
c input arguments:
c ielem (int,sc,in) - element number for inquire
c should be zero for key=DB_NUMDEFINED or
c DB_MAXRECLENG
c = 1 - return convection mask for element

c = 5 - return number of convections for this
c element face
c = DB_NUMDEFINED,
c functionality
c iface = 0 - return number of surface loads
c defined (rec length)
c = 1-6 - return number of convection loads
c defined for this element.
c = DB_MAXRECLENG - return the maximum number of convections
c on any element (max rec length)
c output arguments:
c ecviqr (int,func,out) - the returned value of ecviqr is based on
c setting of key.
2.9.6. ecvget Function (Getting an Element Face Convection)

*deck,ecvget
function ecvget (elem,iface,value)
c *** primary function: get an element face convection (in raw form)
c input arguments:
c output arguments:
c ecvget (int,func,out) - status of element.
c =-1 - element has no convections/heat
c fluxes
c = 0 - this element face has no
c convections/heat fluxes
c value (dp ,ar(*),out) - the element convections
c NOTE: Two values at each node of an

c element face: if loading is a convection,
c the first first value is the film
c coefficient and the second value is the
c bulk temperature. If loading is a heat
c flux, the first value is the heat flux,
c and the second value is a large number
c (2**100)
2.9.7. ecvput Subroutine (Storing an Element Face Convection)

*deck,ecvput
subroutine ecvput (ielem,iface,nval,value)
c *** primary function: store an element face convection.
c input arguments:
c value (dp ,ar(nval),in) - the element convections.
c NOTE: Two values at each node of an

c element face: if loading is a convection,
c the first first value is the film
c coefficient and the second value is the
c bulk temperature. If loading is a heat
c flux, the first value is the heat flux,
c and the second value is a large number
c (2**100)
c output arguments:
c none.
2.9.8. ecvdel Subroutine (Deleting a Convection on an Element)

*deck,ecvdel
subroutine ecvdel (ielem,iface)
c *** primary function: delete a convection on an element
c input arguments:
c ielem (int,sc,in) - element number.
c = 0 - delete all convections on this
c element
c = 1-6 - delete convections on this face
c output arguments:
c none.
2.9.9. etpiqr Function (Getting Information About Element Temperatures)

*deck,etpiqr
function etpiqr (ielem,key)
c *** primary function: get information about element temperatures.
c input arguments:
c DB_MAXDEFINED, and DB_MAXRECLENG
c etpiqr = 0 - element has no temperatures
c = 1 - element has temperatures defined
c = DB_NUMDEFINED - return number of temperatures defined for
c this element (rec length)
c = DB_MAXDEFINED - return number of temperatures defined in
c model
c = DB_MAXRECLENG - return maximum number of temperatures
c defined for any element (max rec length)
c = 3 - return layer number (for cross reference files return
c number of entities)
c = 16 - return location of next record (this increments the
c next record count)
c etpiqr = 0 - integer
c = 2 - real
c = 3 - complex
c = 4 - character*8
c = 7 - index
c etpiqr = 0 - fixed length (4.4 form)
c = 1 - indexed variable length
c (layer data)
c = 3 - bitmap data (for 32 data item packed
c records)
c = 4 - data tables (three dimensional arrays)
c output arguments:
c etpiqr (int,func,out) - the returned value of etpiqr is based on
c setting of key.
2.9.10. etpget Function (Getting an Element Temperature)

*deck,etpget
function etpget (ielem,tem)
c *** primary function: get element temperatures (in raw form)
c input arguments:
c output arguments:
c etpget (int,func,out) - status of element.
c = 0 - this element has no element
c temperatures
c > 0 - number of element temperatures
c retrieved
c tem (dp,ar(n,2),out) - the element temperatures (new,old).
c NOTE THAT TEM MUST DOUBLE THE NUMBER OF DESIRED

c TEMPERATURES IN THE CALLING ROUTINE!
c NOTE: If a value is not defined (i.e.,

c defaults to TUNIF), value will be a
c very small number (2**-100)
2.9.11. etpput Subroutine (Storing an Element Temperature)

*deck,etpput
subroutine etpput (ielem,n,temp)
c *** primary function: store element temperatures.
c input arguments:
c n (int,sc,in) - number of element temperature values
c temp (dp ,ar(n),in) - element temperatures.

c NOTE: If a value is not defined (i.e.,
c defaults to TUNIF), a very small
c number should be used (2**-100)
2.9.12. etpdel Subroutine (Deleting an Element Temperature)

*deck,etpdel
subroutine etpdel (ielem)
c *** primary function: delete element temperatures.
c input arguments:
2.9.13. ehgiqr Function (Getting Information About Element Heat Generation)

*deck,ehgiqr
function ehgiqr (ielem,key)
c *** primary function: get information about element heat generations.
c input arguments:
c should be 0 for key=11, DB_NUMDEFINED,
c DB_MAXDEFINED, and DB_MAXRECLENG
c ehgiqr = 0 - heat generation is undefined
c = 1 - heat generation is defined
c = DB_NUMDEFINED - return number of defined heat generations
c in model
c = DB_MAXRECLENG - return maximum number of heat generations
c = 3 - return layer number (for cross reference files return
c number of entities)
c = 5 - return length (record type units)
c = 16 - return location of next record (this increments the
c next record count)
c ehgiqr = 0 - integer
c = 2 - real
c = 3 - complex
c = 4 - character*8
c = 7 - index
c ehgiqr = 0 - fixed length (4.4 form)
c = 1 - indexed variable length
c (layer data)
c = 3 - bitmap data (for 32 data
c item packed records)
c = 4 - data tables (three
c dimensional arrays)
c output arguments:
c ehgiqr (int,func,out) - the returned value of ehgiqr is based on
c setting of key.
2.9.14. ehgget Function (Getting an Element Heat Generation)

*deck,ehgget
function ehgget (ielem,qgen)
c *** primary function: get element heat generations (in raw form)
c input arguments:
c output arguments:
c ehgget (int,func,out) - status of element.
c = 0 - heat generations undefined for this

c element
c > 0 - number of heat generations defined
c qgen (dp ,ar(*),out) - the element heat generations.
c NOTE: If a value is not defined, it will
c be a very small number (2**-100)
2.9.15. ehgput Subroutine (Storing an Element Heat Generation)

*deck,ehgput
subroutine ehgput (ielem,n,qgen)
c *** primary function: store element heat generations
c input arguments:
c n (int,sc,in) - number of element heat generation values
c qgen (dp ,ar(n),in) - element heat generations

c NOTE: If a value is not defined, a very
c small number should be used (2**-100)
2.9.16. ehgdel Subroutine (Deleting an Element Heat Generation)

*deck,ehgdel
subroutine ehgdel (ielem)
c *** primary function: delete element heat generations.
c input arguments:
c output arguments:
c none
2.9.17. efuiqr Function (Getting Information About Element Fluences)

*deck,efuiqr
function efuiqr (ielem,key)
c *** primary function: get information about element fluences
c input arguments:
c ielem (int,sc,in) - element number or zero (see below)
c = 1 or DB_MAXRECLENG - return element fluences info
c for ielem > 0 - return number of fluences for this
c element (record length)
c = 0 - return maximum number of fluences
c defined for any element
c (max rec length)
c = DB_NUMDEFINED,
c = DB_MAXDEFINED - return number of defined fluences
c in model
c NOTE: both DB_NUMDEFINED and DB_MAXDEFINED
c output arguments:
c efuiqr (int,func,out) - the returned value of efuiqr is based on
c setting of key
2.9.18. efuget Function (Getting an Element Fluence)

*deck,efuget
function efuget (ielem,value)
c *** primary function: get element fluences.
c input arguments:
c output arguments:
c efuget (int,func,out) - status of element.
c = 0 - element has no fluences defined
c > 0 - number of element fluences defined
c value (dp,ar(*),out) - element fluences.

2.9.19. efuput Subroutine (Storing an Element Fluence)

*deck,efuput
subroutine efuput (ielem,n,value)
c *** primary function: store element fluences
c input arguments:
c n (int,sc,in) - the number of values to store
c value (dp,ar(n),in) - element fluences.

2.9.20. efudel Subroutine (Deleting an Element Fluence)

*deck,efudel
subroutine efudel (ielem)
c *** primary function: delete element fluences

2.9.21. edciqr Function (Getting Information About Element Current Densities)

*deck,edciqr
function edciqr (ielem,key)
c *** primary function: get information about element current densities
c input arguments:
c = 1 or DB_MAXRECLENG - return element densities info
c for ielem > 0 - number of current densities for this
c element (rec length)
c = 0 - maximum number of current densities

c defined for any element
c (max rec length)
c = DB_NUMDEFINED,
c = DB_MAXDEFINED - return total number of current densities
c defined in model
c output arguments:
c edciqr (int,func,out) - the returned value of edciqr is based on
c setting of key
2.9.22. edcget Function (Getting Element Current Densities)

*deck,edcget
function edcget (ielem,value)
c *** primary function: get element current densities

c output arguments:
c = 0 - element has no current densities

c defined
c > 0 - number of element current
c densities defined
c value (dp,ar(*),out) - element current densities

2.9.23. edcput Subroutine (Storing an Element Current Density)

*deck,edcput
subroutine edcput (ielem,n,value)
c *** primary function: store element current densities
c input arguments:
c n (int,sc,in) - the number of current densities to store
c value (dp,ar(n),in) - element current densities
c output arguments:
c none
2.9.24. edcdel Subroutine (Deleting an Element Current Density)

*deck,edcdel
subroutine edcdel (ielem)
c *** primary function: delete element current densities
c input arguments:
2.9.25. evdiqr Function (Getting Information About Element Virtual Displace-

ments)
*deck,evdiqr
function evdiqr (ielem,key)
c *** primary function: get information about element virt disps
c input arguments:
c = 1 or DB_MAXRECLENG - return element virt disps info
c for ielem > 0 - number of virt disps defined for this
c = 0 - maximum number of virt disps defined
c for any element (max rec length)
c = DB_NUMDEFINED,
c = DB_MAXDEFINED - return total number of virt disps defined
c in model
c output arguments:
c evdiqr (int,func,out) - the returned value of evdiqr is based on
c setting of key
2.9.26. evdget Function (Getting an Element Virtual Displacement)

*deck,evdget
function evdget (ielem,value)
c *** primary function: get element virtual displacements
c input arguments:
c
c output arguments:
c evdget (int,func,out) - status of element.
c = 0 - no virt disps defined for this
c element
c > 0 - number of element virtual
c displacements
c value (dp,ar(*),out) - element virtual displacements
c
2.9.27. evdput Subroutine (Storing an Element Virtual Displacement)

*deck,evdput
subroutine evdput (ielem,n,value)
c *** primary function: store element virtual displacements
c input arguments:
c n (int,sc,in) - the total number of values
c value (dp,ar(n),in) - element virtual displacments

2.9.28. eimiqr Function (Getting Information About Element Impedances)

*deck,eimiqr
function eimiqr (ielem,iface,key)
c *** primary function: get information about element impedences
c input arguments:
c ielem (int,sc,in) - element number for inquire.
c should be zero for key=DB_NUMDEFINED,
c DB_MAXDEFINED or DB_MAXRECLENG
c = 1 - return impedence mask for element
c = 5 - return number of impedences for this
c element face
c = DB_NUMDEFINED,
c functionality
c iface = 0 - return number of surface loads defined
c in model
c = 1-6 - return number of pressure loads
c defined for this element. (rec length)
c = DB_MAXRECLENG - return the maximum number of element
c impedences defined for any element
c (max rec length)
c output arguments:
c eimiqr (int,func,out) - the returned value of eimiqr is based on
c setting of key.
2.9.29. eimget Function (Getting an Element Face Impedance)

*deck,eimget
function eimget (ielem,iface,value)
c *** primary function: get an element face impedence
c input arguments:
c output arguments:
c eimget (int,func,out) - status of element.
c =-1 - element has no impedences
c = 0 - this element face has no impedences
c value (dp ,ar(*),out) - the element impedences (real,imag)
2.9.30. eimput Subroutine (Storing an Element Impedance)

*deck,eimput
subroutine eimput (ielem,iface,nval,value)
c *** primary function: store an element face impedence.
c input arguments:
c value (dp ,ar(nval),in) - the element impedences (real,imag)
2.9.31. eimdel Subroutine (Deleting an Element Impedance)

*deck,eimdel
subroutine eimdel (ielem,iface)
c *** primary function: delete an impedence on a element
c input arguments:
c = 0 - delete all impedences on this
c element
c = 1-6 - delete impedence on this face
2.9.32. esfiqr Function (Getting Information About Element Surface Stress

Data)
*deck,esfiqr
function esfiqr (ielem,key)
c *** primary function: get information about element surface stress data
c input arguments:
c ielem (int,sc,in) - element number (or zero, see below)
c = 1 - return info about surface stress
c ielem > 0 - return number of surface stresses on this
c = 0 - return maximum number of surface stresses
c = DB_NUMDEFINED - return the number of surface stresses
c defined in model
c output arguments:
c esfiqr (int,func,out) - the returned value of esfiqr is based on
c setting of key
2.9.33. esfget Function (Getting Element Surface Stress Data)

*deck,esfget
function esfget (ielem,value)
c *** primary function: get element surface stress data.
c input arguments:
c output arguments:
c esfget (int,func,out) - status of element.
c > 0 - number of values returned
c value (dp,ar(*),out) - element surface stress data.
2.9.34. esfput Subroutine (Storing Element Surface Stress Data)

*deck,esfput
subroutine esfput (ielem,nval,value)
c *** primary function: store surface stresses for an element.
c input arguments:
c (19 * number of stress faces)
c There is a max of 2 stress faces
c value (dp,ar(nval),in) - the values
2.9.35. esfdel Subroutine (Deleting an Element's Surface Stress Data)

*deck,esfdel
subroutine esfdel (ielem)
c *** primary function: delete element surface stress data
c input arguments:
c = 0 - delete for all defined elements
2.9.36. efsdel Subroutine (Deleting a Flagged Surface on an Element)

*deck,efsdel
subroutine efsdel (ielem,iface)
c *** primary function: delete a flagged surface on an element
c input arguments:
c = 0 - all flagged surfaces
c = 1-6 - this flagged surface
2.9.37. efsget function (Getting Element Face Flagged Surfaces)

*deck,efsget
function efsget (ielem,iface,value)
c *** primary function: get element face flagged surfaces
c input arguments:
c output arguments:
c efsget (int,func,out) - status of element.
c =-1 - no values for this element
c = 0 - zero flagged surfaces defined
c value (dp ,ar(*),out) - the element flagged surfaces
2.9.38. efsiqr function (Getting Information About Flagged Surfaces)

*deck,efsiqr
function efsiqr (ielem,iface,key)
c *** primary function: get information about flagged surfaces
c input arguments:
c ielem (int,sc,in) - element number for inquire.
c should be zero for key=DB_NUMDEFINED,
c DB_MAXDEFINED or DB_MAXRECLENG
c = 1 - return flagged surfaces mask for element
c = 5 - return number of flagged surfaces for this
c element face
c = DB_NUMDEFINED,
c functionality
c iface = 0 - return total number of pressures,
c convections, etc defined in model
c = 1-6 - return number of flagged surfaces
c defined for this element. (rec length)
c = DB_MAXRECLENG - return maximum number of flagged surfaces
c for any element (max rec length)
c output arguments:
c efsiqr (int,func,out) - the returned value of efsiqr is based on
c setting of key.
2.9.39. efsput Subroutine (Storing an Element Face Flagged Surface)

*deck,efsput
subroutine efsput (ielem,iface,nval,value)
c *** primary function: store an element face flagged surface.
c input arguments:
c value (dp ,ar(nval),in) - the element flagged surface values
2.10. Results Information Routines

2.10.1. dspiqr Function (Getting Information About Nodal Results)
*deck,dspiqr
function dspiqr (node,key)
c *** primary function: get information about nodal results
Section 2.10: Results Information Routines
c input arguments:
c > 0 - return result mask at this node
c = 0 - return number of calculated
c displacements in model
c At this time, key should always = 1
c output arguments:
c dspiqr (int,func,out) - the returned value of dspiqr is based on
c setting of key
2.10.2. dspget Function (Getting a Nodal Result from the Database)

*deck,dspget
function dspget (node,ndf,idf,value)
c *** primary function: get a nodal result from the data base
c input arguments:
c ndf (int,sc,in) - number of results requested
c idf (int,ary(ndf),in) - reference number for the DOF: (1-32)
c AZ = 9, VX =10, VY =11, VZ =12
c EMF =25, CURR=26 SP01=27, SP02=28, SP03=29, SP04=30, SP05=31, SP06=32
c (missing entries are spares)
c output arguments:
c dspget (int,func,out) - number of actual results
c value (dp,ar(ndf),out) - result values
2.10.3. dspput Subroutine (Storing a Constraint at a Node)

*deck,dspput
subroutine dspput (node,ndf,idf,value)
c *** primary function: store a result at a node.
c input arguments:
c ndf (int,sc,in) - number of results to be stored
c idf (int,ary(ndf),in) - reference number for the DOF: (1-32)
c value (dp,ar(ndf),in) - displacement values
2.10.4. dspdel Subroutine (Deleting a Result at a Node)

*deck,dspdel
subroutine dspdel (node,ndf,idf)
c *** primary function: delete a result at a node
c input arguments:
c node (int,sc,in) - node number. (0 to delete DOF at all
c nodes)
c ndf (int,sc,in) - number of DOFs to delete (0 to delete
c all DOFs)
c idf (int,ar(*),in) - reference number for the DOF: (1-32)
c UX = 1, UY
= 2, UZ = 3, ROTX= 4, ROTY= 5, ROTZ= 6, AX = 7, AY = 8
c AZ = 9, VX
=10, VY =11, VZ =12
2.10.5. emsiqr Function (Getting Information About an Element's Miscellaneous

Summable Data)
*deck,emsiqr
function emsiqr (ielem,key)
c *** primary function: get information about element misc summable data
c input arguments:
c = 1 - return info about misc summed data records
c ielem > 0 - return number of misc summed
c data items for this element
c (record length)
c = 0 - return maximum number of misc
c summed data items on any
c element (max record length)
c = DB_NUMDEFINED - return total number of misc summed data
c items defined in model
c output arguments:
c emsiqr (int,func,out) - the returned value of emsiqr is based on
c setting of key
2.10.6. emsget Function (Getting an Element's Miscellaneous Summable Data)

*deck,emsget
function emsget (ielem,value)
c *** primary function: get element misc summable data.
c input arguments:
c output arguments:
c emsget (int,func,out) - status of element.
c = 0 - element is undefined
c > 0 - number of data items returned
c value (dp,ar(*),out) - element misc summed data.
c NOTE: the contents of this record is element

c dependent. See SMISC on ETABLE command
2.10.7. emsput Subroutine (Storing an Element's Miscellaneous Summable

Data)
*deck,emsput
subroutine emsput (ielem,nval,value)
c *** primary function: store misc. summable data for an element.
c input arguments:
c nval (int,sc,in) - number of values to be stored
c value (dp,ar(nval),in) - the misc summed data values
c output arguements: none

c dependent. See SMISC on ETABLE command
2.10.8. emsdel Subroutine (Deleting an Element's Miscellaneous Summable

Data)
*deck,emsdel
subroutine emsdel (ielem)
c *** primary function: delete element misc summable data
c input arguments:
c = 0 - delete data for all defined elements
2.10.9. enfiqr Function (Getting Information About Element Nodal Forces)

*deck,enfiqr
function enfiqr (ielem,key)
c *** primary function: get information about element nodal forces
c input arguments:
c = 1 - return info about element nodal forces
c ielem > 0 - return number of element nodal
c forces for this element
c (record length)
c = 0 - return maximum number of element
c nodal forces on any element
c = DB_NUMDEFINED - return total number of element nodal
c forces defined in model
c output arguments:
c enfiqr (int,func,out) - the returned value of enfiqr is based on
c setting of key
2.10.10. enfget Function (Getting an Element's Nodal Forces)

*deck,enfget
function enfget (ielem,value)
c *** primary function: get element nodal forces.
c input arguments:
c output arguments:
c enfget (int,func,out) - status of element.
c = 0 - element has no nodal forces
c > 0 - number of nodal forces returned
c value (dp,ar(*),out) - element nodal forces
2.10.11. enfput Subroutine (Storing an Element's Nodal Forces)

*deck,enfput
subroutine enfput (ielem,nval,value)
c *** primary function: store nodal force results at an element.
c input arguments:
c NOTE: There may be a maximum of 3 sets of
c nodal forces in the record: static
c forces, inertia forces, and damping forces
c value (dp,ar(nval),in) - nodal force results
2.10.12. enfdel Subroutine (Deleting an Element's Nodal Forces)

*deck,enfdel
subroutine enfdel (ielem)
c *** primary function: delete element nodal forces data
c input arguments:
2.10.13. ensiqr Function (Getting Information About an Element's Nodal

Stresses)
*deck,ensiqr
function ensiqr (ielem,key)
c *** primary function: get information about element nodal stresses
c input arguments:
c = 1 - return info about element nodal stresses
c ielem > 0 - return number of element nodal
c stresses for this element
c (record length)
c nodal stresses on any element
c = DB_NUMDEFINED - return total number of element
c nodal stresses defined in model
c output arguments:
c ensiqr (int,func,out) - the returned value of ensiqr is based on
c setting of key
2.10.14. ensget Function (Getting an Element's Nodal Stresses)

*deck,ensget
function ensget (ielem,value)
c *** primary function: get element nodal stresses.
c input arguments:
c output arguments:
c ensget (int,func,out) - status of element.
c > 0 - number of nodal stresses
c returned
c value (dp,ar(*),out) - element nodal stresses
c NOTE: Stresses at each corner node in the order

c X, Y, Z, XY, YZ, XZ, S1, S2, S3, SI, SE
c For solid elements, stresses at each
c corner node
c For shell elements, stresses at each
c corner node (first top durface, then
c bottom)
c For layered elements (w/KEYOPT(8)=0),
c stresses for "first" layer at each
c corner node (first at the bottom
c surface of the bottom layer, then the
c top surface of the top layer).
c Stresses for "second" layer at each
c corner node (first the bottom surface,
c then the top surface for the layer with
c the largest failure criteria).
c The second layer is not present if
c failure criteria were not used or are
c not appropriate
c stresses for each layer at each corner
c node (first at the bottom surface, then
c the top surface)
c For beam elements, the contents of this
c record is element depenent. See LS
c item of ETABLE command.
2.10.15. ensput Subroutine (Storing Nodal Stresses at an Element)

*deck,ensput
subroutine ensput (ielem,nval,value)
c *** primary function: store nodal stresses at an element.
c input arguments:
c (6*nnod*nface)
c value (dp,ar(nval),in) - the stress values
c NOTE: Stresses at each corner node in the order

c X, Y, Z, XY, YZ, XZ, S1, S2, S3, SI, SE
c For solid elements, stresses at each
c corner node
c For shell elements, stresses at each
c bottom)
c stresses for "first" layer at each
c Stresses for "second" layer at each

c not appropriate
c stresses for each layer at each corner
c the top surface)
c record is element depenent. See LS
2.10.16. ensdel Subroutine (Deleting an Element's Nodal Stresses)

*deck,ensdel
subroutine ensdel (ielem)
c *** primary function: delete element nodal stresses
c input arguments:
2.10.17. engiqr Function (Getting Information About an Element's Energies)

*deck,engiqr
function engiqr (ielem,key)
c *** primary function: get information about element energies
c input arguments:
c = 1 - return info about element energies
c ielem > 0 - return number of element energies on
c this element (rec length)
c energies on any element
c (max rec length)
c = DB_NUMDEFINED - return the number of element energies
c defined in model
c output arguments:
c engiqr (int,func,out) - the returned value of engiqr is based on
c setting of key
2.10.18. engget Function (Getting an Element's Energies)

*deck,engget
function engget (ielem,value)
c *** primary function: get element energies.
c input arguments:
c output arguments:
c engget (int,func,out) - status of element.
c = 11 - energies returned
c value (dp,ar(6),out)
c value(1) = volume of element
c (2) = strain energy

c (3) = dissipation energy
c (4) = kinetic energy
c (5) = plastic energy
c (6) = creep energy
c (7-8) = spares
c (9) = thermal energy
c (10-11) = spares
2.10.19. engput Subroutine (Storing an Element's Energies and Volume)

*deck,engput
subroutine engput (ielem,nval,value)
c *** primary function: store volume and energies for an element.
c input arguments:
c nval (int,sc,in) - the total number of values to be stored
c Must be 11!
c value (dp,ar(6),in) - volume and energies
c value(1) = volume of element
c (2) = strain energy
c (3) = dissipation energy
c (4) = kinetic energy
c (5) = plastic energy
c (6) = creep energy
c (7-8) = spares
c (9) = thermal energy
c (10-11) = spares
2.10.20. engdel Subroutine (Deleting an Element's Energies)

*deck,engdel
subroutine engdel (ielem)
c *** primary function: delete element energies
c input arguments:
2.10.21. egriqr Function (Getting Information About an Element's Nodal

Gradients)
*deck,egriqr
function egriqr (ielem,key)
c *** primary function: get information about element nodal gradients
c input arguments:
c = 1 - return info about nodal gradients
c for ielem > 0 - return number of nodal gradients on
c this element (record length)
c = 0 - return maximum number of nodal
c gradients on any element
c (maximum record length)
c = DB_NUMDEFINED - return the number of nodal gradients defined

c in model
c output arguments:
c egriqr (int,func,out) - the returned value of egriqr is based on
c setting of key
2.10.22. egrget Function (Getting an Element's Nodal Gradients)

*deck,egrget
function egrget (ielem,value)
c *** primary function: get element nodal gradients.
c input arguments:
c output arguments:
c egrget (int,func,out) - status of element.
c > 0 - number of nodal gradients
c returned
c value (dp,ar(*),out) - element nodal gradients
c Note: If a coupled field, a set of

c gradients are stored in the following
c order (as available): fluid, thermal,
c electric, magnetic
2.10.23. egrput Subroutine (Storing an Element's Nodal Gradients)

*deck,egrput
subroutine egrput (ielem,nval,value)
c *** primary function: store nodal gradients at an element.
c input arguments:
c (ndir*nnod*nscalr)
c value (dp,ar(nval),in) - the gradient values
c Note: If a coupled field, a set of

c gradients are stored in the following
c order (as appropriate): fluid, thermal,
2.10.24. egrdel Subroutine (Deleting an Element's Nodal Gradients)

*deck,egrdel
subroutine egrdel (ielem)
c *** primary function: delete element nodal gradients
c input arguments:
2.10.25. eeliqr Function (Getting Information About an Element's Nodal

Elastic Strains)
*deck,eeliqr
function eeliqr (ielem,key)
c *** primary function: get information about element nodal elastic strains
c input arguments:
c = 1 - return info about elastic strains
c ielem > 0 - return number of nodal elasic strains
c on this element (rec length)
c = 0 - return maximum number of nodal elastic
c strains on any element
c (max rec length)
c = DB_NUMDEFINED - return the number of nodal elastic strains
c defined in model
c output arguments:
c eeliqr (int,func,out) - the returned value of eeliqr is based on
c setting of key
2.10.26. eelget Function (Getting an Element's Nodal Elastic Strains)

*deck,eelget
function eelget (ielem,value)
c *** primary function: get element nodal elastic strains.
c input arguments:
c output arguments:
c eelget (int,func,out) - status of element.
c > 0 - number of nodal elastic strains
c returned
c value (dp,ar(*),out) - element nodal elastic strains
c NOTE: Strains at each corner node in the order

c X, Y, Z, XY, YZ, XZ
c For solid elements, strains at each
c corner node
c For shell elements, strains at each
c bottom)
c strains for "first" layer at each
c Strains for "second" layer at each
c not appropriate
c strains for each layer at each corner
c the top surface)
c record is element depenent. See LEPEL

2.10.27. eelput Subroutine (Storing an Element's Nodal Elastic Strains)

*deck,eelput
subroutine eelput (ielem,nval,value)
c *** primary function: store nodal elastic strains at an element.
c input arguments:
c (6*nnod*nface)
c value (dp,ar(nval),in) - nval strain values

c corner node
c bottom)
c not appropriate
c the top surface)
c record is element depenent. See LEPEL
2.10.28. eeldel Subroutine (Deleting an Element's Nodal Elastic Strains)

*deck,eeldel
subroutine eeldel (ielem)
c *** primary function: delete element elastic strains
c input arguments:
2.10.29. epliqr Function (Getting Information About an Element's Nodal Plastic

Strains)
*deck,epliqr
function epliqr (ielem,key)
c *** primary function: get information about element nodal plastic strains
c input arguments:
c = 1 - return info about plastic strains
c ielem > 0 - return number of nodal plastic strains
c on this element
c (record length)
c = 0 - return maximum number of nodal plastic
c = DB_NUMDEFINED - return the number of nodal plastic strains
c defined in model
c output arguments:
c epliqr (int,func,out) - the returned value of epliqr is based on
c setting of key
2.10.30. eplget Function (Getting an Element's Nodal Plastic Strains)

*deck,eplget
function eplget (ielem,value)
c *** primary function: get element nodal plastic strains.
c input arguments:
c output arguments:
c eplget (int,func,out) - status of element.
c > 0 - number of nodal plastic strains
c returned
c value (dp,ar(*),out) - element nodal plastic strains

c corner node
c bottom)
c not appropriate
c the top surface)
c record is element depenent. See LEPPL
2.10.31. eplput Subroutine (Storing an Element's Nodal Plastic Strains)

*deck,eplput
subroutine eplput (ielem,nval,value)
c *** primary function: store nodal plastic strains at a element.
c input arguments:
c (6*nnod*nface)
c value (dp,ar(nval),in) - the strain values

c corner node
c bottom)
c not appropriate
c the top surface)
c record is element depenent. See LEPPL
2.10.32. epldel Subroutine (Deleting an Element's Nodal Plastic Strains)

*deck,epldel
subroutine epldel (ielem)
c *** primary function: delete element plastic strains
c input arguments:
2.10.33. ecriqr Function (Getting Information About an Element's Nodal Creep

Strains)
*deck,ecriqr
function ecriqr (ielem,key)
c *** primary function: get information about element nodal creep strains
c input arguments:
c = 1 - return info about creep strains
c ielem > 0 - return number of nodal creep strains
c on this element
c (record length)
c = 0 - return maximum number of nodal creep

c = DB_NUMDEFINED - return the number of nodal creep strains
c defined in model
c output arguments:
c ecriqr (int,func,out) - the returned value of ecriqr is based on
c setting of key
2.10.34. ecrget Function (Getting an Element's Nodal Creep Strains)

*deck,ecrget
function ecrget (ielem,value)
c *** primary function: get element nodal creep strains.
c input arguments:
c output arguments:
c ecrget (int,func,out) - status of element.
c > 0 - number of nodal creep strains
c returned
c value (dp,ar(*),out) - element nodal creep strains

c corner node
c bottom)
c not appropriate
c the top surface)
c record is element depenent. See LEPCR
2.10.35. ecrput Subroutine (Storing an Element's Nodal Creep Strains)

*deck,ecrput
subroutine ecrput (ielem,nval,value)
c *** primary function: store nodal creep strains at an element.
c input arguments:
c (6*nnod*nface)

c corner node
c bottom)
c not appropriate
c the top surface)
c record is element depenent. See LEPCR
2.10.36. ecrdel Subroutine (Deleting an Element's Nodal Creep Strains)

*deck,ecrdel
subroutine ecrdel (ielem)
c *** primary function: delete element creep strains
c input arguments:
2.10.37. ethiqr Function (Getting Information About an Element's Nodal

Thermal Strains)
*deck,ethiqr
function ethiqr (ielem,key)
c *** primary function: get information about element nodal thermal strains
c input arguments:
c = 1 - return info about thermal strains
c ielem > 0 - return number of nodal thermal strains
c on this element
c (record length)
c = 0 - return maximum number of nodal thermal
c = DB_NUMDEFINED - return the number of nodal thermal strains
c defined in model
c output arguments:
c ethiqr (int,sc,out) - the returned value of ethiqr is based on
c setting of key
2.10.38. ethget Function (Getting an Element's Nodal Thermal Stresses)

*deck,ethget
function ethget (ielem,value)
c *** primary function: get element nodal thermal strains.
c also the volumetric swelling strain
c input arguments:
c output arguments:
c ethget (int,func,out) - status of element.
c > 0 - number of nodal thermal strains
c returned
c value (dp,ar(*),out) - element nodal thermal strains

c X, Y, Z, XY, YZ, XZ, epswel
c corner node
c bottom)
c not appropriate
c the top surface)
c record is element depenent. See LEPTH
2.10.39. ethput Subroutine (Storing an Element's Nodal Thermal Stresses)

*deck,ethput
subroutine ethput (ielem,nval,value)
c *** primary function: store nodal thermal strains at an element.
c also the volumetric swelling strain
c input arguments:
c (6*nnod*nface)

c X, Y, Z, XY, YZ, XZ, epswel
c corner node
c bottom)

c not appropriate
c the top surface)
c record is element depenent. See LEPTH
2.10.40. ethdel Subroutine (Deleting an Element's Thermal, Initial, and

Swelling Strains)
*deck,ethdel
subroutine ethdel (ielem)
c *** primary function: delete element thermal, initial, and
c swelling strains
c input arguments:
2.10.41. euliqr Function (Getting Information About an Element's Euler Angles)

*deck,euliqr
function euliqr (ielem,key)
c *** primary function: get information about element euler angles
c input arguments:
c = 1 - return info about element euler angles
c ielem > 0 - return number of euler angles on this
c element
c (record length)
c = 0 - return maximum number of euler angles
c on any element
c = DB_NUMDEFINED - return the number of element euler angles
c defined in model
c output arguments:
c euliqr (int,func,out) - the returned value of euliqr is based on
c setting of key
2.10.42. eulget Function (Getting an Element's Nodal Euler Angles)

*deck,eulget
function eulget (ielem,value)
c *** primary function: get element nodal euler angles.
c input arguments:
c output arguments:
c eulget (int,func,out) - status of element.
c > 0 - number of euler angle values
c returned
c value (dp,ar(*),out) - element euler angles
c NOTE: For lower-ordered elements, rotations

c at centroid
c For higher-ordered elements, rotations
c at each corner node
c For layered shells, rotations at each
c corner node, plus layer rotation angle
c for each layer (real constant THETA)
c For layered solids, rotation angles at
c centroid, plus layer rotation angle
2.10.43. eulput Subroutine (Storing an Element's Euler Angles)

*deck,eulput
subroutine eulput (ielem,nval,value)
c *** primary function: store nodal euler angles for an element.
c input arguments:
c (3 * number of display nodes)
c value (dp,ar(nval),in) - the euler angle values

c NOTE: For lower-ordered elements, rotations
c at centroid
c For higher-ordered elements, rotations
c at each corner node
c For layered shells, rotations at each
c corner node, plus layer rotation angle
c For layered solids, rotation angles at
c centroid, plus layer rotation angle
2.10.44. euldel Subroutine (Deleting an Element's Euler Angles)

*deck,euldel
subroutine euldel (ielem)
c *** primary function: delete element euler angles
c input arguments:
2.10.45. efxiqr Function (Getting Information About Element Fluxes)

*deck,efxiqr
function efxiqr (ielem,key)
c *** primary function: get information about element fluxes
c input arguments:
c = 1 - return info about element fluxes
c ielem > 0 - return number of fluxes on this
c element
c (record length)
c = 0 - return maximum number of fluxes
c on any element
c = DB_NUMDEFINED - return the number of element fluxes defined
c in model
c output arguments:
c efxiqr (int,func,out) - the returned value of efxiqr is based on
c setting of key
2.10.46. efxget Function (Getting an Element Flux)

*deck,efxget
function efxget (ielem,value)
c *** primary function: get element nodal fluxes.
c input arguments:
c output arguments:
c efxget (int,func,out) - status of element.
c > 0 - number of nodal fluxes returned
c value (dp,ar(*),out) - element nodal fluxes
c Note: If a coupled field, a set of fluxes is

c stored in the following order (as
c available): fluid, thermal,
2.10.47. efxput Subroutine (Storing an Element's Fluxes)

*deck,efxput
subroutine efxput (ielem,nval,value)
c *** primary function: store nodal fluxes at an element.
c input arguments:
c (ndir*nnod*nscalr)
c value (dp,ar(nval),in) - the flux values

c Note: If a coupled field, a set of fluxes is
c stored in the following order (as
c available): fluid, thermal,
2.10.48. efxdel Subroutine (Deleting Element Fluxes)

*deck,efxdel
subroutine efxdel (ielem)
c *** primary function: delete element nodal fluxes
c input arguments:
2.10.49. elfiqr Function (Getting Information About Element Local Forces)

*deck,elfiqr
function elfiqr (ielem,key)
c *** primary function: get information about elem local forces
c input arguments:
c = 1 - return info about element local forces
c ielem > 0 - return number of local forces on this
c element
c (record length)
c = 0 - return maximum number of local forces
c on any element
c = DB_NUMDEFINED - return the number of element local forces
c defined in model
c output arguments:
c elfiqr (int,func,out) - the returned value of elfiqr is based on
c setting of key
2.10.50. elfget Function (Getting an Element Local Force)

*deck,elfget
function elfget (ielem,value)
c *** primary function: get element local nodal forces.
c input arguments:
c output arguments:
c elfget (int,func,out) - status of element.
c = 0 - element has no local nodal forces
c > 0 - number of nodal forces returned
c value (dp,ar(*),out) - element local nodal forces.
2.10.51. elfput Subroutine (Storing an Element's Local Forces)

*deck,elfput
subroutine elfput (ielem,nval,value)
c *** primary function: store element local nodal forces.
c input arguments:
c NOTE: There may be a maximum of 3 sets of
c nodal forces in the record: static
c forces, inertia forces, and damping forces
c value (dp,ar(nval),in) - element local nodal forces
2.10.52. elfdel Subroutine (Deleting Element Local Forces)

*deck,elfdel
subroutine elfdel (ielem)
c *** primary function: delete element local forces
c input arguments:
2.10.53. emniqr Function (Getting Information About Element Miscellaneous

Non-summable Data)
*deck,emniqr
function emniqr (ielem,key)
c *** primary function: get information about element misc non-summable
c data
c input arguments:
c = 1 - return info about element misc non-summed data
c ielem > 0 - return number of data items on this
c element
c (record length)
c = 0 - return maximum number of data items
c on any element
c = DB_NUMDEFINED - return the number of element misc non-summed
c data items defined in model
c output arguments:
c emniqr (int,func,out) - the returned value of emniqr is based on
c setting of key
2.10.54. emnget Function (Getting an Element's Miscellaneous Non-summable

Data)
*deck,emnget
function emnget (ielem,value)
c *** primary function: get misc non-summable data.
c input arguments:
c output arguments:
c emnget (int,func,out) - status of element.
c = 0 - no non-summed misc data at this
c element
c > 0 - number of data items returned
c value (dp,ar(*),out) - element misc non-summed data.

c dependent. See NMISC on ETABLE command
2.10.55. emnput Subroutine (Storing an Element's Miscellaneous Non-sum-

mable Data)
*deck,emnput
subroutine emnput (ielem,nval,value)
c *** primary function: store misc. non-summable data for an element.
c input arguments:
c value (dp,ar(nval),in) - the misc. non-summed data items

c dependent. See NMISC on ETABLE command
2.10.56. emndel Subroutine (Deleting an Element's Miscellaneous Non-sum-

mable Data)
*deck,emndel
subroutine emndel (ielem)
c *** primary function: delete element misc non-summable data
c input arguments:
2.10.57. ecdiqr Function (Getting Information About Element Current Densit-

ies)
*deck,ecdiqr
function ecdiqr (ielem,key)
c *** primary function: get information about element current densities
c input arguments:
c = 1 - return info about element current densities
c ielem > 0 - return number of current densities on
c this element
c (record length)
c = 0 - return maximum number of current
c densities on any element
c = DB_NUMDEFINED - return the number of element current
c densities defined in model
c output arguments:
c ecdiqr (int,func,out) - the returned value of ecdiqr is based on
c setting of key
2.10.58. ecdget Function (Getting an Element Current Density)

*deck,ecdget
function ecdget (ielem,value)
c *** primary function: get calculated element current densities.
c input arguments:
c output arguments:
c ecdget (int,func,out) - status of element.
c = 0 - element has no current densities
c > 0 - number of calculated element
c current densities
c value (dp,ar(*),out) - calculated element current densities.
c NOTE: current densities are in the order

c X, Y, Z
2.10.59. ecdput Subroutine (Storing an Element's Current Densities)

*deck,ecdput
subroutine ecdput (ielem,nval,value)
c *** primary function: store calculated element current densities
c input arguments:
c value (dp,ar(nval),in) - calculated element current densities.

c NOTE: current densities are in the order
c X, Y, Z
2.10.60. ecddel Subroutine (Deleting Element Current Densities)

*deck,ecddel
subroutine ecddel (ielem)
c *** primary function: delete element current densities
c input arguments:
2.10.61. enliqr Function (Getting Information About Element Nonlinear Tables)

*deck,enliqr
function enliqr (ielem,key)
c *** primary function: get information about element nonlinear tables
c input arguments:
c = 1 - return info about element nonlinear tables
c ielem > 0 - return number of nonlinear tables for
c this element
c (record length)
c = 0 - return maximum number of nonlinear
c tables for any element
c = DB_NUMDEFINED - return the number of element nonlinear
c tables defined in model
c output arguments:
c enliqr (int,func,out) - the returned value of enliqr is based on
c setting of key
2.10.62. enlget Function (Getting Element Nonlinear Tables)

*deck,enlget
function enlget (ielem,value)
c *** primary function: get element nonlinear tables.
c input arguments:
c output arguments:
c enlget (int,func,out) - status of element.
c = 0 - nonlinear tables undefined
c > 0 - number of nonlinear tables defined
c value (dp ,ar(n),out) - the element nonlinear tables.
c NOTE: Nonlinear data at each node are in the

c order SEPL, SRAT, HPRES, EPEQ, PSV,
c PLWK, and 4 spares
c For beam elements, the contents and
c number of information is element
c dependent. See NLIN on ETABLE
c command
2.10.63. enlput Subroutine (Storing an Element's Nonlinear Tables)

*deck,enlput
subroutine enlput (ielem,n,temp)
c *** primary function: store element nonlinear tables
c input arguments:
c n (int,sc,in) - number of element nonlinear table values
c temp (dp ,ar(6),in) - element nonlinear table,etc.

c NOTE: Nonlinear data at each node are in the
c order SEPL, SRAT, HPRES, EPEQ, PSV,
c PLWK, and 4 spares
c For beam elements, the contents and
c number of information is element
c dependent. See NLIN on ETABLE
c command
2.10.64. enldel Subroutine (Deleting Element Nonlinear Tables)

*deck,enldel
subroutine enldel (ielem)
c *** primary function: delete element nonlinear tables
c input arguments:
2.10.65. ehciqr Function (Getting Information About Calculated Element Heat

Generations)
*deck,ehciqr
function ehciqr (ielem,key)
c *** primary function: get information about calculated elem heat generations
c input arguments:
c = 1 - return info about calculated element heat gens
c for ielem > 0 - return number of heat gens for
c this element
c (record length)
c = 0 - return maximum number of heat gens
c for any element
c = DB_NUMDEFINED - return the number of calculated element heat
c generations defined in model
c output arguments:
c ehciqr (int,func,out) - the returned value of ehciqr is based on
c setting of key
2.10.66. ehcget Function (Getting a Calculated Element Heat Generation)

*deck,ehcget
function ehcget (ielem,value)
c *** primary function: get calculated element heat generations.
c input arguments:
c output arguments:
c ehcget (int,func,out) - status of element.
c > 0 - number of calculated element
c heat generations
c value (dp,ar(*),out) - calculated element heat generations.
2.10.67. ehcput Subroutine (Storing an Element's Calculated Heat Generations)

*deck,ehcput
subroutine ehcput (ielem,nval,value)
c *** primary function: store calculated element heat generations
c input arguments:
c value (dp,ar(nval),in) - calculated element heat generations.
2.10.68. ehcdel Subroutine (Deleting Element Calculated Heat Generations)

*deck,ehcdel
subroutine ehcdel (ielem)
c *** primary function: delete calculated element heat generations
c input arguments:
2–66
Chapter 3: Subroutines for Users' Convenience
3.1. What Subroutines Does This Chapter Describe?
This chapter describes ANSYS routines available to you for use in programming. Using these routines isn't required,
but may make your life easier. These routines include a set of general routines that perform utility-type functions,
a set of routines supporting vector functions, a set of routines supporting matrix functions, and routines supporting
message processing options.
3.1.1. Input and Output Abbreviations

The descriptions of inputs and outputs for the routines discussed in this chapter use the following abbreviations:
int - integer
log - logical
chr - character
in - input argument
3.2. General Subroutines

3.2.1. dptoch Subroutine (Retrieve Eight Characters From a Double Precision
Variable)
*deck,dptoch
subroutine dptoch (dp8,ch8)
c *** primary function: retreive 8 characters from a dp variable
c !!! NOTICE to progammers: this routine does not convert from a !!!
c !!! machine-independent format! Use dpexttoch if this dp word !!!
c !!! came from a common or non-char database record !!!
c input arguments:
c dp8 (dp,sc,in) - dp variable containing characters
c output arguments:
c ch8 (ch*8,sc,out) - characters retreived from the dp word
3.2.2. wrinqr Function (Obtain Information About Output)

*deck,wrinqr
function wrinqr (key)
c *** primary function: obtain information about output
c --- caution: the following variables are "saved/resumed".

c --- key=WR_COLINTER thru WR_SUPCOLMAX in "wrinqr/wrinfo"
c --- (data for "/fmt,/page,/header" commands).
c --- note that the whole common cannot be "saved/resumed". cwa
c input arguments:
c variable (typ,siz,intent) description wrcom name
c key (int,sc,in)
c = WR_PRINT - print flag (kprint) prtkey
c wrinqr = 0 - no output
c = 1 - print
c = WR_OUTPUT - current output unit number (iott) outfil
c = WR_MASTEROUT - master output file frstot
c = WR_COLINTER - interactive columns per page intcol
c = WR_COLBATCH - batch columns per page batcol
c = WR_LINEINTER - interactive lines per page intlin
c = WR_LINEBATCH - batch lines per page batlin
c = WR_CHARITEM - characters per output item chrper
c = WR_CHARDECIMAL - characters past decimal chrdec
c = WR_CHARINTEGER - characters in leading integer chrint
c = WR_CHARTYPE - chrtyp
c wrinqr = 1 - using E format in output
c = 2 - using F format in output
c = 3 - using G format in output
c = WR_SUPTITLE - tlabel supress key keyhed
c = WR_SUPSUBTITLE - subtitle supress key keytit
c = WR_SUPLSITER - ls,iter id supress key keyid
c = WR_NOTELINE - note line supress key keynot
c = WR_SUPCOLHEADER - column header supress key keylab
c = WR_SUPCOLMAX - column maximum supress key keysum
c = WR_LISTOPT - ListOpt from /output command ListOpt
c output arguments:
c wrinqr (int,func,out) - the value corresponding to key
3.2.3. erinqr Subroutine (Obtaining Information from the Errors Common)

*deck,erinqr
function erinqr (key)
c *** primary function: obtain information from errors common
c
c
c input arguments:
c key (int,sc,in) - item to be returned
c 1=keyerr, 2=errfil, 3=numnot, 4=numwrn,
c 5=numerr, 6=numfat, 7=maxmsg, 8=lvlerr,
c 9=mxpcmd, 10=nercmd, 11=nertim,12=nomore,
c 13=eropen,14=ikserr, 15=kystat,16=mxr4r5,
c 17=mshkey, 19=opterr,20=flowrn,
c 21=errhpi,22=noreport,23=pdserr,24=mxpcmdw
c 25=kystop,26=icloads, 27=ifkey
c
c ---- below definitions copied from errcom 7/92 for user information
c
c *** key number= ..........................
c (see ansysdef for parameter definitions) |
c \/
c
Section 3.2: General Subroutines
co keyerr -
master error flag (ER_ERRORFLAG)
co errfil -
errors file unit number (ER_ERRORFILE)
co numnot -
total number of notes displayed (ER_NUMNOTE)
co numwrn -
total number of warnings displayed (ER_NUMWARNING)
co numerr -
total number of errors displayed (ER_NUMERROR)
co numfat -
total number of fatals displayed (ER_NUMFATAL)
co maxmsg -
max allowed number of displayed messages before abort(ER_MAXMESSAGE)
co lvlerr -
used basicly in solution (from cnvr command.) (ER_ERRORLEVEL)
co -1=do not set keyerr for notes/errors/warnings.
co -2=same as -1 but do not display message either.
co mxpcmd - maximum number of messages allowed per command (ER_MAXCOMMAND)
co nercmd - number of messages displayed for any one command (ER_NUMCOMMAND)
co nertim - key as to how message cleared from u/i pop-up (ER_UICLEAR)
co (as per rsg/pft 5/1/92 - only for "info" calls
co -1=message is timed before removal
co 0=message needs pick or keyboard before removal
co 1=message stays up untill replaced by another message
co nomore display any more messages (ER_NOMOREMSG)
co 0=display messages
co 1=display discontinue message and stop displaying
co eropen - 0=errors file is closed (ER_FILEOPEN)
co 1=errors file is opened
co ikserr - 0=if interactive do not set keyerr (ER_INTERERROR)
c - 1=if interactive set keyerr (used by mesher and tessalation)
co kystat - flag to bypass keyopt tests in the elcxx routines (ER_KEYOPTTEST)
c associated with status/panel info inquiries.
c 0=do not bypass keyopt tests
c 1=perform all keyopt tests
c also flag to bypass setting of _STATUS upon resume
co mxr4r5 - mixed rev4-rev5 input logic (*do,*if,*go,*if-go) (ER_MIXEDREV)
c (used in chkmix called from rdmac)
c 1=rev5 found (*do,*fi-then-*endif)
c 2=rev4 found (*go,:xxx,*if,....,:xxx)
c 3=warning printed. do not issue any more.
co mshkey - cpu intensive meshing etc. this will cause (ER_MESHING)
c "nertim (11)" to be set to -1 for "notes", 1 for "warnings",
c and 0 for "errors". checking of this key is done in "anserr".
c 0=not meshing or cpu intensive
c 1=yes, meshing or cpu intensive
co syerro - systop error code. read by anserr if set. (18)
co opterr - 0=no error in main ansys during opt looping (ER_OPTLOOPING)
c 1=an error has happened in main ansys during opt looping
co flowrn - flag used by "floqa" as to list floqa.ans (20)
c 0=list "floqa.ans"
c 1="floqa.ans" has been listed. do not list again.
co noreport- used in GUI for turning off errors due to strsub calls (22)
c 0=process errors as usual
c 1=do NOT report errors
co pdserr - 0=no error in main ansys during pds looping (ER_PDSLOOPING)
c 1=an error has happened in main ansys during pds looping
co mxpcmdw- number of messages written to file.err for any one (24)
co command
c 0=write all errors to file.err
c 1=only write displayed errors to file.err
co icloads - key to forbid the iclist command from listing solution (26)
c data instead of the input data.
c 0=iclist is OK
c 1=do not permit iclist
co ifkey - key on whether or not to abort during /input on error (27)
c 0=do not abort
c 1=abort
c
co espare - spare integer variables
c
c --- end of information from errcom
c
c output arguments:
c erinqr (int,sc,out) - value corresponding to key
c
3.2.4. TrackBegin Subroutine (Beginning Tracking for a Subroutine Call)

*deck,TrackBegin
subroutine TrackBegin (sub32)
c *****function: mark beginning of track ansys call
c input arguments:
c sub32 (char*(*),sc,in) - name of subroutine being entered and left
c (32 characters max)
3.2.5. TrackEnd Subroutine (Ending Tracking for a Subroutine Call)

*deck,TrackEnd
subroutine TrackEnd (sub32)
c *****function: mark end of track ansys call
c input arguments:
c sub32 (char*(*),sc,in) - name of subroutine being left
c (32 characters max)
3.2.6. erhandler Subroutine (Displaying ANSYS Errors)

*deck,erhandler
subroutine erhandler (filein,msgid,msglvl,lngstrng,dperr,cherr)
c *** primary function: Display ANSYS error messages
c input arguments:
c filein (ch*40,sc,in) - Filename used for character portion of
c message ID (this is the file name of the
c file which contains the source for this
c routine)
c
c if 'ErrorMessageProbe', then error was
c generated on another processor (distributed
c ANSYS). In that case, dperr contains the
c message already made ASCII and expanded
c
c msgid (int,sc,in) - Numeric portion of the message ID
c 1 - 9999, unique for each erhandler
c call in the FILE. Recommend using
c a sequence, similar to format conventions,
c i.e., 3010, 3020, 3030
c if filein='ErrorMessageProbe', this is the
c CPU # that originally generated the error
c msglvl (int,sc,in) - level of error (same as lngerr)
c 0=no label (used for u/i pop-ups)
c -1=no label (used for u/i pop-ups) timed
c as a note message
c 1=note, 2=warning, 3=error, 4=fatal
c lngstrng (ch*(*),sc,in) - error message to display. use keywords
c of %i %g %c %/ for formating (same as
c lngerr)
c dperr (dp,ar(*),in) - vector of data to display. contains both
c integer and double precision data.
Section 3.2: General Subroutines
c (same as lngerr)
c if filein='ErrorMessageProbe', dperr
c contains the unpacked message and lngstrng
c and cherr are ignored
c cherr (ch*(*),ar(*),in) - vector of character data to display
c max length of character data is 32
c characters
3.2.7. intrp Subroutine (Doing Single Interpolation)

*deck,intrp
subroutine intrp (klog,kppx,kstpz,xval,ax,ay,yval,nmax,kyoff)
c *** primary function: **** subroutine for single interpolation ****
c (if double interpolation is needed, see intrpt)
c
c
c
c input arguments:
c klog (int,sc,in) - interpolation type
c = 0 - use linear interpolation
c = 1 - use log-log interpolation
c -- note: there is no option yet for
c lin-log or log-lin
c kppx (int,sc,in) - X value end of table signal
c = 0 - a repeated x-value will signal the end
c of the table
c = 1 - a repeated x-value will not signal the
c end of the table
c (only known use = c evaluation)
c kstpz (int,sc,in) - Y value end of table signal
c = 0 - a yval of zero will not signal the end
c of the table (e.g. stress fitting)
c = 1 - a yval of zero will signal the end of
c the table (in general, material
c properties (exception: alpx))
c
c NOTE: the end of the table will be signaled thru
c either of the above conditions, or more
c commonly, that nmax values have been processed,
c or that the present x table entry is less than
c the previous one (ax(i) .lt. ax(i-1)).
c evaluations done after the end of the table are
c evaluated as if they were at the end of the
c table. similarly, evaluations done before the
c beginning of the table are done as if they were
c done at the beginning of the table.
c
c xval (dp,sc,in) - value of x with which to go into the table
c ax (dp,ar(*),in) - table of x values, in ascending order
c ay (dp,ar(*),in) - table of y values
c nmax (int,sc,in) - maximum table size allowed
c
c output arguments:
c yval (dp,sc,out) - value of y which comes back from the table
c kyoff (int,sc,out) - xval status flag
c = 0 - xval in x range
c = 1 - xval less than minimum x
c = 2 - xval greater than maximum x
c
3.2.8. tranx3 Subroutine (Processing Geometry for 3-D Line Elements)

*deck,tranx3
subroutine tranx3 (nnod,xyz,nx,tr)
c *** primary function: geometric processor for 3-d line elements
c with or without a 3rd node
c
c
c input arguments:
c nnod (int,sc,in) - number of nodes (2 or 3)
c xyz (dp,ar(nx,*),in) - coordinates (x,y,z down)
c nx (int,sc,in) - row dimension of xyz array
c
c output arguments:
c tr (dp,ar(3,3),in) - transformation matrix
c
3.2.9. systop Subroutine (Stopping an ANSYS Program Run)

*deck,systop
subroutine systop (icode)
c *** primary function: stop an ansys run
c *** secondary functions: pass an error code to the system
c
c
c input arguments:
c icode (int,sc,in) - stop error code (0<icode<127)
c 0 - normal exit
c 1 - stack overflow error
c 2 - stack level overflow
c 3 - stack pop below zero
c 4 - names do not match in stkpxp
c 5 - command line argument error
c 6 - unused (was: accounting file error)
c 7 - licensing failure
c 8 - indicated error or end-of-run
c 11 - error in user routine
c 12 - macro stop command
c 13 - job already running
c 14 - untrapped xox error
c 15 - anserr fatal error
c 16 - possible full disk
c 17 - possible corrupted or missing file
c 18 - Error in VM routines (corrupt db?)
c 21 - unauthorized code section entered
c 25 - unable to open x11 server
c 30 - quit signal
c 31 - failure to get signal in max time
c (syhold)
c >32 - system dependent error
c 35 - fatal error on another process
c (distributed ANSYS)
c
3.3. Vector Functions

3.3.1. vdot Function (Computing the Dot Product of Two Vectors)
*deck,vdot
function vdot (v1,v2,n)
c *** primary function: compute dot product of vectors v1 and v2
c input arguments:
c v1 (dp,ar(n),in) - vector v1
c n (int,sc,in) - length of vectors v1 and v2
c output arguments:
Section 3.3: Vector Functions
c vdot (dp,sc,out) - dot product of v1 and v2

c
3.3.2. vsum Function (Summing Vector Components)

*deck,vsum
function vsum (va,n)
c *** primary function: sum the components of a vector
c input arguments:
c va (dp,ar(n),in) - vector va
c n (int,sc,in) - length of vector va
c output arguments:
c vsum (dp,sc,out) - vector sum
3.3.3. vmax Function (Retrieving the Maximum Vector Value at a Given Loca-
tion)
*deck,vmax
function vmax (v,n,locmax)
c *** primary function: return the max value and location in a vector
c input arguments:
c v (dp,ar(n),in) - vector v
c n (int,sc,in) - length of vector v
c output arguments:
c locmax (int,sc,out) - location of max value in vector v
c vmax (dp,sc,out) - max value in vector v
3.3.4. lastv Function (Retrieving the Position of the Last Nonzero Term in a
Double Precision Vector)
*deck,lastv
function lastv (v,n)
c ********* find position of last non-zero term in a d.p. vector *********
3.3.5. izero Function (Setting an Integer Vector to Zero)

*deck,izero
subroutine izero (ivect,n)
c ********** set an integer vector to zero **********
c
3.3.6. imove Function (Assigning Equal Values to Two Integer Vectors)

*deck,imove
subroutine imove (i1,i2,n)
c ********** move a vector from one to another **********
c
3.3.7. vzero Subroutine (Initializing a Vector to Zero)

*deck,vzero
subroutine vzero (v,n)

c *** primary function: initialize a vector to zero
c input arguments:
c v (dp,ar(n),inout) - vector to zero out
c n (int,sc,in) - number of words to zero out
c output arguments:
c v (dp,ar(n),inout) - zeroed vector
c
3.3.8. vmove Subroutine (Moving One Vector into Another)

*deck,vmove
subroutine vmove (v1,v2,n)
c *** primary function: move a vector into another vector
c
c
c *** Note: This function can have unpredictable results if v1 and v2
c reference the same array and overlap.
c
c input arguments:
c v1 (dp,ar(*),in) - vector v1
c n (int,sc,in) - length of vectors v1, v2
c
c output arguments:
c v2 (dp,ar(*),out) - vector v2
c
c
3.3.9. vimove Subroutine (Moving One Vector into Another Incrementally)

*deck,vimove
subroutine vimove (v1,inc1,v2,inc2,n)
c *** primary function: move one vector into another
c
c
c input arguments:
c v1 (dp,ar(inc1,n),in) - vector v1
c inc1 (int,sc,in) - increment on vector v1
c inc2 (int,sc,in) - increment on vector v2
c n (int,sc,in) - number of items to be moved
c
c output arguments:
c v2 (dp,ar(inc2,n),in) - vector v2
c
3.3.10. vinit Subroutine (Assigning a Scalar Constant to a Vector)

*deck,vinit
subroutine vinit (v,n,const)
c *** primary function: initialize a vector to a constant
c input arguments:
c n (int,sc,in) - length of vector v
c const (dp,sc,in) - constant to set vector v to
c output arguments:
c v (dp,ar(n),out) - vector v
c
3.3.11. viinit Subroutine (Assigning a Scalar Constant to a Vector Incrementally)

*deck,viinit
subroutine viinit (v,inc,n,const)
c *** primary function: set the components of vector v to const by increments
c
c
c input arguments:
c inc (int,sc,in) - increment (first dimension) of vector v
c n (int,sc,in) - length (second dimension) of vector v
c const (dp,sc,in) - constant to set components of vector v to
c
c output arguments:
c v (dp,ar(inc,n),out) - vector v
c
3.3.12. vapb Subroutine (Setting a Vector to Sum of Two Vectors)

*deck,vapb
subroutine vapb (a,b,c,n)
c *** primary function: add vector a to vector b to get vector c
c input arguments:
c a (dp,ar(n),in) - a vector
c b (dp,ar(n),in) - b vector
c n (int,sc,in) - length of vectors a,b,c
c output arguments:
c c (dp,ar(n),out) - c vector
c
3.3.13. vapb1 Subroutine (Combining Two Vectors in One)

*deck,vapb1
subroutine vapb1 (a,b,n)
c *** primary function: add vector b to vector a,
c and store in vector a
3.3.14. vapcb1 Subroutine (Multiplying a Vector to a Constant)

*deck,vapcb1
subroutine vapcb1 (a,b,n,const)
c *** primary function: multiply vector b to constant, add to vector a,
c and store in vector a
3.3.15. vamb Subroutine (Gets a Third Vector by Subtracting One Vector from
Another)
*deck,vamb
subroutine vamb (a,b,c,n)
c *** primary function: subtract vector b from vector a to get vector c
c input arguments:
c a (dp,ar(n),in) - vector a
c b (dp,ar(n),in) - vector b
c n (int,sc,in) - length of vectors a,b,c
c output arguments:
c c (dp,ar(n),out) - vector c
c
3.3.16. vamb1 Subroutine (Subtracting One Vector from Another)

*deck,vamb1
subroutine vamb1 (a,b,n)
c *** primary function: subtract vector b from vector a and save in vector a
c input arguments:
c a (dp,ar(n),inout) - a vector
c b (dp,ar(n),in) - b vector
c n (int,sc,in) - length of vectors a,b
c output arguments:
c a (dp,ar(n),inout) - a vector
c
3.3.17. vmult Subroutine (Multiplying a Vector by a Constant)

*deck,vmult
subroutine vmult (v1,v2,n,const)
c *** primary function: multiply a vector by a constant
c input arguments:
c n (int,sc,in) - length of vectors v1, v2
c const (dp,sc,in) - constant to multiply v1
c output arguments:
c v2 (dp,ar(n),out) - vector v2
3.3.18. vmult1 Subroutine (Multiplying a Vector by a Constant)

*deck,vmult1
subroutine vmult1 (v1,n,const)
c *** primary function: multiply a vector by a constant
c input arguments:
c v1 (dp,ar(n),inout) - vector v1
c n (int,sc,in) - length of vector n
c const (dp,sc,in) - constant to multiply v1
c output arguments:
c v1 (dp,ar(n),inout) - vector v1
c
3.3.19. vcross Subroutine (Defining a Vector via a Cross Product)

*deck,vcross
subroutine vcross (a,b,c)
c primary function: calculate c = a x b
c input arguments:
c a (dp,ar(3),in) - first vector to be cross-multiplied
c b (dp,ar(3),in) - second vector to be cross-multiplied
c output arguments:
c c (dp,ar(3),out) - resulting vector
c
3.3.20. vnorme Subroutine (Normalizing a Three-Component Vector)

*deck,vnorme
subroutine vnorme (iel,v)
c primary function: normalize a vector to unit length
c this routine is to be called only from the elements. it is only
c for a three component vector(i.e. processing geometry).
c this routine also differs from vnorm in that an error message is called
c if the vector length is zero.
c input arguments:
c iel (int,sc,inout) - element number
c v (dp,ar(3),inout) - vector to be normalized
c output arguments:
c iel (int,sc,inout) - if 0, vector has zero length
c v (dp,ar(3),inout) - normalized vector
3.3.21. vnorm Subroutine (Normalizing a Vector to Unit Length)

*deck,vnorm
subroutine vnorm (v,n)
c *** primary function: normalize a vector to unit length
c input arguments:
c v (dp,ar(n),inout) - vector v
c n (int,sc,inout) - dimension length of vector v
c output arguments:
c v (dp,ar(n),inout) - normalized vector v
c n (int,sc,inout) - n = 0 if error in operation
3.3.22. ndgxyz Function (Getting the X,Y,Z Vector for a Node)

*deck,ndgxyz
function ndgxyz (node,xyz)
c *** primary function: get x,y,z vector for a node.
c input arguments:
c output arguments:
c ndgxyz (int,sc,out) - status of node.
c 0=node is undefined.
c -1=node is unselected.
c 1=node is selected.
c xyz (dp,ar(3),out) - vector containing x,y,z
3.3.23. ndpxyz Subroutine (Storing X,Y,Z for a Node)

*deck,ndpxyz
subroutine ndpxyz (node,xyz)
c *** primary function: store x,y,z vector for a node.
c input arguments:
c xyz (dp,ar(3),in) - vector containing x,y,z
c (vector should be in global system)
3.4. Matrix Subroutines

3.4.1. maxv Subroutine (Multiplying a Vector by a Matrix)
*deck,maxv
subroutine maxv (a,v,w, nr,nc)
c *** primary function: multiply a vector by a matrix
c input arguments:
c a (dp,ar(nr,*),in) - matrix a
c v (dp,ar(*),in) - vector v
c nr (int,sc,in) - number of rows in matrix a
c nc (int,sc,in) - number of columns to multiply in matrix a
c output arguments:
c w (dp,ar(*),out) - product vector w
c
3.4.2. maxv1 Subroutine (Multiplying a Vector by a Matrix)

*deck,maxv1
subroutine maxv1 (a,v, nr,nc)
c *** primary function: multiply a vector by a matrix
c input arguments:
c a (dp,ar(nr,nc),in) - matrix a
c v (dp,ar(nc),inout) - vector v
c nr (int,sc,in) - number of rows in matrix a
c *** nr limited to 60 ***
c nc (int,sc,in) - number of columns to multiply in matrix a
c output arguments:
c v (dp,ar(nr),inout) - product, stored in vector v
3.4.3. matxv Subroutine (Multiplying a Vector by a Full Transposed Matrix)

*deck,matxv
subroutine matxv (a,v,w, nr,nc)
c *** primary function: multiply vector by full transposed matrix
c input arguments:
c a (dp,ar(nr,*),in) - matrix a (first dimension must = nr)
c v (dp,ar(nv),in) - vector v (nv must be greater or equal
Section 3.4: Matrix Subroutines
c to nr)
c nr (int,sc,in) - first dimension and number of active
c rows of the untransposed matrix a
c (also the number of active rows
c of vector v)
c nc (int,sc,in) - number of columns of the untransposed
c matrix a
c (also the number of computed items
c in the product vector w)
c if negative, accumulate
c output arguments:
c w (dp,ar(na,*),out) - product vector w
c
3.4.4. matxv1 Subroutine (Multiplying a Vector by a Full Transposed Matrix)

*deck,matxv1
subroutine matxv1 (a,v, nr,nc)
c *** primary function: multiply vector by full transposed matrix
c input arguments:
c a (dp,ar(nr,*),in) - matrix a
c v (dp,ar(nr),inout) - vector v
c nr (int,sc,in) - number of rows in matrix (un-transposed)
c nc (int,sc,in) - number of columns in matrix (un-transposed)
c *** nc limited to 60 ***
c output arguments:
c v (dp,ar(nc),inout) - product, stored in vector v
c
3.4.5. matxb Subroutine (Transposing a matrix)

*deck,matxb
subroutine matxb (a,b,c, na,nb,nc, n1,n2,n3)
c *** primary function: (a)t * (b) = (c) t means transpose
c input arguments:
c a (dp,ar(na,*),in) - matrix a
c b (dp,ar(nb,*),in) - matrix b
c na (int,sc,in) - number of rows in matrix a
c nb (int,sc,in) - number of rows in matrix b
c nc (int,sc,in) - number of rows in matrix c
c n1 (int,sc,in) - number of rows in matrix c to fill
c n2 (int,sc,in) - number of columns in matrix c to fill
c n3 (int,sc,in) - number of columns in matrix a and
c number of rows of matrix b
c to work with (the two need
c to be the same for the inner product)
c if n3 is negative, accumulate results in c
c output arguments:
c c (dp,ar(nc,*),out) - product matrix c
c
3.4.6. maat Subroutine (Changing a Matrix Value via Addition, Multiplication,

and Transposition)
*deck,maat
subroutine maat(a,c, nc,n, con)
c primary function: does con*a*at and sums the result onto c (a is a vector)

c input arguments:
c a (dp,ar(*),in) - vector to be multiplied by itself to
c generate an nxn square matrix
c (a by a-transposed)
c c (dp,ar(nc,*),inout) - matrix to be accumulated onto
c nc (int,sc,in) - number of rows in the c matrix
c n (int,sc,in) - size of square matrix
c con (dp,sc,in) - multiplier on above square matrix
c output arguments:
c c (dp,ar(nc,*),inout) - matrix to be accumulated onto
c only the lower triangular matrix is done
c Note: this routine is usually followed by matsym,

c to do the complete matrix
c
3.4.7. matsym Subroutine (Filling the Upper Triangle from the Lower Triangle)
*deck,matsym
subroutine matsym (a,nd,n)
c primary function: fill upper triangle from lower triangle
c input arguments:
c a (dp,ar(nd,*),inout) - matrix to have its lower triangular part
c copied to its upper triangular part
c nd (int,sc,in) - number of rows of the a matrix
c n (int,sc,in) - size of matrix to be processed
c output arguments:
c a (dp,ar(nd,*),inout) - matrix that has its lower triangular part
c copied to its upper triangular part
c
3.4.8. mctac Subroutine (Transposing a symmetric matrix)

*deck,mctac
subroutine mctac (a,na,c,nc,nold,nnew)
c **** function: do a = c(transpose) * a * c , where a is symmetric **
c input arguments:
c a (dp,ar(na,na),inout) matrix to be pre and post multiplied
c (part operated on must be
c square(nold x nold) and symmetric)
c na (int,sc,in) first dimension of the a matrix
c c (dp,ar(nc,nnew),in) matrix to pre and post multiply a by
c (part used may be rectangular(nold x nnew))
c nc (int,sc,in) first dimension of the c matrix
c nold (int,sc,in) size of part of 'A' matrix that is
c to be processed(input size). maximum = 64
c nnew (int,sc,in) size of part of 'A' matrix that
c results from this operation(output size).
c maximum = 64
c output arguments:
c a (dp,ar(na,na),inout) resulting matrix
c (still square(nnew x nnew) and symmetric).
Section 3.4: Matrix Subroutines
3.4.9. tran Subroutine (Transposing a matrix)

*deck,tran
subroutine tran (zs,tr,nz,ntr,nrow,irot)
c primary function: perform tr-transpose * zs * tr ************
c
c input arguments:
c zs (dp,ar(nz,nz),inout) - matrix to be transformed
c tr (dp,ar(ntr,ntr),in) - transformation matrix
c nz (int,sc,in) - dimensioned size of zs matrix
c ntr (int,sc,in) - dimensioned size of tr matrix
c nrow (int,sc,in) - number of rows of zs matrix to transform
c irot (int,sc,in) - block size to transform(size of tr matrix)
c output arguments:
c zs (dp,ar(nz,nz),inout) - transformed matrix
3.4.10. symeqn Subroutine (Solving Simultaneous Linear Equations)

*deck,symeqn
function symeqn (a,nd,n,nc)
c primary function: solve a set of simultaneous linear equations
c secondary functions: invert a matrix
c this routine assumes that the matrix to be solved or
c inverted is positive or negative definite
c ************** this routine assumes diagonal is non-zero ******
c If this assumption is not true, use isimeq.F
c
c
c
c input arguments:
c a (dp,ar(nd,*),inout) - matrix to be solved or inverted
c second dimension must be at least:
c n + abs(nc)
c nd (int,sc,in) - first dimension of the a matrix
c n (int,sc,in) - number of equations
c nc (int,sc,in) - number of additional columns.
c if nc = +n or -n, invert n x n matrix and
c put result in the n+1 to 2xn columns.
c if nc is 0 or negative, nc will be reset to
c n and then symeqn will set up identity
c matrix after the input matrix, where the
c result of the inversion will be put.
c if nc is positive and less than n, do a
c partial inversion. see example 1 below.
c
c output arguments:
c symeqn (in,sc,out) - 0 - positive definite matrix
c 1 - singular matrix
c (zero-definite or almost zero-definite)
c a (dp,ar(nd,*),inout) - results or inverted matrix.
c starts in column n+1.
c note: original information is destroyed.
c
c example 1: Solve three simultaneous linear equations:
c i = symeqn (a(1,1),3,3,1)
c calling routine has a dimensioned as a(3,4)
c each equation has its 3 coefficents in the first 3 columns,
c and the constant term is in the fourth column.
c solution is in fourth column.

c
c example 2: Invert a 3x3 matrix:
c i = symeqn (a(1,1),3,3,-3)
c calling routine has a dimensioned as a(3,6)
c input matrix was input in first 3 columns
c output matrix in ouput in last 3 columns
c
Appendix A. Creating External Commands in
UNIX
A.1. Introduction to External Commands
External commands allow you to add your own customized extensions to ANSYS without relinking the program.
You can create custom routines in C that access any of the ANSYS API functions, link them into shared libraries
using the supplied utilities, and execute the routines via the "external command" feature within ANSYS. In addition,
ANSYS provides special commands that list all available external commands and allow you to reset all currently
referenced external commands.
External command capability is supported on all UNIX platforms. Refer to your installation guide for currently
supported compilers; the following instructions assume the presence of compatible compilers and linkers.
A.2. Tasks in Creating an External Command

To create a functional external command, you will need to complete the following general steps:
• Create compilable source code.

• Create a shared library. This is facilitated by the gen_share utility and your system's make capability.
• Create an external table file (ans_ext.tbl), listing the various shared libraries, functions, and the related
command.
• Set an environment variable pointing to the directory that holds the external table file.
The following sections detail each of these tasks.
A.2.1. Creating Compatible Code

You can create your functions using any of the API functions described in //ansys_inc/v100/ansys/custom/in-
clude/cAnsInterface.h, cAnsQuery.h, and cAnsPick.h. The following code segment demonstrates, at a minimal
level, how to create functions that can be used as an entry point into a custom coded shared library.
The most important point in the following example it that the C program interface is an integer function that
has one argument (a char pointer).
#include "cAnsInterface.h"
#include "CAnsQuery.h"
/*
-------------------------- Function Description ---------------------
extfnc
int extfnc(uecmd)
char *uecmd;
Purpose:
Demonstrate C API entry function for an external command.
Parameters:
Input
-----------------------------
uecmd
The ANSYS external command string.
Output
-----------------------------
Appendix A. Creating External Commands in UNIX
Return Value:
The return value is ignored by the calling function;
------------------------- End Function Description ------------------

*/
int extfnc(char* uecmd)
{
/* Note: uecmd is the entire command given to invoke this function */
char* cmdsend = {"/COM, COMMAND SENT FROM EXTERNAL COMMAND"};
char* querystr = {"NODE,,NUM,MAX"};
char strrtn[32];
int i, itype;
double dblrtn;
/* Send a simple command to be executed */

i = cAnsSendCommand(cmdsend);
/* Perform a simple query */

i = cAnsGetValue(querystr,dblrtn,strrtn,itype);
/* Display the value retrieved */

cAnsPrintf("Max Node Number = %g\n",dblrtn);
return (i);
A.2.2. Creating a Shared Library

Once you have written the source code for your functions, you can create a Makefile (using the gen_share utility)
to build a shared library. The utility creates the Makefile in the current directory. The Makefile incorporates all
the interdependencies of the C source files it encounters in that current directory. The gen_share utility is meant
to setup the basic build. The user may need to make modifications to the Makefile depending on the situation.
The gen_share utility has the following syntax:

gen_share [-h] [-64] shared_object_name
where
-h
Produces command help.
-64
Configures the Makefile to use the -mips4 option for IRIX64 .
shared_object_name
Is the name that will be given to the shared library.
As gen_share is executing, you may see one or more "No match" messages. This is normal. The script is
searching for .c, .f, and .F file types in the current directory and returns this message if it cannot locate any files
matching one of those types.
To create a shared library called mylibrary.so, you would issue the following command:
% gen_share mylibrary.so
The utility will produce a Makefile in the current directory. You will be able to generate the shared library by is-
suing the following command:
make
For example, to create the shared library for mylibrary.so, you would issue the following command:
% make
A–2 Guide to ANSYS User Programmable Features . ANSYS Release 10.0 . 002187 . © SAS IP, Inc.
Section A.2: Tasks in Creating an External Command
You will then find the specified shared library file in the current directory. You may also see warnings from the
make process, and you may need to modify the Makefile or your source code.
A.2.3. Creating an External Table File

The external table file (ans_ext.tbl) can reside in any directory (but you must specify that directory in the AN-
SYS_EXTERNAL_PATH environment variable). The file contains an entry for each shared library function you
wish to allow ANSYS to access. There is no limit to the number of entries. The file entries have the following
format:
/shared/library/path/library.so ~cm_name function_name
where
/shared/library/path/library.so
Is the path to the directory that contains the shared library file. (Remotely mounted file systems are not recom-
mended.)
~cm_name
Is the command used to invoke the function within ANSYS. The command name must begin with a tilde (~) and
each command name must be unique within the first four characters. The command name must be eight char-
acters or less, including the tilde (~).
function_name
Is the name of the function that is referenced by the specified command name. (This must be unique within the
first four characters if multiple external commands are specified.)
For example, the following entry references the /home/mydir/mylibs/myobject.so shared library and the my-
object_ function. It specifies ~myobj as the related command:
/home/mydir/mylibs/myobject.so ~myobj myobject_
ANSYS also makes use of external commands, and places its own shared libraries and the associated external
table file in the /ansys_inc/v100/ansys/lib/<platform> directory (where <platform> is the directory specific
to your computing platform, such as /sgi64 or /hppa8000-64).
ANSYS loads external commands in the following order:
• ANSYS first checks the ans_ext.tbl file in the /ansys_inc/v100/ansys/lib/<platform> directory and
loads any external commands referenced there.
• ANSYS then loads external commands referenced by the external table file in the directory designated
with the ANSYS_EXTERNAL_PATH environment variable (see section Section A.2.4: Setting the ANSYS_EX-
TERNAL_PATH Environment Variable).
If you designate a command name that has the same first four characters as a command listed in the /an-
sys_inc/v100/ansys/lib/<platform>/ans_ext.tbl file, you will not be able to access your command. Therefore,
it is a good practice to check the ANSYS external table file to make sure you have no external command name
conflicts. Do not modify the /ansys_inc/v100/ansys/lib/<platform>/ans_ext.tbl file. You can also use the
~DEBUG command to verify that no external command name conflicts exist.
Note — The shared library must be consistent with the computer type and OS level on which ANSYS will
be executed.
Guide to ANSYS User Programmable Features . ANSYS Release 10.0 . 002187 . © SAS IP, Inc. A–3
Appendix A. Creating External Commands in UNIX
A.2.4. Setting the ANSYS_EXTERNAL_PATH Environment Variable

Before launching ANSYS, you must first set the ANSYS_EXTERNAL_PATH to point to the directory containing
the external table file. (For convenience, if you distribute your new functionality to other users they should set
their .login or .cshrc files so that it is persistent from session to session.) For example, the following sets the en-
vironment variable to point to the /home/mydir directory.
setenv ANSYS_EXTERNAL_PATH /home/mydir
A.2.5. Using External Commands

To call an external command, enter it as you would any other ANSYS command. You can also call external com-
mands through either an APDL macro or UIDL script.
Note — Avoid recursive external commands; that is, avoid situations where an external command calls
another external command.
A.2.6. Checking External Command Status

You can check what shared libraries are currently accessible by entering the ~DEBUG command in the command
input window. The following figure shows an example of ~DEBUG command output.
External Command Mappings:
Command Library Function Accessed?

*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-
~excmd /home/mydir/mycode/mycommand.so excmd YES
In this example, the output lists the command, the related shared library, the function, and if the command has
been accessed.
A.2.7. Resetting External Commands

You can
• Close all shared libraries

• Free memory associated with external commands
by issuing the ~RESET command. The command issues the following message to confirm that the reset operation
was complete.
~RESET was processed: The external command buffers have been cleared.
Note — The /CLEAR command also closes/resets all external command shared libraries.
A–4 Guide to ANSYS User Programmable Features . ANSYS Release 10.0 . 002187 . © SAS IP, Inc.
Appendix B. Creating External Commands in
Windows
B.1. Tasks in Creating an External Command
To create a functional external command, you will need to complete the following general steps:
• Create compatible C source code.

• Create an external definition file (projname.def).
• Create a new project in Microsoft Developer Studio.
• Create a shared library.
• Create an external table file (ans_ext.tbl), listing the various shared libraries, each function and the related
command.
• Set the ANSYS_EXTERNAL_PATH environment variable
The following sections detail each of these tasks.
B.1.1. Creating Compatible Code

You can create your functions using any of the API functions described in Program Files\Ansys Inc\V100\cus-
tom\include\cAnsysInterface.h, cAnsQuery.h, and cAnspick.h. You can then execute these functions via the
“external command” feature within ANSYS. In addition, ANSYS provides special commands that list all available
external commands and allow you to reset all currently referenced external commands. The following code
segment demonstrates, at a minimal level, how to create functions that can be used as an entry point into a
custom coded shared library.
The most important point in the following example is:
• The C program interface is an integer function that has one argument (a char pointer).
#include <windows.h>
#include "cAnsInterface.h"
#include "CAnsQuery.h"
/*
------------------------------ Function Description -----------------------
extfnc
int extfnc(uecmd)
char *uecmd;
Purpose:
Demonstrate C API entry function for an external command.
Parameters:
Input
-----------------------------
uecmd
The ANSYS external command string.
Output
-----------------------------
Return Value:
Appendix B. Creating External Commands in Windows
The return value is ignored by the calling function;
----------------------------- End Function Description --------------------
*/
int extfnc(char* uecmd)
{
/* Note: uecmd is the entire command given to invoke this function */
char* cmdsend = {"/COM, COMMAND SENT FROM EXTERNAL COMMAND"};
char* querystr = {"NODE,,NUM,MAX"};
char strrtn[32];
int i, itype;
double dblrtn;
/* Send a simple command to be executed */

i = cAnsSendCommand(cmdsend);
/* Perform a simple query */

i = cAnsGetValue(querystr,dblrtn,strrtn,itype);
/* Display the value retrieved */

cAnsPrintf("Max Node Number = %g\n",dblrtn);
return (i);
B.1.2. Creating a New Project

To build and link your code, you will first need to create a project in the Microsoft Developer Studio.
• After launching Developer Studio, press Ctrl+N (or choose New from the FILE menu). In the New window,
click on the Projects tab. Select Win 32 Dynamic-Link Library, and specify your project name and directory.
• In the Workspace frame, click on the File View tab. Right click on the sub category projname files and
press F or select Add Files to Project). Choose your source and definition files, ansys.lib, cAnsInterface.h
and any other necessary header files. The import library file ansys.lib is in /ansys100/lib and the header
file cAnsysInterface.h is in /ansys100/extra/custom/include.
B.1.3. Creating an External Definition File

For each external command, you must declare it in the external definition file. The naming convention for this
file is the name of your project with the .def extension; it must be located in your project directory. This file
consists of the word EXPORTS on the first line, and the name(s) of the functions to be exported on each successive
line. For the example function above:
EXPORTS
extfunc
B.1.4. Creating a Shared Library

Once all of the necessary files have been incorporated into your project, simply compile (Ctrl+F7) and build
(F7) the project. In your project directory, Developer Studio will create a Debug directory and will place the library
in that directory (projname.dll).
B.1.5. Creating an External Table File

The external table file (ans_ext.tbl) can reside in any directory (but you must specify that directory in the AN-
SYS_EXTERNAL_PATH environment variable). The file contains an entry for each shared library function you
wish ANSYS to access. There is no limit to the number of entries. The file entries have the following format:
B–2 Guide to ANSYS User Programmable Features . ANSYS Release 10.0 . 002187 . © SAS IP, Inc.
Section B.1: Tasks in Creating an External Command
C:\shared\library\path\projname.dll ~cm_name function_name
where:
C:\shared\library\path\projname.dll is the path to the directory that contains the shared library file. (Remotely
mounted file systems are not recommended.)
~cm_name Is the command used to invoke the function within ANSYS. The command name must begin with a
tilde (~) and the first four characters of each command name must be unique.
function_name Is the name of the function that is referenced by the specified command name. (This must be
unique within the first four characters if multiple external commands are specified.)
For example, the following entry references the C:\home\mydir\mylibs\myobject.dll shared library and the
myobject function, and specifies ~myobj as the related command:
C:\home\mydir\mylibs\myobject.dll ~myobj myobject
ANSYS also makes use of external commands, and places its own shared libraries and the associated external
table file in the C:\Program Files\Ansys Inc\V100\lib\platform directory (where platform is the directory spe-
cific to your computing platform, such as \Intel). ANSYS loads external commands in the following order:
• ANSYS first checks the ans_ext.tbl file in the C:\Program Files\Ansys Inc\V100\lib\platform directory
and loads any external commands referenced there. ˙
• ANSYS then loads external commands referenced by the external table file in the directory designated
with the ANSYS_EXTERNAL_PATH environment variable (see Section B.1.6: Setting the ANSYS_EXTERN-
AL_PATH Environment Variable).
If you designate a command name that has the same first four characters as a command listed in the C:\Program
Files\Ansys Inc\V100\lib\platform file, you will not be able to access your command. Therefore, it is a good
practice to check the ANSYS external table file to make sure you have no external command name conflicts. Do
not modify the C:\Program Files\Ansys Inc\V100\lib\platform\ans_ext.tbl file. You can also use the ~DEBUG
command to verify that no external command name conflicts exist.
Note — The shared library must be consistent with the computer type and OS level on which ANSYS will
be executed.
B.1.6. Setting the ANSYS_EXTERNAL_PATH Environment Variable

Before launching ANSYS, you must first set the ANSYS_EXTERNAL_PATH to point to the directory containing
the external table file. In Windows NT, the environment variables are in System Properties, which can be accessed
through the Control Panel. For example, the following string sets the environment variable to point to the
C:\home\mydir directory.
set ANSYS_EXTERNAL_PATH=C:\home\mydir
B.1.7. Using External Commands

To call an external command, enter it as you would any other ANSYS command in the ANSYS command window.
You can also call external commands through either an APDL macro or UIDL routine.
Note — Avoid recursive external commands; that is, avoid situations where an external command calls
another external command.
Guide to ANSYS User Programmable Features . ANSYS Release 10.0 . 002187 . © SAS IP, Inc. B–3
Appendix B. Creating External Commands in Windows
B.1.8. Checking External Command Status

You can check what shared libraries are currently accessible by entering the ~DEBUG command in the command
input window. The following figure shows an example of ~DEBUG command output.
External Command Mappings:
Command Library Function Accessed?
*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-
~excmd /home/mydir/mycode/mycommand.so excmd YES
Note that the output lists the command, the related shared library, the function, and whether or not the command
has been accessed.
B.1.9. Resetting External Commands

You can
• Close all shared libraries

• Free memory associated with external commands
by issuing the ~RESET command. This command issues the following message to confirm that the reset operation
is complete.
~RESET was processed: The external command buffers have been cleared.
Note — The /CLEAR command also closes/resets all external command shared libraries.
B–4 Guide to ANSYS User Programmable Features . ANSYS Release 10.0 . 002187 . © SAS IP, Inc.
creating, 1–57
Index Common blocks, 1–4
cmopt, 1–68
Symbols Constitutive material models
3-D line elements, 3–5 creating, 1–40
3-D nodal coordinates, 1–30 Constraint equations
3-D spar element, 1–12 deleting or selecting, 2–18
getting , 2–17
getting information about, 2–17
A storing, 2–18
Accessing program logic, 1–65
Constraints
acelcm.inc file, 1–4
deleting at a node, 2–19
Activating UPFs, 1–7
getting from the database, 2–19, 2–20
ANSYS
getting information, 2–18
customized version of, 1–5
storing at a node, 2–19, 2–41
executing command from a user routine, 1–74
Convection loads
linking, 1–5, 1–67
defining, 1–31
optimization program to, 1–67
Converting nodal data to fixed format data blocks, 1–12
UPFs to, 1–5
Coordinate system
parameters, 1–4
deleting a coordinate system, 2–15
running as a subroutine, 1–56
getting a coordinate system, 2–14
start-up, 1–65
getting information about a coordinate system, 2–14
accessing program logic at, 1–65
storing a coordinate system, 2–15
stopping, 3–6
Coupled set
tailoring with UPFs, 1–1
getting a coupled set, 2–16
UPFs for, 1–1
ansyscust file, 1–6
selecting or deleting, 2–17
ansysdef.inc file, 1–4
storing a coupled set, 2–16
Arc-length debugging, 1–9
Coupling and constraint routines, 2–15
Auto time stepping debugging, 1–9
cpget, 2–16
cpinqr, 2–15
B cpput, 2–16
Basic element pass debugging, 1–10 cpsel, 2–17
Creating
C constitutive material models, 1–40
C, 1–1, 1–3 hyperelastic material models, 1–47
FORTRAN shell for, 1–3 plasticity laws, 1–42
.c extension, 1–5 swelling laws, 1–47
Calculating creep1 subroutine, 1–25
dot product of two vectors, 3–6 creep3 subroutine, 1–25
rotation caused by internal pressure, 1–36 csydel, 2–15
sum of vector components, 3–7 csyget, 2–14
ceget, 2–17 csyiqr, 2–14
ceinqr, 2–17 csyput, 2–15
ceput, 2–18 Custom failure criteria, 1–50
cesel, 2–18 Custom optimization routine, 1–68
Characters retrieved from a double precision variable, Customizing
3–1 ANSYS, 1–2
cmopt common block, 1–68 loads, 1–52
cmopt.inc file, 1–4 material properties, 1–39
cnvget subroutine, 1–31
COMBIN7 and COMBIN37 parameters, 1–35
Commands
Index
D efxdel, 2–58
Database access routines, 2–1 efxget, 2–58
/DEBUG command, 1–9 efxiqr, 2–57
Debugging efxput, 2–58
elements, 1–10 egen function, 1–51
solutions, 1–9 egrdel, 2–48
Decks, 1–4 egrget, 2–48
disdel, 2–19 egriqr, 2–47
disget, 2–18, 2–19 egrput, 2–48
Displacement and coordinate debugging, 1–10 ehcdel, 2–65
Displacement values, 1–64 ehcget, 2–64
Displacement vector debugging, 1–9 ehciqr, 2–64
disput, 2–19 ehcput, 2–64
DOF pointers, 1–4 ehgdel, 2–33
Double precision vectors, 3–7 ehgget, 2–32
dptoch subroutine, 3–1 ehgiqr, 2–32
dspdel, 2–41 ehgput, 2–33
dspget, 2–41 eimdel, 2–38
dspiqr, 2–40 eimget, 2–37
dspput, 2–41 eimiqr, 2–37
eimput, 2–37
E elccmt subroutine, 1–13
elccmt.inc file, 1–4
ecddel, 2–62
eldwrnL subroutine, 1–29
ecdget, 2–62
eldwrtL subroutine, 1–28
ecdiqr, 2–61
elecom.inc file, 1–4
ecdput, 2–62
Element array data pointers, 1–4
echprm.inc file, 1–4
Element Attribute Routines, 2–7
echrtr, 2–9
Element calculated heat generation
ecrdel, 2–54
deleting, 2–65
ecrget, 2–53
getting, 2–64
ecriqr, 2–52
ecrput, 2–53
storing, 2–64
ecvdel, 2–30
Element convection
ecvget, 2–29
deleting, 2–30
ecviqr, 2–28
getting, 2–29
ecvput, 2–29
edcdel, 2–35
storing, 2–29
edcget, 2–35
Element current densities
edciqr, 2–34
deleting, 2–62
edcput, 2–35
getting, 2–62
eeldel, 2–50
eelget, 2–49
storing, 2–62
eeliqr, 2–49
Element current density
eelput, 2–50
deleting, 2–35
efsdel, 2–39
getting, 2–35
efsget, 2–39
efsiqr, 2–40
storing, 2–35
efsput, 2–40
Element data
efudel, 2–34
converting to fixed format blocks, 1–12
efuget, 2–34
writing to a file, 1–28
efuiqr, 2–33
Element energy
efuput, 2–34
Index–2 Guide to ANSYS User Programmable Features . ANSYS Release 10.0 . 002187 . © SAS IP, Inc.
Index
deleting, 2–47 getting, 2–60

getting, 2–46 getting information about, 2–60
getting information about, 2–46 storing, 2–61
storing, 2–47 Element miscellaneous summable data
Element euler angle deleting, 2–43
storing, 2–57 storing, 2–42
Element euler angles Element nodal creep strain
getting information about, 2–56 deleting, 2–54
Element face flagged surface getting, 2–53
deleting, 2–39 getting information about, 2–52
getting, 2–39 storing, 2–53
getting information about, 2–40 Element nodal elastic strain
storing, 2–40 deleting, 2–50
Element face impedance getting, 2–49
Element face pressure storing, 2–50
getting, 2–27 Element nodal force
storing, 2–28 getting, 2–43
Element fluence getting information about, 2–43
deleting, 2–34 storing, 2–44
getting, 2–34 Element nodal forces
getting information about, 2–33 deleting, 2–44
storing, 2–34 Element nodal gradients
Element fluxes deleting, 2–48
getting information about, 2–57 getting information about, 2–47
storing, 2–58 storing, 2–48
Element Fluxes Element nodal plastic strain
getting, 2–58 deleting, 2–52
Element heat generation getting, 2–51
getting information about, 2–32 Element nodal stress
storing, 2–33 deleting, 2–46
Element impedance getting, 2–44
getting information about, 2–37 storing, 2–45
storing, 2–37 Element nodal thermal strain
Element loading routines, 2–27 getting information about, 2–54
Element local force Element nodal thermal stress
storing, 2–59 Element nonlinear tables
Element local forces deleting, 2–63
getting information about, 2–59 getting, 2–63
Element matrices, 1–14 getting information about, 2–62
accessing, 1–36 storing, 2–63
reusing, 1–19 Element pressure/convection
Element miscellaneous non-summable data deleting, 2–28
deleting, 2–61 getting informatin about, 2–27
Guide to ANSYS User Programmable Features . ANSYS Release 10.0 . 002187 . © SAS IP, Inc. Index–3
Index
Element surface stress data updating, 1–30

deleting, 2–39 routines for selecting and retrieving, 2–1
getting, 2–38 selecting, unselecting, deleting, or inverting an ele-
getting information about, 2–38 ment, 2–4
storing, 2–39 selecting, unselecting, deleting, or inverting an ele-
Element temperature ment type, 2–10
deleting, 2–31 storing, 1–33
getting, 2–31 user-supplied output, 1–33
getting information about, 2–30 storing an element, 2–8
storing, 2–31 storing element type data, 2–9
Element thermal, initial, and swelling strain subroutines, 1–3, 1–13, 1–17
deleting, 2–56 for element characteristics, 1–13
Element virtual displacement for element creation, 1–17
getting, 2–36 transformation matrix, 1–29
getting information about, 2–36 computing, 1–29
storing, 2–36 types, 1–12
Elements, 1–1 updating, 1–23, 1–25, 1–26, 1–30
accessing information, 1–17 3-D nodal coordinates, 1–30
changing face, 1–54, 1–55, 1–55 creep history, 1–25
charge density surface information, 1–55 plastic history, 1–23
convection surface information, 1–54 swelling history, 1–26
heat flux surface information, 1–55 updating rotational pseudovector, 1–30
changing pressure information, 1–53 writing saved variable set, 1–18
creating, 1–12 elfdel, 2–60
debugging, 1–10 elfget, 2–59
evaluating material properties, 1–22 elfiqr, 2–59
example of element attribute routines, 2–15 elfput, 2–59
finding coordinates, 1–65 ElInterp subroutine, 1–65
getting information about an element, 2–7 elLenPsvrBuf function, 1–27
getting information about an element type, 2–8, elmiqr, 2–7
2–9 elmput, 2–8
getting information about element characteristics, elnext, 2–3
2–9 elnxdf, 2–3
getting the number of the next defined element, elparm.inc file, 1–4
2–3 elprev, 2–3
getting the number of the next element, 2–3 ElResultGet subroutine, 1–65
getting the number of the previous selected element, ElResultStrt subroutine, 1–64
2–3 elsel, 2–4
load vectors, 1–21 elucom.inc file, 1–4
matrix debugging, 1–10 emndel, 2–61
modifying, 1–32, 1–35 emnget, 2–60
orientation of material properties and stress of emniqr, 2–60
layers, 1–35 emnput, 2–61
monitoring, 1–32 emsdel, 2–43
non-summable miscellaneous data, 1–29 emsget, 2–42
writing to results file, 1–29 emsiqr, 2–42
overriding characteristic defaults, 1–14 emsput, 2–42
parameters, 1–4 enfdel, 2–44
returning reference names, 1–17 enfget, 2–43
rotation vectors, 1–29 enfiqr, 2–43
computing, 1–29 enfput, 2–44
rotational pseudovector, 1–30 engdel, 2–47
Index
engget, 2–46 Faces

engiqr, 2–46 convection surface information, 1–54
engput, 2–47 fAnsMemAlloc function, 1–70
enldel, 2–63 fAnsMemFree subroutine, 1–70
enlget, 2–63 File headers, 1–11
enliqr, 2–62 Files, 1–5, 1–5, 1–5, 1–6
enlput, 2–63 ansyscust, 1–6
ensdel, 2–46 fordel, 2–21
ensget, 2–44 forget, 2–20
ensiqr, 2–44 foriqr, 2–20
ensput, 2–45 forput, 2–20
epldel, 2–52 FORTRAN, 1–1, 1–2, 1–3
eplget, 2–51 Full transposed matrix, 3–12
epliqr, 2–50 Functions
eplput, 2–51 miscellaneous, 1–74
eprdel, 2–28 vector, 3–6
eprget, 2–27
epriqr, 2–27 G
eprput, 2–28 getnod, 2–5
erhandler subroutine, 3–4 GetRForce function, 1–63
erinqr subroutine, 3–2 GetStackDisp function, 1–64
Errors
displaying, 3–4 H
obtaining information, 3–2 Heat generation
esfdel, 2–39 defining loads, 1–32
esfget, 2–38 hgnget subroutine, 1–32
esfiqr, 2–38 /HOLD command, 1–75
esfput, 2–39 Hygrothermal growth, 1–49
ethdel, 2–56 Hyperelastic material models
ethget, 2–55 creating, 1–47
ethiqr, 2–54
ethput, 2–55 I
etpdel, 2–31
imove function, 3–7
etpget, 2–31
impcom.inc file, 1–4
etpiqr, 2–30
Files
etpput, 2–31
.inc, 1–4
etycom.inc file, 1–4
.inc extension, 1–4
etyget, 2–9
Include files, 1–4
etyiqr, 2–8
Interpolation, 3–5
etyput, 2–9
intrp subroutine, 3–5
etysel, 2–10
izero function, 3–7
euldel, 2–57
eulget, 2–56
euliqr, 2–56
L
Large data files, 1–12
eulput, 2–57
lastv function, 3–7
Evaluating Material Properties for 1-D Elements, 1–23
LINK8 element, 1–12
evdget, 2–36
Linking UPFs to ANSYS, 1–1, 1–5
evdiqr, 2–36
Load data
evdput, 2–36
getting from analysis results, 1–64
reading for a substructure generation run, 1–20
F Load steps
.F extension, 1–5
accessing program logic, 1–65
Index
containing information about, 1–4 Multifield debugging, 1–9

Load vectors, 1–14
accessing, 1–36 N
Loads, 1–1 ndcdel, 2–25
computing complex load vector, 1–33 ndcget, 2–25
convection, 1–31 ndciqr, 2–24
customizing, 1–52 ndcput, 2–25
debugging, 1–10 ndgall, 2–6
heat generation, 1–32 ndgxyz function, 3–11
pressure, 1–31 ndinqr, 2–4
temperature, 1–30 ndnext, 2–1
ndnxdf, 2–2
M ndprev, 2–2
maat subroutine, 3–13 ndpxyz subroutine, 3–12
MASS21 element, 1–12 ndsel, 2–2
Material properties, 1–1 ndspgt, 2–6
checking user-defined data, 1–49 Newton-Raphson debugging, 1–9
customizing, 1–39 nfudel, 2–24
debugging, 1–10 nfuget F, 2–24
deleting a material property table, 2–12 nfuiqr, 2–23
getting a material property table, 2–11 nfuput, 2–24
getting information about a material property, 2–10 nhgdel, 2–23
modifying orientation of, 1–34 nhgget, 2–23
nonlinear information, 1–27 nhgiqr, 2–22
storing a material property table, 2–12 nhgput, 2–23
updating nonlinear strain history for, 1–48 nlget function, 1–27
Matrix nminfo subroutine, 1–17
changing a matrix value, 3–13 nmisc record
debugging, 1–9 storing data in, 1–28
filling upper triangle from lower triangle, 3–14 Nodal coordinate system transformation debugging,
multiplying a vector by, 3–12 1–11
multiplying a vector by full transposed, 3–12 Nodal current density
subroutines, 3–12 deleting, 2–25
transposing, 3–13 getting, 2–25
transposing symmetric, 3–14 getting information about, 2–24
matsym subroutine, 3–14 storing, 2–25
matxb subroutine, 3–13 Nodal data conversion to fixed format data blocks, 1–12
matxv subroutine, 3–12 Nodal fluence
matxv1 subroutine, 3–13 deleting, 2–24
maxv subroutine, 3–12 Nodal fluences
maxv1 subroutine, 3–12 getting, 2–24
mctac subroutine, 3–14 getting information about, 2–23
Memory management routines, 1–70 storing, 2–24
Meshing debugging, 1–11 Nodal heat generation
Miscellaneous functions, 1–74 deleting, 2–23
Monitoring elements, 1–32 getting, 2–23
Moving one vector into another, 3–8 getting information, 2–22
mpdel, 2–12 storing, 2–23
mpget, 2–11 Nodal load
mpinqr, 2–10 deleting at a node, 2–21
mpput, 2–12 storing at a node, 2–20
mreuse subroutine, 1–19 Nodal loading routines, 2–18
Index
Nodal loads .obj extension, 1–6

getting information about, 2–20 Object files, 1–5, 1–6
Nodal magnetic virtual displacement OPEXE command, 1–67
getting, 2–26 Optimization program
getting information about, 2–26 creating, 1–67
Nodal orientation matrix linking to ANSYS, 1–67
adjusting, 1–16 Optimization variables, 1–4
Nodal reaction force values Optimizing ANSYS file reads, 1–12
getting, 1–63 OPTYPE command, 1–67
Nodal results OPUSER command, 1–67
getting from the database, 2–41 Orientation of material properties, 1–35
getting information about, 2–40 outpcm.inc file, 1–4
Nodal temperature Output
deleting, 2–22 generating, 1–12
getting, 2–21 obtaining information about, 3–2
getting information about, 2–21 /OUTPUT command, 1–12
storing, 2–22 Output control, 1–4
Nodal virtual displacement
deleting, 2–27 P
storing, 2–26 Parallel processing and UPFs, 1–2
Node information routines, 2–4 Parameters
Nodes adding, 1–73
getting a nodal point, 2–5 ANSYS, 1–4
getting information about a node, 2–4 creating a dimensioned parameter, 1–72
getting the next node number, 2–1 defining in subroutines, 1–13
getting the nodal solution for a node of an element, element characteristics, 1–4
2–6 finding and evaluating, 1–72
getting the number of the next defined node, 2–2 performing user operations on COMBIN7 and COM-
getting the number of the previous selected node, BIN37, 1–35
2–2 routines to process, 1–72
getting the xyz/rotation coordinates vector for a pardef subroutine, 1–73
node, 2–6 pardim subroutine, 1–72
getting XYZ vector for, 3–11 plast1 subroutine, 1–23
routines for selecting and retrieving, 2–1 plast3 subroutine, 1–24
selecting, unselecting, deleting, or inverting a node, Plasticity laws
2–2 creating, 1–42
storing a node, 2–5 Pointers to element data array, 1–4
storing XYZ vector for, 3–12 POST1 postprocessor, 1–13
Nonlinear debugging, 1–10 Pressure loads
Nonlinear strain history for materials, 1–48 defining, 1–31
NSVR command, 1–11 Printer output, 1–15
ntpdel, 2–22 Program logic
ntpget, 2–21 accessing, 1–65
ntpiqr, 2–21 tracking, 1–9
ntpput, 2–22 Programmer debugging, 1–9
nvddel, 2–27 Programming UPFs, 1–3
nvdget, 2–26 prope1 subroutine, 1–22
nvdiqr, 2–26 propev subroutine, 1–22
nvdput, 2–26 prsget subroutine, 1–31
pstev1 subroutine, 1–23
O putnod, 2–5
.o extension, 1–5
Index
R matrix, 3–12
Reading large data files rapidly, 1–12 running ANSYS as, 1–56
Real constants supporting for user-created elements, 1–17
debugging, 1–10 supporting user-defined commands, 1–63
fetching, 1–21 tracking calls to, 3–4
getting information about a real constant set, 2–12 subwrt subroutine, 1–21
getting real constant data, 2–13 svgidx subroutine, 1–17
selecting or deleting a real constant set, 2–13 svpidx subroutine, 1–19
Restrictions on UPF creation, 1–1 svrget subroutine, 1–18
Results svrput subroutine, 1–18
deleting at a node, 2–41 swell1 subroutine, 1–26
Results information routines, 2–40 swell3 subroutine, 1–26
Results values Swelling laws, 1–47
getting at selected points, 1–65 symeqn subroutine, 3–15
Retrieving System dependencies, 1–3
maximum vector value for a location, 3–7 systop subroutine, 3–6
position of last nonzero term in a vector, 3–7
Reusing element matrices, 1–19 T
rlget, 2–13 Table data
rlinqr, 2–12 retrieving, 1–23
rlsel, 2–13 tbuser subroutine, 1–23
rottr subroutine, 1–29 Temperature loads
RunCommand function, 1–74 defining, 1–30
rvrget subroutine, 1–21 tmpget subroutine, 1–30
/TRACK command, 1–9
S TrackBegin subroutine, 1–9, 3–4
Saved variables TrackEnd subroutine, 1–9, 3–4
debugging, 1–10 tran subroutine, 3–15
fetching, 1–18 Transient debugging, 1–9
Scalar constants Transposing a matrix, 3–13
assigning to vectors, 3–8 tranx3 subroutine, 3–5
Scalar fields to user-defined values, 1–52 trrot subroutine, 1–29
Simultaneous linear equations, 3–15
Solution control debugging, 1–9 U
Solutions UAnBeg subroutine, 1–65
accessing program logic, 1–65 UAnFin subroutine, 1–65
debugging, 1–9 /UCMD command, 1–11
soptcm.inc file, 1–4 uec100 routine, 1–13
Source files, 1–5 uec100 subroutine, 1–13, 1–13
Stack storage definition, 1–4 uel100 subroutine, 1–13, 1–14
stack.inc file, 1–4 uel101 subroutine, 1–3
START.ANS file, 1–57 UElMatx subroutine, 1–36
stepcm.inc file, 1–4 uep100 subroutine, 1–13, 1–15
Stopping ANSYS, 3–6 uex100 subroutine, 1–13, 1–14
Storing UItBeg subroutine, 1–65
user-supplied element output, 1–33 UItFin subroutine, 1–65
Structural mass element, 1–12 ULdBeg subroutine, 1–65
subrd subroutine, 1–20 ULdFin subroutine, 1–65
Subroutines /UNDO command, 1–75
for elements, 1–3 UNIX systems
for memory management, 1–70 compiling and linking UPFs on, 1–5
for processing parameters, 1–72 FORTRAN programming on, 1–3
Index
UPFs (see User programmable functions (UPFs)) uservp subroutine, 1–48

usanly subroutine, 1–35 USolBeg subroutine, 1–65
User programmable features (UPFs), 1–1 USolFin subroutine, 1–65
activating, 1–7 USRCAL command, 1–7, 1–7, 1–52, 1–65
and loads, 1–1 usrefl subroutine, 1–52
and material properties, 1–1 usrfc6 subroutine, 1–50
before you begin using, 1–2 UsrFictive subroutine, 1–38
capabilities of, 1–1 UsrViscEl subroutine, 1–38
compiling and linking, 1–5, 1–6 USsBeg subroutine, 1–65
on UNIX systems, 1–5 USsFin subroutine, 1–65
on Windows systems, 1–6 USTRESS subroutine, 1–37
considerations for using, 1–2 usvrcm.inc file, 1–4
debugging, 1–9 UTHICK subroutine, 1–37
definition of, 1–1
development strategy, 1–3 V
directions for, 1–3 vamb subroutine, 3–9
include files, 1–4 vamb1 subroutine, 3–10
linking subroutines to user routines, 1–5 vapb subroutine, 3–9
planning, 1–3 vapb1 subroutine, 3–9
running your executable, 1–8 vapcb1 subroutine, 3–9
verifying your routines, 1–8 Variables
User subroutines, 1–13 defining additional, 1–11
for creating new elements, 1–12 fetching the index for saved, 1–17
User-defined commands, 1–57 optimization, 1–4
making available to all ANSYS sessions, 1–57 retrieving characters from, 3–1
User-defined variable storage, 1–4 writing saved element index, 1–19
user01 command, 1–57, 1–57 vcross subroutine, 3–10
user02 command, 1–58 vdot function, 3–6
user03 command, 1–59 Vector functions, 3–6
userac, 2–15 Vectors
userac subroutine, 1–13, 1–17 assigning equal values to two vectors, 3–7
useran subroutine, 1–34 assigning scalar constants to, 3–8
userch subroutine, 1–55 assigning scalar constants to incrementally, 3–9
userck subroutine, 1–49 combining two in one, 3–9
usercr subroutine, 1–44 defining by a cross product, 3–10
usercreep subroutine, 1–44 getting the difference of two, 3–9
usercv subroutine, 1–54 getting XYZ vector for a node, 3–11
usereo subroutine, 1–28 initializing to zero, 3–7
userfd subroutine, 1–33 moving one into another, 3–8
userfx subroutine, 1–55 moving one into another incrementally, 3–8
UserHyper subroutine, 1–47 multiplying a matrix by, 3–12
usermat subroutine, 1–40 multiplying by a full transposed matrix, 3–13
usermc subroutine, 1–49 multiplying one by a constant, 3–10, 3–10
userop subroutine, 1–1, 1–68 multiplying to a constant, 3–9
userou subroutine, 1–33 normalizing a three-component vector, 3–11
userpe function, 1–36 normalizing to unit length, 3–11
userpl subroutine, 1–42 setting integer vector to zero, 3–7
userpr subroutine, 1–53 setting one to be the sum of two vectors, 3–9
userrc subroutine, 1–35 storing XYZ vector for a node, 3–12
usersw subroutine, 1–47 subtracting one from another, 3–10
usertr subroutine, 1–13, 1–16 Velocity information, 1–4
UserVisLaw subroutine, 1–50 Verifying UPFs, 1–8
Index
viinit subroutine, 3–9

vimove subroutine, 3–8
vinit subroutine, 3–8
Viscoplastic/creep material behavior, 1–44
Viscosity laws
defining, 1–50
vmax function, 3–7
vmove subroutine, 3–8
vmult subroutine, 3–10
vmult1 subroutine, 3–10
vnorm subroutine, 3–11
vnorme subroutine, 3–11
vsum function, 3–7
vzero subroutine, 3–7
W
Wavefront reordering debugging, 1–11
Windows systems
compiling and linking UPFs on, 1–6
wrinqr function, 3–2
X
xyzup3 subroutine, 1–30

Ansys Prog Features PDF

Uploaded by

Copyright:

Available Formats

Ansys Prog Features PDF

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Ansys Prog Features PDF

Uploaded by

Copyright:

Available Formats

What is the purpose of this document?

What is the purpose of this document?

What are User Programmable Features (UPFs) and what can they be used for?

What are User Programmable Features (UPFs) and what can they be used for?

Guide to ANSYS User

ANSYS, Inc. and

ANSYS Release 10.0

Copyright and Trademark Information

U.S. GOVERNMENT RIGHTS

Published in the U.S.A.

1.4.11. Subroutine prope1 (Evaluating One Material Property) ...................................................... 1–22

1.7.2. Subroutine userpr (Changing Element Pressure Information) .............................................. 1–53

2.8.20. nfudel Subroutine (Deleting a Nodal Fluence) ................................................................... 2–24

2.10.3. dspput Subroutine (Storing a Constraint at a Node) .......................................................... 2–41

2.10.53. emniqr Function (Getting Information About Element Miscellaneous Non-summable

3.3.21. vnorm Subroutine (Normalizing a Vector to Unit Length) .................................................. 3–11

About the Programmer's Guide Set

The APDL Programmer's Guide

Guide To ANSYS User Programmable Features

Other versions of the ANSYS program do not support UPFs.

1.1.1. What Are UPFs?

UPFs provide the following capabilities:

1.1.2. What You Should Know Before Using UPFs

• The ANSYS program.

1.1.3. Planning Your UPFs

1.1.4. Studying the ANSYS User Routines

1.1.5. Programming in Languages Other than FORTRAN

1.1.6. Developing UPFs: a Suggested Strategy

1.1.7. Include Decks

Include File Description

Include File Description

1.1.8. Linking User Routines

1.1.9. Compiling and Linking UPFs on UNIX Systems

1.1.10. Compiling and Linking UPFs on Windows Systems

1. To execute the relinked version of the ANSYS program:

• Click Start>Programs>ANSYS 10.0>Configure ANSYS Products

where “path” indicates the full path to the relinked ansys.exe.

1.1.11. Activating UPFs

• Issuing the USRCAL command

1.1.12. Running Your Custom Executable

1.1.13. Verifying Your Routines

1.1.14. Debugging Commands

1.1.14.1. Tracking the Path of Program Logic

1.1.14.2. Debugging Elements and Solutions

1.1.14.2.1. Solution Debug Format

2 (provides transient debugging using velocities and accelerations)

2 (provides element matrix debugging with load vectors only)

2 (provides Newton-Raphson debugging and prints out-of-balance forces or incremental displacement or

2 (provides displacement vector debugging with incremental displacement)

3 (provides displacement vector debugging with contact database)

1.1.14.2.2. Element Debug Format

2 (provides element matrix debugging with load vectors only)

2 (provides element material property debugging with nonlinear properties)

2 (provides element nonlinear debugging with large deformation)

3 (provides element nonlinear debugging with contact database)

1.1.14.2.3. General Debug Format

2 (provides input line (character))

3 (provides input line (decoded))

2 (provides meshing debugging)

c * Notice - This file contains ANSYS Confidential information *

c * Notice - This file contains ANSYS Confidential information *

c * Notice - This file contains ANSYS Confidential information *

c * Notice - This file contains ANSYS Confidential information *

c * Notice - This file contains ANSYS Confidential information *

c * Notice - This file contains ANSYS Confidential information *

c * Notice - This file contains ANSYS Confidential information *

c * Notice - This file contains ANSYS Confidential information *

c * Notice - This file contains ANSYS Confidential information *

c * Notice - This file contains ANSYS Confidential information *

c * Notice - This file contains ANSYS Confidential information *

c * Notice - This file contains ANSYS Confidential information *

c * Notice - This file contains ANSYS Confidential information *

c * Notice - This file contains ANSYS Confidential information *

c * Notice - This file contains ANSYS Confidential information *