sign convention docs and proof

[bradcarman]

Adding documentation about the applied sign convention. No changes were made to the current library except to add Constant input sources which aligned with the already available input sources. This PR replaces the previous incorrect PR #246.

[codecov]

Codecov Report

Attention: Patch coverage is 15.78947% with 16 lines in your changes are missing coverage. Please review.

Project coverage is 54.28%. Comparing base (e6ffefa) to head (fba3324).

Files	Patch %	Lines
src/Hydraulic/IsothermalCompressible/components.jl	15.78%	16 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##            main     #248       +/-   ##
==========================================
+ Coverage   0.00%   54.28%   +54.28%     
==========================================
  Files         33       46       +13     
  Lines       1630     1667       +37     
==========================================
+ Hits           0      905      +905     
+ Misses      1630      762      -868     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[baggepinnen]

something appears off with this PR, it looks like every single file has been modified by the formatter?

[bradcarman]

I truly modified about 15 files. Formatter, maybe a new update, modified a few others.

[baggepinnen]

This PR introduces ConstantForce, ConstantCurrent and ConstantMassFlow which are against our convention of having a single Force component that takes a signal (Constant in this case) as input. The reason for splitting the shape of the input out like this is that otherwise we'd need a ton of components,

• ConstantForce
• SineForce
• SquareWaveForce
• ...
• ConstantVoltage
• SineVoltage
• ...
• ConstantMassFlow
• ...

Exploding into n_domains x n_shapes components.

For tutorials in particular, if a new users sees

they immediately understand how to make the force sinusoidal instead of constant, but if they just see a ConstantForce block, they will be confused when they do not see a SineForce block

[bradcarman]

Ah OK, makes sense. I removed the ConstantX components and define them simply in the "sign_convention.md" doc for illustration purposes only.

[ven-k]

This PR looks great!