Revised comments on functions and error messages in if statements for consistency

Author: pabloseleson

PDMATLAB2D.m

@@ -30,7 +30,7 @@ function PDMATLAB2D(InputDeck)
     cd('InputFiles/')
     run(InputDeck);
 
-    % Run main function
+    % Run Main script
     cd('../Source/')
     Main
 

Source/ForceEnergyDensity.m

@@ -59,16 +59,16 @@
 %
 % The input variable "model" currently only takes 'GPMB' as valid input. 
 % Additional models can be added using the overall if statement by adding
-% an extra condition. As an example, if an 'X' model is needed, one could 
-% extend the if statement as follows:
+% an elseif statement to specify a condition for each desired model. As an example, 
+% if the 'X' model is needed, one could extend the if statement as follows:
 %
 % if strcmp(model,'GPMB')
 %
 % elseif strcmp(model,'X')
 %
 % else
 %
-%     error('Model unknown.')
+%     error('Invalid model.')
 %
 % end
 
@@ -269,7 +269,7 @@
 
     else
 
-        error('Model unknown.')
+        error('Invalid model.')
 
     end
 

Source/Main.m

@@ -11,7 +11,7 @@
 % ========================================================================
 
 % ========================================================================
-% Main function for running a PDMATLAB2D simulation
+% Main script for running a PDMATLAB2D simulation
 % ========================================================================
 
 % Check if simulation output directory exists and creates it otherwise

Source/NeighborAreaBondLengthCoord.m

@@ -584,7 +584,7 @@
 
     else
 
-        error('Unknown algorithm name.')
+        error('Invalid AlgName.')
 
     end
 

Source/PDBondConstants.m

@@ -50,16 +50,16 @@
 %
 % The input variable "model" currently only takes 'GPMB' as valid input. 
 % Additional models can be added using the overall if statement by adding
-% an extra condition. As an example, if an 'X' model is needed, one could 
-% extend the if statement as follows:
+% an elseif statement to specify a condition for each desired model. As an example, 
+% if the 'X' model is needed, one could extend the if statement as follows:
 %
 % if strcmp(model,'GPMB')
 %
 % elseif strcmp(model,'X')
 %
 % else
 %
-%     error('Model unknown.')
+%     error('Invalid model.')
 %
 % end
 
@@ -161,13 +161,13 @@
 
         else
 
-            error('PlanarModel unknown.')
+            error('Invalid PlanarModel.')
 
         end
 
     else
 
-        error('Model unknown.')
+        error('Invalid model.')
 
     end
 

Source/TimeIntegrator.m

@@ -66,6 +66,24 @@
 % W           : macroleastic energy density for all nodes (at time t+dt)    
 % u_NA        : updated array of neighbor numbers for all nodes after possible bond breaking (at time t+dt)
 
+% Discussion:
+% ----------
+% The input variable "TimeScheme" currently only takes 'VVerlet' as valid input. 
+% Additional time-integration schemes can be added using the overall if statement 
+% by adding an elseif statement to specify a condition for each desired
+% time-integration scheme. As an example, if the 'X' time-integration scheme 
+% is needed, one could extend the if statement as follows:
+%
+% if strcmp(TimeScheme,'VVerlet')
+%
+% elseif strcmp(TimeScheme,'X')
+%
+% else
+%
+%     error('Invalid TimeScheme.')
+%
+% end
+
 function [v,w,Vv,Vw,Fv,Fw,bv,bw,W,u_NA] = TimeIntegrator(TimeScheme,xx,yy,v,w,Vv,Vw,Fv,Fw,bv,bw,t,bvfunc,bwfunc,dt,u_NA,IF_NA,V_NA,r_hat_NA,x_hat_NA,y_hat_NA,rho,c,model,flag_RDUG,so,mask_nofail,flag_BB)
 
     % --------------------------------------------------------------------