Class FaradayLaw<T>

A force law computes the forces on one or more bodies in the system.

Type Parameters

T

Hierarchy

AbstractSimObject
- FaradayLaw

Implements

ForceLaw<T>

Index

Constructors

Accessors

expireTime forces

Methods

disconnect potentialEnergy updateForces

Constructors

constructor

new FaradayLaw<T>(body, field): FaradayLaw<T>
force = Q * (v << F), where Q is the body charge, v is the ordinary spacetime velocity, F is the Faraday field at the body location.
Type Parameters
- T
Parameters
- body: Charged<T>
  the body upon which the field acts.
- field: ((position) => T)
  the Faraday field. This field that has a bivector value.
  - - (position): T
    - Parameters
      position: T
      Returns T
Returns FaradayLaw<T>
Overrides AbstractSimObject.constructor
- Defined in src/lib/core/FaradayLaw.ts:16

Accessors

expireTime

get expireTime(): number
Returns number
Implementation of ForceLaw.expireTime
Inherited from AbstractSimObject.expireTime
- Defined in src/lib/objects/AbstractSimObject.ts:37
set expireTime(expireTime): void
Parameters
- expireTime: number
Returns void
Implementation of ForceLaw.expireTime
Inherited from AbstractSimObject.expireTime
- Defined in src/lib/objects/AbstractSimObject.ts:40

forces

get forces(): Force<T>[]
The forces that were computed the last time that the updateForces() method was called.

Returns Force<T>[]
Implementation of ForceLaw.forces
- Defined in src/lib/core/FaradayLaw.ts:24

Methods

disconnect

disconnect(): void
TODO: This does not do anything in the existing implementations of ForceLaw.

Returns void
Implementation of ForceLaw.disconnect
- Defined in src/lib/core/FaradayLaw.ts:52

potentialEnergy

potentialEnergy(): T
Computes the potential energy associated with the interaction of the bodies.

Returns T
Implementation of ForceLaw.potentialEnergy
- Defined in src/lib/core/FaradayLaw.ts:55

updateForces

updateForces(): Force<T>[]
Updates the forces based upon the current state of the bodies.

Returns Force<T>[]
Implementation of ForceLaw.updateForces
- Defined in src/lib/core/FaradayLaw.ts:27

Generated using TypeDoc