Skip to content

Commit 19c31df

Browse files
committed
Address minor comments
1 parent 5ba8ea3 commit 19c31df

File tree

3 files changed

+8
-11
lines changed

3 files changed

+8
-11
lines changed

tidy3d/components/spice/sources/ac.py

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,12 @@ class SSACVoltageSource(Tidy3dBaseModel):
1414
"""
1515
Small-signal AC voltage source.
1616
17+
Notes
18+
-----
1719
This source represents a small-signal AC excitation defined by a list of bias voltages,
1820
a set of small-signal analysis frequencies, and a small-signal amplitude (linear scale).
1921
20-
Notes
21-
-----
22-
- The bias `voltage` refer to the DC operating point above the simulation ground.
23-
- The `frequency` array lists the AC analysis frequencies (in Hz).
24-
- The `amplitude` is the small-signal AC magnitude (in Volts).
25-
- Currently, electrical ports are not defined.
22+
The bias ``voltage`` refer to the DC operating point above the simulation ground. Currently, electrical ports are not defined.
2623
2724
Examples
2825
--------
@@ -42,21 +39,21 @@ class SSACVoltageSource(Tidy3dBaseModel):
4239
voltage: ArrayFloat1D = pd.Field(
4340
...,
4441
title="DC Bias Voltages",
45-
description="List of DC operating point voltages (above ground) used with 'VoltageBC'.",
42+
description="List of DC operating point voltages (above ground) used with :class:`VoltageBC`.",
4643
units=VOLT,
4744
)
4845

4946
frequency: ArrayFloat1D = pd.Field(
5047
...,
5148
title="AC Analysis Frequencies",
52-
description="List of small-signal analysis frequencies (in Hz).",
49+
description="List of small-signal analysis frequencies.",
5350
units=HERTZ,
5451
)
5552

5653
amplitude: pd.FiniteFloat = pd.Field(
5754
...,
5855
title="Small-Signal Amplitude",
59-
description="Small-signal AC amplitude (linear scale, in Volts).",
56+
description="Small-signal AC amplitude.",
6057
units=VOLT,
6158
)
6259

tidy3d/components/tcad/data/sim_data.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ class DeviceCharacteristics(Tidy3dBaseModel):
8888
ac_current_voltage: Optional[FreqPotentialDataArray] = pd.Field(
8989
None,
9090
title="AC current vs voltage and frequency",
91-
description="Complex small-signal current I(v, f) as a FreqPotentialDataArray.",
91+
description="Complex small-signal current I(v, f).",
9292
)
9393

9494

tidy3d/components/tcad/simulation/heat_charge.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1948,5 +1948,5 @@ def _get_ssac_frequency_and_amplitude(self):
19481948
bc.condition.source.amplitude,
19491949
)
19501950
raise SetupError(
1951-
"'HeatSimulation' does not include any `SSACVoltageSource` in 'boundary_spec')."
1951+
"'HeatSimulation' does not include any 'SSACVoltageSource' in 'boundary_spec')."
19521952
)

0 commit comments

Comments
 (0)