API Reference about vesseljs HOT 14 CLOSED

from vesseljs.

Restructure API page according to Elias' suggestions (break classes into different headers, document all classes of the library).

from vesseljs.

Debug Hull Hydrostatics example and document it with a tutorial.

from vesseljs.

@EliasHasle, as to the ship.calculateStability() method, how can I force it to calculate stability parameters for a draft chosen by the user, instead of using the draft derived from weight equilibrium calculations inside the calculateDraft(shipState, epsilon=0.001) method?

from vesseljs.

In addition, is it ok to push example commits directly to the master branch? This will make them reachable through https://shiplab.github.io/vesseljs/ right away, as the dev branch can't be reached from there.

from vesseljs.

Good questions. I take the last one first. It is OK that you push commits for your own examples to the master branch, if you know what you are doing. :-) It will not be too hard to merge later.

Ship.prototype.calculateStability depends on both draft and weight, and draft depends on weight (and hull geometry). So having draft as a parameter would be misleading. We could possibly have weight (or "displacement") as a parameter, though, instead of the full ship state. The same goes for calculateDraft. I think that is cleaner, as none of those methods need to know more. But then, actually, we could have them in the hull class. I think that might be the way to go. (It could even make proper caching easier.)

What is your use case for inputting draft to Ship.prototype.calculateStability?

from vesseljs.

I am working on this example. The idea is to display some hydrostatic properties as functions of the draft, which should be controlled by the user with the gui slider on the page.

from vesseljs.

from vesseljs.

Yes, I understand. That's why the intention was to display only KB and BM, which depend on the submerged volume but not on the position of the center of gravity (as GM does). In that sense, they could be calculated as functions of the draft only.

from vesseljs.

Ok, so from the information you provided, I was able to get everything I needed from the outputs of calculateAttributesAtDraft(T): Volume of displacement, KB, BMl, BMt, LCB and LCF (https://github.com/shiplab/vesseljs/blob/master/examples/Hull_hydrostatics.html#L274). Maybe you'll still want to present those values with their hydrostatic names inside the method just to use familiar terminology to naval architects.

from vesseljs.

from vesseljs.

Ok, so I'll do it this week or the next. When I update it, should I deprecate the properties with the current terminology (Cv, xcwp, etc.) or should I leave them there? I wonder if removing them could cause incompatibilities.

from vesseljs.

from vesseljs.

@icarofonseca We shoukd have a "manual" for new examples, given that every year we expect to have students creating new examples. Let's talk about it on the october meeting. I'm closing it for now.

from vesseljs.