Skip to content

Commit

Permalink
revise currentAmplitude doc, #130
Browse files Browse the repository at this point in the history
  • Loading branch information
pixelzoom committed Mar 26, 2024
1 parent 7f92ed9 commit 9062c78
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion doc/model.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ are provided, e.g. `BarMagnet`. Code can be found [here](https://github.com/phe

**B-field**: a synonym for magnetic field.

**Current amplitude**: A percentage with range [-1,1] that describes the amount of current relative to the
**Current amplitude**: A value with range [-1,1]. The magnitude describes the amount of current relative to the
maximum current that may be induced in the model. The sign indicates the direction
of the current. View components use this value to determine how they should respond to induced current.
For example, deflection of the voltmeter needle, brightness of the light bulb, and speed of
Expand Down
8 changes: 4 additions & 4 deletions js/common/model/Coil.ts
Original file line number Diff line number Diff line change
Expand Up @@ -78,10 +78,10 @@ export type CoilOptions = SelfOptions & PickRequired<PhetioObjectOptions, 'tande

export default class Coil extends PhetioObject {

// This is a quantity that PhET made up. It is a percentage [-1,1] that describes the amount of current relative to
// some maximum current in the model, and the sign indicates the direction of that current. View components can use
// this value to determine how they should behave -- eg, how far to move a voltmeter needle, how bright to make a
// light bulb, and how fast to move electrons.
// This is a quantity that PhET made up. It is a value in the range [-1,1]. The magnitude describes the amount of
// current relative to some maximum current in the model. The sign indicates the direction of that current. View
// components can use this value to determine how they should behave -- eg, how far to move a voltmeter needle,
// how bright to make a light bulb, and how fast to move electrons.
public readonly currentAmplitudeProperty: TReadOnlyProperty<number>;
private readonly currentAmplitudeRange: Range;

Expand Down

0 comments on commit 9062c78

Please sign in to comment.