Merge pull request #34 from ComputationalScienceLaboratory/size_validation

Add warnings when parameters are inconsistent with length of Y0

Author: AndreyAPopov

src/+otp/+allencahn/AllenCahnProblem.m

@@ -8,6 +8,20 @@
     end
 
     methods (Access = protected)
+        function validateNewState(obj, newTimeSpan, newY0, newParameters)
+            [email protected](obj, newTimeSpan, newY0, ...
+                newParameters);
+            
+            y0Len = length(newY0);
+            gridPts = newParameters.Size^2;
+            
+            if y0Len ~= gridPts
+                warning('OTP:inconsistentNumVars', ...
+                    'NumVars is %d, but there are %d grid points', ...
+                    y0Len, gridPts);
+            end
+        end
+        
         function onSettingsChanged(obj)
             n = obj.Parameters.Size;
             alpha = obj.Parameters.Alpha;

src/+otp/+cusp/CUSPProblem.m

@@ -19,6 +19,20 @@
     end
 
     methods (Access = protected)
+        function validateNewState(obj, newTimeSpan, newY0, newParameters)
+            [email protected](obj, newTimeSpan, newY0, ...
+                newParameters);
+            
+            y0Len = length(newY0);
+            gridPts = 3 * newParameters.Size;
+            
+            if y0Len ~= gridPts
+                warning('OTP:inconsistentNumVars', ...
+                    'NumVars is %d, but there are %d grid points', ...
+                    y0Len, gridPts);
+            end
+        end
+        
         function onSettingsChanged(obj)
             n = obj.Parameters.Size;
             epsilon = obj.Parameters.Epsilon;

src/+otp/+nbody/NBodyProblem.m

@@ -6,6 +6,21 @@
     end
 
     methods (Access = protected)
+        function validateNewState(obj, newTimeSpan, newY0, newParameters)
+            [email protected](obj, newTimeSpan, newY0, ...
+                newParameters);
+            
+            numMasses = length(newParameters.Masses);
+            expectedLen = numMasses * 2^newParameters.SpatialDim;
+            actualLen = length(newY0);
+            
+            if expectedLen ~= actualLen
+                warning('OTP:inconsistentNumVars', ...
+                    'With %d masses, NumVars should be %d but is %d', ...
+                    numMasses, expectedLen, actualLen);
+            end
+        end
+        
         function onSettingsChanged(obj)
             spatialDim = obj.Parameters.SpatialDim;
             masses = obj.Parameters.Masses;

src/+otp/+pendulum/PendulumProblem.m

@@ -24,10 +24,29 @@
     end
 
     methods (Access = protected)
+        function validateNewState(obj, newTimeSpan, newY0, newParameters)
+            [email protected](obj, newTimeSpan, newY0, ...
+                newParameters);
+            
+            y0Len = length(newY0);
+            numMasses = length(newParameters.Masses);
+            numLens = length(newParameters.Lengths);
+            
+            if y0Len ~= 2 * numMasses
+                warning('OTP:inconsistentNumVars', ...
+                    'With %d masses, NumVars should be %d but is %d', ...
+                    numMasses, 2 * numMasses, y0Len);
+            elseif y0Len ~= 2 * numLens
+                warning('OTP:inconsistentNumVars', ...
+                    'With %d lengths, NumVars should be %d but is %d', ...
+                    numLens, 2 * numLens, y0Len);
+            end
+        end
+        
         function onSettingsChanged(obj)
             g = obj.Parameters.Gravity;
-            lengths = obj.Parameters.Lengths(:);
-            masses  = obj.Parameters.Masses(:);
+            lengths = obj.Parameters.Lengths;
+            masses  = obj.Parameters.Masses;
 
             numBobs = min(numel(lengths), numel(masses));
             lengths = lengths(1:numBobs);

src/+otp/+qg/QuasiGeostrophicProblem.m

@@ -100,6 +100,19 @@
     end
 
     methods (Access = protected)
+        function validateNewState(obj, newTimeSpan, newY0, newParameters)
+            [email protected](obj, newTimeSpan, newY0, ...
+                newParameters);
+            
+            y0Len = length(newY0);
+            gridPts = newParameters.Nx * newParameters.Ny;
+            
+            if y0Len ~= gridPts
+                warning('OTP:inconsistentNumVars', ...
+                    'NumVars is %d, but there are %d grid points', ...
+                    y0Len, gridPts);
+            end
+        end
 
         function onSettingsChanged(obj)
 

src/+otp/Problem.m

@@ -29,6 +29,8 @@
             end
             obj.Name = name;
             obj.ExpectedNumVars = expectedNumVars;
+            
+            % IDEA: Make Settings a class with property validation
             obj.Settings = struct('timeSpan', timeSpan(:), 'y0', y0, 'parameters', parameters);
         end