refactor: release fixes

docs/source/conf.py

@@ -43,6 +43,7 @@
     "sphinx.ext.githubpages",
     # "recommonmark",
     "nbsphinx",
+    "sphinx.ext.napoleon",
 ]
 
 autodoc_member_order = "bysource"

docs/source/notebooks/mesh_showcase.ipynb

@@ -238,7 +238,7 @@
     "oblique_grillage.create_osp_model(\n",
     "    pyfile=False\n",
     ")  \n",
-    "og.opsplt.plot_model(\"nodes\")"
+    "og.opsplt.plot_model(show_nodes=\"yes\",show_nodetags=\"yes\",)"
    ]
   },
   {
@@ -330,7 +330,7 @@
     "ortho_grillage.create_osp_model(\n",
     "    pyfile=False\n",
     ")  \n",
-    "og.opsplt.plot_model(\"nodes\")"
+    "og.opsplt.plot_model(show_nodes=\"yes\",show_nodetags=\"yes\",)"
    ]
   },
   {
@@ -422,7 +422,7 @@
     "varied_edge_angle_grillage.create_osp_model(\n",
     "    pyfile=False\n",
     ")  \n",
-    "og.opsplt.plot_model(\"nodes\")"
+    "og.opsplt.plot_model(show_nodes=\"yes\",show_nodetags=\"yes\",)"
    ]
   },
   {
@@ -458,7 +458,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.10"
+   "version": "3.10.12"
   }
  },
  "nbformat": 4,

docs/source/notebooks/multi_span.ipynb

@@ -505,7 +505,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.10"
+   "version": "3.10.12"
   }
  },
  "nbformat": 4,

docs/source/notebooks/super_t_analysis_workflow.ipynb

@@ -267,7 +267,7 @@
     "simple_grid.create_osp_model(\n",
     "    pyfile=False\n",
     ")  # pyfile will not (False) be generated for further analysis (should be create_osp?)\n",
-    "og.opsplt.plot_model(\"nodes\")  # plotting using Get_rendering\n",
+    "og.opsplt.plot_model(show_nodes=\"yes\",show_nodetags=\"yes\")  # plotting using vfo\n",
     "og.opsv.plot_model(az_el=(-90, 0))  # plotting using ops_vis\n",
     "og.plt.show()"
    ]

docs/source/rst/ModelTemplates.rst

@@ -77,7 +77,7 @@ Table 1 outlines the specific variables for beam link model.
 
 
 .. note::
-    As of release 0.1.0, `OpenSeesPy` visualization module ops_vis is unable to visualize the joint offsets.
+    As of release 0.1.0, `OpenSeesPy` visualization module `vfo` and `opsvis` is unable to visualize the joint offsets.
 
 .. _shell hybrid model:
 

docs/source/rst/Module description.rst

@@ -317,7 +317,7 @@ Therefore, one can run access `ops_vis` by running the following code line and a
 
 .. code-block:: python
 
-    og.opsplt.plot_model("nodes") # using Get Rendering module
+    og.opsplt.plot_model(show_nodes="yes",show_nodetags="yes") # using Vfo module
     og.opsv.plot_model(az_el=(-90, 0)) # using osp_vis
 
 Whilst all nodes will be visualized, only the assigned members are visualized.

docs/source/rst/ModuleDoc.rst

@@ -253,11 +253,11 @@ In tandem with this, the :class:`~ospgrillage.mesh.EdgeControlPoints` class will
 are only recognized as end supports - catering to current meshing procedures for single span configuration.
 
 The developers also acknowledges that there are conflicts between the adopted coordinate system of *ospgrillage* and the default
-coordinate system for the OpenSees's `ops_vis` module. The `ops_vis` module default isotropic angle is x - y with z axis plane
+coordinate system for the OpenSees's `opsvis` module. The `opsvis` module default isotropic angle is x - y with z axis plane
 being the model plane of a 2-D model in 3-D space. Currently it is not easy to alter the coordinate system of
-*ospgrillage*. However, the developers are hoping that `ops_vis` can cater to
+*ospgrillage*. However, the developers are hoping that `opsvis` can cater to
 multi isotropic views of the model space as oppose to the current fixed coordinate system.
 It would require substantial rework of the entire *ospgrillage* module if one decides to "fit"
-*ospgrillage* 's coordinate system to `ops_vis` - since the module assume the model plane of the 2D grillage is the
+*ospgrillage* 's coordinate system to `opsvis` - since the module assume the model plane of the 2D grillage is the
 y axis.
 

docs/source/rst/PostProcessing.rst

@@ -229,15 +229,15 @@ Plotting results of DataArrays
 Current limitation of `OpenSees` visualization module
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-`OpenSeesPy`'s visualization module - `ops_vis` - offers comprehensive visualization analysis results in `OpenSees`.
-However, `ops_vis` operates only for a single model instance (and analysis) in `OpenSees`
-framework.
-In other words, results from `xarray` DataSet (of :func:`~ospgrillage.osp_grillage.OspGrillage.get_results`) cannot be plotted using the current visualization module.
-Additionally, `ops_vis` does not contain enveloping feature across multiple analysis - especially for moving load analysis comprise of multiple incremental load case for each moving load position.
-
-If needed, users can still utilize `ops_vis` however only in a specific condition i.e. only a single load case is defined and :func:`~ospgrillage.osp_grillage.OspGrillage.analyze` in the `OpenSees` framework.
-With only a single load case and analysis, users can directly access the model results and plot using `ops_vis`.
-The following code example plots the results of the **current analysis instance** using `ops_vis`:
+`OpenSeesPy`'s visualization module uses either `vfo` or `opsvis`.
+However both modules requires the model instance been created in `OpenSeesPy` model space.
+
+In other words, results from `xarray` DataSet (of :func:`~ospgrillage.osp_grillage.OspGrillage.get_results`) cannot be plotted using the current visualization modules.
+Additionally, `opsvis` and `vfo` does not contain enveloping feature across multiple analysis - especially for moving load analysis comprise of multiple incremental load case for each moving load position.
+
+If needed, users can still utilize `opsvis` however only in a specific condition i.e. only a single load case is defined and :func:`~ospgrillage.osp_grillage.OspGrillage.analyze` in the `OpenSees` framework.
+With only a single load case and analysis, users can directly access the model results and plot using `opsvis`.
+The following code example plots the results of the **current analysis instance** using `opsvis`:
 
 .. code-block:: python
 

examples/workshop/super-t_example-final.ipynb

@@ -566,7 +566,7 @@
     "tags": []
    },
    "source": [
-    "Plot using the *opsplt* `GetRendering` library."
+    "Plot using the *opsplt* `Vfo` library."
    ]
   },
   {
@@ -600,7 +600,7 @@
     }
    ],
    "source": [
-    "og.opsplt.plot_model(\"nodes\");"
+    "og.opsplt.plot_model(show_nodes=\"yes\",show_nodetags=\"yes\",);"
    ]
   },
   {
@@ -613,7 +613,7 @@
     "tags": []
    },
    "source": [
-    "Plot using `ops_vis` library"
+    "Plot using `opsvis` library"
    ]
   },
   {
@@ -6296,7 +6296,7 @@
     "tags": []
    },
    "source": [
-    "Plot the model using `GetRendering` - currently `ops_vis` is not able to visualize mix element model (shell + beam)"
+    "Plot the model using `Vfo` - currently `opsvis` is not able to visualize mix element model (shell + beam)"
    ]
   },
   {
@@ -7279,9 +7279,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python [conda env:civil]",
+   "display_name": "env",
    "language": "python",
-   "name": "conda-env-civil-py"
+   "name": "env"
   },
   "language_info": {
    "codemirror_mode": {
@@ -7293,7 +7293,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.9"
+   "version": "3.10.12"
   }
  },
  "nbformat": 4,

src/ospgrillage/__init__.py

@@ -1,9 +1,9 @@
-from ospgrillage.static import *
+from ospgrillage.utils import *
 from ospgrillage.mesh import *
 from ospgrillage.load import *
 from ospgrillage.material import *
 from ospgrillage.members import *
 from ospgrillage.osp_grillage import *
 from ospgrillage.postprocessing import *
 
-__version__ = "0.3.1"
+__version__ = "0.3.2"

src/ospgrillage/load.py

@@ -667,35 +667,32 @@ def _define_patch_edge_lines(self):
             # create equation of plane from four straight lines
 
             # create interpolate object f
-            p = np.array(
-                [
-                    [self.load_point_1.p, self.load_point_2.p],
-                    [self.load_point_3.p, self.load_point_4.p],
-                ]
-            )
+
             x = np.array(
                 [
-                    [self.load_point_1.x, self.load_point_2.x],
-                    [self.load_point_3.x, self.load_point_4.x],
+                    self.load_point_1.x,
+                    self.load_point_2.x,
+                    self.load_point_3.x,
+                    self.load_point_4.x,
                 ]
             )
             z = np.array(
                 [
-                    [self.load_point_1.z, self.load_point_2.z],
-                    [self.load_point_3.z, self.load_point_4.z],
+                    self.load_point_1.z,
+                    self.load_point_2.z,
+                    self.load_point_3.z,
+                    self.load_point_4.z,
                 ]
             )
-
-            # create function to get interpolation of p
-            self.patch_mag_interpolate = interpolate.interp2d(x, z, p)
-            mod_list = [ls for ls in self.point_list if ls is not None]
-            self.patch_min_dim = min(
+            p = np.array(
                 [
-                    get_distance(p1, p2)
-                    for (p1, p2) in zip(mod_list, mod_list[1:] + [mod_list[0]])
-                    if all([p1 is not None, p2 is not None])
+                    self.load_point_1.p,
+                    self.load_point_2.p,
+                    self.load_point_3.p,
+                    self.load_point_4.p,
                 ]
             )
+
         elif self.load_point_4 is None:
             # update line 3
             self.line_3 = LineLoading(
@@ -704,35 +701,28 @@ def _define_patch_edge_lines(self):
 
             # TODO create equation of plane from 3 points
             # create interpolate object f
-            p = np.array(
-                [
-                    [self.load_point_1.p, self.load_point_2.p],
-                    [self.load_point_3.p, self.load_point_4.p],
-                ]
-            )
             x = np.array(
                 [
-                    [self.load_point_1.x, self.load_point_2.x],
-                    [self.load_point_3.x, self.load_point_4.x],
+                    self.load_point_1.x,
+                    self.load_point_2.x,
+                    self.load_point_3.x,
                 ]
             )
             z = np.array(
                 [
-                    [self.load_point_1.z, self.load_point_2.z],
-                    [self.load_point_3.z, self.load_point_4.z],
+                    self.load_point_1.z,
+                    self.load_point_2.z,
+                    self.load_point_3.z,
                 ]
             )
-
-            # create function to get interpolation of p
-            self.patch_mag_interpolate = interpolate.interp2d(x, z, p)
-            mod_list = [ls for ls in self.point_list if ls is not None]
-            self.patch_min_dim = min(
+            p = np.array(
                 [
-                    get_distance(p1, p2)
-                    for (p1, p2) in zip(mod_list, mod_list[1:] + [mod_list[0]])
-                    if all([p1 is not None, p2 is not None])
+                    self.load_point_1.p,
+                    self.load_point_2.p,
+                    self.load_point_3.p,
                 ]
             )
+
         elif self.load_point_8 is not None:
             # TODO
             # point 1 2 3
@@ -745,6 +735,18 @@ def _define_patch_edge_lines(self):
             raise ValueError(
                 "Patch load points for patch load {} not valid".format(self.name)
             )
+        # create function to get interpolation of p
+        self.patch_mag_interpolate = interpolate.LinearNDInterpolator(
+            list(zip(x, z)), p
+        )
+        mod_list = [ls for ls in self.point_list if ls is not None]
+        self.patch_min_dim = min(
+            [
+                get_distance(p1, p2)
+                for (p1, p2) in zip(mod_list, mod_list[1:] + [mod_list[0]])
+                if all([p1 is not None, p2 is not None])
+            ]
+        )
 
 
 # ---------------------------------------------------------------------------------------------------------------

src/ospgrillage/members.py

@@ -9,6 +9,8 @@
 
 # if TYPE_CHECKING:
 #     from material import Material
+g = 9.81
+mm = 1e3
 
 
 def create_section(**kwargs):
@@ -233,7 +235,7 @@ def __init__(
             self.section_command_flag = False  #
 
             # determine mass from section area and material density
-            self.mass = self.section.A * self.material.density
+            self.mass = self.section.A * self.material.density * mm  # kg/mm
         elif any(
             [
                 self.section.op_ele_type == "ShellMITC4",
@@ -423,7 +425,7 @@ def get_element_command_str(
         ele_str = None
         if self.section.op_ele_type == "ElasticTimoshenkoBeam":
             section_input = self.get_member_prop_arguments(ele_width)
-            ele_str = 'ops.element("{type}", {tag}, *{node_tag_list}, *{memberprop}, {transftag}, {mass})\n'.format(
+            ele_str = 'ops.element("{type}", {tag}, *{node_tag_list}, *{memberprop}, {transftag},"-mass", {mass})\n'.format(
                 type=self.section.op_ele_type,
                 tag=ele_tag,
                 node_tag_list=node_tag_list,
@@ -433,7 +435,7 @@ def get_element_command_str(
             )
         elif self.section.op_ele_type == "elasticBeamColumn":
             section_input = self.get_member_prop_arguments(ele_width)
-            ele_str = 'ops.element("{type}", {tag}, *{node_tag_list}, *{memberprop}, {transftag}, {mass})\n'.format(
+            ele_str = 'ops.element("{type}", {tag}, *{node_tag_list}, *{memberprop}, {transftag}, "-mass", {mass})\n'.format(
                 type=self.section.op_ele_type,
                 tag=ele_tag,
                 node_tag_list=node_tag_list,
@@ -442,7 +444,7 @@ def get_element_command_str(
                 mass=self.mass,
             )
         elif self.section.op_ele_type == "nonlinearBeamColumn":
-            ele_str = 'ops.element("{type}",{tag},*{node_tag_list},{num_int_pt},{sectag},{transftag},{mass})\n'.format(
+            ele_str = 'ops.element("{type}",{tag},*{node_tag_list},{num_int_pt},{sectag},{transftag},"-mass", {mass})\n'.format(
                 type=self.section.op_ele_type,
                 tag=ele_tag,
                 node_tag_list=node_tag_list,

src/ospgrillage/mesh.py

@@ -7,7 +7,7 @@
 """
 import math
 
-from ospgrillage.static import *
+from ospgrillage.utils import *
 from collections import namedtuple
 
 
@@ -1486,7 +1486,7 @@ def _get_geo_transform_tag(self, ele_nodes: list, offset=None):
         node_i = self.node_spec[ele_nodes[0]]["coordinate"]
         node_j = self.node_spec[ele_nodes[1]]["coordinate"]
         vxz = self._get_vector_xz(node_i, node_j)
-        vxz = [np.round(num, decimals=self.decimal_lim) for num in vxz]
+        vxz = [np.round(num, decimals=self.decimal_lim).tolist() for num in vxz]
         tag_value = self.transform_dict.setdefault(
             repr(vxz) + "|" + repr(offset), self.transform_counter + 1
         )
@@ -2178,7 +2178,7 @@ def _get_geo_transform_tag(self, ele_nodes, offset=None):
                 global_offset_i = [a + b for a, b in zip(node_i, local_offset)]
                 global_offset_j = [a - b for a, b in zip(node_j, local_offset)]
             global_offset = [global_offset_i, global_offset_j]
-        vxz = [np.round(num, decimals=self.decimal_lim) for num in vxz]
+        vxz = [np.round(num, decimals=self.decimal_lim).tolist() for num in vxz]
         tag_value = self.transform_dict.setdefault(
             repr(vxz) + "|" + repr(global_offset), self.transform_counter + 1
         )