Dyad

Appearance

LIBRARY
Sources.Sine.md

Sources.Sine ​

Generates a sine wave signal with configurable parameters.

The component produces a sinusoidal output according to:

When time < start_time, the output depends on the continuous parameter:

  • continuous = true (default): output equals offset + amplitude * sin(2π * frequency * (start_time - shift_time) + phase), ensuring value continuity at start_time (backwards compatible)

  • continuous = false: output equals offset

By default shift_time = start_time (backwards compatible). Set shift_time = 0 for absolute time reference where phase has its exact physical meaning.

Note: when shift_time = start_time, the start_time parameter introduces a hidden phase shift of 2π * frequency * start_time. Use shift_time = 0 to avoid this.

This component extends from BlockComponents.Interfaces.Signal

Usage ​

BlockComponents.Sources.Sine(start_time=0.0, offset=0.0, amplitude, frequency, phase=0.0, shift_time=start_time, continuous=true)

Parameters: ​

NameDescriptionUnitsDefault value
start_timeTime at which the signal starts changing from its offset values0.0
offsetConstant value added to the signal output–0.0
amplitudePeak value of the sine wave–
frequencyNumber of cycles per time unitHz
phaseAngular displacement of the sine waverad0.0
shift_timeTime origin for the waveform (default: start_time for backwards compatibility; set to 0 for absolute time reference)sstart_time
continuousIf true, output is continuous at start_time by holding at the start value; if false, output is offset before start_time–true

Connectors ​

  • y - This connector represents a real signal as an output from a component (RealOutput)

Behavior ​

Source ​

dyad
"""
Generates a sine wave signal with configurable parameters.

The component produces a sinusoidal output according to:

```math
y = \text{offset} + \text{amplitude} \cdot \sin(2\pi \cdot \text{frequency} \cdot (\text{time} - \text{shift\_time}) + \text{phase})
```

When `time < start_time`, the output depends on the `continuous` parameter:
- `continuous = true` (default): output equals `offset + amplitude * sin(2π * frequency * (start_time - shift_time) + phase)`, ensuring value continuity at `start_time` (backwards compatible)
- `continuous = false`: output equals `offset`

By default `shift_time = start_time` (backwards compatible). Set `shift_time = 0` for
absolute time reference where `phase` has its exact physical meaning.

Note: when `shift_time = start_time`, the `start_time` parameter introduces a hidden
phase shift of `2π * frequency * start_time`. Use `shift_time = 0` to avoid this.
"""
component Sine
  extends BlockComponents.Interfaces.Signal
  "Peak value of the sine wave"
  parameter amplitude::Real
  "Number of cycles per time unit"
  parameter frequency::Frequency
  "Angular displacement of the sine wave"
  parameter phase::Angle = 0.0
  "Time origin for the waveform (default: start_time for backwards compatibility; set to 0 for absolute time reference)"
  parameter shift_time::Time = start_time
  "If true, output is continuous at start_time by holding at the start value; if false, output is offset before start_time"
  parameter continuous::Boolean = true
relations
  y = offset + ifelse(continuous, amplitude * ifelse(time >= start_time, sin(2 * π * frequency * (time - shift_time) + phase), sin(2 * π * frequency * (start_time - shift_time) + phase)), ifelse(time >= start_time, amplitude * sin(2 * π * frequency * (time - shift_time) + phase), 0.0))
metadata {
  "Dyad": {
    "labels": [{"label": "$(instance)", "x": 500, "y": 1100, "rot": 0}],
    "icons": {"default": "dyad://BlockComponents/Sine.svg"}
  }
}
end
Flattened Source
dyad
"""
Generates a sine wave signal with configurable parameters.

The component produces a sinusoidal output according to:

```math
y = \text{offset} + \text{amplitude} \cdot \sin(2\pi \cdot \text{frequency} \cdot (\text{time} - \text{shift\_time}) + \text{phase})
```

When `time < start_time`, the output depends on the `continuous` parameter:
- `continuous = true` (default): output equals `offset + amplitude * sin(2π * frequency * (start_time - shift_time) + phase)`, ensuring value continuity at `start_time` (backwards compatible)
- `continuous = false`: output equals `offset`

By default `shift_time = start_time` (backwards compatible). Set `shift_time = 0` for
absolute time reference where `phase` has its exact physical meaning.

Note: when `shift_time = start_time`, the `start_time` parameter introduces a hidden
phase shift of `2π * frequency * start_time`. Use `shift_time = 0` to avoid this.
"""
component Sine
  "Real-valued output connector for the component"
  y = RealOutput() {
    "Dyad": {
      "placement": {
        "icon": {"iconName": "default", "x1": 1000, "y1": 450, "x2": 1100, "y2": 550, "rot": 0},
        "diagram": {"iconName": "default", "x1": 1000, "y1": 450, "x2": 1100, "y2": 550, "rot": 0}
      }
    }
  }
  "Time at which the signal starts changing from its offset value"
  parameter start_time::Time = 0.0
  "Constant value added to the signal output"
  parameter offset::Real = 0.0
  "Peak value of the sine wave"
  parameter amplitude::Real
  "Number of cycles per time unit"
  parameter frequency::Frequency
  "Angular displacement of the sine wave"
  parameter phase::Angle = 0.0
  "Time origin for the waveform (default: start_time for backwards compatibility; set to 0 for absolute time reference)"
  parameter shift_time::Time = start_time
  "If true, output is continuous at start_time by holding at the start value; if false, output is offset before start_time"
  parameter continuous::Boolean = true
relations
  y = offset + ifelse(continuous, amplitude * ifelse(time >= start_time, sin(2 * π * frequency * (time - shift_time) + phase), sin(2 * π * frequency * (start_time - shift_time) + phase)), ifelse(time >= start_time, amplitude * sin(2 * π * frequency * (time - shift_time) + phase), 0.0))
metadata {
  "Dyad": {
    "labels": [{"label": "$(instance)", "x": 500, "y": 1100, "rot": 0}],
    "icons": {"default": "dyad://BlockComponents/Sine.svg"}
  }
}
end


Test Cases ​

No test cases defined.