Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 14 additions & 14 deletions src/Electrical/Analog/ideal_components.jl
Original file line number Diff line number Diff line change
Expand Up @@ -33,14 +33,14 @@ Generic resistor with optional temperature dependency.

# States:

- See [OnePort](@ref)
- See [`OnePort`](@ref)
- `R(t)`: [`Ω`] Resistance (temperature dependent if `T_dep = true`)

# Connectors:

- `p` Positive pin
- `n` Negative pin
- `heat_port` [HeatPort](@ref) (only if `T_dep = true`) Heat port to model the temperature dependency
- `heat_port` [`HeatPort`](@ref) (only if `T_dep = true`) Heat port to model the temperature dependency

# Parameters:

Expand Down Expand Up @@ -100,7 +100,7 @@ Creates an ideal conductor.

# States:

See [OnePort](@ref)
See [`OnePort`](@ref)

# Connectors:

Expand Down Expand Up @@ -141,7 +141,7 @@ Initial voltage of capacitor can be set with `v` ([`V`])

# States:

See [OnePort](@ref)
See [`OnePort`](@ref)

# Connectors:

Expand Down Expand Up @@ -182,7 +182,7 @@ Initial current through inductor can be set with `i` ([`A`]).

# States:

See [OnePort](@ref)
See [`OnePort`](@ref)

# Connectors:

Expand Down Expand Up @@ -262,7 +262,7 @@ Short is a simple short cut branch. That means the voltage drop between both pin

# States:

See [OnePort](@ref)
See [`OnePort`](@ref)

# Connectors:

Expand Down Expand Up @@ -304,10 +304,10 @@ Electromotoric force (electric/mechanic transformer)

# Connectors

- `p` [Pin](@ref) Positive pin
- `n` [Pin](@ref) Negative pin
- `flange` [Flange](@ref) Shaft of EMF shaft
- `support` [Support](@ref) Support/housing of emf shaft
- `p` [`Pin`](@ref) Positive pin
- `n` [`Pin`](@ref) Negative pin
- `flange` [`Flange`](@ref) Shaft of EMF shaft
- `support` [`Support`](@ref) Support/housing of emf shaft

# Parameters:

Expand Down Expand Up @@ -350,13 +350,13 @@ Generic diode with optional temperature dependency.

# States

- See [OnePort](@ref)
- See [`OnePort`](@ref)

# Connectors

- `p` Positive pin
- `n` Negative pin
- `port` [HeatPort](@ref) (only if `T_dep = true`) Heat port to model variable temperature dependency
- `port` [`HeatPort`](@ref) (only if `T_dep = true`) Heat port to model variable temperature dependency

# Parameters:

Expand Down Expand Up @@ -433,7 +433,7 @@ R = R_const + pos * R_ref * (1 + alpha * (port.T - T_ref))

# States

- See [OnePort](@ref)
- See [`OnePort`](@ref)
- `pos(t)`: Position of the wiper (normally 0-1)
- `R(t)`: Resistance

Expand All @@ -442,7 +442,7 @@ R = R_const + pos * R_ref * (1 + alpha * (port.T - T_ref))
- `p` Positive pin
- `n` Negative pin
- `position` RealInput to set the position of the wiper
- `port` [HeatPort](@ref) Heat port to model the temperature dependency
- `port` [`HeatPort`](@ref) Heat port to model the temperature dependency

# Parameters

Expand Down
4 changes: 2 additions & 2 deletions src/Electrical/Analog/sensors.jl
Original file line number Diff line number Diff line change
Expand Up @@ -113,8 +113,8 @@ consumed by a circuit.
# States:

- `power(t)`: [`W`] The power being consumed, given by the product of voltage and current
- See [VoltageSensor](@ref)
- See [CurrentSensor](@ref)
- See [`VoltageSensor`](@ref)
- See [`CurrentSensor`](@ref)

# Connectors:

Expand Down
8 changes: 4 additions & 4 deletions src/Electrical/Analog/sources.jl
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ Acts as an ideal voltage source with no internal resistance.

# States:

See [OnePort](@ref)
See [`OnePort`](@ref)

# Connectors:

- `p` Positive pin
- `n` Negative pin
- `V` [RealInput](@ref) Input for the voltage control signal, i.e. `V ~ p.v - n.v`
- `V` [`RealInput`](@ref) Input for the voltage control signal, i.e. `V ~ p.v - n.v`
"""
@component function Voltage(; name)
@named oneport = OnePort()
Expand Down Expand Up @@ -42,13 +42,13 @@ Acts as an ideal current source with no internal resistance.

# States:

See [OnePort](@ref)
See [`OnePort`](@ref)

# Connectors:

- `p` Positive pin
- `n` Negative pin
- `I` [RealInput](@ref) Input for the current control signal, i.e. `I ~ p.i
- `I` [`RealInput`](@ref) Input for the current control signal, i.e. `I ~ p.i
"""
@component function Current(; name)
@named oneport = OnePort()
Expand Down
28 changes: 14 additions & 14 deletions src/Mechanical/Rotational/components.jl
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Flange fixed in housing at a given angle.

# Connectors:

- `flange` [Flange](@ref)
- `flange` [`Flange`](@ref)

# Parameters:

Expand Down Expand Up @@ -43,8 +43,8 @@ end

# Connectors:

- `flange_a` [Flange](@ref) Left flange
- `flange_b` [Flange](@ref) Right flange
- `flange_a` [`Flange`](@ref) Left flange
- `flange_b` [`Flange`](@ref) Right flange

# Parameters:

Expand Down Expand Up @@ -91,8 +91,8 @@ Linear 1D rotational spring

# Connectors:

- `flange_a` [Flange](@ref)
- `flange_b` [Flange](@ref)
- `flange_a` [`Flange`](@ref)
- `flange_b` [`Flange`](@ref)

# Parameters:

Expand Down Expand Up @@ -138,8 +138,8 @@ Linear 1D rotational damper

# Connectors:

- `flange_a` [Flange](@ref)
- `flange_b` [Flange](@ref)
- `flange_a` [`Flange`](@ref)
- `flange_b` [`Flange`](@ref)

# Parameters:

Expand Down Expand Up @@ -182,8 +182,8 @@ Linear 1D rotational spring and damper

# Connectors:

- `flange_a` [Flange](@ref)
- `flange_b` [Flange](@ref)
- `flange_a` [`Flange`](@ref)
- `flange_b` [`Flange`](@ref)

# Parameters:

Expand Down Expand Up @@ -233,9 +233,9 @@ This element characterizes any type of gear box which is fixed in the ground and

# Connectors:

- `flange_a` [Flange](@ref)
- `flange_b` [Flange](@ref)
- `support` [Support](@ref) if `use_support == true`
- `flange_a` [`Flange`](@ref)
- `flange_b` [`Flange`](@ref)
- `support` [`Support`](@ref) if `use_support == true`

# Parameters:

Expand Down Expand Up @@ -286,8 +286,8 @@ Friction model: "Armstrong, B. and C.C. de Wit, Friction Modeling and Compensati

# Connectors:

- `flange_a` [Flange](@ref)
- `flange_b` [Flange](@ref)
- `flange_a` [`Flange`](@ref)
- `flange_b` [`Flange`](@ref)

# Parameters:

Expand Down
20 changes: 10 additions & 10 deletions src/Mechanical/Rotational/sensors.jl
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ Ideal sensor to measure the absolute flange angle

# Connectors:

- `flange`: [Flange](@ref) Flange of shaft from which sensor information shall be measured
- `phi`: [RealOutput](@ref) Absolute angle of flange
- `flange`: [`Flange`](@ref) Flange of shaft from which sensor information shall be measured
- `phi`: [`RealOutput`](@ref) Absolute angle of flange
"""
@component function AngleSensor(; name)
pars = @parameters begin
Expand Down Expand Up @@ -35,8 +35,8 @@ Ideal sensor to measure the absolute flange angular velocity

# Connectors:

- `flange`: [Flange](@ref) Flange of shaft from which sensor information shall be measured
- `w`: [RealOutput](@ref) Absolute angular velocity of flange
- `flange`: [`Flange`](@ref) Flange of shaft from which sensor information shall be measured
- `w`: [`RealOutput`](@ref) Absolute angular velocity of flange
"""
@component function SpeedSensor(; name)
pars = @parameters begin
Expand Down Expand Up @@ -65,9 +65,9 @@ Ideal sensor to measure the torque between two flanges (`= flange_a.tau`)

# Connectors:

- `flange_a`: [Flange](@ref) Left flange of shaft
- `flange_b`: [Flange](@ref) Left flange of shaft
- `tau`: [RealOutput](@ref) Torque in flange flange_a and flange_b (`tau = flange_a.tau = -flange_b.tau`)
- `flange_a`: [`Flange`](@ref) Left flange of shaft
- `flange_b`: [`Flange`](@ref) Left flange of shaft
- `tau`: [`RealOutput`](@ref) Torque in flange flange_a and flange_b (`tau = flange_a.tau = -flange_b.tau`)
"""
@component function TorqueSensor(; name)
pars = @parameters begin
Expand Down Expand Up @@ -98,9 +98,9 @@ Ideal sensor to measure the relative angular velocity

# Connectors:

- `flange_a`: [Flange](@ref) Flange of shaft from which sensor information shall be measured
- `flange_b`: [Flange](@ref) Flange of shaft from which sensor information shall be measured
- `w`: [RealOutput](@ref) Absolute angular velocity of flange
- `flange_a`: [`Flange`](@ref) Flange of shaft from which sensor information shall be measured
- `flange_b`: [`Flange`](@ref) Flange of shaft from which sensor information shall be measured
- `w`: [`RealOutput`](@ref) Absolute angular velocity of flange
"""
@component function RelSpeedSensor(; name, phi_rel = nothing)
pars = @parameters begin
Expand Down
10 changes: 5 additions & 5 deletions src/Mechanical/Rotational/sources.jl
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ Input signal acting as external torque on a flange

# Connectors:

- `flange` [Flange](@ref)
- `tau` [RealInput](@ref) Accelerating torque acting at flange `-flange.tau`
- `flange` [`Flange`](@ref)
- `tau` [`RealInput`](@ref) Accelerating torque acting at flange `-flange.tau`

# Parameters:

Expand Down Expand Up @@ -72,7 +72,7 @@ Constant torque source
- `w`: Angular velocity of flange with respect to support (= der(phi))

# Connectors:
- `flange` [Flange](@ref)
- `flange` [`Flange`](@ref)

# Arguments:
- `tau_constant`: The constant torque applied by the source
Expand Down Expand Up @@ -115,8 +115,8 @@ Forced movement of a flange according to a reference angular velocity signal

# Connectors:

- `flange` [Flange](@ref)
- `w_ref` [RealInput](@ref) Reference angular velocity of flange with respect to support as input signal needs to be continuously differential
- `flange` [`Flange`](@ref)
- `w_ref` [`RealInput`](@ref) Reference angular velocity of flange with respect to support as input signal needs to be continuously differential

# Parameters:

Expand Down
16 changes: 8 additions & 8 deletions src/Mechanical/Rotational/utils.jl
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@ Partial model for the compliant connection of two rotational 1-dim. shaft flange

# Connectors:

- `flange_a` [Flange](@ref)
- `flange_b` [Flange](@ref)
- `flange_a` [`Flange`](@ref)
- `flange_b` [`Flange`](@ref)

"""
@component function PartialCompliant(; name, phi_rel = nothing, tau = nothing)
Expand Down Expand Up @@ -94,8 +94,8 @@ Partial model for the compliant connection of two rotational 1-dim. shaft flange

# Connectors:

- `flange_a` [Flange](@ref)
- `flange_b` [Flange](@ref)
- `flange_a` [`Flange`](@ref)
- `flange_b` [`Flange`](@ref)
"""
@component function PartialCompliantWithRelativeStates(; name, phi_rel = nothing, w_rel = nothing, a_rel = nothing, tau = nothing)
pars = @parameters begin
Expand Down Expand Up @@ -136,7 +136,7 @@ Partial model for a component with one rotational 1-dim. shaft flange and a supp

# Connectors:

- `flange` [Flange](@ref)
- `flange` [`Flange`](@ref)

# Parameters:

Expand Down Expand Up @@ -172,9 +172,9 @@ Partial model for a component with two rotational 1-dim. shaft flanges and a sup

# Connectors:

- `flange_a` [Flange](@ref)
- `flange_b` [Flange](@ref)
- `support` [Support](@ref) if `use_support == true`
- `flange_a` [`Flange`](@ref)
- `flange_b` [`Flange`](@ref)
- `support` [`Support`](@ref) if `use_support == true`

# Parameters:

Expand Down
16 changes: 8 additions & 8 deletions src/Thermal/HeatTransfer/sensors.jl
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ lags are associated with this sensor model.

# Connectors:

- `port`: [HeatPort](@ref) Thermal port from which sensor information shall be measured
- `T`: [RealOutput](@ref) [K] Absolute temperature of port
- `port`: [`HeatPort`](@ref) Thermal port from which sensor information shall be measured
- `T`: [`RealOutput`](@ref) [K] Absolute temperature of port
"""
@component function TemperatureSensor(; name)
pars = @parameters begin
Expand Down Expand Up @@ -42,9 +42,9 @@ output signal in kelvin.

# Connectors:

- `port_a`: [HeatPort](@ref) Thermal port from which sensor information shall be measured
- `port_b`: [HeatPort](@ref) Thermal port from which sensor information shall be measured
- `T`: [RealOutput](@ref) [K] Relative temperature `a.T - b.T`
- `port_a`: [`HeatPort`](@ref) Thermal port from which sensor information shall be measured
- `port_b`: [`HeatPort`](@ref) Thermal port from which sensor information shall be measured
- `T`: [`RealOutput`](@ref) [K] Relative temperature `a.T - b.T`
"""
@component function RelativeTemperatureSensor(; name)
pars = @parameters begin
Expand Down Expand Up @@ -80,9 +80,9 @@ The output signal is positive, if the heat flows from `port_a` to `port_b`.

# Connectors:

- `port_a`: [HeatPort](@ref) Thermal port from which sensor information shall be measured
- `port_b`: [HeatPort](@ref) Thermal port from which sensor information shall be measured
- `Q_flow`: [RealOutput](@ref) [W] Heat flow from `port_a` to `port_b`
- `port_a`: [`HeatPort`](@ref) Thermal port from which sensor information shall be measured
- `port_b`: [`HeatPort`](@ref) Thermal port from which sensor information shall be measured
- `Q_flow`: [`RealOutput`](@ref) [W] Heat flow from `port_a` to `port_b`
"""
@component function HeatFlowSensor(; name)
pars = @parameters begin
Expand Down
Loading