agi.foundation.celestial

(agi.foundation.orbitpropagation-2024r2.jar)

Enum KindOfForce

java.lang.Object

java.lang.Enum<KindOfForce>

agi.foundation.celestial.KindOfForce

All Implemented Interfaces:

Enumeration, Serializable, Comparable<KindOfForce>

public enum KindOfForce
extends Enum<KindOfForce>
implements Enumeration

Indicates the properties of a given force to be used when distinguishing the behavior of forces when defining equations of motion.

Enum Constant Summary

Enum Constants

Enum Constant and Description
NEWTONIAN_FORCE A Newtonian force which may be applied to any given point mass to produce an acceleration.
NEWTONIAN_REACTION_FORCE A Newtonian "reaction" force is a force which results from the change in mass of a system.
NEWTONIAN_SPECIFIC_FORCE A Newtonian "specific" force which takes the target mass into account to produce a force independent of mass.

Method Summary

Modifier and Type	Method and Description
static KindOfForce	getDefault() Get the enum constant that is considered to be the default.
static KindOfForce	getFromValue(int value) Get the enum constant that is associated with the given numeric value.
int	getValue() Get the numeric value associated with this enum constant.
static KindOfForce	valueOf(String name) Returns the enum constant of this type with the specified name.
static KindOfForce[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NEWTONIAN_FORCE

public static final KindOfForce NEWTONIAN_FORCE

A Newtonian force which may be applied to any given point mass to produce an acceleration. For example, atmospheric drag is a Newtonian force.

NEWTONIAN_SPECIFIC_FORCE

public static final KindOfForce NEWTONIAN_SPECIFIC_FORCE

A Newtonian "specific" force which takes the target mass into account to produce a force independent of mass. For example, gravity is a specific force.

NEWTONIAN_REACTION_FORCE

public static final KindOfForce NEWTONIAN_REACTION_FORCE

A Newtonian "reaction" force is a force which results from the change in mass of a system. Usually, a reaction force is equivalent to "thrust" on a body and acts on the instantaneous point-mass in proportion to the rate of change of the mass of the system.

Method Detail

values

public static KindOfForce[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (KindOfForce c : KindOfForce.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static KindOfForce valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getValue

public int getValue()

Get the numeric value associated with this enum constant.

Specified by:

getValue in interface Enumeration

Returns:

A numeric value.

getFromValue

@Nonnull
public static KindOfForce getFromValue(int value)

Get the enum constant that is associated with the given numeric value.

Parameters:

value - a numeric value.

Returns:

The enum constant associated with value.

getDefault

@Nonnull
public static KindOfForce getDefault()

Get the enum constant that is considered to be the default.

Returns:

The default enum constant.