Skip to content

Commit e65952e

Browse files
committed
update eigen docs
1 parent 883f4a8 commit e65952e

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

source/user/manual/analysis/eigen.rst

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,25 +8,25 @@ eigen
88

99
.. tab:: Python
1010

11-
.. py:method:: Model.eigen(n, solver="-genBandArpack")
12-
11+
.. py:method:: Model.eigen(n, solver="GenBandArpack")
12+
1313
Perform an eigenvalue analysis and return a list of eigenvalues.
1414

1515
:param n: number of eigenvalues required.
1616
:type n: |integer|
17-
:param solver: optional string detailing type of solver: -genBandArpack, -symmBandLapack, -fullGenLapack (default: -genBandArpack).
17+
:param solver: optional string detailing type of solver: ``GenBandArpack``, ``SymmBandLapack``, ``FullGenLapack`` (default: ``GenBandArpack``).
1818
:type solver: |string|
19-
:returns: A |list| containing the eigenvalues
19+
:returns: A |list| containing ``n`` eigenvalues
2020

2121
.. tab:: Tcl
2222

23-
.. function:: eigen <$solver> $numEigenvalues
23+
.. function:: eigen <$solver> $n
2424

2525
.. csv-table::
2626
:header: "Argument", "Type", "Description"
2727
:widths: 10, 10, 40
2828

29-
``numEigenvalues``, |integer|, number of eigenvalues required.
29+
``n``, |integer|, number of eigenvalues required.
3030
``solver``, |string|, "optional string detailing type of solver: -genBandArpack, -symmBandLapack, -fullGenLapack (default: -genBandArpack)."
3131

3232
.. note::
@@ -41,12 +41,13 @@ Theory
4141
The *generalized eigenvalue problem* for two symmetric matrices :math:`\boldsymbol{K}` and :math:`M` of size :math:`n \times n` is given by:
4242

4343
.. math::
44-
\left (\boldsymbol{K} - \lambda M \right ) \Phi = 0
44+
45+
\left( \boldsymbol{K} - \lambda \boldsymbol{M} \right) \Phi = 0
4546
4647
where:
4748

4849
* :math:`\boldsymbol{K}` is the stiffness matrix
49-
* :math:`M` is the mass matrix
50+
* :math:`\boldsymbol{M}` is the mass matrix
5051
* :math:`\lambda` is the eigenvalue
5152
* and :math:`\Phi` is the associated eigenvector
5253

0 commit comments

Comments
 (0)