Skip to content

Commit e50b321

Browse files
committed
document order of nodeDisp
1 parent 434a086 commit e50b321

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

source/user/manual/output/nodeDisp.rst

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ nodeDisp
1414

1515
:param |integer| tag: The tag of the :ref:`node` whose displacements are sought.
1616
:param |integer| dof: Optional: specific degree of freedom at the node (between 1 and :py:attr:`Model.ndf`, inclusive).
17-
:returns: A |list| of the displacement components at the node when ``dof=None``, otherwise a |float|.
17+
:returns: A |list| of :py:attr:`Model.ndf` displacement values at the node when ``dof=None``. When ``dof`` is supplied, the result is a |float|.
1818

1919
.. tab:: Tcl
2020

@@ -29,8 +29,17 @@ nodeDisp
2929
dof, |integer|, optional: specific dof at the node (1 through ndf)
3030

3131

32+
The components are ordered as follows for various combinations of dimension (:py:attr:`Model.ndm`) and degrees of freedom (:py:attr:`Model.ndf`):
3233

33-
If optional $dof is not provided, an array containing all displacement components for every dof at the node is returned.
34+
.. csv-table::
35+
:header: "ndm", "ndf", "Order of components"
36+
:widths: 10, 10, 40
37+
38+
1, 1, "u1"
39+
2, 2, "u1, u2"
40+
3, 3, "u1, u2, u3"
41+
2, 3, "u1, u2, r3"
42+
3, 6, "u1, u2, u3, r1, r2, r3"
3443

3544

3645
Example

0 commit comments

Comments
 (0)