Fixing documentation inconsistency for PTO-Sim blocks #1330
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kmruehl
reviewed
Sep 24, 2024
| simpleDirectDrivePTO (1,1) struct = struct(... % simple direct drive linear PTO Block properties | ||
| rectifyingCheckValve (1,1) struct = struct(... % Rectifying Check Valve Block properties | ||
| 'Cd', 'NOT DEFINED',... % [1] Discharge coefficient | ||
| 'Amax', 'NOT DEFINED',... % [m^2] Maximum opening area of the valve |
Collaborator
There was a problem hiding this comment.
@jleonqu this looks good, thank you. Can you clarify the [1] in front of Discharge Coefficient and Valve Coefficient?
Contributor
Author
There was a problem hiding this comment.
@kmruehl These are nondimensional values. I added a comment to all the nondimensional values for clarification.
Contributor
|
@jleonqu Thank you for the PR, I reviewed it and its good to be merged. |
kmruehl
added a commit
that referenced
this pull request
Oct 16, 2024
* Fixing documentation inconsistency for PTO-Sim blocks (#1330) * Fixing documentation inconsistency for PTO-Sim blocks * Adding comments to nondimensional values for clarification * update analytics implementation in docs re deprecation of analytics_id (#1342) --------- Co-authored-by: Jorge Leon <72461917+jleonqu@users.noreply.github.com> Co-authored-by: Adam Keester <72414466+akeeste@users.noreply.github.com>
akeeste
added a commit
that referenced
this pull request
Nov 4, 2024
* Fixing documentation inconsistency for PTO-Sim blocks (#1330) * Fixing documentation inconsistency for PTO-Sim blocks * Adding comments to nondimensional values for clarification * update analytics implementation in docs re deprecation of analytics_id (#1342) * Body block library update for bug fix #1346 (#1347) * fix on pDis function call * preliminary fix for issue #1288 * Update readAQWA.m (#1253) * body mask fixes for #1346 * add warning when variable hydro turned on for drag or nonhydro bodies * flex body - add missing mask lines, define h5 button callback --------- Co-authored-by: jtgrasb <87095491+jtgrasb@users.noreply.github.com> Co-authored-by: akeeste <akeeste@sandia.gov> * BIMIO to read NEMO QTF output files and do plots * Fixes the plotQTF function when multiple hydro strctures are i/p * Makes the body indecies start from 0 not from 1 to match the rest of NEMOH-BIMIO inputs for multibodies * Fixes the bug in the bodyClass for the QTFs and variable hydro (#1351) * fixes the bug in the bodyClass for the QTFs and variable hydro * fix QTF block issue - dont make it an atomic systme --------- Co-authored-by: akeeste <akeeste@sandia.gov> * Update source/functions/BEMIO/QTFs/triToFullMatrix.m Co-authored-by: Adam Keester <72414466+akeeste@users.noreply.github.com> * Update source/functions/BEMIO/QTFs/triToFullMatrix.m Co-authored-by: Adam Keester <72414466+akeeste@users.noreply.github.com> * Update wecSimTest.m Co-authored-by: Adam Keester <72414466+akeeste@users.noreply.github.com> * Update source/functions/BEMIO/QTFs/triToFullMatrix.m Co-authored-by: Adam Keester <72414466+akeeste@users.noreply.github.com> * Update source/functions/BEMIO/plotBEMIO.m Co-authored-by: Adam Keester <72414466+akeeste@users.noreply.github.com> * Update source/functions/BEMIO/QTFs/plotQTFs.m Co-authored-by: Adam Keester <72414466+akeeste@users.noreply.github.com> * Update source/functions/BEMIO/QTFs/plotQTFs.m Co-authored-by: Adam Keester <72414466+akeeste@users.noreply.github.com> --------- Co-authored-by: Jorge Leon <72461917+jleonqu@users.noreply.github.com> Co-authored-by: Adam Keester <72414466+akeeste@users.noreply.github.com> Co-authored-by: dforbush2 <dforbus@sandia.gov> Co-authored-by: jtgrasb <87095491+jtgrasb@users.noreply.github.com> Co-authored-by: akeeste <akeeste@sandia.gov>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is related to issue #1314
The comments for the PTO-Sim class have been revised and updated