Added overviews for each workflow

Author: smiller01985

Models/Libraries/Excavator_Parts_Lib.slx

@@ -1,5 +1,9 @@
-%% Excavator with Hydraulic System
+%% Excavator Design with Simscape: Hydromechanical Model with Controls
 % 
+% <<Excavator_Complete_Overview_Image.png>>
+%
+% (<matlab:web('Excavator_Design_Overview.html') return to Excavator Design Overview>)
+%
 % This example models an excavator with complete hydraulic system to power
 % cylinders for the boom, stick, and bucket, as well as the swing motor to
 % orient the excavator. It can be used to measure the duration and
@@ -9,7 +13,7 @@
 
 %% Model
 open_system('Excavator_Complete')
-ann_h = find_system('Excavator_Complete','FindAll', 'on','type','annotation','Tag','ModelFeatures');
+ann_h = find_system('Excavator_Complete','MatchFilter',@Simulink.match.allVariants,'FindAll', 'on','type','annotation','Tag','ModelFeatures');
 for i=1:length(ann_h)
     set_param(ann_h(i),'Interpreter','off');
 end
@@ -64,6 +68,27 @@
 open_system('Excavator_Complete/Controller/Function Commander','force')
 
 %% Dig Cycle Test
+%
+% The following code runs the model and produces plots of the operator
+% commands, actuator positions, cylinder pressures, and the load on the
+% bucket due to the soil.
+%   
+%   mdl = 'Excavator_Complete';
+%   
+%   Excavator_Init_Params
+%   Excavator_System_params
+%   Scenario = Excavator_Test_Scenario_Define;
+%   
+%   Excavator_Test_Scenario_Select('loadedBucketDigCycle')
+%   
+%   simOut = sim(mdl);
+%   
+%   Excavator_Complete_plot1operatorcmds
+%   Excavator_Complete_plot2position
+%   Excavator_Complete_plot3pressure
+%   Excavator_Complete_plot4loadsoil
+%   Excavator_Energy_Calc
+
 mdl = 'Excavator_Complete';
 
 Excavator_Init_Params

Models/Overview/Excavator_Complete.m

@@ -1,5 +1,9 @@
-%% Excavator Design Solution in Simscape: BOF, TOF Calculation
+%% Excavator Design with Simscape: BOF, TOF Calculation
 % 
+% <<Excavator_BOF_TOF_Overview_Image.png>>
+%
+% (<matlab:web('Excavator_Design_Overview.html') return to Excavator Design Overview>)
+%
 % This app enables you to calculate the Break Out Force (BOF) and Tear Out
 % Force (TOF) per standard ISO 6015:2006 "Earth-moving machinery --
 % Hydraulic excavators and backhoe loaders -- Methods of determing tool

Models/Overview/Excavator_Param_BOF_TOF.m

@@ -1,5 +1,9 @@
-%% Excavator Design Solution in Simscape: Load Chart Calculation
+%% Excavator Design with Simscape: Load Chart Calculation
 % 
+% <<Excavator_Load_Chart_Overview_Image.png>>
+%
+% (<matlab:web('Excavator_Design_Overview.html') return to Excavator Design Overview>)
+%
 % This app enables you to create a load chart for a given excavator design.
 % The load chart calculation is performed using a minimal set of parameters
 % to enable design space exploration.
@@ -66,7 +70,7 @@
 % <<Excavator_LoadChart_UI_Calc.png>>
 %
 
-%% Load Chart Test, Pressure Settings A
+%% Load Chart Test, Design A
 %
 % Generating the load chart can be automated using MATLAB commands.  The
 % MATLAB code below creates a load chart for Design A.
@@ -96,6 +100,16 @@
 Excavator_LoadChart_Create(qBoomSet,qStickSet,qBucketSet,...
     mdl_LoadChart_setup,mdl_LoadChart_calc,true);
 
+%% Load Capacity Test, Design A, Pin Loads
+%
+% In this test we calculate and plot the pin loads and cylinder pressures
+% for one of the positions of the load capacity test.
+
+Excavator_Test_Scenario_Select('Lift',mdl_LoadChart_setup,mdl_LoadChart_calc);
+simOut = sim(mdl_LoadChart_calc);
+[fLoad,test_type,pBoom,pStick,pBucket,pinForces]= Excavator_simlogToBOFTOF(simOut.logsout);
+Excavator_BOFTOFLoad_plot(ExcvGlobal,fLoad,test_type,pBoom,pStick,pBucket,pinForces);
+
 %% Load Chart Test, Design B
 %
 % In this test we generate the load chart using Design B

Models/Overview/Excavator_Param_Load_Chart.m

@@ -6,7 +6,7 @@
    <!--
 This HTML was auto-generated from MATLAB code.
 To make changes, update the MATLAB code and republish this document.
-      --><title>Excavator with Hydraulic System</title><meta name="generator" content="MATLAB 9.13"><link rel="schema.DC" href="http://purl.org/dc/elements/1.1/"><meta name="DC.date" content="2022-10-06"><meta name="DC.source" content="Excavator_Complete.m"><style type="text/css">
+      --><title>Excavator Design with Simscape: Hydromechanical Model with Controls</title><meta name="generator" content="MATLAB 9.13"><link rel="schema.DC" href="http://purl.org/dc/elements/1.1/"><meta name="DC.date" content="2022-12-22"><meta name="DC.source" content="Excavator_Complete.m"><style type="text/css">
 html,body,div,span,applet,object,iframe,h1,h2,h3,h4,h5,h6,p,blockquote,pre,a,abbr,acronym,address,big,cite,code,del,dfn,em,font,img,ins,kbd,q,s,samp,small,strike,strong,tt,var,b,u,i,center,dl,dt,dd,ol,ul,li,fieldset,form,label,legend,table,caption,tbody,tfoot,thead,tr,th,td{margin:0;padding:0;border:0;outline:0;font-size:100%;vertical-align:baseline;background:transparent}body{line-height:1}ol,ul{list-style:none}blockquote,q{quotes:none}blockquote:before,blockquote:after,q:before,q:after{content:'';content:none}:focus{outine:0}ins{text-decoration:none}del{text-decoration:line-through}table{border-collapse:collapse;border-spacing:0}
 
 html { min-height:100%; margin-bottom:1px; }
@@ -67,16 +67,25 @@
 
 
 
-  </style></head><body><div class="content"><h1>Excavator with Hydraulic System</h1><!--introduction--><p>This example models an excavator with complete hydraulic system to power cylinders for the boom, stick, and bucket, as well as the swing motor to orient the excavator. It can be used to measure the duration and efficiency of a dig cycle.</p><!--/introduction--><h2>Contents</h2><div><ul><li><a href="#1">Model</a></li><li><a href="#2">Excavator Subsystem</a></li><li><a href="#3">Excavator Machine Subsystem</a></li><li><a href="#4">Excavator Hydraulics Subsystem</a></li><li><a href="#5">Excavator Hydraulic Pump Subsystem</a></li><li><a href="#6">Excavator Hydraulic Valve Block (Left) Subsystem</a></li><li><a href="#7">Excavator Hydraulic Boom Cylinder Subsystem</a></li><li><a href="#8">Excavator Controller</a></li><li><a href="#9">Dig Cycle Test</a></li></ul></div><h2 id="1">Model</h2><pre class="codeoutput">Warning: Using find_system without the 'Variants' argument skips inactive
-Variant Subsystem blocks in the search. This behavior will change in a future
-release to look at all choices of the Variant Subsystem. To find blocks that are
-active in simulation or code generation, compile the model and use the built-in
-variant filters with the 'MatchFilter' option. To find all blocks use filter
-'@Simulink.match.allVariants' with the 'MatchFilter' option. 
-</pre><img vspace="5" hspace="5" src="Excavator_Complete_01.png" alt=""> <h2 id="2">Excavator Subsystem</h2><p><a href="matlab:open_system('Excavator_Complete');open_system('Excavator_Complete/Excavator','force');">Open Subsystem</a></p><img vspace="5" hspace="5" src="Excavator_Complete_02.png" alt=""> <h2 id="3">Excavator Machine Subsystem</h2><p><a href="matlab:open_system('Excavator_Complete');open_system('Excavator_Complete/Excavator/Machine','force');">Open Subsystem</a></p><img vspace="5" hspace="5" src="Excavator_Complete_03.png" alt=""> <h2 id="4">Excavator Hydraulics Subsystem</h2><p><a href="matlab:open_system('Excavator_Complete');open_system('Excavator_Complete/Excavator/Hydraulics','force');">Open Subsystem</a></p><img vspace="5" hspace="5" src="Excavator_Complete_04.png" alt=""> <h2 id="5">Excavator Hydraulic Pump Subsystem</h2><p><a href="matlab:open_system('Excavator_Complete');open_system('Excavator_Complete/Excavator/Hydraulics/LeftPump','force');">Open Subsystem</a></p><img vspace="5" hspace="5" src="Excavator_Complete_05.png" alt=""> <h2 id="6">Excavator Hydraulic Valve Block (Left) Subsystem</h2><p><a href="matlab:open_system('Excavator_Complete');open_system('Excavator_Complete/Excavator/Hydraulics/ValveBlocks/LeftValveBlock','force');">Open Subsystem</a></p><img vspace="5" hspace="5" src="Excavator_Complete_06.png" alt=""> <h2 id="7">Excavator Hydraulic Boom Cylinder Subsystem</h2><p><a href="matlab:open_system('Excavator_Complete');open_system('Excavator_Complete/Excavator/Hydraulics/Functions/Boom','force');">Open Subsystem</a></p><img vspace="5" hspace="5" src="Excavator_Complete_07.png" alt=""> <h2 id="8">Excavator Controller</h2><p><a href="matlab:open_system('Excavator_Complete');open_system('Excavator_Complete/Controller/Function%20Commander','force');">Open Subsystem</a></p><img vspace="5" hspace="5" src="Excavator_Complete_08.png" alt=""> <h2 id="9">Dig Cycle Test</h2><img vspace="5" hspace="5" src="Excavator_Complete_09.png" alt=""> <img vspace="5" hspace="5" src="Excavator_Complete_10.png" alt=""> <img vspace="5" hspace="5" src="Excavator_Complete_11.png" alt=""> <img vspace="5" hspace="5" src="Excavator_Complete_12.png" alt=""> <img vspace="5" hspace="5" src="Excavator_Complete_13.png" alt=""> <img vspace="5" hspace="5" src="Excavator_Complete_14.png" alt=""> <p class="footer">Copyright 2022 The MathWorks, Inc.<br><a href="https://www.mathworks.com/products/matlab/">Published with MATLAB&reg; R2022b</a><br></p></div><!--
+  </style></head><body><div class="content"><h1>Excavator Design with Simscape: Hydromechanical Model with Controls</h1><!--introduction--><p><img vspace="5" hspace="5" src="Excavator_Complete_Overview_Image.png" alt=""> </p><p>(<a href="matlab:web('Excavator_Design_Overview.html')">return to Excavator Design Overview</a>)</p><p>This example models an excavator with complete hydraulic system to power cylinders for the boom, stick, and bucket, as well as the swing motor to orient the excavator. It can be used to measure the duration and efficiency of a dig cycle.</p><!--/introduction--><h2>Contents</h2><div><ul><li><a href="#1">Model</a></li><li><a href="#2">Excavator Subsystem</a></li><li><a href="#3">Excavator Machine Subsystem</a></li><li><a href="#4">Excavator Hydraulics Subsystem</a></li><li><a href="#5">Excavator Hydraulic Pump Subsystem</a></li><li><a href="#6">Excavator Hydraulic Valve Block (Left) Subsystem</a></li><li><a href="#7">Excavator Hydraulic Boom Cylinder Subsystem</a></li><li><a href="#8">Excavator Controller</a></li><li><a href="#9">Dig Cycle Test</a></li></ul></div><h2 id="1">Model</h2><img vspace="5" hspace="5" src="Excavator_Complete_01.png" alt=""> <h2 id="2">Excavator Subsystem</h2><p><a href="matlab:open_system('Excavator_Complete');open_system('Excavator_Complete/Excavator','force');">Open Subsystem</a></p><img vspace="5" hspace="5" src="Excavator_Complete_02.png" alt=""> <h2 id="3">Excavator Machine Subsystem</h2><p><a href="matlab:open_system('Excavator_Complete');open_system('Excavator_Complete/Excavator/Machine','force');">Open Subsystem</a></p><img vspace="5" hspace="5" src="Excavator_Complete_03.png" alt=""> <h2 id="4">Excavator Hydraulics Subsystem</h2><p><a href="matlab:open_system('Excavator_Complete');open_system('Excavator_Complete/Excavator/Hydraulics','force');">Open Subsystem</a></p><img vspace="5" hspace="5" src="Excavator_Complete_04.png" alt=""> <h2 id="5">Excavator Hydraulic Pump Subsystem</h2><p><a href="matlab:open_system('Excavator_Complete');open_system('Excavator_Complete/Excavator/Hydraulics/LeftPump','force');">Open Subsystem</a></p><img vspace="5" hspace="5" src="Excavator_Complete_05.png" alt=""> <h2 id="6">Excavator Hydraulic Valve Block (Left) Subsystem</h2><p><a href="matlab:open_system('Excavator_Complete');open_system('Excavator_Complete/Excavator/Hydraulics/ValveBlocks/LeftValveBlock','force');">Open Subsystem</a></p><img vspace="5" hspace="5" src="Excavator_Complete_06.png" alt=""> <h2 id="7">Excavator Hydraulic Boom Cylinder Subsystem</h2><p><a href="matlab:open_system('Excavator_Complete');open_system('Excavator_Complete/Excavator/Hydraulics/Functions/Boom','force');">Open Subsystem</a></p><img vspace="5" hspace="5" src="Excavator_Complete_07.png" alt=""> <h2 id="8">Excavator Controller</h2><p><a href="matlab:open_system('Excavator_Complete');open_system('Excavator_Complete/Controller/Function%20Commander','force');">Open Subsystem</a></p><img vspace="5" hspace="5" src="Excavator_Complete_08.png" alt=""> <h2 id="9">Dig Cycle Test</h2><p>The following code runs the model and produces plots of the operator commands, actuator positions, cylinder pressures, and the load on the bucket due to the soil.</p><pre class="language-matlab">mdl = <span class="string">'Excavator_Complete'</span>;
+</pre><pre class="language-matlab">Excavator_Init_Params
+Excavator_System_params
+Scenario = Excavator_Test_Scenario_Define;
+</pre><pre class="language-matlab">Excavator_Test_Scenario_Select(<span class="string">'loadedBucketDigCycle'</span>)
+</pre><pre class="language-matlab">simOut = sim(mdl);
+</pre><pre class="language-matlab">Excavator_Complete_plot1operatorcmds
+Excavator_Complete_plot2position
+Excavator_Complete_plot3pressure
+Excavator_Complete_plot4loadsoil
+Excavator_Energy_Calc
+</pre><img vspace="5" hspace="5" src="Excavator_Complete_09.png" alt=""> <img vspace="5" hspace="5" src="Excavator_Complete_10.png" alt=""> <img vspace="5" hspace="5" src="Excavator_Complete_11.png" alt=""> <img vspace="5" hspace="5" src="Excavator_Complete_12.png" alt=""> <img vspace="5" hspace="5" src="Excavator_Complete_13.png" alt=""> <img vspace="5" hspace="5" src="Excavator_Complete_14.png" alt=""> <p class="footer">Copyright 2022 The MathWorks, Inc.<br><a href="https://www.mathworks.com/products/matlab/">Published with MATLAB&reg; R2022b</a><br></p></div><!--
 ##### SOURCE BEGIN #####
-%% Excavator with Hydraulic System
+%% Excavator Design with Simscape: Hydromechanical Model with Controls
 % 
+% <<Excavator_Complete_Overview_Image.png>>
+%
+% (<matlab:web('Excavator_Design_Overview.html') return to Excavator Design Overview>)
+%
 % This example models an excavator with complete hydraulic system to power
 % cylinders for the boom, stick, and bucket, as well as the swing motor to
 % orient the excavator. It can be used to measure the duration and
@@ -86,7 +95,7 @@
 
 %% Model
 open_system('Excavator_Complete')
-ann_h = find_system('Excavator_Complete','FindAll', 'on','type','annotation','Tag','ModelFeatures');
+ann_h = find_system('Excavator_Complete','MatchFilter',@Simulink.match.allVariants,'FindAll', 'on','type','annotation','Tag','ModelFeatures');
 for i=1:length(ann_h)
     set_param(ann_h(i),'Interpreter','off');
 end
@@ -141,6 +150,27 @@
 open_system('Excavator_Complete/Controller/Function Commander','force')
 
 %% Dig Cycle Test
+%
+% The following code runs the model and produces plots of the operator
+% commands, actuator positions, cylinder pressures, and the load on the
+% bucket due to the soil.
+%   
+%   mdl = 'Excavator_Complete';
+%   
+%   Excavator_Init_Params
+%   Excavator_System_params
+%   Scenario = Excavator_Test_Scenario_Define;
+%   
+%   Excavator_Test_Scenario_Select('loadedBucketDigCycle')
+%   
+%   simOut = sim(mdl);
+%   
+%   Excavator_Complete_plot1operatorcmds
+%   Excavator_Complete_plot2position
+%   Excavator_Complete_plot3pressure
+%   Excavator_Complete_plot4loadsoil
+%   Excavator_Energy_Calc
+
 mdl = 'Excavator_Complete';
 
 Excavator_Init_Params