opstool package index

opstool.vis module

class opstool.vis.FiberSecVis(ele_tag: int, sec_tag: int, results_dir: str = 'opstool_output', line_width: float = 0.75, line_color: str = 'k', colormap: str = 'viridis', opacity: float = 0.75)

Bases: object

A class to vis the fiber section in OpenSeesPy.

Parameters

ele_tag: int

The element tag to which the section is to be displayed.

sec_tag: int

Which integration point section is displayed, tag from 1 from segment i to j.

results_dir: str, default=”opstool_output”

The dir that results saved.

line_width: float, default = 0.75

The line width of mesh edges.

line_color: str, default = “k”

The color of mesh edges.

colormap: str, default = “jet”

Color map used to display the response.

opacity: float, default=0.75

Transparency of mesh.

Returns

FiberSecVis instance.

animation(output_file: str, input_file: str = 'FiberRespStepData-1.hdf5', show_variable: str = 'strain', show_mats: Optional[Union[int, list[int], tuple[int]]] = None, framerate: int = 24)

fiber section response animation.

Parameters

output_file: str

The output file name, must end with .gif.

input_file: str, default=’FiberRespStepData-1.hdf5’

The file name that fiber section responses saved.

show_variable: str, default=’strain

Response type to display, optional “stress” or “strain”.

show_mats: Union[int, list[int], tuple[int]], default=None

Mat tag to dispaly. If None, all tags will display.

framerate: int, default=24

The number of frames per second.

Returns

None

resp_vis(input_file: str = 'FiberRespStepData-1.hdf5', step: Optional[int] = None, show_variable: str = 'strain', show_mats: Optional[Union[int, list[int], tuple[int]]] = None)

fiber section response vis.

Parameters

input_file: str, default=’FiberRespStepData-1.hdf5’

The file name that fiber section responses saved.

step: int, default = None

Analysis step to display. If None, the step that max response; If -1, the final step; Else, the other step.

show_variable: str, default = ‘srain’

Response type to display, optional “stress” or “strain”.

show_mats: Union[int, list[int], tuple[int]]

matTags to dispaly. matTag is the material tag defined in openseespy, bu it must in the section. If None, all tags will display.

Returns

None

sec_vis(input_file: str = 'FiberData.hdf5', mat_color: Optional[dict] = None)

plot the fiber section.

Parameters

input_file: str, default=’FiberData.hdf5’

The file name that fiber section data saved.

Warning

Be careful not to include any path, only filename, the file will be saved to the directory results_dir.

mat_color: dict

Dict for assign color by matTag, {matTag1:color1,matTag2:color2, and so on} matTag is the material tag defined in openseespy, bu it must in the section.

Returns

None

class opstool.vis.GetFEMdata(results_dir: str = 'opstool_output')

Bases: object

Get the data in the openseespy model domain.

Parameters

results_dir: str, default=”opstool_output”

The dir that results saved.

get_eigen_data(mode_tag: int = 1, solver: str = '-genBandArpack', save_file: str = 'EigenData.hdf5')

Get eigenvalue Analysis Data. The data will saved to file results_dir + save_file.

Parameters

mode_tag: int

mode tag.

solver: str, default ‘-genBandArpack’

type of solver, optional ‘-genBandArpack’, ‘-fullGenLapack’, see https://openseespydoc.readthedocs.io/en/latest/src/eigen.html.

save_file: str, default=’EigenData.hdf5’

The file name that data saved. If None of False, the data will not be saved.

Warning

Be careful not to include any path, only filename, the file will be saved to the directory results_dir.

Returns

None

get_fiber_data(ele_sec: list[tuple[int, int]], save_file: str = 'FiberData.hdf5')

Get data from the section assigned by parameter ele_sec.

Parameters

ele_sec: list[tuple[int, int]]

A list or tuple composed of element tag and sectag. e.g., [(ele1, sec1), (ele2, sec2), … , (elen, secn)], The section is attached to an element in the order from end i to end j of that element.

save_file: str, default=’FiberData.hdf5’

The file name that data saved. If None of False, the data will not be saved.

Warning

Be careful not to include any path, only filename, the file will be saved to the directory results_dir.

Returns

None

get_fiber_resp_step(num_steps: int = 100000000000, total_time: float = 100000000000, stop_cond: bool = False, save_file: str = 'FiberRespStepData-1.hdf5')

Get analysis step data for fiber section.

Parameters

num_steps: int, default=100000000000

Total number of steps, set to determine when to save data.

total_time: float, default=100000000000

Total analysis time, set to determine when to save data. You can specify one of the parameters num_steps and total_time. If both are used, it depends on which one arrives first.

stop_cond: bool, default = False

Condition used to determine when data is saved if num_steps and total_time unavailable. For example, stop_cond = ops.nodeDisp(nodeTag, 1) >= 0.1, i.e., once the displacement of node with tag nodeTag and dof 1 is greater than 0.1, the loop is terminated to save the data.

save_file: str, default=’FiberRespStepData-1.hdf5’

The file name that data saved. If None of False, the data will not be saved.

Warning

Be careful not to include any path, only filename, the file will be saved to the directory results_dir. You need to specify different suffixes to distinguish between the different analysis cases. Such as “FiberRespStepData-1.hdf5”, “FiberRespStepData-2.hdf5”, etc.

Returns

None

get_frame_resp_step(num_steps: int = 100000000000, total_time: float = 100000000000, stop_cond: bool = False, save_file: str = 'BeamRespStepData-1.hdf5')

Get the response data step by step. .. note:

You need to call this function at each analysis step in OpenSees.
The advantage is that you can modify the iterative algorithm at
each analysis step to facilitate convergence.

Parameters

num_steps: int, default=100000000000

Total number of steps, set to determine when to save data.

total_time: float, default=100000000000

Total analysis time, set to determine when to save data. You can specify one of the parameters num_steps and total_time. If both are used, it depends on which one arrives first.

stop_cond: bool, default = False

Condition used to determine when data is saved if num_steps and total_time unavailable. For example, stop_cond = ops.nodeDisp(nodeTag, 1) >= 0.1, i.e., once the displacement of node with tag nodeTag and dof 1 is greater than 0.1, the loop is terminated to save the data.

save_file: str, default=’BeamRespStepData-1.hdf5’

The file name that data saved. If None of False, the data will not be saved.

Warning

Be careful not to include any path, only filename, the file will be saved to the directory results_dir. You need to specify different suffixes to distinguish between the different analysis cases. Such as “BeamRespStepData-1.hdf5”, “BeamRespStepData-2.hdf5”, etc.

Returns

None

get_model_data(save_file: Union[str, bool] = 'ModelData.hdf5')

Get data from the current model domain. The data will saved to file results_dir + save_file.

Parameters

save_file: str, default=”ModelData.hdf5”

The file name that data saved. If None of False, the data will not be saved.

Warning

Be careful not to include any path, only filename, the file will be saved to the directory results_dir.

get_node_resp_step(num_steps: int = 100000000000, total_time: float = 100000000000, stop_cond: bool = False, save_file: str = 'NodeRespStepData-1.hdf5', model_update: bool = False)

Get the node response data step by step.

Note

You need to call this function at each analysis step in OpenSees. The advantage is that you can modify the iterative algorithm at each analysis step to facilitate convergence.

Parameters

num_steps: int, default=100000000000

Total number of steps, set to determine when to save data.

total_time: float, default=100000000000

Total analysis time, set to determine when to save data. You can specify one of the parameters num_steps and total_time. If both are used, it depends on which one arrives first.

stop_cond: bool, default = False

Condition used to determine when data is saved if num_steps and total_time unavailable. For example, stop_cond = ops.nodeDisp(nodeTag, 1) >= 0.1, i.e., once the displacement of node with tag nodeTag and dof 1 is greater than 0.1, the loop is terminated to save the data.

save_file: str, default=’NodeRespStepData-1.hdf5’

The file name that data saved. If None of False, the data will not be saved.

Warning

Be careful not to include any path, only filename, the file will be saved to the directory results_dir. You need to specify different suffixes to distinguish between the different analysis cases. Such as “NodeRespStepData-1.hdf5”, “NodeRespStepData-2.hdf5”, etc.

model_update: bool, default False

whether to update the model domain data at each analysis step, this will be useful if model data has changed. For example, some elements and nodes were removed.

Returns

None

reset_eigen_state()

Reset the state of results extract of eigen data.

reset_model_state()

Reset the state of results extract of model data.

reset_steps_state()

Reset the state of results extract in analysis step.

Important

As the data is saved in the loop analysis using the list append method, it is important to clear the data from previous analysis case before each analysis loop.

class opstool.vis.OpsVisPlotly(point_size: float = 5, line_width: float = 5, colors_dict: Optional[dict] = None, theme: str = 'plotly', color_map: str = 'jet', on_notebook: bool = False, results_dir: str = 'opstool_output')

Bases: object

A class to visualize OpenSeesPy model based on plotly.

Parameters

point_size: float

The render size of node.

line_width: float

The width of line element;

colors_dict: dict,

default: dict(point=’#840000’, line=’#0165fc’, face=’#06c2ac’, solid=’#f48924’, truss=”#7552cc”, link=”#00c16e”) The dict for ele color.

theme: str, default=plotly

Plot theme, optional “plotly”, “plotly_white”, “plotly_dark”, “ggplot2”, “seaborn”, “simple_white”, “none”.

color_map: str, default=”jet”

color map to display the cloud plot. Optional, [‘aggrnyl’, ‘agsunset’, ‘algae’, ‘amp’, ‘armyrose’, ‘balance’, ‘blackbody’, ‘bluered’, ‘blues’, ‘blugrn’, ‘bluyl’, ‘brbg’, ‘brwnyl’, ‘bugn’, ‘bupu’, ‘burg’, ‘burgyl’, ‘cividis’, ‘curl’, ‘darkmint’, ‘deep’, ‘delta’, ‘dense’, ‘earth’, ‘edge’, ‘electric’, ‘emrld’, ‘fall’, ‘geyser’, ‘gnbu’, ‘gray’, ‘greens’, ‘greys’, ‘haline’, ‘hot’, ‘hsv’, ‘ice’, ‘icefire’, ‘inferno’, ‘jet’, ‘magenta’, ‘magma’, ‘matter’, ‘mint’, ‘mrybm’, ‘mygbm’, ‘oranges’, ‘orrd’, ‘oryel’, ‘oxy’, ‘peach’, ‘phase’, ‘picnic’, ‘pinkyl’, ‘piyg’, ‘plasma’, ‘plotly3’, ‘portland’, ‘prgn’, ‘pubu’, ‘pubugn’, ‘puor’, ‘purd’, ‘purp’, ‘purples’, ‘purpor’, ‘rainbow’, ‘rdbu’, ‘rdgy’, ‘rdpu’, ‘rdylbu’, ‘rdylgn’, ‘redor’, ‘reds’, ‘solar’, ‘spectral’, ‘speed’, ‘sunset’, ‘sunsetdark’, ‘teal’, ‘tealgrn’, ‘tealrose’, ‘tempo’, ‘temps’, ‘thermal’, ‘tropic’, ‘turbid’, ‘turbo’, ‘twilight’, ‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].

on_notebook: bool, default=False

Whether work in a jupyter notebook.

results_dir: str, default=”opstool_output”

The dir that results saved.

Returns

None

deform_anim(input_file: str = 'NodeRespStepData-1.hdf5', response: str = 'disp', alpha: Optional[float] = None, show_outline: bool = False, opacity: float = 1, framerate: int = 24, show_face_line: bool = True, save_html: str = 'DefoAnimation', model_update: bool = False)

Deformation animation of the model.

Parameters

input_file: str, default = “NodeRespStepData-1.hdf5”,

The filename that node responses data saved by opstool.vis.GetFEMdata.get_node_resp_step().

Warning

Be careful not to include any path, only filename, the file will be saved to the directory results_dir.

response: str, default=’disp’

Response type. Optional, “disp”, “vel”, “accel”.

alpha: float, default=None

Scaling factor, the default value is 1/5 of the model boundary according to the maximum deformation.

show_outline: bool, default=False

Whether to display the axes.

show_face_line: bool, default=True

If True, the edges of plate and solid elements will be displayed.

framerate: int, default=24

The number of frames per second.

opacity: float, default=1.0

Plane and solid element transparency.

save_html: str, default=’DefoAnimation.html’

The html file name to output. If False, the html file will not be generated.

Returns

None

deform_vis(input_file: str = 'NodeRespStepData-1.hdf5', slider: bool = False, response: str = 'disp', alpha: Optional[float] = None, show_outline: bool = False, show_origin: bool = False, show_face_line: bool = True, opacity: float = 1, save_html: str = 'DefoVis', model_update: bool = False)

Visualize the deformation of the model at a certain analysis step.

Parameters

input_file: str, default = “NodeRespStepData-1.hdf5”,

The filename that node responses data saved by opstool.vis.GetFEMdata.get_node_resp_step().

Warning

Be careful not to include any path, only filename, the file will be saved to the directory results_dir.

slider: bool, default=False

If True, responses in all steps will display by slider style. If False, the step that max response will display.

response: str, default=’disp’

Response type. Optional, “disp”, “vel”, “accel”.

alpha: float, default=None

Scaling factor, the default value is 1/5 of the model boundary according to the maximum deformation.

show_outline: bool, default=False

Whether to display the axes.

show_origin: bool, default=False

Whether to show undeformed shape.

show_face_line: bool, default=True

If True, the edges of plate and solid elements will be displayed.

opacity: float, default=1.0

Plane and solid element transparency.

save_html: str, default=’DefoVis.html’

The html file name to output. If False, the html file will not be generated.

Returns

None

eigen_anim(mode_tag: int = 1, input_file: str = 'EigenData.hdf5', alpha: Optional[float] = None, show_outline: bool = False, opacity: float = 1, framerate: int = 3, show_face_line: bool = True, save_html: str = 'EigenAnimation')

Animation of Modal Analysis.

Parameters

mode_tag: int

The mode tag.

input_file: str, default = ‘EigenData.hdf5’,

The filename that eigen data saved by opstool.vis.GetFEMdata.get_eigen_data().

Warning

Be careful not to include any path, only filename, the file will be saved to the directory results_dir.

alpha: float, default=None

Scaling factor, the default value is 1/5 of the model boundary according to the maximum deformation.

show_outline: bool, default=False

Whether to display the axes.

opacity: float, default=1.0

Plane and solid element transparency.

framerate: int

The number of frames per second.

show_face_line: bool, default=True

If True, the edges of plate and solid elements will be displayed.

save_html: str, default=’EigenAnimation.html’

The html file name to output. If False, the html file will not be generated.

Returns

None

eigen_vis(mode_tags: list[int], input_file: str = 'EigenData.hdf5', subplots: bool = False, alpha: Optional[float] = None, show_outline: bool = False, show_origin: bool = False, opacity: float = 1.0, show_face_line: bool = True, save_html: str = 'EigenVis')

Eigenvalue Analysis Visualization.

Parameters

mode_tags: list[int], or tuple[int]

Mode tags to be shown, if list or tuple [mode1, mode2], display the multiple modes from mode1 to mode2.

input_file: str, default = ‘EigenData.hdf5’,

The filename that eigen data saved by opstool.vis.GetFEMdata.get_eigen_data().

Warning

Be careful not to include any path, only filename, the file will be saved to the directory results_dir.

subplots: bool, default=False

If True, subplots in a figure. If False, plot in a slide style.

alpha: float, default=None

Model scaling factor, the default value is 1/5 of the model boundary according to the maximum deformation.

show_outline: bool, default=True

Whether to display the axes.

show_origin: bool, default=False

Whether to show undeformed shape.

opacity: float, default=1.0

Plane and solid element transparency.

show_face_line: bool, default=True

If True, the edges of plate and solid elements will be displayed.

save_html: str, default=’EigenVis.html’

The html file name to output. If False, the html file will not be generated.

Returns

None

frame_resp_vis(input_file: str = 'BeamRespStepData-1.hdf5', ele_tags: Optional[list[int]] = None, slider: bool = False, response: str = 'Mz', show_values=True, alpha: Optional[float] = None, opacity: float = 1, save_html: str = 'FrameRespVis')

Display the force response of frame elements.

Parameters

input_file: str, default = “BeamRespStepData-1.hdf5”,

The filename that beam frame elements responses data saved by opstool.vis.GetFEMdata.get_frame_resp_step().

Warning

Be careful not to include any path, only filename, the file will be saved to the directory results_dir.

ele_tags: int or list[int], default=None

Element tags to display, if None, all frame elements will display.

slider: bool, default=False

If True, responses in all steps will display by slider style. If False, the step that max response will display.

response: str, default=’Mz’

Response type. Optional, “Fx”, “Fy”, “Fz”, “My”, “Mz”, “Mx”.

show_values: bool, default=True

If True, will show the response values.

alpha: float, default=None

Scaling factor.

opacity: float, default=1.0

Plane and solid element transparency.

save_html: str, default=’FrameRespVis.html’

The html file name to output. If False, the html file will not be generated.

model_vis(input_file: str = 'ModelData.hdf5', show_node_label: bool = False, show_ele_label: bool = False, show_local_crd: bool = False, label_size: float = 8, show_outline: bool = True, opacity: float = 1.0, save_html: str = 'ModelVis.html')

Visualize the model in the current domain.

Parameters

input_file: str, default = “ModelData.hdf5”,

The filename that model data saved by opstool.vis.GetFEMdata.get_model_data().

Warning

Be careful not to include any path, only filename, the file will be saved to the directory results_dir.

show_node_label: bool, default=False

Whether to display the node label.

show_ele_label: bool, default=False

Whether to display the ele label.

show_local_crd: bool, default=False

Whether to display the local coordinate system.

label_size: float, default=8

The foontsize of node and ele label.

show_outline: bool, default=True

Whether to show the axis frame.

opacity: float, default=1.0

Plane and solid element transparency.

save_html: str, default=’ModelVis.html’

The html file name to output. If False, the html file will not be generated.

Returns

None

class opstool.vis.OpsVisPyvista(point_size: float = 1, line_width: float = 3, colors_dict: Optional[dict] = None, theme: str = 'document', color_map: str = 'jet', on_notebook: bool = False, results_dir: str = 'opstool_output')

Bases: object

A class to visualize OpenSeesPy model based on pyvista.

Parameters

point_size: float, default=1

The render size of node.

line_width: float, default=3

The width of line element.

colors_dict: dict,

default: dict(point=’#840000’, line=’#0165fc’, face=’#06c2ac’, solid=’#f48924’, truss=”#7552cc”, link=”#00c16e”) The dict for ele color.

theme: str, default=’document’

Plot theme for pyvista, optional ‘default’, ‘paraview’, ‘document’, ‘dark’.

color_map: str, default=”jet”

color map to display the cloud plot for pyvista. optional ‘jet’, ‘rainbow’, ‘hot’, ‘afmhot’, ‘copper’, ‘winter’, ‘cool’, ‘coolwarm’, ‘gist_earth’, ‘bone’, ‘binary’, ‘gray’, or any Matplotlib colormap .

on_notebook: bool, default=False

Whether work in a notebook.

results_dir: str, default=”opstool_output”

The dir that results saved.

Returns

None

deform_anim(input_file: str = 'NodeRespStepData-1.hdf5', response: str = 'disp', alpha: Optional[float] = None, show_outline: bool = False, opacity: float = 1, framerate: int = 24, show_face_line: bool = True, save_fig: str = 'DefoAnimation.gif', model_update: bool = False)

Deformation animation of the model.

Parameters

input_file: str, default = “NodeRespStepData-1.hdf5”,

The filename that node responses data saved by opstool.vis.GetFEMdata.get_node_resp_step().

Warning

Be careful not to include any path, only filename, the file will be saved to the directory results_dir.

response: str, default=’disp’

Response type. Optional, “disp”, “vel”, “accel”.

alpha: float, default=None

Scaling factor, the default value is 1/5 of the model boundary according to the maximum deformation.

show_outline: bool, default=False

Whether to display the axes.

show_face_line: bool, default=True

If True, the edges of plate and solid elements will be displayed.

framerate: int, default=24

The number of frames per second.

opacity: float, default=1.0

Plane and solid element transparency.

save_fig: str, default=’DefoAnimation.gif’

The output file name, must end with .gif or .mp4. You can export to any folder, such as “C:mydir/myfile.gif”, but the folder mydir must exist.

model_update: bool, default False

whether to update the model domain data at each analysis step, this will be useful if model data has changed. For example, some elements and nodes were removed. This parameter must same as that in opstool.vis.GetFEMdata.get_node_resp_step().

Returns

None

deform_vis(input_file: str = 'NodeRespStepData-1.hdf5', slider: bool = False, response: str = 'disp', alpha: Optional[float] = None, show_outline: bool = False, show_origin: bool = False, show_face_line: bool = True, opacity: float = 1, save_fig: str = 'DefoVis.svg', model_update: bool = False)

Visualize the deformation of the model at a certain analysis step.

Parameters

input_file: str, default = “NodeRespStepData-1.hdf5”,

The filename that node responses data saved by opstool.vis.GetFEMdata.get_node_resp_step().

Warning

Be careful not to include any path, only filename, the file will be saved to the directory results_dir.

slider: bool, default=False

If True, responses in all steps will display by slider style. If False, the step that max response will display.

response: str, default=’disp’

Response type. Optional, “disp”, “vel”, “accel”.

alpha: float, default=None

Scaling factor, the default value is 1/5 of the model boundary according to the maximum deformation.

show_outline: bool, default=False

Whether to display the axes.

show_origin: bool, default=False

Whether to show undeformed shape.

show_face_line: bool, default=True

If True, the edges of plate and solid elements will be displayed.

opacity: float, default=1.0

Plane and solid element transparency.

save_fig: str, default=’DefoVis.svg’

The file name to output. If False or None, the file will not be generated. The supported formats are:

• ‘.svg’

• ‘.eps’

• ‘.ps’

• ‘.pdf’

• ‘.tex’

model_update: bool, default False

whether to update the model domain data at each analysis step, this will be useful if model data has changed. For example, some elements and nodes were removed. This parameter must same as that in opstool.vis.GetFEMdata.get_node_resp_step().

Returns

None

eigen_anim(mode_tag: int = 1, input_file: str = 'EigenData.hdf5', alpha: Optional[float] = None, show_outline: bool = False, opacity: float = 1, framerate: int = 3, show_face_line: bool = True, save_fig: str = 'EigenAnimation.gif')

Animation of Modal Analysis.

Parameters

mode_tag: int

The mode tag.

input_file: str, default = ‘EigenData.hdf5’,

The filename that eigen data saved by opstool.vis.GetFEMdata.get_eigen_data().

Warning

Be careful not to include any path, only filename, the file will be saved to the directory results_dir.

alpha: float, default=None

Scaling factor, the default value is 1/5 of the model boundary according to the maximum deformation.

show_outline: bool, default=False

Whether to display the axes.

opacity: float, default=1.0

Plane and solid element transparency.

framerate: int

The number of frames per second.

show_face_line: bool, default=True

If True, the edges of plate and solid elements will be displayed.

save_fig: str, default=’EigenAnimation.gif’

The output file name, must end with .gif or .mp4. You can export to any folder, such as “C:mydir/myfile.gif”, but the folder mydir must exist.

Returns

None

eigen_vis(mode_tags: list[int], input_file: str = 'EigenData.hdf5', subplots: bool = False, alpha: Optional[float] = None, show_outline: bool = False, show_origin: bool = False, opacity: float = 1.0, show_face_line: bool = True, save_fig: str = 'EigenVis.svg')

Eigenvalue Analysis Visualization.

Parameters

mode_tags: list[int], or tuple[int]

Mode tags to be shown, if list or tuple [mode1, mode2], display the multiple modes from mode1 to mode2.

input_file: str, default = ‘EigenData.hdf5’,

The filename that eigen data saved by opstool.vis.GetFEMdata.get_eigen_data().

Warning

Be careful not to include any path, only filename, the file will be saved to the directory results_dir.

subplots: bool, default=False

If True, subplots in a figure. If False, plot in a slider style.

alpha: float, default=None

Model scaling factor, the default value is 1/5 of the model boundary according to the maximum deformation.

show_outline: bool, default=True

Whether to display the axes.

show_origin: bool, default=False

Whether to show undeformed shape.

opacity: float, default=1.0

Plane and solid element transparency.

show_face_line: bool, default=True

If True, the edges of plate and solid elements will be displayed.

save_fig: str, default=’EigenVis.svg’

The file name to output. If False or None, the file will not be generated. The supported formats are:

• ‘.svg’

• ‘.eps’

• ‘.ps’

• ‘.pdf’

• ‘.tex’

Returns

None

frame_resp_vis(input_file: str = 'BeamRespStepData-1.hdf5', ele_tags: Optional[list[int]] = None, slider: bool = False, response: str = 'Mz', show_values=True, alpha: Optional[float] = None, opacity: float = 1, save_fig: str = 'FrameRespVis.svg')

Display the force response of frame elements.

Parameters

input_file: str, default = “BeamRespStepData-1.hdf5”,

The filename that beam frame elements responses data saved by opstool.vis.GetFEMdata.get_frame_resp_step().

Warning

Be careful not to include any path, only filename, the file will be saved to the directory results_dir.

ele_tags: int or list[int], default=None

Element tags to display, if None, all frame elements will display.

slider: bool, default=False

If True, responses in all steps will display by slider style. If False, the step that max response will display.

response: str, default=’Mz’

Response type. Optional, “Fx”, “Fy”, “Fz”, “My”, “Mz”, “Mx”.

show_values: bool, default=True

If True, will show the response values.

alpha: float, default=None

Scaling factor.

opacity: float, default=1.0

Plane and solid element transparency.

save_fig: str, default=’FrameRespVis.svg’

The file name to output. If False or None, the file will not be generated. The supported formats are:

• ‘.svg’

• ‘.eps’

• ‘.ps’

• ‘.pdf’

• ‘.tex’

Returns

None

model_vis(input_file: str = 'ModelData.hdf5', show_node_label: bool = False, show_ele_label: bool = False, show_local_crd: bool = False, label_size: float = 8, show_outline: bool = True, opacity: float = 1.0, save_fig: str = 'ModelVis.svg')

Visualize the model in the current domain.

Parameters

input_file: str, default = “ModelData.hdf5”,

The filename that model data saved by opstool.vis.GetFEMdata.get_model_data().

Warning

Be careful not to include any path, only filename, the file will be saved to the directory results_dir.

show_node_label: bool, default=False

Whether to display the node label.

show_ele_label: bool, default=False

Whether to display the ele label.

show_local_crd: bool, default=False

Whether to display the local coordinate system.

label_size: float, default=8

The foontsize of node and ele label.

show_outline: bool, default=True

Whether to show the axis frame.

opacity: float, default=1.0

Plane and solid element transparency.

save_fig: str, default=’ModelVis.svg’

The file name to output. If False or None, the file will not be generated. The supported formats are:

• ‘.svg’

• ‘.eps’

• ‘.ps’

• ‘.pdf’

• ‘.tex’

Returns

None

opstool.preprocessing module

class opstool.preprocessing.Rebars

Bases: object

A class to create the rebar point.

add_rebar_circle(xo: list[float, float], radius: float, dia: float, gap: float, angle1=0.0, angle2=360, matTag: Optional[int] = None, color: str = 'black', group_name: Optional[str] = None)

Add the rebars along a circle.

Parameters

xolist[float, float]

Center coords, [(xc, yc)].

radius: float

radius.

diafloat

rebar dia.

angle1float

The start angle, degree

angle2float

The end angle, deree

gapfloat

Rebar space

matTagint

OpenSees mat Tag for rebar previously defined.

colorstr or rgb tuple.

Color to plot rebar.

group_namestr

Assign rebar group name.

Returns

None

add_rebar_line(points: list[list[float, float]], dia: float, gap: float, closure: bool = False, matTag: Optional[int] = None, color: str = 'black', group_name: Optional[str] = None)

Add rebar along a line, can be a line or polygon.

Parameters

pointslist[list[float, float]]

A list of rebar coords, [(x1, y1), (x2, y2),…,(xn, yn)]

diafloat

Rebar dia.

gapfloat

Rebar space.

closure: bool, default=False

If True, the rebar line is a closed loop.

matTagint

OpenSees mat Tag for rebar previously defined.

colorstr or rgb tuple.

Color to plot rebar.

group_namestr

Assign rebar group name

Returns

None

class opstool.preprocessing.SecMesh(sec_name: str = 'My Section')

Bases: object

A class to mesh the cross-section with triangular fibers.

Parameters

sec_namestr

Assign a name to the section

Returns

None

Examples

>>> outlines = [[0, 0], [-0.5, 1], [1.5, 1], [1, 0]]
>>> outlines2 = offset(outlines, d=0.05)
>>> holes1 = [[0.2, 0.2], [0.4, 0.2], [0.4, 0.4], [0.2, 0.4]]
>>> holes2 = [[0.6, 0.2], [0.8, 0.2], [0.8, 0.5], [0.6, 0.5]]
>>> cover = add_polygon(outlines, holes=[outlines2])
>>> core = add_polygon(outlines2, holes=[holes1, holes2])
>>> # create section obj
>>> sec = SecMesh(sec_name="My Section")
>>> sec.assign_group(dict(cover=cover, core=core))
>>> sec.assign_mesh_size(dict(cover=0.001, core=0.005))
>>> sec.assign_ops_matTag(dict(cover=1, core=2))
>>> sec.mesh()
>>> # create rebars data
>>> rebar_lines1 = offset(outlines, d=0.05 + 0.032 / 2)
>>> rebar_lines2 = [[0.2, 0.2], [0.8, 0.8]]
>>> rebars = Rebars()
>>> rebars.add_rebar_line(points=rebar_lines1, dia=0.032, gap=0.1, color="red", matTag=3)
>>> rebars.add_rebar_line(points=rebar_lines2, dia=0.020, gap=0.1, color="black", matTag=3)
>>> sec.add_rebars(rebars)
>>> # get section properties
>>> sec.get_sec_props(plot_centroids=False)
>>> sec.centring()
>>> # sec.rotate(45)
>>> sec.to_file("mysec.py", secTag=1, GJ=10000)
>>> sec.view()

add_rebars(rebars_obj)

Add rebars.

Parameters

rebars_objmesh obj

The instance of Rebars class.

Returns

None

assign_group(group: dict[str, any])

Assign the group dict for each mesh.

Parameters

groupdict

A dict of name as key, mesh obj as value.

Returns

instance

assign_group_color(colors)

Assign the color dict to plot the section.

Parameters

colorsdict[str, str]

A dict of name as key, color as value.

assign_mesh_size(mesh_size: dict[str, float])

Assign the mesh size dict for each mesh.

Parameters

mesh_sizedict[str, float]

A dict of name as key, mesh size as value.

Returns

instance

assign_ops_matTag(mat_tag: dict[str, int])

Assign the mesh size dict for each mesh.

Parameters

mat_tagdict[str, int]

A dict of name as key, opensees matTag previous defined as value.

Returns

instance

centring()

Move the section centroid to (0, 0).

Returns

None

get_fiber_data()

Return fiber data.

Returns

Tuple(dict, dict)

fiber center dict, fiber area dict

get_sec_props(Eref: float = 1.0, display_results: bool = False, plot_centroids: bool = False)

Solving Section Geometry Properties by Finite Element Method, by sectionproperties pacakge.

Parameters

Eref: float, default=1.0

Reference modulus of elasticity, it is important to analyze the composite section. See sectionproperties doc

display_resultsbool, default=True

whether to display the results.

plot_centroidsbool, default=False

whether to plot centroids

Returns

sec_props: dict

section props dict, including:

• Cross-sectional area (A)

• Shear area (Asy, Asz)

• Elastic centroid (centroid)

• Second moments of area about the centroidal axis (Iy, Iz, Iyz)

• Torsion constant (J)

• Principal axis angle (phi)

• ratio of reinforcement (rho_rebar)

• Effective Material Properties (Effective elastic modulus: E_eff; Effective shear modulus: G_eff; Effective Poisson’s ratio: Nu_eff)

If materials are specified for the cross-section, the area, second moments of area and torsion constant are elastic modulus weighted.

mesh()

Mesh the section.

Returns

None

opspy_cmds(secTag: int, GJ: float)

Generate openseespy fiber section command.

Parameters

secTagint

The section tag assigned in OpenSees.

GJfloat

Torsion stiffness.

Returns

None

rotate(theta: float = 0)

Rotate the section clockwise.

Parameters

thetafloat, default=0

Rotation angle, unit: degree.

Returns

None

to_file(output_path: str, secTag: int, GJ: float)

Output the opensees fiber code to file.

Parameters

output_pathstr

The filepath to save, e.g., r”my_dir/my_section.py”

secTagint

The section tag assigned in OpenSees.

GJfloat

Torsion stiffness.

Returns

None

Notes

Notes that output_path must be endswith .py or .tcl, function will create the file by a right style.

view(fill: bool = True, engine: str = 'plotly', save_html: str = 'SecMesh.html', on_notebook: bool = False)

Display the section mesh.

Parameters

fillbool, default=True

Whether to fill the trangles.

engine: str, default=’plotly’

Plot engine, optional “plotly” or “matplotlib”.

save_html: str, default=”SecMesh.html”

If set, the figure will save as a html file, only useful for engine=”plotly”. If False or None, this parameter will be ignored.

on_notebook: bool, default=False

If True, the figure will display in a notebook.

Returns

None

opstool.preprocessing.add_circle(xo: list[float, float], radius: float, holes=None, angle1=0.0, angle2=360, n_sub=40, material=None)

Add the circle geom obj.

Parameters

xolist[float, float]

Center coords, [(xc, yc)].

radius: float

radius.

holes: list[list[list[float, float]]].

Hole of the section, a list of multiple hole coords, [hole1, hole2,…holeN], holeN=[(x1, y1), (x2, y2),…,(xn, yn)].

angle1float

The start angle, degree

angle2float

The end angle, deree

n_sub: int

The partition number of the perimeter.

material: material obj

The instance from add_material().

Returns

None

opstool.preprocessing.add_material(name='default', elastic_modulus=1, poissons_ratio=0, yield_strength=1, density=1, color='w')

Add a meterial.

Parameters

namestr, default=’default’

meterial name.

elastic_modulusfloat, default==1

elastic_modulus.

poissons_ratiofloat, default=0

poissons_ratio

yield_strengthfloat, default==1

yield_strength

densityfloat, default=1

density

colorstr or rgb tuple, default==’w’

color for plot this material.

Returns

Material instance

opstool.preprocessing.add_polygon(outline: list[list[float, float]], holes: Optional[list[list[list[float, float]]]] = None, material=None)

Add polygon plane geom obj.

Parameters

outlinelist[list[float, float]]

The coords list of polygon points, [(x1, y1), (x2, y2),…,(xn, yn)]

holes: list[list[list[float, float]]].

Hole of the section, a list of multiple hole coords, [hole1, hole2,…holeN], holeN=[(x1, y1), (x2, y2),…,(xn, yn)].

material: material obj

The instance from add_material().

Returns

polygon obj

opstool.preprocessing.gen_grav_load(ts_tag: int, pattern_tag: int, direction: str = 'Z', factor: float = -9.81)

Applying the gravity loads.

Notes

The mass values are from nodeMass(nodeTag) command, i.e., ones set in mass() command.

Parameters

ts_tag: int

The timeSeries tag you must assign.

pattern_tag: int

The pattern tag you must assign.

direction: str, default=”Z”

The gravity load direction.

factor: float, default=-9.81

The factor applied to the mass values, it should be the multiplication of gravitational acceleration and directional indicators, e.g., -9.81, where 9.81 is the gravitational acceleration and -1 indicates along the negative Z axis. Of course, it can be multiplied by an additional factor to account for additional constant loads, e.g., 1.05 * (-9.81).

Returns

None

opstool.preprocessing.offset(points: list[list[float, float]], d: float)

Offsets closed polygons

Parameters

pointslist[list[float, float]]

A list containing the coordinate points, [(x1, y1),(x2, y2),…,(xn.yn)].

dfloat

Offsets closed polygons, positive values offset inwards, negative values outwards.

Returns

coords: list[[float, float]]

opstool.preprocessing.tcl2py(input_file: str, output_file: str, prefix: str = 'ops')

Convert tcl code of opensees to openseespy code.

Tip

• This function will flatten your tcl code, including loops, judgments, assignments, proc, etc.

• Do not use assignment statements for openseens commands, such as set ok [analyze 1], set lambdaN [eigen 10], it will trigger an error!

• It is recommended to remove analysis related tcl code and keep only commands such as model building and load definition to avoid possible exceptions. The analysis-related python code you can add manually, although this function provides the ability to convert the analysis tcl code.

Parameters

input_filestr

The name of input .tcl file.

output_filestr

The name of output .py file.

prefixstr, optional

Prefix name of openseespy, by default ops. i.e., import openseespy.opensees as ops. If None or void str ‘’, the prefix is not used. i.e., from openseespy.opensees import *.

opstool module contents

opstool.load_ops_examples(name: str)

load the examples.

Parameters:

name: str,

Optional, “ArchBridge”, “ArchBridge2”, “CableStayedBridge”, “Dam”, “Frame3D”, “Igloo”, “Pier”, “SuspensionBridge”, “SDOF”, “DamBreak”,

Returns:

None