OpenSeesPy
stable
Contents
1. Installation
1.1. PyPi (Windows, Linux, Mac)
1.1.1. PyPi (Windows)
1.1.1.1. Install Anaconda
1.1.1.2. Install In Jupyter Notebook
1.1.1.3. Install In command line
1.1.2. PyPi (Linux)
1.1.2.1. Install Python
1.1.2.2. Install in terminal
1.1.3. PyPi (Mac)
1.1.3.1. Install Dependencies
1.1.3.2. Install Python
1.1.3.3. Install in terminal
1.2. Other Instalation
1.2.1. DesignSafe (Web-based)
1.2.1.1. OpenSeesPy in DesignSafe
1.2.1.2. Paraview in DesignSafe
1.2.2. Windows Subsystem for Linux (Windows)
1.2.2.1. Install the Windows Subsystem for Linux
1.2.2.2. Install Anaconda and start Jupyter Notebook
1.2.2.3. In Jupyter Notebook
1.2.2.4. In the command line (optional)
2. Compilation
2.1. Compilation for Windows
2.2. Compilation for MacOS
2.3. Compilation using QT
2.3.1. A Qt build environment for OpenSees
2.3.2. Dependency
2.3.3. Getting started:
2.3.4. Building OpenSeesPy:
2.3.5. Supported Build Environments:
2.3.6. MUMPS
2.3.7. OpenMPI
2.3.8. UMFPACK
2.3.9. SUPERLU
2.3.10. SUPERLUMT
2.3.11. SUPERLUDIST
2.3.12. LAPACK (SCALAPACK)
2.3.13. BLAS
2.3.14. ARPACK
2.3.15. GCC
2.3.16. PYTHON
2.3.17. MISC. NOTES
3. Change Log
4. Model Commands
4.1. model command
4.2. element commands
4.2.1. Zero-Length Element
4.2.1.1. zeroLength Element
4.2.1.2. zeroLengthND Element
4.2.1.3. zeroLengthSection Element
4.2.1.4. CoupledZeroLength Element
4.2.1.5. zeroLengthContact Element
4.2.1.6. zeroLengthContactNTS2D
4.2.1.7. zeroLengthInterface2D
4.2.1.8. zeroLengthImpact3D
4.2.2. Truss Elements
4.2.2.1. Truss Element
4.2.2.2. Corotational Truss Element
4.2.3. Beam-Column Elements
4.2.3.1. Elastic Beam Column Element
4.2.3.2. Elastic Beam Column Element with Stiffness Modifiers
4.2.3.3. Elastic Timoshenko Beam Column Element
4.2.3.4. Beam With Hinges Element
4.2.3.5. dispBeamColumn
4.2.3.6. forceBeamColumn
4.2.3.7. nonlinearBeamColumn
4.2.3.8. Flexure-Shear Interaction Displacement-Based Beam-Column Element
4.2.3.9. MVLEM - Multiple-Vertical-Line-Element-Model for RC Walls
4.2.3.10. SFI MVLEM - Cyclic Shear-Flexure Interaction Model for RC Walls
4.2.4. Joint Elements
4.2.4.1. BeamColumnJoint Element
4.2.4.2. ElasticTubularJoint Element
4.2.4.3. Joint2D Element
4.2.5. Link Elements
4.2.5.1. Two Node Link Element
4.2.6. Bearing Elements
4.2.6.1. Elastomeric Bearing (Plasticity) Element
4.2.6.2. Elastomeric Bearing (Bouc-Wen) Element
4.2.6.3. Flat Slider Bearing Element
4.2.6.4. Single Friction Pendulum Bearing Element
4.2.6.5. Triple Friction Pendulum Bearing Element
4.2.6.6. Triple Friction Pendulum Element
4.2.6.7. MultipleShearSpring Element
4.2.6.8. KikuchiBearing Element
4.2.6.9. YamamotoBiaxialHDR Element
4.2.6.10. ElastomericX
4.2.6.11. LeadRubberX
4.2.6.12. HDR
4.2.6.13. RJ-Watson EQS Bearing Element
4.2.6.14. FPBearingPTV
4.2.7. Quadrilateral Elements
4.2.7.1. Quad Element
4.2.7.2. Shell Element
4.2.7.3. ShellDKGQ
4.2.7.4. ShellDKGT
4.2.7.5. ShellNLDKGQ
4.2.7.6. ShellNLDKGT
4.2.7.7. ShellNL
4.2.7.8. Bbar Plane Strain Quadrilateral Element
4.2.7.9. Enhanced Strain Quadrilateral Element
4.2.7.10. SSPquad Element
4.2.8. Triangular Elements
4.2.8.1. Tri31 Element
4.2.9. Brick Elements
4.2.9.1. Standard Brick Element
4.2.9.2. Bbar Brick Element
4.2.9.3. Twenty Node Brick Element
4.2.9.4. SSPbrick Element
4.2.10. Tetrahedron Elements
4.2.10.1. FourNodeTetrahedron
4.2.11. UC San Diego u-p element (saturated soil)
4.2.11.1. Four Node Quad u-p Element
4.2.11.2. Brick u-p Element
4.2.11.3. BbarQuad u-p Element
4.2.11.4. BbarBrick u-p Element
4.2.11.5. Nine Four Node Quad u-p Element
4.2.11.6. Twenty Eight Node Brick u-p Element
4.2.12. Other u-p elements
4.2.12.1. SSPquadUP Element
4.2.12.2. SSPbrickUP Element
4.2.13. Contact Elements
4.2.13.1. SimpleContact2D
4.2.13.2. SimpleContact3D
4.2.13.3. BeamContact2D
4.2.13.4. BeamContact3D
4.2.13.5. BeamEndContact3D
4.2.14. Cable Elements
4.2.14.1. CatenaryCableElement
4.2.15. PFEM Elements
4.2.15.1. PFEMElementBubble
4.2.15.2. PFEMElementCompressible
4.2.16. Misc.
4.2.16.1. SurfaceLoad Element
4.2.16.2. VS3D4
4.2.16.3. AC3D8
4.2.16.4. ASI3D8
4.2.16.5. AV3D4
4.3. node command
4.4. sp constraint commands
4.4.1. fix command
4.4.2. fixX command
4.4.3. fixY command
4.4.4. fixZ command
4.5. mp constraint commands
4.5.1. equalDOF command
4.5.2. equalDOF_Mixed command
4.5.3. rigidDiaphragm command
4.5.4. rigidLink command
4.6. timeSeries commands
4.6.1. Constant TimeSeries
4.6.2. Linear TimeSeries
4.6.3. Trigonometric TimeSeries
4.6.4. Triangular TimeSeries
4.6.5. Rectangular TimeSeries
4.6.6. Pulse TimeSeries
4.6.7. Path TimeSeries
4.7. pattern commands
4.7.1. Plain Pattern
4.7.1.1. load command
4.7.1.2. eleLoad command
4.7.1.3. sp command
4.7.2. UniformExcitation Pattern
4.7.3. Multi-Support Excitation Pattern
4.7.3.1. Plain Ground Motion
4.7.3.2. Interpolated Ground Motion
4.7.3.3. Imposed Motion
4.8. mass command
4.9. region command
4.10. rayleigh command
4.11. block commands
4.11.1. block2D command
4.11.2. block3D command
4.12. beamIntegration commands
4.12.1. Lobatto
4.12.2. Legendre
4.12.3. NewtonCotes
4.12.4. Radau
4.12.5. Trapezoidal
4.12.6. CompositeSimpson
4.12.7. UserDefined
4.12.8. FixedLocation
4.12.9. LowOrder
4.12.10. MidDistance
4.12.11. UserHinge
4.12.12. HingeMidpoint
4.12.13. HingeRadau
4.12.14. HingeRadauTwo
4.12.15. HingeEndpoint
4.13. uniaxialMaterial commands
4.13.1. Steel & Reinforcing-Steel Materials
4.13.1.1. Steel01
4.13.1.2. Steel02
4.13.1.3. Steel4
4.13.1.4. Hysteretic
4.13.1.5. ReinforcingSteel
4.13.1.6. Dodd_Restrepo
4.13.1.7. RambergOsgoodSteel
4.13.1.8. SteelMPF
4.13.1.9. Steel01Thermal
4.13.2. Concrete Materials
4.13.2.1. Concrete01
4.13.2.2. Concrete02
4.13.2.3. Concrete04
4.13.2.4. Concrete06
4.13.2.5. Concrete07
4.13.2.6. Concrete01WithSITC
4.13.2.7. ConfinedConcrete01
4.13.2.8. ConcreteD
4.13.2.9. FRPConfinedConcrete
4.13.2.10. FRPConfinedConcrete02
4.13.2.11. ConcreteCM
4.13.2.12. TDConcrete
4.13.2.13. TDConcreteEXP
4.13.2.14. TDConcreteMC10
4.13.2.15. TDConcreteMC10NL
4.13.3. Standard Uniaxial Materials
4.13.3.1. Elastic Uniaxial Material
4.13.3.2. Elastic-Perfectly Plastic Material
4.13.3.3. Elastic-Perfectly Plastic Gap Material
4.13.3.4. Elastic-No Tension Material
4.13.3.5. Parallel Material
4.13.3.6. Series Material
4.13.4. PyTzQz uniaxial materials for p-y, t-z and q-z elements for modeling soil-structure interaction through the piles in a structural foundation
4.13.4.1. PySimple1 Material
4.13.4.2. TzSimple1 Material
4.13.4.3. QzSimple1 Material
4.13.4.4. PyLiq1 Material
4.13.4.5. TzLiq1 Material
4.13.5. Other Uniaxial Materials
4.13.5.1. Hardening Material
4.13.5.2. CastFuse Material
4.13.5.3. ViscousDamper Material
4.13.5.4. BilinearOilDamper Material
4.13.5.5. Modified Ibarra-Medina-Krawinkler Deterioration Model with Bilinear Hysteretic Response (Bilin Material)
4.13.5.6. Modified Ibarra-Medina-Krawinkler Deterioration Model with Peak-Oriented Hysteretic Response (ModIMKPeakOriented Material)
4.13.5.7. Modified Ibarra-Medina-Krawinkler Deterioration Model with Pinched Hysteretic Response (ModIMKPinching Material)
4.13.5.8. SAWS Material
4.13.5.9. BarSlip Material
4.13.5.10. Bond SP01 - - Strain Penetration Model for Fully Anchored Steel Reinforcing Bars
4.13.5.11. Fatigue Material
4.13.5.12. Impact Material
4.13.5.13. Hyperbolic Gap Material
4.13.5.14. Limit State Material
4.13.5.15. MinMax Material
4.13.5.16. ElasticBilin Material
4.13.5.17. ElasticMultiLinear Material
4.13.5.18. MultiLinear
4.13.5.19. Initial Strain Material
4.13.5.20. Initial Stress Material
4.13.5.21. PathIndependent Material
4.13.5.22. Pinching4 Material
4.13.5.23. Engineered Cementitious Composites Material
4.13.5.24. SelfCentering Material
4.13.5.25. Viscous Material
4.13.5.26. BoucWen Material
4.13.5.27. BWBN Material
4.13.5.28. KikuchiAikenHDR Material
4.13.5.29. KikuchiAikenLRB Material
4.13.5.30. AxialSp Material
4.13.5.31. AxialSpHD Material
4.13.5.32. Pinching Limit State Material
4.13.5.33. CFSWSWP Wood-Sheathed Cold-Formed Steel Shear Wall Panel
4.13.5.34. CFSSSWP Steel-Sheathed Cold-formed Steel Shear Wall Panel
4.14. nDMaterial commands
4.14.1. Standard Models
4.14.1.1. ElasticIsotropic
4.14.1.2. ElasticOrthotropic
4.14.1.3. J2Plasticity
4.14.1.4. DruckerPrager
4.14.1.5. Damage2p
4.14.1.6. PlaneStress
4.14.1.7. PlaneStrain
4.14.1.8. MultiaxialCyclicPlasticity
4.14.1.9. BoundingCamClay
4.14.1.10. PlateFiber
4.14.1.11. FSAM
4.14.1.12. ManzariDafalias
4.14.1.13. PM4Sand
4.14.1.14. StressDensityModel
4.14.1.15. AcousticMedium
4.14.2. Tsinghua Sand Models
4.14.2.1. CycLiqCP
4.14.2.2. CycLiqCPSP
4.14.3. Materials for Modeling Concrete Walls
4.14.3.1. PlaneStressUserMaterial
4.14.3.2. PlateFromPlaneStress
4.14.3.3. PlateRebar
4.14.3.4. PlasticDamageConcretePlaneStress
4.14.4. Contact Materials for 2D and 3D
4.14.4.1. ContactMaterial2D
4.14.4.2. ContactMaterial3D
4.14.5. Wrapper material for Initial State Analysis
4.14.5.1. InitialStateAnalysisWrapper
4.14.5.2. Initial Stress Material
4.14.5.3. Initial Strain Material
4.14.6. UC San Diego soil models
4.14.6.1. PressureIndependMultiYield
4.14.6.2. PressureDependMultiYield
4.14.6.3. PressureDependMultiYield02
4.14.6.4. PressureDependMultiYield03
4.14.7. UC San Diego Saturated Undrained soil
4.14.7.1. FluidSolidPorousMaterial
4.15. section commands
4.15.1. Elastic Section
4.15.2. Fiber Section
4.15.2.1. Fiber Command
4.15.2.2. Patch Command
4.15.2.3. Layer Command
4.15.3. Fiber Thermal Section
4.15.4. NDFiber Section
4.15.5. Wide Flange Section
4.15.6. RC Section
4.15.7. RCCircular Section
4.15.8. Parallel Section
4.15.9. Section Aggregator
4.15.10. Uniaxial Section
4.15.11. Elastic Membrane Plate Section
4.15.12. Plate Fiber Section
4.15.13. Bidirectional Section
4.15.14. Isolator2spring Section
4.15.15. LayeredShell
4.16. frictionModel commands
4.16.1. Coulomb
4.16.2. Velocity Dependent Friction
4.16.3. Velocity and Normal Force Dependent Friction
4.16.4. Velocity and Pressure Dependent Friction
4.16.5. Multi-Linear Velocity Dependent Friction
4.17. geomTransf commands
4.17.1. Linear Transformation
4.17.2. PDelta Transformation
4.17.3. Corotational Transformation
5. Analysis Commands
5.1. constraints commands
5.1.1. Plain Constraints
5.1.2. Lagrange Multipliers
5.1.3. Penalty Method
5.1.4. Transformation Method
5.2. numberer commands
5.2.1. Plain Numberer
5.2.2. RCM Numberer
5.2.3. AMD Numberer
5.2.4. Parallel Plain Numberer
5.2.5. Parallel RCM Numberer
5.3. system commands
5.3.1. BandGeneral SOE
5.3.2. BandSPD SOE
5.3.3. ProfileSPD SOE
5.3.4. SuperLU SOE
5.3.5. UmfPack SOE
5.3.6. FullGeneral SOE
5.3.7. SparseSYM SOE
5.3.8. MUMPS Solver
5.4. test commands
5.4.1. NormUnbalance
5.4.2. NormDispIncr
5.4.3. energyIncr
5.4.4. RelativeNormUnbalance
5.4.5. RelativeNormDispIncr
5.4.6. RelativeTotalNormDispIncr
5.4.7. RelativeEnergyIncr
5.4.8. FixedNumIter
5.4.9. NormDispAndUnbalance
5.4.10. NormDispOrUnbalance
5.5. algorithm commands
5.5.1. Linear Algorithm
5.5.2. Newton Algorithm
5.5.3. Newton with Line Search
5.5.4. Modified Newton Algorithm
5.5.5. Krylov-Newton Algorithm
5.5.6. SecantNewton Algorithm
5.5.7. RaphsonNewton Algorithm
5.5.8. PeriodicNewton Algorithm
5.5.9. BFGS Algorithm
5.5.10. Broyden Algorithm
5.6. integrator commands
5.6.1. Static integrator objects
5.6.1.1. LoadControl
5.6.1.2. DisplacementControl
5.6.1.3. Parallel DisplacementControl
5.6.1.4. Minimum Unbalanced Displacement Norm
5.6.1.5. Arc-Length Control
5.6.2. Transient integrator objects
5.6.2.1. Central Difference
5.6.2.2. Newmark Method
5.6.2.3. Hilber-Hughes-Taylor Method
5.6.2.4. Generalized Alpha Method
5.6.2.5. TRBDF2
5.6.2.6. Explicit Difference
5.7. analysis command
5.8. eigen command
5.9. analyze command
6. Output Commands
6.1. basicDeformation command
6.2. basicForce command
6.3. basicStiffness command
6.4. eleDynamicalForce command
6.5. eleForce command
6.6. eleNodes command
6.7. eleResponse command
6.8. getEleTags command
6.9. getLoadFactor command
6.10. getNodeTags command
6.11. getTime command
6.12. nodeAccel command
6.13. nodeBounds command
6.14. nodeCoord command
6.15. nodeDisp command
6.16. nodeEigenvector command
6.17. nodeDOFs command
6.18. nodeMass command
6.19. nodePressure command
6.20. nodeReaction command
6.21. nodeResponse command
6.22. nodeVel command
6.23. nodeUnbalance command
6.24. numFact command
6.25. numIter command
6.26. printA command
6.27. printB command
6.28. printGID command
6.29. printModel command
6.30. record command
6.31. recorder command
6.31.1. node recorder command
6.31.2. node envelope recorder command
6.31.3. element recorder command
6.31.4. element envelope recorder command
6.31.5. pvd recorder command
6.31.6. background recorder command
6.31.7. Collapse Recorder command
6.32. sectionForce command
6.33. sectionDeformation command
6.34. sectionStiffness command
6.35. sectionFlexibility command
6.36. sectionLocation command
6.37. sectionWeight command
6.38. systemSize command
6.39. testIter command
6.40. testNorm command
6.41. version command
6.42. logFile command
7. Utility Commands
7.1. convertBinaryToText command
7.2. convertTextToBinary command
7.3. database command
7.4. InitialStateAnalysis command
7.5. loadConst command
7.6. modalDamping command
7.7. reactions command
7.8. remove command
7.9. reset command
7.10. restore command
7.11. save command
7.12. sdfResponse command
7.13. setTime command
7.14. setNodeCoord command
7.15. setNodeDisp command
7.16. setNodeVel command
7.17. setNodeAccel command
7.18. setPrecision command
7.19. setElementRayleighDampingFactors command
7.20. start command
7.21. stop command
7.22. stripXML command
7.23. updateElementDomain command
7.24. updateMaterialStage
7.25. wipe command
7.26. wipeAnalysis command
7.27. setNumthread command
7.28. getNumthread command
8. FSI Commands
8.1. mesh command
8.1.1. line mesh
8.1.2. triangular mesh
8.1.3. quad mesh
8.1.4. tetrahedron mesh
8.1.5. particle mesh
8.1.6. background mesh
8.2. remesh command
8.3. PFEM integrator
8.4. PFEM SOE
8.5. PFEM test
8.6. PFEM analysis
9. Sensitivity Commands
9.1. parameter command
9.1.1. Examples
9.2. addToParameter command
9.3. updateParameter command
9.4. setParameter command
9.5. getParamTags command
9.6. getParamValue command
9.7. computeGradients command
9.8. sensitivityAlgorithm command
9.9. sensNodeDisp command
9.10. sensNodeVel command
9.11. sensNodeAccel command
9.12. sensLambda command
9.13. sensSectionForce command
9.14. sensNodePressure command
10. Reliability Commands
10.1. randomVariable command
11. Parallel Commands
11.1. getPID command
11.2. getNP command
11.3. barrier command
11.4. send command
11.5. recv command
11.6. Bcast command
11.7. setStartNodeTag command
11.8. domainChange command
11.9. partition command
12. Preprocessing Commands
12.1. DiscretizeMember command
13. Postprocessing Modules
13.1. Get_Rendering Commands
13.1.1. Create Output Database
13.1.2. saveFiberData2D command
13.1.3. plot_model command
13.1.4. plot_modeshape command
13.1.5. plot_deformedshape command
13.1.6. plot_fiberResponse2D command
13.1.7. animate_deformedshape command
13.1.8. animate_fiberResponse2D command
13.1.9. Plotting OpenSees Tcl Output
13.1.10. Visualization Development Guide
13.1.10.1. Internal Database functions
13.1.10.2. Internal Plotting functions
13.1.10.3. User functions
13.1.10.4. Example of an internal function
13.1.10.5. Naming conventions
13.1.10.6. Wish List
13.2. ops_vis module
13.2.1. plot_model (ops_vis)
13.2.2. plot_defo (ops_vis)
13.2.3. plot_mode_shape (ops_vis)
13.2.4. section_force_diagram_2d (ops_vis)
13.2.5. section_force_diagram_3d (ops_vis)
13.2.6. plot_stress_2d (ops_vis)
13.2.7. anim_defo (ops_vis)
13.2.8. anim_mode (ops_vis)
13.2.9. plot_fiber_section (ops_vis)
13.2.10. fib_sec_list_to_cmds (ops_vis)
13.2.11. sig_out_per_node (ops_vis)
14. Examples
14.1. Structural Examples
14.1.1. Elastic Truss Analysis
14.1.2. Nonlinear Truss Analysis
14.1.3. Portal Frame 2d Analysis
14.1.4. Moment Curvature Analysis
14.1.5. Reinforced Concrete Frame Gravity Analysis
14.1.6. Reinforced Concrete Frame Pushover Analysis
14.1.7. Three story steel building with rigid beam-column connections and W-section
14.1.8. Cantilever FRP-Confined Circular Reinforced Concrete Column under Cyclic Lateral Loading
14.1.9. Reinforced Concrete Shear Wall with Special Boundary Elements
14.2. Earthquake Examples
14.2.1. Cantilever 2D EQ ground motion with gravity Analysis
14.2.2. Reinforced Concrete Frame Earthquake Analysis
14.2.3. Example name spaced nonlinear SDOF
14.2.4. RotD Spectra of Ground Motion
14.2.5. Portal 2D Frame - Dynamic EQ Ground Motion
14.2.6. 2D Column - Dynamic EQ Ground Motion
14.2.7. Nonlinear Canti Col Uniaxial Inelastic Section- Dyn EQ GM
14.2.8. Nonlin Canti Col Inelstc Uniaxial Mat in Fiber Sec - Dyn EQ
14.2.9. Cantilever 2D Column with Units- Dynamic EQ Ground Motion
14.2.10. Cantilever 2D Column with Units-Static Pushover
14.2.11. 2D Portal Frame with Units- Dynamic EQ Ground Motion
14.2.12. 2D Portal Frame with Units- Multiple Support Dynamic EQ Ground Motion-acctimeseries
14.2.13. 2D Portal Frame with Units- Multiple Support Dynamic EQ Ground Motion-disptimeseries
14.2.14. 2D Portal Frame with Units- Uniform Dynamic EQ -bidirectional-acctimeseries
14.3. Tsunami Examples
14.3.1. Moving Mesh
14.3.1.1. Dambreak Analysis using moving mesh
14.3.1.2. Dambreak with Elastic Obstacle Analysis using moving mesh
14.3.2. Background Mesh
14.3.2.1. Dambreak Analysis using background mesh
14.3.2.2. Dambreak with Elastic Obstacle Analysis using background mesh
14.4. GeoTechnical Examples
14.4.1. Laterally-Loaded Pile Foundation
14.4.2. Effective Stress Site Response Analysis of a Layered Soil Column
14.5. Thermal Examples
14.5.1. Restrained beam under thermal expansion
14.6. Parallel Examples
14.6.1. Hello World Example 1
14.6.2. Hello World Example 2
14.6.3. Parallel Truss Example
14.6.4. Parallel Tri31 Example
14.6.5. Parallel Parametric Study Example
14.7. Plotting Examples
14.7.1. A Procedure to Render 2D or 3D OpenSees Model and Mode Shapes
14.7.2. Statics of a 2d Portal Frame (ops_vis)
14.7.3. Statics of a 3d 3-element cantilever beam (ops_vis)
14.7.4. Plot stress distribution of plane stress quad model (ops_vis)
14.7.5. Plot steel and reinforced concrete fiber sections (ops_vis)
14.7.6. Animation of dynamic analysis and mode shapes of a 2d Portal Frame (ops_vis)
OpenSeesPy
Docs
»
9. Sensitivity Commands
»
9.6. getParamValue command
Edit on GitHub
9.6. getParamValue command
¶
getParamValue
(
tag
)
¶
Return the value of a parameter
tag
(
int
)
integer tag identifying the parameter.
Read the Docs
v: stable
Versions
latest
stable
Downloads
On Read the Docs
Project Home
Builds
Free document hosting provided by
Read the Docs
.