OpenSeesMatlabVis¤

Open an interactive GUI for the current OpenSees model.

plotModelGUI collects model information from the current OpenSees model and opens a small control panel around plotter.PlotModel. The GUI toggles common PlotModel options and redraws the same axes.

1
2
3
4

app = vis.plotModelGUI()
app = vis.plotModelGUI(opts=opts)
app = vis.plotModelGUI(watchFile=true)
app = vis.plotModelGUI(watchFile="modelData_1.hdf5")

Input arguments:

• opts (struct) –

  Initial visualization options passed to plotter.PlotModelGUI.

• watchFile (char or string) –

  false disables watching. true watches the caller file. A text value watches that path.

• reloadFcn (function handle) –

  Function returning a fresh modelInfo struct after watchFile changes. If omitted, PlotModelGUI tries to read .hdf5/.h5, .mat, or .json modelInfo files directly.

• pollInterval (double) –

  File polling interval in seconds. Default is 1.0.

Output arguments:

• app ( struct ) –

  GUI handles and helper callbacks. Use app.getOptions() to read the current PlotModel option struct.

Open an interactive GUI for eigen mode visualization.

plotEigenGUI collects model information from the current OpenSees model and opens a control panel around plotter.PlotEigen. The GUI lets users switch mode tags and common PlotEigen options.

1
2

app = vis.plotEigenGUI(eigenData)
app = vis.plotEigenGUI(eigenData, opts=opts)

Input arguments:

• eigenData (struct) –

  Eigenvalue analysis results, typically returned by opsmat.post.getEigenData.

• opts (struct) –

  Initial visualization options passed to plotter.PlotEigenGUI.

Output arguments:

• app ( struct ) –

  GUI handles and helper callbacks. Use app.getOptions() to read the current PlotEigen option struct.

Open an interactive GUI for nodal response visualization.

1
2
3

app = vis.plotNodalResponseGUI(nodeRespData)
app = vis.plotNodalResponseGUI(nodeRespData, opts=opts)
app = vis.plotNodalResponseGUI(nodeRespData, respType="disp", respComponent="magnitude")

Input arguments:

• nodeRespData (struct) –

  Nodal response data, typically obtained from opsmat.post.getNodalResponse(odbTag).

• respType (string) –

  Initial response field. Default is "disp".

• respComponent (string) –

  Initial response component. Default is "magnitude".

• stepIdx (integer or string) –

  Initial step selector. Use a 0-based integer, "absMax", "absMin", "Max", or "Min".

• opts (struct) –

  Initial visualization options passed to plotter.PlotNodalRespGUI.

Open an interactive GUI for frame element response diagrams.

plotFrameResponseGUI displays frame response data with controls for response type, component, step selection, style, scaling, colours, labels, and common performance options.

1
2
3

app = vis.plotFrameResponseGUI(respData)
app = vis.plotFrameResponseGUI(respData, opts=opts)
app = vis.plotFrameResponseGUI(respData, stepIdx=0)

Input arguments:

• respData (struct) –

  Frame response data, typically obtained from opsmat.post.getElementResponse(odbTag, eleType="Frame").

• opts (struct) –

  Initial visualization options passed to plotter.PlotFrameRespGUI.

• stepIdx (integer or string) –

  Initial step selector. Use a 0-based integer, "absMax", "absMin", "Max", or "Min".

Output arguments:

• app ( struct ) –

  GUI handles and helper callbacks. Use app.getOptions() to read the current PlotFrameResp option struct.

Open an interactive GUI for shell element response visualization.

1
2
3

app = vis.plotShellResponseGUI(respData)
app = vis.plotShellResponseGUI(respData, opts=opts)
app = vis.plotShellResponseGUI(respData, respType="StressAtGP", respComponent="sxx")

Open an interactive GUI for plane or solid continuum response visualization.

1
2
3

app = vis.plotContinuumResponseGUI(respData)
app = vis.plotContinuumResponseGUI(respData, eleType="Solid")
app = vis.plotContinuumResponseGUI(respData, respType="StressAtGP", respComponent="sxx")

Visualize the current OpenSees model.

plotModel collects model information from the current OpenSees model through obj.parent.post.getModelData and renders the model geometry using plotter.PlotModel.

1
2
3
4

h = vis.plotModel()
h = vis.plotModel(opts=opts)
h = vis.plotModel(ax=ax)
h = vis.plotModel(opts=opts, ax=ax)

Input arguments:

• opts (struct) –

  Visualization options passed to plotter.PlotModel. Start from vis.defaultPlotModelOptions when you want to customize the default model-plot appearance.

• ax (matlab.graphics.axis.Axes) –

  Target axes. If omitted or empty, a new figure/axes is created by the underlying plotter.

Output arguments:

• h ( array of graphics objects ) –

  Handles to the created graphics objects.

1
2
3
4
5
6
7
8

opsmat = OpenSeesMatlab();
% Build model with opsmat.opensees...
h = opsmat.vis.plotModel();

opts = opsmat.vis.defaultPlotModelOptions;
figure;
ax = axes();
h = opsmat.vis.plotModel(opts=opts, ax=ax);

Visualize one mode shape from eigenvalue analysis results.

eigenData is usually collected with opsmat.post.getEigenData or loaded from a file generated by opsmat.post.saveEigenData.

1
2
3
4

h = vis.plotEigen(modeTag, eigenData)
h = vis.plotEigen(modeTag, eigenData, opts=opts)
h = vis.plotEigen(modeTag, eigenData, ax=ax)
h = vis.plotEigen(modeTag, eigenData, opts=opts, ax=ax)

Input arguments:

• modeTag (integer) –

  Mode number to visualize. For example, modeTag=1 plots the first mode shape.

• eigenData (struct) –

  Eigenvalue analysis results, typically returned by opsmat.post.getEigenData.

• opts (struct) –

  Visualization options passed to plotter.PlotEigen. Start from vis.defaultPlotEigenOptions for customization.

• ax (matlab.graphics.axis.Axes) –

  Target axes. If omitted or empty, a new figure/axes is created.

Output arguments:

• h ( array of graphics objects ) –

  Handles to the created graphics objects.

1
2
3
4
5
6

eigenData = opsmat.post.getEigenData(numModes=3);
h = opsmat.vis.plotEigen(1, eigenData);

opts = opsmat.vis.defaultPlotEigenOptions;
opts.deform.scale = 10;
h = opsmat.vis.plotEigen(2, eigenData, opts=opts);

Visualize nodal response data at a selected analysis step.

plotNodalResponse renders nodal scalar or vector response fields such as displacement, velocity, acceleration, reaction, Rayleigh force, or pressure. The model information is loaded from the ODB referenced by nodeRespData.odbTag.

1
2
3
4
5

vis.plotNodalResponse(nodeRespData)
vis.plotNodalResponse(nodeRespData, respType=respType)
vis.plotNodalResponse(nodeRespData, respComponent=component)
vis.plotNodalResponse(nodeRespData, stepIdx=stepIdx)
vis.plotNodalResponse(nodeRespData, opts=opts, ax=ax)

Input arguments:

• nodeRespData (struct) –

  Nodal response data, typically obtained from opsmat.post.getNodalResponse(odbTag). The struct must include an odbTag field so the corresponding model information can be loaded.

• respType (string) –

  Response type to visualize. Default is "disp". Common values include "disp", "vel", "accel", "reaction", "reactionIncInertia", "rayleighForces", and "pressure". Custom fields in nodeRespData are also accepted.

• respComponent (string) –

  Response component to visualize. Default is "magnitude". For vector responses, common values include "ux", "uy", "uz", "rx", "ry", "rz", and "magnitude". For custom fields, use a name in nodeRespData.(respType).dofs or a Layout-C subfield name. Scalar custom fields may use any label for the colorbar.

• stepIdx (integer or string) –

  Analysis step selector. Default is "absMax".

  • "absMax": step with the maximum absolute response.
  • "absMin": step with the minimum absolute response.
  • "Max": step with the maximum response.
  • "Min": step with the minimum response.
  • integer: explicit step index.
• opts (struct) –

  Visualization options passed to plotter.PlotNodalResp. Start from vis.defaultPlotNodalResponseOptions for customization.

• ax (matlab.graphics.axis.Axes) –

  Target axes. If omitted or empty, a new figure/axes is created.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

% Scalar:
nodeRespData.MyScalar = [nStep x nNode]

% Vector with component list:
nodeRespData.MyVector.data = [nStep x nNode x nComp]
nodeRespData.MyVector.dofs = {'c1','c2',...}

% Layout-C:
nodeRespData.MyLayoutC.c1 = [nStep x nNode]
nodeRespData.MyLayoutC.c2 = [nStep x nNode]

% Optional node tags:
nodeRespData.nodeTags = [nNode x 1]
nodeRespData.MyVector.nodeTags = [nNode x 1]

1
2
3
4
5
6

nodeRespData = opsmat.post.getNodalResponse("MyODB");
opsmat.vis.plotNodalResponse(nodeRespData);
opsmat.vis.plotNodalResponse(nodeRespData, ...
    respType="disp", ...
    respComponent="magnitude", ...
    stepIdx="absMax");

Visualize deformed model geometry from nodal displacement data.

plotDeformation is a convenience wrapper around the nodal response plotter. It enables deformation display, uses displacement data from nodeRespData, and allows direct control of deformation color, interpolation, scale factor, and undeformed-shape visibility.

1
2
3
4

vis.plotDeformation(nodeRespData)
vis.plotDeformation(nodeRespData, scaleFactor=scale)
vis.plotDeformation(nodeRespData, showUndeformed=tf)
vis.plotDeformation(nodeRespData, ax=ax)

Input arguments:

• nodeRespData (struct) –

  Nodal response data containing displacement information, typically obtained from opsmat.post.getNodalResponse(odbTag). The struct must include an odbTag field.

• stepIdx (integer or string) –

  Analysis step selector. Default is "absMax". Supported string selectors include "absMax", "absMin", "Max", and "Min".

• color (char or string) –

  Solid color used for the deformed shape. Default is "blue".

• useInterpolation (logical) –

  Whether to use interpolation for smoother visualized deformation. Default is true.

• scaleFactor (double) –

  Deformation scale factor. Default is 1.0.

• showUndeformed (logical) –

  Whether to show the undeformed model together with the deformed shape. Default is false.

• ax (matlab.graphics.axis.Axes) –

  Target axes. If omitted or empty, a new figure/axes is created.

1
2
3
4
5
6
7

nodeRespData = opsmat.post.getNodalResponse("MyODB");
opsmat.vis.plotDeformation(nodeRespData, ...
    stepIdx="absMax", ...
    color="red", ...
    useInterpolation=true, ...
    scaleFactor=20, ...
    showUndeformed=true);

Visualize frame element response at a selected analysis step.

plotFrameResponse displays frame-element result fields such as section forces, section deformations, basic forces, basic deformations, local forces, and plastic deformation. The response data is typically collected from an ODB through the post-processing interface.

1

vis.plotFrameResponse(respData, respType=respType, respComponent=component, stepIdx=stepIdx, opts=opts, ax=ax)

Input arguments:

• respData (struct) –

  Frame response data containing element response information, typically obtained from opsmat.post.getElementResponse(odbTag, eleType="Frame").

• respType (string, optional. The type of response to visualize. Default is "sectionForces". Common options include) –
  • 'sectionForces'
  • 'sectionDeformations'
  • 'basicForces'
  • 'basicDeformations'
  • 'localForces'
  • 'plasticDeformation'
  • Any custom field in respData.
• respComponent (string, optional. The component of the response to visualize. Default is "MZ". Common options include) –
  • For 'sectionForces' and 'sectionDeformations', components include 'N','MZ','VY','MY','VZ','T'.
  • For 'basicForces', 'basicDeformations' and 'plasticDeformation', components include 'N','MZ','MY','T'.
  • For 'localForces', components include 'FX','FY','MZ' in 2D and 'FX','FY','FZ','MX','MY','MZ' in 3D.
  • For custom fields, use a name listed in respData.(respType).dofs or a Layout-C subfield name. Scalar custom fields may use any label for the colorbar.
• responseLocation (string) –

  Controls where values are placed along each frame element.

  • "" or "auto": Built-in responses use fixed rules:
  • sectionForces, sectionDeformations -> "section"
  • basicForces, basicDeformations, localForces, plasticDeformation -> "element"
  • "section": Values are interpreted as section/sample-point values and are placed using recorded sectionLocs. Use this for arrays such as [nStep x nEle x nSec] or [nStep x nEle x nSec x nComp].
  • "element": Values are placed uniformly along each element. A scalar is drawn as an element-constant diagram; two values are placed at element locations [0,1]. Use this for local/basic/end values.
• stepIdx (integer or 'absMax') –
  • The index of the analysis step to visualize. Default is "absMax".
  • If "absMax", the step with the maximum absolute response will be visualized.
  • If "absMin", the step with the minimum absolute response will be visualized.
  • If "Max", the step with the maximum response will be visualized.
  • If "Min", the step with the minimum response will be visualized.
  • If an integer, the step with the specified index will be visualized.

  For large response histories, passing a numeric step index is faster than using "absMax", "absMin", "Max", or "Min", because those string selectors scan all analysis steps to find the requested peak step.

• opts (struct) –

  Visualization options. Use vis.defaultPlotFrameResponseOptions to get default options.

• ax (matlab.graphics.axis.Axes) –

  Target axes. If omitted, a new figure/axes will be created.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

% Element scalar, element-constant diagram:
respData.MyScalar = [nStep x nEle]
responseLocation="element"

% Element vector with component list:
respData.MyVector.data = [nStep x nEle x nComp]
respData.MyVector.dofs = {'c1','c2',...}
responseLocation="element"

% End-pair labels such as {'c1I','c1J'} or {'c11','c12'} 
% can be plotted by passing respComponent="c1"; the two end values
% are drawn at element locations [0,1]. A single matching
% component is drawn as an element constant.

% Section-style vector, section/sample-point diagram:
respData.MySection.data = [nStep x nEle x nSec x nComp]
respData.MySection.dofs = {'c1','c2',...}
responseLocation="section"

% Layout-C:
respData.MyLayoutC.c1 = [nStep x nEle]
responseLocation="element"
respData.MyLayoutC.c1 = [nStep x nEle x nSec]
responseLocation="section"

% For custom fields, set responseLocation explicitly when the
% same data shape could mean either element or section values.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

opts = opsmat.vis.defaultPlotFrameResponseOptions;
opts.showMaxMinLabel = "none";
opts.performance.fastMode = true;
opts.performance.maxSectionsPerElement = 12;
opts.surf.show = false;
opts.cbar.show = false;
opts.color.useColormap = false;

opsmat.vis.plotFrameResponse(frameRespData, ...
    respType="sectionForces", ...
    respComponent="MZ", ...
    stepIdx=0, ...  % numeric step index is faster than "absMax"
    opts=opts);

Visualize Shell element response for a specific step.

1
2
3
4

plotShellResponse(respData)
plotShellResponse(respData, respType="StressAtGP", ...
    respComponent="sxx", fiberPoint="top", ...
    stepIdx="absMax", ax=ax, opts=opts)

Input arguments:

• respData (struct) –

  Shell element response data. Typically obtained from post.getElementResponse(odbTag, eleType="Shell").

• respType (string, optional (default "SecForceAtGP")) –
  • "SecForceAtGP" | "SecDefoAtGP" | "SecForceAtNode" | "SecDefoAtNode"
  • "StressAtGP" | "StrainAtGP" | "StressAtNode" | "StrainAtNode"
  • Any custom EleResp field name. Names containing "AtNode" are node-based; all other custom names are element-based.
• respComponent (string, optional (default "mxx")) –
  • Section responses : "fxx" "fyy" "fxy" "mxx" "myy" "mxy" "vxz" "vyz"
  • Stress / Strain : "sxx" "syy" "sxy" "syz" "sxz" | "exx" "eyy" "exy" "eyz" "exz"
  • For custom fields, a name listed in EleResp.(respType).dofs or a numeric subfield EleResp.(respType).(respComponent).
• responseLocation (string) –

  Controls how the response rows are interpreted.

  • "" or "auto": Infer from respType. Names containing "AtNode" are nodal; names containing "AtGP" are Gauss-point/element responses. Custom names without either token are treated as element data.

  • "node": Response rows are nodes. Use [nStep x nNode] scalar data or [nStep x nNode x nComp] vector data.

  • "gp": Response rows are elements with a Gauss-point dimension. Gauss-point values are averaged per element before plotting.

  • "element": Response rows are already element-level values. If the data still contains a GP dimension, opts.surf.gpReduce controls the reduction.

• fiberPoint (string or integer, optional (default "top")) –

  Through-thickness location for stress/strain responses. "top" | "bottom" | "middle" or 1-based integer fiber index. Also applies to custom data with a fiber dimension:

  1 2 3 4

  EleResp.MyVector.data = [nStep x nEle x nGP x nFiber x nComp] EleResp.MyVectorAtNode.data = [nStep x nNode x nFiber x nComp] EleResp.MyLayoutC.c1 = [nStep x nEle x nGP x nFiber] EleResp.MyLayoutCAtNode.c1 = [nStep x nNode x nFiber]

• stepIdx (integer or string, optional (default "absMax")) –

  "absMax" | "absMin" | "Max" | "Min" | integer step index.

• opts (struct) –

  Visualisation options. Obtain defaults via plotter.PlotUnstruResponse.defaultOptions().

• ax (matlab.graphics.axis.Axes) –

  Target axes. A new figure is created when omitted.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

% Element scalar:
EleResp.MyScalar = [nStep x nEle]
responseLocation="element"

% Node scalar:
EleResp.MyScalarAtNode = [nStep x nNode]
responseLocation="node"

% Element vector:
EleResp.MyVector.data = [nStep x nEle x nComp]
EleResp.MyVector.dofs = {'c1','c2',...}
responseLocation="element"

% Node vector:
EleResp.MyVectorAtNode.data = [nStep x nNode x nComp]
EleResp.MyVectorAtNode.dofs = {'c1','c2',...}
responseLocation="node"

% Element Layout-C:
EleResp.MyLayoutC.c1 = [nStep x nEle]
responseLocation="element"
EleResp.MyLayoutC.c1 = [nStep x nEle x nGP]
responseLocation="gp"
EleResp.MyLayoutC.c1 = [nStep x nEle x nGP x nFiber]
responseLocation="gp"

% Node Layout-C:
EleResp.MyLayoutCAtNode.c1 = [nStep x nNode]
responseLocation="node"
EleResp.MyLayoutCAtNode.c1 = [nStep x nNode x nFiber]
responseLocation="node"

Visualize Plane or Solid continuum element response for a step.

1
2
3

plotContinuumResponse(respData, eleType="Solid", ...
    respType="StressAtGP", respComponent="sigmavm", ...
    stepIdx="absMax", ax=ax, opts=opts)

Input arguments:

• respData (struct) –

  Continuum element response data. Typically obtained from post.getElementResponse(odbTag, eleType="Plane") or post.getElementResponse(odbTag, eleType="Solid").

• respType (string, optional (default "StressAtGP")) –
  • "StressAtGP" | "StressAtNode" | "StrainAtGP" | "StrainAtNode"
  • "StressMeasureAtGP" | "StressMeasureAtNode"
  • Any custom EleResp field name. Element-based custom fields should normally use a name without "AtNode"; node-based custom fields should include "AtNode" in the field name.
• respComponent (string, optional (default "sxx")) –
  • Plane stress : "sxx" "syy" "sxy" "szz"
  • Solid stress : "sxx" "syy" "szz" "sxy" "syz" "sxz"
  • Plane strain : "exx" "eyy" "exy"
  • Solid strain : "exx" "eyy" "ezz" "exy" "eyz" "exz"
  • Measures : "sigmaOct" "tauOct" "tauMax" "vonMises" "p1" "p2" "p3"
  • For custom fields, a name listed in EleResp.(respType).dofs or a numeric subfield EleResp.(respType).(respComponent). Scalar custom fields may use any label for the colorbar.
  • Layout-C custom fields use subfield names as components, so respComponent="c1" reads EleResp.(respType).c1.
• responseLocation (string) –

  Controls how the response rows are interpreted.

  • "" or "auto": Infer from respType. Names containing "AtNode" are nodal; names containing "AtGP" are Gauss-point/element responses. Custom names without either token are treated as element data.

  • "node": Response rows are nodes. Use [nStep x nNode] scalar data or [nStep x nNode x nComp] vector data.

  • "gp": Response rows are elements with a Gauss-point dimension. Gauss-point values are averaged per element before plotting.

  • "element": Response rows are already element-level values. If the data still contains a GP dimension, opts.surf.gpReduce controls the reduction.

• stepIdx (integer or string, optional (default "absMax")) –

  "absmax" | "absmin" | "max" | "min" | 0-based integer step index.

• opts (struct) –

  Visualisation options. Obtain defaults via plotter.PlotUnstruResponse.defaultOptions().

• ax (matlab.graphics.axis.Axes) –

  Target axes. A new figure is created when omitted.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

% The field name decides whether custom data is element- or
% node-based. Names containing "AtNode" are node-based; all other
% custom names are element-based.

% Element scalar:
EleResp.MyScalar = [nStep x nEle]
responseLocation="element"

% Node scalar:
EleResp.MyScalarAtNode = [nStep x nNode]
responseLocation="node"

% Element vector with component list:
EleResp.MyVector.data = [nStep x nEle x nComp]
EleResp.MyVector.dofs = {'c1','c2',...}
responseLocation="element"

% Node vector with component list:
EleResp.MyVectorAtNode.data = [nStep x nNode x nComp]
EleResp.MyVectorAtNode.dofs = {'c1','c2',...}
responseLocation="node"

% Element Layout-C:
EleResp.MyLayoutC.c1 = [nStep x nEle]
responseLocation="element"
EleResp.MyLayoutC.c1 = [nStep x nEle x nGP]
responseLocation="gp"

% Node Layout-C:
EleResp.MyLayoutCAtNode.c1 = [nStep x nNode]
responseLocation="node"