Skip to content

Commit c9bd9fd

Browse files
author
Brad Carman
committed
Some doc string edits
1 parent 171a928 commit c9bd9fd

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

src/Hydraulic/IsothermalCompressible/components.jl

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ end
2828
"""
2929
Open(; p_int, name)
3030
31-
Simple hydraulic port for use in multiport components like FlowDivider.
31+
Provides an "open" boundary condition for a hydraulic port such that mass flow `dm` is non-zero. This is opposite from an un-connected hydraulic port or the `Cap` boundary component which sets the mass flow `dm` to zero.
3232
3333
# Parameters:
3434
- `p_int`: [Pa] initial pressure (set by `p_int` argument)
@@ -729,6 +729,8 @@ Spool valve with `x` valve opening input as mechanical flange port and `d` diame
729729
- `port_a`: hydraulic port
730730
- `port_b`: hydraulic port
731731
- `flange`: mechanical translational port
732+
733+
See [`Valve`](@ref) for more information.
732734
"""
733735
@component function SpoolValve(reversible = false; p_a_int, p_b_int, x_int, Cd, d, name)
734736
pars = @parameters begin
@@ -765,15 +767,15 @@ end
765767
"""
766768
SpoolValve2Way(reversible = false; p_s_int, p_a_int, p_b_int, p_r_int, m, g, x_int, Cd, d, name)
767769
768-
2-ways spool valve with 4 ports and mass. Fluid flow direction S → A and B → R. See `SpoolValve` for more information.
770+
2-ways spool valve with 4 ports and spool mass. Fluid flow direction S → A and B → R when `x` is positive and S → B and A → R when `x` is negative.
769771
770772
# Parameters:
771773
- `p_s_int`: [Pa] initial pressure for `port_s`
772774
- `p_a_int`: [Pa] initial pressure for `port_a`
773775
- `p_b_int`: [Pa] initial pressure for `port_b`
774776
- `p_r_int`: [Pa] initial pressure for `port_r`
775-
- `m`: [kg] mass of the body
776-
- `g`: [m/s²] gravity field acting on the mass, positive value acts in the positive direction
777+
- `m`: [kg] mass of the spool
778+
- `g`: [m/s²] gravity field acting on the spool, positive value acts in the positive direction
777779
- `x_int`: [m] initial valve opening
778780
- `d`: [m] orifice diameter
779781
- `Cd`: discharge coefficient flowing from `s → a` and `b → r`
@@ -784,6 +786,8 @@ end
784786
- `port_b`: hydraulic port
785787
- `port_r`: hydraulic port
786788
- `flange`: mechanical translational port
789+
790+
See [`SpoolValve`](@ref) for more information.
787791
"""
788792
@component function SpoolValve2Way(reversible = false; p_s_int, p_a_int, p_b_int, p_r_int,
789793
m, g, x_int, Cd, d, name)

0 commit comments

Comments
 (0)