refactor

Author: claudioperez

source/about/features/compatibility.rst

@@ -1,3 +1,6 @@
+.. _CompatibilityLayer:
+
+
 Compatibility
 ^^^^^^^^^^^^^
 

source/about/features/index.rst

@@ -5,12 +5,13 @@ Xara offers several advanced features that make it a powerful tool for nonlinear
 
 - **Mixed Formulations**: It supports mixed formulations for beams and solids, enabling accurate modeling of complex structural systems.
 - **Extensive Material Models**: With over 200 material models, Xara provides flexibility for simulating various materials and their nonlinear behaviors.
+- **Performance Optimization**: Built on the OpenSeesRT framework, Xara delivers substantial performance improvements over traditional interpreters.
 - **Continuation Algorithms**: These algorithms are designed to solve highly nonlinear problems efficiently, making Xara suitable for challenging engineering scenarios.
 - **Stateless Modeling**: Xara introduces a `Model` class for true stateless modeling, allowing users to work without relying on a single global program state.
-- **Compatibility Layer**: It reproduces OpenSeesPy functions, ensuring seamless integration for users familiar with the OpenSees ecosystem.
-- **Performance Optimization**: Built on the OpenSeesRT framework, Xara delivers substantial performance improvements over traditional interpreters.
+- `Compatibility Layer <CompatibilityLayer>`: Although *xara* in includes a completely rewritten interpreter architecture, compatibility layers allow legacy OpenSeesPy and Tcl scripts to run with minimal modifications.
 
 .. toctree::
+   :hidden:
    :maxdepth: 1
 
    compatibility

source/about/references.rst

@@ -97,6 +97,8 @@
     'sphinx_sitemap',
     "myst_parser"
 ]
+autosummary_generate = False
+autodoc_docstring_signature = True
 myst_enable_extensions = [
     "dollarmath",
     "attrs_inline"
@@ -132,16 +134,16 @@
     "user/manual/model/elements/other/SFI_MVLEM_3D.rst",
     "user/manual/model/elements/other/E_SFI.rst",
     "user/manual/model/elements/other/E_SFI_MVLEM_3D.rst",
-    "user/manual/model/elements/fluid/7045-BbarBrickUP.rst",
-    "user/manual/model/elements/fluid/7046-BbarQuadUP.rst",
-    "user/manual/model/elements/fluid/7066-BrickUP.rst",
-    "user/manual/model/elements/fluid/7264-FourNodeQuadUP.rst",
-    "user/manual/model/elements/fluid/7266-Four Node QuadUP.rst",
-    "user/manual/model/elements/fluid/7419-NineFourNodeQuadUP.rst",
-    "user/manual/model/elements/fluid/7612-SSPbrickUP.rst",
-    "user/manual/model/elements/fluid/7614-SSPquadUP.rst",
-    "user/manual/model/elements/fluid/7720-TwentyEightNodeBrickUP.rst",
-    "user/manual/model/elements/fluid/index.rst",
+    "user/manual/model/elements/grainfluid/7045-BbarBrickUP.rst",
+    "user/manual/model/elements/grainfluid/7046-BbarQuadUP.rst",
+    "user/manual/model/elements/grainfluid/7066-BrickUP.rst",
+    "user/manual/model/elements/grainfluid/7264-FourNodeQuadUP.rst",
+    "user/manual/model/elements/grainfluid/7266-Four Node QuadUP.rst",
+    "user/manual/model/elements/grainfluid/7419-NineFourNodeQuadUP.rst",
+    "user/manual/model/elements/grainfluid/7612-SSPbrickUP.rst",
+    "user/manual/model/elements/grainfluid/7614-SSPquadUP.rst",
+    "user/manual/model/elements/grainfluid/7720-TwentyEightNodeBrickUP.rst",
+    # "user/manual/model/elements/fluid/index.rst",
     "user/manual/materialCommands.rst",
     "user/manual/material/ndMaterials/BoundingCamClay.rst",
     "user/manual/material/ndMaterials/PM4Sand.rst",
@@ -169,25 +171,6 @@
     "user/manual/model/nodes/sp.rst",
     "user/examples/basicExamples/basicTruss.rst",
     "user/manual/material/matTestCommands.rst",
-#   "user/manual/model/beamIntegration.rst",
-#   "user/manual/model/beamIntegrations/test.rst",
-#   "user/manual/model/beamIntegrations/CompositeSimpson.rst",
-#   "user/manual/model/beamIntegrations/ConcentratedCurvature.rst",
-#   "user/manual/model/beamIntegrations/ConcentratedPlasticity.rst",
-#   "user/manual/model/beamIntegrations/FixedLocation.rst",
-#   "user/manual/model/beamIntegrations/HingeEndpoint.rst",
-#   "user/manual/model/beamIntegrations/HingeMidpoint.rst",
-#   "user/manual/model/beamIntegrations/HingeRadau.rst",
-#   "user/manual/model/beamIntegrations/HingeRadauTwo.rst",
-#   "user/manual/model/beamIntegrations/Legendre.rst",
-#   "user/manual/model/beamIntegrations/Lobatto.rst",
-#   "user/manual/model/beamIntegrations/LowOrder.rst",
-#   "user/manual/model/beamIntegrations/MidDistance.rst",
-#   "user/manual/model/beamIntegrations/NewtonCotes.rst",
-#   "user/manual/model/beamIntegrations/Radau.rst",
-#   "user/manual/model/beamIntegrations/Trapezoidal.rst",
-#   "user/manual/model/beamIntegrations/UserHinge.rst",
-#   "user/manual/model/beamIntegrations/userDefined.rst",
     "user/manual/model/damping/elementalDamping/SecStifDamping.rst",
     "user/manual/model/damping/elementalDamping/URDDamping.rst",
     "user/manual/model/damping/elementalDamping/UniformDamping.rst",
@@ -213,7 +196,7 @@
 
 if html_theme == "sphinx_rtd_theme":
     html_theme_options = {
-        'navigation_depth': 5,
+        'navigation_depth': 6,
         'logo_only': True,
         'style_nav_header_background': 'white',
         'prev_next_buttons_location': None,

source/conf.py

@@ -36,6 +36,7 @@ then constructs and analyzes a finite element simulation by invoking its *method
 Documentation of these methods is organized as follows:
 
 * :ref:`Modeling <modeling>` methods are used to add components to the finite element model.
+* :ref:`Loading <pattern>` methods are used to define loads and load patterns.
 * :ref:`Analysis <lblAnalysisCommands>` methods are used to move the state of the model from one converged state to another via a number of trial steps.
 * :ref:`Output <output>` methods allow one to obtain output from a finite element analysis, e.g. to record the node displacement history.
 
@@ -47,9 +48,10 @@ Documentation of these methods is organized as follows:
 
    user/manual/modeling
    user/manual/meshing/index
+   user/manual/loading/index
    user/manual/analysis/index
    user/manual/output/index
-   user/manual/misc/index
+   user/manual/strategy/index
    user/manual/modules/index
    Examples <https://gallery.stairlab.io/examples/>
 
@@ -63,6 +65,5 @@ Documentation of these methods is organized as follows:
    user/guides/index
    about/features/index
    about/license
-   about/references
    cite
 

source/launch.rst

@@ -0,0 +1,12 @@
+Command Line
+^^^^^^^^^^^^
+
+.. code-block:: bash
+
+   python -m opensees
+   opensees > model Basic -ndm 2
+   opensees > node 1 0.0 0.0
+   opensees > node 2 1.0 0.0
+   opensees > print -json
+   opensees > exit
+

source/user/guides/command-line.rst

@@ -10,8 +10,10 @@ Manual
 
    manual/modeling
    manual/meshing/index
+   mannual/loading/index
    manual/analysis/index
    manual/output/index
+   manual/strategy/index
    manual/misc/index
 
 

source/user/index.rst

@@ -19,15 +19,3 @@ algorithm
 where ``name`` is a string indentifying one of the following algorithms:
 
 
-.. toctree::
-   :maxdepth: 1
-
-   algorithm/LinearAlgorithm
-   algorithm/Newton
-   algorithm/NewtonLineSearch
-   algorithm/ModifiedNewton
-   algorithm/AcceleratedNewton
-   algorithm/Broyden
-   algorithm/ExpressNewton
-
-

source/user/manual/analysis/algorithm.rst

@@ -5,6 +5,8 @@ eigen
 
 
 .. tabs::
+   .. tab:: xara
+      .. autofunction:: xara.eigen
 
    .. tab:: Python 
 
@@ -38,7 +40,7 @@ eigen
 Theory
 ------
 
-The *generalized eigenvalue problem* for two symmetric matrices :math:`\boldsymbol{K}` and :math:`M` of size :math:`n \times n` is given by:
+The *generalized eigenvalue problem* for two symmetric matrices :math:`\boldsymbol{K}` and :math:`\boldsymbol{M}` of size :math:`n \times n` is given by:
 
 .. math::
 
@@ -57,7 +59,8 @@ Of course. Here is the breakdown formatted in reStructuredText, suitable for doc
 To convert the eigenvalues obtained from the generalized eigenvalue problem into natural frequencies, use the following relationships:
 
 **Eigenvalue** (`:math:\lambda`)
-This is the direct numerical output from the `model.eigen` call. Each eigenvalue corresponds to a specific vibration mode and represents the square of the natural angular frequency for that mode.
+This is the direct numerical output from the `model.eigen` call. 
+Each eigenvalue corresponds to a specific vibration mode and represents the square of the natural angular frequency for that mode.
 
 **Angular Frequency** (`:math:\omega`)
 The angular frequency, measured in **radians per second**, is the square root of the eigenvalue.

source/user/manual/analysis/eigen.rst …rce/user/manual/analysis/eigen/index.rstsource/user/manual/analysis/eigen.rst renamed to source/user/manual/analysis/eigen/index.rst source/user/manual/analysis/eigen.rst renamed to source/user/manual/analysis/eigen/index.rst

@@ -187,10 +187,6 @@ The eigenvalues :math:`\lambda` and the eigenvectors :math:`\Phi` can be obtaine
 .. math::
    \left (K - \lambda M \right ) \Phi = 0
 
-The global mass matrix :math:`M` is given by the assembly of :math:`n` elemental and nodal mass matrices :math:`m_e`:
-
-.. math::
-   M = \bigwedge_{i=1}^{n} m_e
 
 :math:`M` is not necessarily diagonal, because some elemental matrices :math:`m_e` may be consistent. However, the computation of :math:`CoM`, :math:`m_t` and :math:`m_f` requires a lumped version of :math:`M`. The global lumped mass matrix :math:`LM` can be computed by the assembly of a diagonalized version of the elemental mass matrices :math:`m_e`: