Skip to content

Commit df36063

Browse files
committed
docs: drop non-existant refs to p_int
1 parent e14e633 commit df36063

File tree

3 files changed

+15
-26
lines changed

3 files changed

+15
-26
lines changed

src/Hydraulic/IsothermalCompressible/components.jl

Lines changed: 7 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,17 @@
11

22
"""
3-
Cap(; p_int, name)
3+
Cap(; name)
44
55
Caps a hydraulic port to prevent mass flow in or out.
66
7-
# Parameters:
8-
- `p_int`: [Pa] initial pressure (set by `p_int` argument)
9-
107
# Connectors:
118
- `port`: hydraulic port
129
"""
1310
@mtkmodel Cap begin
1411

1512
@variables begin
1613
p(t), [guess = 0]
17-
end
14+
end
1815

1916
@components begin
2017
port = HydraulicPort()
@@ -28,12 +25,9 @@ Caps a hydraulic port to prevent mass flow in or out.
2825
end
2926

3027
"""
31-
Open(; p_int, name)
28+
Open(; name)
3229
33-
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.
34-
35-
# Parameters:
36-
- `p_int`: [Pa] initial pressure (set by `p_int` argument)
30+
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.
3731
3832
# Connectors:
3933
- `port`: hydraulic port
@@ -230,12 +224,11 @@ end
230224
@deprecate Pipe Tube
231225

232226
"""
233-
FlowDivider(;p_int, n, name)
227+
FlowDivider(; n, name)
234228
235229
Reduces the flow from `port_a` to `port_b` by `n`. Useful for modeling parallel tubes efficiently by placing a `FlowDivider` on each end of a tube.
236230
237231
# Parameters:
238-
- `p_int`: [Pa] initial pressure
239232
- `n`: divide flow from `port_a` to `port_b` by `n`
240233
241234
# Connectors:
@@ -738,7 +731,7 @@ end
738731
"""
739732
SpoolValve2Way(reversible = false; p_s_int, p_a_int, p_b_int, p_r_int, m, g, x_int, Cd, d, name)
740733
741-
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.
734+
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.
742735
743736
# Parameters:
744737
- `p_s_int`: [Pa] initial pressure for `port_s`
@@ -819,7 +812,7 @@ end
819812
Cd = 1e4,
820813
Cd_reverse = Cd,
821814
name)
822-
815+
823816
Actuator made of two DynamicVolumes connected in opposite direction with body mass attached.
824817
825818
# Features:

src/Hydraulic/IsothermalCompressible/sources.jl

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
"""
2-
MassFlow(; name, p_int)
2+
MassFlow(; name)
33
44
Hydraulic mass flow input source
55
66
# Connectors:
77
88
- `port`: hydraulic port
9-
- `dm`: real input
9+
- `dm`: real input
1010
"""
1111
@mtkmodel MassFlow begin
1212

@@ -55,7 +55,7 @@ input pressure source
5555
5656
# Connectors:
5757
- `port`: hydraulic port
58-
- `p`: real input
58+
- `p`: real input
5959
"""
6060
@mtkmodel Pressure begin
6161

src/Hydraulic/IsothermalCompressible/utils.jl

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,10 @@ regPow(x, a, delta = 0.01) = x * (x * x + delta * delta)^((a - 1) / 2);
44
regRoot(x, delta = 0.01) = regPow(x, 0.5, delta)
55

66
"""
7-
HydraulicPort(;p_int, name)
7+
HydraulicPort(; name)
88
99
Connector port for hydraulic components.
1010
11-
# Arguments:
12-
13-
- `p_int`: [Pa] initial gauge pressure
14-
1511
# States:
1612
- `p`: [Pa] gauge total pressure
1713
- `dm`: [kg/s] mass flow
@@ -38,15 +34,15 @@ end
3834
"""
3935
HydraulicFluid(; density = 997, bulk_modulus = 2.09e9, viscosity = 0.0010016, gas_density = 0.0073955, gas_pressure = -1000, n = 1, let_gas = 1, name)
4036
41-
Fluid parameter setter for isothermal compressible fluid domain. Defaults given for water at 20°C and 0Pa gage (1atm absolute) reference pressure. Density is modeled using the Tait equation of state. For pressures below the reference pressure, density is linearly interpolated to the gas state (when `let_gas` is set to 1), this helps prevent pressures from going below the reference pressure.
37+
Fluid parameter setter for isothermal compressible fluid domain. Defaults given for water at 20°C and 0Pa gage (1atm absolute) reference pressure. Density is modeled using the Tait equation of state. For pressures below the reference pressure, density is linearly interpolated to the gas state (when `let_gas` is set to 1), this helps prevent pressures from going below the reference pressure.
4238
4339
# Parameters:
4440
4541
- `ρ`: [kg/m^3] fluid density at 0Pa reference gage pressure (set by `density` argument)
4642
- `Β`: [Pa] fluid bulk modulus describing the compressibility (set by `bulk_modulus` argument)
4743
- `μ`: [Pa*s] or [kg/m-s] fluid dynamic viscosity (set by `viscosity` argument)
4844
- `n`: density exponent
49-
- `let_gas`: set to 1 to allow fluid to transition from liquid to gas (for density calculation only)
45+
- `let_gas`: set to 1 to allow fluid to transition from liquid to gas (for density calculation only)
5046
- `ρ_gas`: [kg/m^3] density of fluid in gas state at reference gage pressure `p_gas` (set by `gas_density` argument)
5147
- `p_gas`: [Pa] reference pressure (set by `gas_pressure` argument)
5248
"""
@@ -80,12 +76,12 @@ f_turbulent(shape_factor, Re) = (shape_factor / 64) / (0.79 * log(Re) - 1.64)^2
8076
"""
8177
friction_factor(dm, area, d_h, viscosity, shape_factor)
8278
83-
Calculates the friction factor ``f`` for fully developed flow in a tube such that ``Δp = f \\cdot \\rho \\frac{u^2}{2} \\frac{l}{d_h}`` where
79+
Calculates the friction factor ``f`` for fully developed flow in a tube such that ``Δp = f \\cdot \\rho \\frac{u^2}{2} \\frac{l}{d_h}`` where
8480
8581
- ``Δp``: [Pa] is the pressure difference over the tube length ``l``
8682
- ``\\rho``: [kg/m^3] is the average fluid density
8783
- ``u``: [m/s] is the average fluid velocity
88-
- ``l``: [m] is the tube length
84+
- ``l``: [m] is the tube length
8985
9086
The friction factor is calculated for laminar and turbulent flow with a transition region between Reynolds number 2000 to 3000. Turbulent flow equation is for smooth tubes, valid for the Reynolds number range up to 5e6.
9187

0 commit comments

Comments
 (0)