OpenSeesMatlab

OpenSeesMatlab

Bases: handle

OpenSeesMatlab Main MATLAB interface for OpenSees.

OpenSeesMatlab is the top-level entry point of this toolbox. It creates and connects the OpenSees command interface, pre-processing utilities, analysis helpers, post-processing tools, visualization tools, and general utilities around an OpenSees MATLAB MEX module.

The OpenSees commands are accessed through the opensees property:

  opsmat = OpenSeesMatlab();
  ops = opsmat.opensees;

Command syntax follows OpenSeesPy/OpenSees command conventions as closely as possible. For command-level details, refer to:

OpenSeesPy: https://openseespydoc.readthedocs.io/en/latest/index.html

OpenSees : https://opensees.github.io/OpenSeesDocumentation/

Syntax

  opsmat = OpenSeesMatlab()
  opsmat = OpenSeesMatlab(mexName=name)
  opsmat = OpenSeesMatlab(mexDir=dir)
  opsmat = OpenSeesMatlab(mexName=name, mexDir=dir)

Properties:

Name	Type	Description
opensees	_Ax3g3L8eYwTuflGUg	OpenSees command wrapper. Use this object to call OpenSees commands such as wipe, model, node, element, system, numberer, constraints, integrator, algorithm, analysis, analyze, recorder, and related APIs.
pre	_EME3kqP0ATvayfHC	Pre-processing utilities, including section-geometry recording, unit-system utilities, mesh import helpers, mass/matrix utilities, and load transformation helpers.
anlys	_wb28mcyOTcmPZHU0DuEoV	Analysis utilities. Includes smartAnalyze for robust transient/static analysis with retries, algorithm switching, step splitting, and progress reporting.
post	_Eqy30AMdXvgrQOtbN	Post-processing utilities for collecting model information, eigen data, and response data, and for saving/loading output databases.
vis	_PAk6E4OxNRY373ur	Visualization utilities for model geometry, mode shapes, deformations, nodal responses, frame responses, shell responses, and continuum responses.
utils	_oDYhum65ehwPLv6o6	General helper tools, including example-model loading.

Example

  opsmat = OpenSeesMatlab();
  ops = opsmat.opensees;

  ops.wipe();
  ops.model('basic', '-ndm', 2, '-ndf', 3);
  ops.node(1, 0.0, 0.0);
  ops.node(2, 5.0, 0.0);
  ops.fix(1, 1, 1, 1);
  ops.fix(2, 0, 1, 0);

  % Define materials, sections, elements, loads, and analysis commands.
  % The calls follow OpenSees/OpenSeesPy-style command arguments.
  % ops.uniaxialMaterial(...);
  % ops.element(...);
  % ops.timeSeries(...);
  % ops.pattern(...);

  modelInfo = opsmat.post.getModelData();
  h = opsmat.vis.plotModel();

opensees SetAccess=private

opensees: ops.OpenSeesMatlabCmds

OpenSees command interface.

post SetAccess=private

post: post.OpenSeesMatlabPost

Post-processing interface.

vis SetAccess=private

vis: plotter.OpenSeesMatlabVis

Visualization interface.

pre SetAccess=private

pre: pre.OpenSeesMatlabPre

Pre-processing interface.

anlys SetAccess=private

anlys: analysis.OpenSeesMatlabAnalysis

Analysis management interface.

utils SetAccess=private

utils: utils.OpenSeesMatlabTool

General utility interface.

OpenSeesMatlab

(mexName='OpenSeesMATLAB', mexDir='derived/')

Construct the main OpenSeesMatlab interface.

The constructor creates the OpenSees command wrapper first, then initializes visualization, post-processing, utility, analysis, and pre-processing helper objects that share the same parent interface.

Syntax

  opsmat = OpenSeesMatlab()
  opsmat = OpenSeesMatlab(mexName=name)
  opsmat = OpenSeesMatlab(mexDir=dir)
  opsmat = OpenSeesMatlab(mexName=name, mexDir=dir)

Input arguments:

Name	Type	Description	Default
mexName	string or char	Name of the OpenSees MATLAB MEX module. Default is 'OpenSeesMATLAB'.	required
mexDir	string or char	Directory containing the OpenSees MATLAB MEX module. Relative paths are resolved by OpenSeesMatlabBase relative to this class location when possible. Default is 'derived/'.	required

Example

  opsmat = OpenSeesMatlab();
  ops = opsmat.opensees;

  opsmatCustom = OpenSeesMatlab( ...
      mexName="OpenSeesMATLAB", ...
      mexDir="derived/");