PlotModeShape for python

Silvia-s-Brainery · Nov 10, 2023 · 1ee97f5 · 1ee97f5
1 parent 06a3e8d
commit 1ee97f5
Show file tree

Hide file tree

Showing 57 changed files with 10,396 additions and 12 deletions.
diff --git a/docs/Python_Version/index.html b/docs/Python_Version/index.html
@@ -412,9 +412,27 @@
 <li class="toctree-l2"><a class="reference internal" href="plotdefo/RetainedConstrained.html">show_constrained and not_show_retained_list and constrained_size Options</a></li>
 </ul>
 </li>
-<li class="toctree-l1"><a class="reference internal" href="plotmodeshape.html">PlotModeShape Command (Plot mode shape)</a></li>
+<li class="toctree-l1 has-children"><a class="reference internal" href="plotmodeshape.html">PlotModeShape Command (Plot mode shape)</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-3"><i class="fa-solid fa-chevron-down"></i></label><ul>
+<li class="toctree-l2"><a class="reference internal" href="plotmodeshape/modenumber.html">mode_number Option</a></li>
+<li class="toctree-l2"><a class="reference internal" href="plotmodeshape/rounddigits.html">round_digit Option</a></li>
+<li class="toctree-l2"><a class="reference internal" href="plotmodeshape/scalefactor.html">scale_factor Option</a></li>
+<li class="toctree-l2"><a class="reference internal" href="plotmodeshape/drawwire.html">draw_wire_shadow Option</a></li>
+<li class="toctree-l2"><a class="reference internal" href="plotmodeshape/draw_nodes.html">draw_nodes Option</a></li>
+<li class="toctree-l2"><a class="reference internal" href="plotmodeshape/show_nodes_tag.html">show_nodes_tag Option</a></li>
+<li class="toctree-l2"><a class="reference internal" href="plotmodeshape/show_elemens_tag.html">show_elemens_tag Option</a></li>
+<li class="toctree-l2"><a class="reference internal" href="plotmodeshape/onhover.html">onhover_message Option</a></li>
+<li class="toctree-l2"><a class="reference internal" href="plotmodeshape/title.html">title Option</a></li>
+<li class="toctree-l2"><a class="reference internal" href="plotmodeshape/widthheight.html">fig_width and fig_height Options</a></li>
+<li class="toctree-l2"><a class="reference internal" href="plotmodeshape/eledata.html">elements_data_tag and elements_data Options</a></li>
+<li class="toctree-l2"><a class="reference internal" href="plotmodeshape/nodedata.html">nodes_data_tag and nodes_data Options</a></li>
+<li class="toctree-l2"><a class="reference internal" href="plotmodeshape/imagetypename.html">image_type and image_filename Options</a></li>
+<li class="toctree-l2"><a class="reference internal" href="plotmodeshape/legends.html">plot_legends Option</a></li>
+<li class="toctree-l2"><a class="reference internal" href="plotmodeshape/verticalaxis.html">vertical_axis Option</a></li>
+<li class="toctree-l2"><a class="reference internal" href="plotmodeshape/RetainedConstrained.html">show_constrained and not_show_retained_list and constrained_size Options</a></li>
+</ul>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="realtime.html">RealTimeObj Command (Plot at Each desired Time Step)</a></li>
-<li class="toctree-l1 has-children"><a class="reference internal" href="plotanime.html">PlotAnime Command (Plot Animation)</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-3"><i class="fa-solid fa-chevron-down"></i></label><ul>
+<li class="toctree-l1 has-children"><a class="reference internal" href="plotanime.html">PlotAnime Command (Plot Animation)</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-4"><i class="fa-solid fa-chevron-down"></i></label><ul>
 <li class="toctree-l2"><a class="reference internal" href="plotanime/scalefactor.html">scale_factor Option</a></li>
 <li class="toctree-l2"><a class="reference internal" href="plotanime/drawwire.html">draw_wire_shadow Option</a></li>
 <li class="toctree-l2"><a class="reference internal" href="plotanime/draw_nodes.html">draw_nodes Option</a></li>
@@ -434,7 +452,7 @@
 <li class="toctree-l2"><a class="reference internal" href="plotanime/record.html">Record() Command</a></li>
 </ul>
 </li>
-<li class="toctree-l1 has-children"><a class="reference internal" href="plotanimegif.html">PlotAnimeGif command (Create Animation in gif format)</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-4"><i class="fa-solid fa-chevron-down"></i></label><ul>
+<li class="toctree-l1 has-children"><a class="reference internal" href="plotanimegif.html">PlotAnimeGif command (Create Animation in gif format)</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-5"><i class="fa-solid fa-chevron-down"></i></label><ul>
 <li class="toctree-l2"><a class="reference internal" href="plotanimegif/scalefactor.html">scale_factor Option</a></li>
 <li class="toctree-l2"><a class="reference internal" href="plotanimegif/drawwire.html">draw_wire_shadow Option</a></li>
 <li class="toctree-l2"><a class="reference internal" href="plotanimegif/draw_nodes.html">draw_nodes Option</a></li>

diff --git a/docs/Python_Version/plotmodeshape.html b/docs/Python_Version/plotmodeshape.html
@@ -45,7 +45,7 @@
     <link rel="icon" href="../_static/BraineryWizico.ico"/>
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
-    <link rel="next" title="RealTimeObj Command (Plot at Each desired Time Step)" href="realtime.html" />
+    <link rel="next" title="mode_number Option" href="plotmodeshape/modenumber.html" />
     <link rel="prev" title="show_constrained and not_show_retained_list and constrained_size Options" href="plotdefo/RetainedConstrained.html" />
   <meta name="viewport" content="width=device-width, initial-scale=1"/>
   <meta name="docsearch:language" content="en"/>
@@ -412,11 +412,27 @@
 <li class="toctree-l2"><a class="reference internal" href="plotdefo/RetainedConstrained.html">show_constrained and not_show_retained_list and constrained_size Options</a></li>
 </ul>
 </li>
-<li class="toctree-l1 current active"><a class="current reference internal" href="#">PlotModeShape Command (Plot mode shape)</a></li>
+<li class="toctree-l1 current active has-children"><a class="current reference internal" href="#">PlotModeShape Command (Plot mode shape)</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-3"><i class="fa-solid fa-chevron-down"></i></label><ul>
+<li class="toctree-l2"><a class="reference internal" href="plotmodeshape/modenumber.html">mode_number Option</a></li>
+<li class="toctree-l2"><a class="reference internal" href="plotmodeshape/rounddigits.html">round_digit Option</a></li>
+<li class="toctree-l2"><a class="reference internal" href="plotmodeshape/scalefactor.html">scale_factor Option</a></li>
+<li class="toctree-l2"><a class="reference internal" href="plotmodeshape/drawwire.html">draw_wire_shadow Option</a></li>
+<li class="toctree-l2"><a class="reference internal" href="plotmodeshape/draw_nodes.html">draw_nodes Option</a></li>
+<li class="toctree-l2"><a class="reference internal" href="plotmodeshape/show_nodes_tag.html">show_nodes_tag Option</a></li>
+<li class="toctree-l2"><a class="reference internal" href="plotmodeshape/show_elemens_tag.html">show_elemens_tag Option</a></li>
+<li class="toctree-l2"><a class="reference internal" href="plotmodeshape/onhover.html">onhover_message Option</a></li>
+<li class="toctree-l2"><a class="reference internal" href="plotmodeshape/title.html">title Option</a></li>
+<li class="toctree-l2"><a class="reference internal" href="plotmodeshape/widthheight.html">fig_width and fig_height Options</a></li>
+<li class="toctree-l2"><a class="reference internal" href="plotmodeshape/eledata.html">elements_data_tag and elements_data Options</a></li>
+<li class="toctree-l2"><a class="reference internal" href="plotmodeshape/nodedata.html">nodes_data_tag and nodes_data Options</a></li>
+<li class="toctree-l2"><a class="reference internal" href="plotmodeshape/imagetypename.html">image_type and image_filename Options</a></li>
+<li class="toctree-l2"><a class="reference internal" href="plotmodeshape/legends.html">plot_legends Option</a></li>
+<li class="toctree-l2"><a class="reference internal" href="plotmodeshape/verticalaxis.html">vertical_axis Option</a></li>
+<li class="toctree-l2"><a class="reference internal" href="plotmodeshape/RetainedConstrained.html">show_constrained and not_show_retained_list and constrained_size Options</a></li>
+</ul>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="realtime.html">RealTimeObj Command (Plot at Each desired Time Step)</a></li>
-<li class="toctree-l1 has-children"><a class="reference internal" href="plotanime.html">PlotAnime Command (Plot Animation)</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-3"><i class="fa-solid fa-chevron-down"></i></label><ul>
-<li class="toctree-l2"><a class="reference internal" href="plotanime/recorderreset.html">RecorderReset() Command</a></li>
-<li class="toctree-l2"><a class="reference internal" href="plotanime/record.html">Record() Command</a></li>
+<li class="toctree-l1 has-children"><a class="reference internal" href="plotanime.html">PlotAnime Command (Plot Animation)</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-4"><i class="fa-solid fa-chevron-down"></i></label><ul>
 <li class="toctree-l2"><a class="reference internal" href="plotanime/scalefactor.html">scale_factor Option</a></li>
 <li class="toctree-l2"><a class="reference internal" href="plotanime/drawwire.html">draw_wire_shadow Option</a></li>
 <li class="toctree-l2"><a class="reference internal" href="plotanime/draw_nodes.html">draw_nodes Option</a></li>
@@ -431,9 +447,27 @@
 <li class="toctree-l2"><a class="reference internal" href="plotanime/legends.html">plot_legends Option</a></li>
 <li class="toctree-l2"><a class="reference internal" href="plotanime/verticalaxis.html">vertical_axis Option</a></li>
 <li class="toctree-l2"><a class="reference internal" href="plotanime/RetainedConstrained.html">show_constrained and not_show_retained_list and constrained_size Options</a></li>
+<li class="toctree-l2"><a class="reference internal" href="plotanime/recorderfilename.html">recorderfilename option</a></li>
+<li class="toctree-l2"><a class="reference internal" href="plotanime/recorderreset.html">RecorderReset() Command</a></li>
+<li class="toctree-l2"><a class="reference internal" href="plotanime/record.html">Record() Command</a></li>
+</ul>
+</li>
+<li class="toctree-l1 has-children"><a class="reference internal" href="plotanimegif.html">PlotAnimeGif command (Create Animation in gif format)</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-5"><i class="fa-solid fa-chevron-down"></i></label><ul>
+<li class="toctree-l2"><a class="reference internal" href="plotanimegif/scalefactor.html">scale_factor Option</a></li>
+<li class="toctree-l2"><a class="reference internal" href="plotanimegif/drawwire.html">draw_wire_shadow Option</a></li>
+<li class="toctree-l2"><a class="reference internal" href="plotanimegif/draw_nodes.html">draw_nodes Option</a></li>
+<li class="toctree-l2"><a class="reference internal" href="plotanimegif/show_nodes_tag.html">show_nodes_tag Option</a></li>
+<li class="toctree-l2"><a class="reference internal" href="plotanimegif/show_elemens_tag.html">show_elemens_tag Option</a></li>
+<li class="toctree-l2"><a class="reference internal" href="plotanimegif/onhover.html">onhover_message Option</a></li>
+<li class="toctree-l2"><a class="reference internal" href="plotanimegif/title.html">title Option</a></li>
+<li class="toctree-l2"><a class="reference internal" href="plotanimegif/widthheight.html">fig_width and fig_height Options</a></li>
+<li class="toctree-l2"><a class="reference internal" href="plotanimegif/verticalaxis.html">vertical_axis Option</a></li>
+<li class="toctree-l2"><a class="reference internal" href="plotanimegif/RetainedConstrained.html">show_constrained and not_show_retained_list and constrained_size Options</a></li>
+<li class="toctree-l2"><a class="reference internal" href="plotanimegif/recorderfilename.html">recorderfilename option</a></li>
+<li class="toctree-l2"><a class="reference internal" href="plotanimegif/recorderreset.html">RecorderReset() Command</a></li>
+<li class="toctree-l2"><a class="reference internal" href="plotanimegif/record.html">Record() Command</a></li>
 </ul>
 </li>
-<li class="toctree-l1"><a class="reference internal" href="plotanimegif.html">PlotAnimeGif command (Create Animation in gif format)</a></li>
 </ul>
 </div>
 </nav></div>
@@ -493,6 +527,43 @@
 
   <section id="plotmodeshape-command-plot-mode-shape">
 <span id="plotmodepy"></span><h1>PlotModeShape Command (Plot mode shape)<a class="headerlink" href="#plotmodeshape-command-plot-mode-shape" title="Permalink to this heading">#</a></h1>
+<p>PlotModeShape command is for plotting one of the modeshapes of the model. This command initially using eigen command execute a eigen analysis and according results of the eigen analysis plots the requested mode shape.</p>
+<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">PlotModeShape</span> <span class="p">(</span><span class="n">plotmode</span><span class="o">=</span><span class="mi">3</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
+</pre></div>
+</div>
+<ul class="simple">
+<li><dl class="simple">
+<dt>plotmode</dt><dd><p>For different python editors there is a need to consider some settings to plot the figure. There are different modes to plot figures and if your editor does not show the figure change the number of the mode! (1,2,3,4,5,6)</p>
+</dd>
+</dl>
+</li>
+<li><dl class="simple">
+<dt><cite>**kwargs</cite></dt><dd><p>Stands for other options that user can use to provide desired changes in the plot. In the following the existing options are described.</p>
+</dd>
+</dl>
+</li>
+</ul>
+<div class="toctree-wrapper compound">
+<p aria-level="2" class="caption" role="heading"><span class="caption-text">PlotModeShape Command Options</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="plotmodeshape/modenumber.html">mode_number Option</a></li>
+<li class="toctree-l1"><a class="reference internal" href="plotmodeshape/rounddigits.html">round_digit Option</a></li>
+<li class="toctree-l1"><a class="reference internal" href="plotmodeshape/scalefactor.html">scale_factor Option</a></li>
+<li class="toctree-l1"><a class="reference internal" href="plotmodeshape/drawwire.html">draw_wire_shadow Option</a></li>
+<li class="toctree-l1"><a class="reference internal" href="plotmodeshape/draw_nodes.html">draw_nodes Option</a></li>
+<li class="toctree-l1"><a class="reference internal" href="plotmodeshape/show_nodes_tag.html">show_nodes_tag Option</a></li>
+<li class="toctree-l1"><a class="reference internal" href="plotmodeshape/show_elemens_tag.html">show_elemens_tag Option</a></li>
+<li class="toctree-l1"><a class="reference internal" href="plotmodeshape/onhover.html">onhover_message Option</a></li>
+<li class="toctree-l1"><a class="reference internal" href="plotmodeshape/title.html">title Option</a></li>
+<li class="toctree-l1"><a class="reference internal" href="plotmodeshape/widthheight.html">fig_width and fig_height Options</a></li>
+<li class="toctree-l1"><a class="reference internal" href="plotmodeshape/eledata.html">elements_data_tag and elements_data Options</a></li>
+<li class="toctree-l1"><a class="reference internal" href="plotmodeshape/nodedata.html">nodes_data_tag and nodes_data Options</a></li>
+<li class="toctree-l1"><a class="reference internal" href="plotmodeshape/imagetypename.html">image_type and image_filename Options</a></li>
+<li class="toctree-l1"><a class="reference internal" href="plotmodeshape/legends.html">plot_legends Option</a></li>
+<li class="toctree-l1"><a class="reference internal" href="plotmodeshape/verticalaxis.html">vertical_axis Option</a></li>
+<li class="toctree-l1"><a class="reference internal" href="plotmodeshape/RetainedConstrained.html">show_constrained and not_show_retained_list and constrained_size Options</a></li>
+</ul>
+</div>
 </section>
 
 
@@ -515,11 +586,11 @@
       </div>
     </a>
     <a class="right-next"
-       href="realtime.html"
+       href="plotmodeshape/modenumber.html"
        title="next page">
       <div class="prev-next-info">
         <p class="prev-next-subtitle">next</p>
-        <p class="prev-next-title">RealTimeObj Command (Plot at Each desired Time Step)</p>
+        <p class="prev-next-title">mode_number Option</p>
       </div>
       <i class="fa-solid fa-angle-right"></i>
     </a>