feat: initial otko import

examples/ex3_canti2d_elastic_element.py

@@ -0,0 +1,138 @@
+"""OpenSees Example 3. Cantilever Column with units: elastic build.
+
+This example follows the separated-build/analysis style of the Tcl
+tutorial. Here we package the elastic build variant together with the
+shared gravity, pushover, and uniform-earthquake analyses.
+"""
+
+from __future__ import annotations
+
+from pathlib import Path
+import math
+import sys
+
+if __package__ is None or __package__ == "":
+    sys.path.insert(0, str(Path(__file__).resolve().parents[1] / "src"))
+
+from otko.core import (  # noqa: E402
+    ElasticBeamColumn,
+    ElasticSection,
+    LinearTimeSeries,
+    NodalLoad,
+    Node,
+    PathTimeSeries,
+    PlainLoadPattern,
+    Project,
+    ProjectMeta,
+    PushoverCase,
+    StaticCase,
+    TransientCase,
+    UniformExcitationPattern,
+    UnitSystem,
+)
+from otko.services import load_project, save_project  # noqa: E402
+from otko.services.peer_record import parse_plain_values  # noqa: E402
+
+
+INCH = 1.0
+KIP = 1.0
+SEC = 1.0
+FT = 12.0 * INCH
+KSI = KIP / INCH**2
+PSI = KSI / 1000.0
+G_ACCEL = 32.2 * FT / SEC**2
+
+L_COL = 36.0 * FT
+WEIGHT = 2000.0 * KIP
+H_COL = 5.0 * FT
+B_COL = 5.0 * FT
+
+P_COL = WEIGHT
+MASS = P_COL / G_ACCEL
+A_COL = B_COL * H_COL
+IZ_COL = (1.0 / 12.0) * B_COL * H_COL**3
+FC = -4.0 * KSI
+E_C = 57.0 * KSI * math.sqrt(-FC / PSI)
+
+N_GRAVITY = 10
+GRAVITY_STEP = 1.0 / N_GRAVITY
+PUSH_TARGET = 0.05 * L_COL
+PUSH_STEP = 0.001 * L_COL
+H_LOAD = WEIGHT
+
+GROUND_DT = 0.01
+GROUND_FACTOR = 1.0
+ANALYSIS_DT = 0.01
+ANALYSIS_STEPS = 1000
+DAMPING_RATIO = 0.02
+
+_ROOT = Path(__file__).resolve().parent
+GROUND_MOTION_FILE = _ROOT / "data" / "BM68elc.acc"
+REFERENCE_BUILD_TCL = _ROOT / "data" / "Ex3.Canti2D.build.ElasticElement.tcl.txt"
+REFERENCE_PUSH_TCL = _ROOT / "data" / "Ex3.Canti2D.analyze.Static.Push.tcl.txt"
+REFERENCE_EQ_TCL = _ROOT / "data" / "Ex3.Canti2D.analyze.Dynamic.EQ.Uniform.tcl.txt"
+
+
+def _ground_motion_values() -> list[float]:
+    return parse_plain_values(GROUND_MOTION_FILE)
+
+
+def build_ex3_canti2d_elastic_element() -> Project:
+    values = _ground_motion_values()
+    return Project(
+        meta=ProjectMeta(
+            name="OpenSees Ex 3 - Cantilever (Elastic Build)",
+            author="OpenSees Wiki / Silvia Mazzoni & Frank McKenna",
+            description=(
+                "Example 3 elastic cantilever build with unit-scaled geometry "
+                "and shared push / uniform-EQ analysis files."
+            ),
+            units=UnitSystem.US_IN_KIP,
+        ),
+        ndm=2,
+        ndf=3,
+        nodes=[
+            Node(id=1, name="Base", coords=(0.0, 0.0, 0.0), restraint=(True, True, False, False, False, True)),
+            Node(id=2, name="Top", coords=(0.0, L_COL, 0.0), mass=(MASS, 1.0e-9, 0.0, 0.0, 0.0, 0.0)),
+        ],
+        sections=[
+            ElasticSection(id=1, name="Elastic-Column", E=E_C, A=A_COL, Iz=IZ_COL, Iy=IZ_COL, G=1.0, J=1.0),
+        ],
+        elements=[
+            ElasticBeamColumn(id=1, name="Column", nodes=(1, 2), section_id=1, geom_transf="Linear"),
+        ],
+        time_series=[
+            LinearTimeSeries(id=1, name="Gravity"),
+            LinearTimeSeries(id=200, name="Lateral"),
+            PathTimeSeries(id=400, name="BM68elc", dt=GROUND_DT, factor=GROUND_FACTOR, values=values, file_path=str(GROUND_MOTION_FILE.name)),
+        ],
+        load_patterns=[
+            PlainLoadPattern(id=1, name="Gravity", time_series_id=1, nodal_loads=[NodalLoad(node_id=2, forces=(0.0, -P_COL, 0.0, 0.0, 0.0, 0.0))]),
+            PlainLoadPattern(id=200, name="Pushover-X", time_series_id=200, nodal_loads=[NodalLoad(node_id=2, forces=(H_LOAD, 0.0, 0.0, 0.0, 0.0, 0.0))]),
+            UniformExcitationPattern(id=400, name="GroundMotion-X", direction=1, accel_series_id=400),
+        ],
+        analyses=[
+            StaticCase(id=1, name="Gravity", pattern_ids=[1], n_steps=N_GRAVITY, load_factor_increment=GRAVITY_STEP, system="BandGeneral", constraints="Plain", integrator="LoadControl", algorithm="Newton", test="NormDispIncr", tolerance=1e-8, max_iter=6),
+            PushoverCase(id=2, name="Push", preload_case_ids=[1], pattern_ids=[200], control_node=2, control_dof=1, target_disp=PUSH_TARGET, step_size=PUSH_STEP, base_nodes=[1], system="BandGeneral", constraints="Plain", algorithm="Newton", test="EnergyIncr", tolerance=1e-8, max_iter=6),
+            TransientCase(id=3, name="Earthquake", preload_case_ids=[1], pattern_ids=[400], dt=ANALYSIS_DT, n_steps=ANALYSIS_STEPS, system="SparseGeneral", constraints="Transformation", integrator="Newmark", integrator_params=(0.5, 0.25), algorithm="ModifiedNewton", test="EnergyIncr", tolerance=1e-8, max_iter=10, rayleigh_mode1_damping=DAMPING_RATIO),
+        ],
+    )
+
+
+def main() -> None:
+    project = build_ex3_canti2d_elastic_element()
+    project.validate_references()
+    print(f"Built '{project.meta.name}'")
+    print(f"  Build Tcl: {REFERENCE_BUILD_TCL.name}")
+    print(f"  Analysis Tcls: {REFERENCE_PUSH_TCL.name}, {REFERENCE_EQ_TCL.name}")
+    out_path = Path(__file__).with_suffix(".osmodel")
+    save_project(project, out_path)
+    print(f"Saved -> {out_path}")
+    restored = load_project(out_path)
+    restored.validate_references()
+    assert restored.model_dump(by_alias=True) == project.model_dump(by_alias=True)
+    print("Round-trip OK.")
+
+
+if __name__ == "__main__":
+    main()