Gravity Engine  1.5
Unity Asset for Gravity
LeapFrogIntegrator Class Reference
Inheritance diagram for LeapFrogIntegrator:
INBodyIntegrator

Public Member Functions

 LeapFrogIntegrator (IForceDelegate force)
 Initializes a new instance of the LeapFrogIntegrator class. An optional force delegate can be provided if non-Newtonian gravity is desired. More...
 
void Setup (int maxBodies, double timeStep)
 Setup the specified maxBodies and timeStep. More...
 
INBodyIntegrator DeepClone ()
 Clone this instance, replicating internal arrays. Copy across any internal state required for continued evolution. More...
 
void AddNBody (int bodyNum, NBody nbody, Vector3 position, Vector3 velocity)
 Adds the N body. Implementation may support the case where the initial number of bodies in Setup() is exceeded, creating space, or may ignore additions that exceed this limit (e.g. AZTTriple). More...
 
void RemoveBodyAtIndex (int atIndex)
 Removes NBody at index i. More...
 
void GrowArrays (int growBy)
 Grows the arrays. Called by GravityEngine when it changes internal data sizes. More...
 
Vector3 GetVelocityForIndex (int i)
 
void GetVelocityDoubleForIndex (int i, ref double[] vel)
 
void SetVelocityForIndex (int i, Vector3 vel)
 
Vector3 GetAccelerationForIndex (int i)
 
void PreEvolve (GravityState gravityState, ref byte[] info)
 Call ONCE after all game objects have been added to allow integrator to pre-calc starting quantities required for integration More...
 
float GetEnergy (GravityState gravityState)
 Gets the energy of the system. More...
 
float GetInitialEnergy (GravityState gravityState)
 Gets the initial energy. More...
 
double Evolve (double time, GravityState gravityState, ref byte[] info)
 Evolve the specified time, m, r and info. More...
 

Constructor & Destructor Documentation

LeapFrogIntegrator.LeapFrogIntegrator ( IForceDelegate  force)

Initializes a new instance of the LeapFrogIntegrator class. An optional force delegate can be provided if non-Newtonian gravity is desired.

Parameters
forceForce.

Member Function Documentation

void LeapFrogIntegrator.AddNBody ( int  bodyNum,
NBody  nbody,
Vector3  position,
Vector3  velocity 
)

Adds the N body. Implementation may support the case where the initial number of bodies in Setup() is exceeded, creating space, or may ignore additions that exceed this limit (e.g. AZTTriple).

Parameters
nbodyNBody component
positionPhysics position
velocityPhysics velocity

Implements INBodyIntegrator.

INBodyIntegrator LeapFrogIntegrator.DeepClone ( )

Clone this instance, replicating internal arrays. Copy across any internal state required for continued evolution.

Implements INBodyIntegrator.

double LeapFrogIntegrator.Evolve ( double  time,
GravityState  gravityState,
ref byte[]  info 
)

Evolve the specified time, m, r and info.

Integrators will evolve for at least as long as the specified time, but can overshoot. The GravityEngine will correct on the next cycle.

Parameters
timeTime.
mM.
rThe red component.
infoInfo.

Implements INBodyIntegrator.

float LeapFrogIntegrator.GetEnergy ( GravityState  gravityState)

Gets the energy of the system.

Returns
The energy.
Parameters
massMass.
posPosition.

Implements INBodyIntegrator.

float LeapFrogIntegrator.GetInitialEnergy ( GravityState  gravityState)

Gets the initial energy.

Returns
The initial energy.
Parameters
massMass.
posPosition.

Implements INBodyIntegrator.

void LeapFrogIntegrator.GrowArrays ( int  growBy)

Grows the arrays. Called by GravityEngine when it changes internal data sizes.

Parameters
growByGrow by.

Implements INBodyIntegrator.

void LeapFrogIntegrator.PreEvolve ( GravityState  gravityState,
ref byte[]  info 
)

Call ONCE after all game objects have been added to allow integrator to pre-calc starting quantities required for integration

To avoid copies of mass and position arrays in integrators provide a reference to these for Evolve and PreEvolve

Some implementations (e.g. AZTriple) may make their own copies and then copy the result back into these arrays ///

Parameters
mM.
rThe red component.
infoInfo.

Implements INBodyIntegrator.

void LeapFrogIntegrator.RemoveBodyAtIndex ( int  atIndex)

Removes NBody at index i.

Parameters
atIndexAt index.

Implements INBodyIntegrator.

void LeapFrogIntegrator.Setup ( int  maxBodies,
double  timeStep 
)

Setup the specified maxBodies and timeStep.

Parameters
maxBodiesMax bodies.
timeStepTime step.

Implements INBodyIntegrator.


The documentation for this class was generated from the following file: