Skip to content

Commit

Permalink
improve docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jbphet committed Aug 7, 2023
1 parent 4984c36 commit e9a2082
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion js/common/model/PhotonAbsorbingEmittingLayer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -75,13 +75,29 @@ type SelfOptions = {
export type PhotonAbsorbingEmittingLayerOptions = SelfOptions & WithRequired<PhetioObjectOptions, 'tandem'>;

class PhotonAbsorbingEmittingLayer extends PhetioObject {

// thickness of this layer in meters
public readonly thickness: number;

// time, in seconds, for which photons are absorbed by this layer
private readonly photonAbsorptionTime: number;

// max horizontal distance that a photon will "jump" between absorption and re-emission
private readonly photonMaxJumpDistance: number;

// see options description for this one
private readonly absorbanceMultiplier: number;

// a Map that is used to track the amount of time that an absorbed photon has been absorbed into this layer
private readonly photonToAbsorbedTimeMap: Map<Photon, number>;

// photons that are moving around in the model and could potentially cross and be absorbed by this layer
public readonly photons: ObservableArray<Photon>;

// the atmosphere layer in the model to which this layer corresponds
private atmosphereLayer: AtmosphereLayer;

// a Property that transitions from false to true when the first photon is absorbed by this layer
public atLeastOnePhotonAbsorbedProperty: BooleanProperty;

public constructor( photons: ObservableArray<Photon>,
Expand Down Expand Up @@ -109,7 +125,6 @@ class PhotonAbsorbingEmittingLayer extends PhetioObject {
phetioReadOnly: true
} );

// a Map that is used to track the amount of time that an absorbed photon has been absorbed into this layer
this.photonToAbsorbedTimeMap = new Map<Photon, number>();

// options that control various aspects of the photon re-emission process
Expand Down

0 comments on commit e9a2082

Please sign in to comment.