Warning/Error flags #826

jtgrasb · 2022-03-14T19:33:42Z

This is an updated version of PR #820 to be compatible with the new updates to dev.

In this PR, I’ve implemented warning and error flags that seek to provide more feedback to the user regarding common errors and issues. The following flags/messages have been implemented into wecSim as part of this PR:

Argument checks were placed in some functions (such as plotResponse, plotForces, etc) of the response and wave classes to provide context on the expected function inputs.
Properties within the simulation and wave class were given more specific requirements (such as requiring a positive timestep value).
Error message when non-hydro bodies are specified before hydro in the wecSimInputFile
Warning message when waves.waterDepth is defined and there is an .h5 file present
Error message when waveSpread does not sum to 1
Error when the name or filename is not specified in the body, constraint, pto, cable, mooring, and ptoSim classes, which indicates to the user that the objects have likely been defined in the wrong order.
Error messages when necessary parameters (such as cg and cb) are not defined for bodies based on type (hydro, non-hydro, etc)
Warning messages when extra parameters specified that don’t affect result (such as cg and cb for hydro body)
Warning message for STL greater than half the size of the domain and error message for when it is greater than the domain size
Warning for noWaveCIC case that waves.T is not used
Errors and warning messages for parameters needed for each wave type
Warning message when simu.dtOut < simu.dt
Moves check for geometry file to only when explorer is on because the geometry file is not necessary when simulation explorer is off

I am working on more warning and error flags, but wanted to get a PR started here so that it can start to be reviewed.

AQWA Examples (WEC-Sim#779)

Revert "DRAFT: Warning/Error flags"

kmruehl

@jtgrasb this looks great so far. I've made several comments in line. Also, the tests are failing, any idea why?

source/functions/initializeWecSim.m

source/objects/bodyClass.m

source/objects/responseClass.m

kmruehl · 2022-03-15T20:13:41Z

source/objects/simulationClass.m

+        solver                                        = 'ode4'          % (`string`) PDE solver used by the Simulink/SimMechanics simulation. Any continuous solver in Simulink possible. Recommended to use 'ode4, 'ode45' for WEC-Sim. Default = ``'ode4'``
+        stateSpace {mustBeMember(stateSpace,0:1)}     = 0               % (`integer`) Flag for convolution integral or state-space calculation, Options: 0 (convolution integral), 1 (state-space). Default = ``0``
+        startTime {mustBeNonnegative}                 = 0               % (`float`) Simulation start time. Default = ``0`` s        
+        zeroCross                                     = 'DisableAll'    % (`string`) Disable zero cross control. Default = ``'DisableAll'``


How do this property validation work? Can you share a MATLAB link? How does it affect our documentation, etc? Are you planning to add this to the other classes too?

https://www.mathworks.com/help/matlab/matlab_oop/validate-property-values.html
Here's the documentation for this MATLAB feature. I used it for the simulation class because there are a lot of simple checks on properties that I felt would be helpful (such as limiting the different timesteps to positive values), so I thought would be an easy way to check these.
Not sure how it affects the documentation yet, but I will check.
I think it would be helpful to add to more of the properties/classes, but I felt most of the other classes were easier to check using checkInputs methods.
Lastly, it is possible to add checks for the variable type (double, string, etc.) and size, but I ran into some issues with these when the variable is optional and can remain undefined.

@jtgrasb I like this feature a lot, and think we should implement it, but I'm wondering whether it's something we should push to after v5.0 and implement across all the classes, or whether we should work to include it in v5.0, LMK what you think.

@kmruehl I agree, it is a very useful feature. I think it may be best to wait until after v5.0 because although helpful, I don't think it affects WEC-Sim significantly with most use cases. It would also give me more time to work out the kinks and implement it for the other classes. If you think it should be part of v5.0 though, I can try to get the rest of the classes implemented.

I agree, let's hold off of this on v5.0, but please add it to the project board for future development.

Actually, can you revert the simulationClass property validation, and then I'll merge this.

kmruehl · 2022-03-15T22:37:04Z

@jtgrasb can you resolve the merge conflicts?

kmruehl · 2022-03-16T23:02:46Z

@jtgrasb sorry that dev is a moving target due to the other PRs. This should be the last major change to dev to resolve conflicts with and then we can merge this PR too.

kmruehl · 2022-03-23T00:12:56Z

@jtgrasb thanks for resolving merge conflicts! I'll merge this once the property validation has been removed.

kmruehl · 2022-03-23T00:14:28Z

source/objects/simulationClass.m

+        solver                                        = 'ode4'          % (`string`) PDE solver used by the Simulink/SimMechanics simulation. Any continuous solver in Simulink possible. Recommended to use 'ode4, 'ode45' for WEC-Sim. Default = ``'ode4'``
+        stateSpace {mustBeMember(stateSpace,0:1)}     = 0               % (`integer`) Flag for convolution integral or state-space calculation, Options: 0 (convolution integral), 1 (state-space). Default = ``0``
+        startTime {mustBeNonnegative}                 = 0               % (`float`) Simulation start time. Default = ``0`` s        
+        zeroCross                                     = 'DisableAll'    % (`string`) Disable zero cross control. Default = ``'DisableAll'``


Actually, can you revert the simulationClass property validation, and then I'll merge this.

source/objects/waveClass.m

kmruehl · 2022-03-23T14:20:31Z

Thanks @jtgrasb

jtgrasb and others added 15 commits January 21, 2022 16:26

add argument checks

aefd662

Implement different methods of input validation

0e15c35

Merge pull request #8 from jtgrasb/dev

6151d1d

AQWA Examples (WEC-Sim#779)

Implement checks for waves and bodies

87068fe

Check mass

423feb6

Check some body and wave class parameters to be valid

90b7a14

Implement some body and simu class errors/warnings

c335f17

Add a few errors

59f86a3

Hydro bodies before nonhydro check

712652c

Check for order of class calls

b4e20eb

Merge branch 'WarningFlags' into dev

8403a8d

Revert "DRAFT: Warning/Error flags"

8aa73a7

Merge pull request WEC-Sim#825 from WEC-Sim/revert-820-WarningFlags

62f4d20

Revert "DRAFT: Warning/Error flags"

Reimplement warning/error flags

53e099d

Add property validations

cf27bae

kmruehl force-pushed the dev branch from 62f4d20 to e338e65 Compare March 14, 2022 20:04

Update variable names

1156eea

kmruehl reviewed Mar 15, 2022

View reviewed changes

kmruehl added the SCM source code mangagement and warnings label Mar 15, 2022

jtgrasb and others added 3 commits March 16, 2022 12:33

Merge branch 'dev' into warningFlags-updated

0c112d6

Fix bodyClass checkInputs() and small fixes

2ed734b

Change loc to location of constraint in cableCLass

7305f47

jtgrasb and others added 3 commits March 20, 2022 11:56

Merge branch 'dev' into warningFlags-updated

1e47d53

Fix conflicting variables

d264b2f

Update cableClass

104654b

kmruehl reviewed Mar 23, 2022

View reviewed changes

Revert property validation

f8a4c1d

Spacing

a9df80a

kmruehl merged commit 30963ad into WEC-Sim:dev Mar 23, 2022

jtgrasb deleted the warningFlags-updated branch July 5, 2022 13:29

Warning/Error flags #826

Warning/Error flags #826

Uh oh!

Conversation

jtgrasb commented Mar 14, 2022

Uh oh!

kmruehl left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kmruehl Mar 15, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jtgrasb Mar 16, 2022

Choose a reason for hiding this comment

Uh oh!

kmruehl Mar 16, 2022

Choose a reason for hiding this comment

Uh oh!

jtgrasb Mar 18, 2022

Choose a reason for hiding this comment

Uh oh!

kmruehl Mar 23, 2022

Choose a reason for hiding this comment

Uh oh!

kmruehl Mar 23, 2022

Choose a reason for hiding this comment

Uh oh!

kmruehl commented Mar 15, 2022

Uh oh!

kmruehl commented Mar 16, 2022

Uh oh!

kmruehl commented Mar 23, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kmruehl Mar 23, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

kmruehl commented Mar 23, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

kmruehl Mar 15, 2022 •

edited

Loading

kmruehl commented Mar 23, 2022 •

edited

Loading