Om  1.0.0
A universal framework for multimedia simulation
Public Types | Public Member Functions | List of all members
om::physics::base::PhysicsIntegrator Class Reference

A class that specifies how a simulation state is numerically integrated forward in time. More...

#include <omPhysicsIntegrator.h>

Public Types

enum  Enum {
  UNDEFINED = 0, EULER, EULER_SEMI_IMPLICIT, MIDPOINT,
  RK4, DEFAULT = EULER_SEMI_IMPLICIT
}
 An enum type that specifies the kinds of integrators. More...
 

Public Member Functions

 PhysicsIntegrator ()
 Create a new DEFAULT physics integrator. More...
 
 PhysicsIntegrator (Enum newIntegrator)
 Create a new physics integrator with the specified physics integrator enum value. More...
 
 operator Enum () const
 Convert this physics integrator to an enum value. More...
 
String toString () const
 Return a string representation of the physics integrator. More...
 
 operator String () const
 Convert this physics integrator into a string representation. More...
 

Detailed Description

A class that specifies how a simulation state is numerically integrated forward in time.

Member Enumeration Documentation

An enum type that specifies the kinds of integrators.

Enumerator
UNDEFINED 

An unfefined physics integrator.

EULER 

A forward first-order Euler integrator.

EULER_SEMI_IMPLICIT 

A semi-implicit first-order Euler integrator.

MIDPOINT 

A second-order midpoint integrator.

RK4 

A Runge-Kutta 4th order integrator.

DEFAULT 

The default integrator type.

Constructor & Destructor Documentation

om::physics::base::PhysicsIntegrator::PhysicsIntegrator ( )
inline

Create a new DEFAULT physics integrator.

om::physics::base::PhysicsIntegrator::PhysicsIntegrator ( Enum  newIntegrator)
inline

Create a new physics integrator with the specified physics integrator enum value.

Member Function Documentation

om::physics::base::PhysicsIntegrator::operator Enum ( ) const
inline

Convert this physics integrator to an enum value.

String om::physics::base::PhysicsIntegrator::toString ( ) const

Return a string representation of the physics integrator.

om::physics::base::PhysicsIntegrator::operator String ( ) const
inline

Convert this physics integrator into a string representation.


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