Skip to content

Commit

Permalink
added doc, #51
Browse files Browse the repository at this point in the history
  • Loading branch information
zepumph committed Jun 23, 2017
1 parent 80cb97d commit f7572db
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 1 deletion.
15 changes: 15 additions & 0 deletions doc/implementation_notes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Ohm's Law - Implementation Notes

This document contains notes that will be helpful to developers and future maintainers of this simulation.

## Model

This sim uses axon.Property throughout the model and view for storage of properties and
notification of changes.

Start by reading the model description model.md

## View


The view adds batteries around a circuit to demonstrait current. It also has sound.
12 changes: 12 additions & 0 deletions doc/model.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Ohm's Law model

This document describes the model for the Ohm's Law simulation.<br>

The model describes the current of a straight ohmic wire. I is the current through the conductor in units of amperes,
V is the voltage measured across the conductor in units of volts, and R is the resistance of the conductor in units of ohms.
More specifically, Ohm's law states that the R in this relation is constant, independent of the current. This simulation's
model is simple. It represents this formula.

The Formula is
I= V/R or
Current = Volts / Ohms
1 change: 0 additions & 1 deletion js/ohms-law/view/FormulaNode.js
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,6 @@ define( function( require ) {
.timesMatrix( Matrix3.scale( entry.scaleA * value + entry.scaleB ) );
} );
} );

}

ohmsLaw.register( 'FormulaNode', FormulaNode );
Expand Down

0 comments on commit f7572db

Please sign in to comment.