Skip to content

docs: add six constraint query commands (getFixedNodes, getConstrainedNodes, etc.)#328

Open
jiandong-qiao wants to merge 1 commit into
zhuminjie:masterfrom
jiandong-qiao:master
Open

docs: add six constraint query commands (getFixedNodes, getConstrainedNodes, etc.)#328
jiandong-qiao wants to merge 1 commit into
zhuminjie:masterfrom
jiandong-qiao:master

Conversation

@jiandong-qiao
Copy link
Copy Markdown

Description

This PR adds documentation for six constraint query commands that are currently undocumented in OpenSeesPyDoc.

Commands added

  • getFixedNodes - returns all fixed nodes
  • getFixedDOFs - returns fixed DOFs for a node
  • getConstrainedNodes - returns all constrained (slave) nodes
  • getRetainedNodes - returns all retained (master) nodes
  • getConstrainedDOFs - returns constrained DOFs for a slave node
  • getRetainedDOFs - returns retained DOFs for a master node

Testing

  • Each command tested locally with OpenSeesPy
  • Documentation built successfully with sphinx-build

Notes

As encouraged in the documentation:

"You are very welcome to contribute to OpenSeesPy with new command documents..."

The equationConstraint command will be added in a follow-up PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant