agi.foundation.celestial

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

Enum RoleOfForce

java.lang.Object

java.lang.Enum<RoleOfForce>

agi.foundation.celestial.RoleOfForce

All Implemented Interfaces:

Enumeration, Serializable, Comparable<RoleOfForce>

public enum RoleOfForce
extends Enum<RoleOfForce>
implements Enumeration

An indication of how important a given force is in the overall composite force acting on a given object. Certain integrators will use this information to optimize the efficiency of evaluating the equations of motion during propagation of forces.

See Also:

GaussJacksonIntegrator

Enum Constant Summary

Enum Constants

Enum Constant and Description
MIXED Indicates that a particular force contains both a principal component representing the first-order effects and more complex perturbation effects.
PERTURBATION Indicates that a particular force is a perturbation added to the principal force (or in rare cases, principal forces).
PRINCIPAL Indicates that a particular force dominates the force resultant and is simple to compute.

Method Summary

Modifier and Type	Method and Description
static RoleOfForce	getDefault() Get the enum constant that is considered to be the default.
static RoleOfForce	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 RoleOfForce	valueOf(String name) Returns the enum constant of this type with the specified name.
static RoleOfForce[]	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

PRINCIPAL

public static final RoleOfForce PRINCIPAL

Indicates that a particular force dominates the force resultant and is simple to compute. For instance, in orbital equations of motion, two body gravity is often the principal force and all others are perturbations.

PERTURBATION

public static final RoleOfForce PERTURBATION

Indicates that a particular force is a perturbation added to the principal force (or in rare cases, principal forces). Such forces usually have a small effect on the overall force but can be expensive to compute.

MIXED

public static final RoleOfForce MIXED

Indicates that a particular force contains both a principal component representing the first-order effects and more complex perturbation effects. Usually, this role is treated as a principal force for most purposes but is intended to be broken into its components when creating evaluators.

Method Detail

values

public static RoleOfForce[] 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 (RoleOfForce c : RoleOfForce.values())
    System.out.println(c);

Returns:

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

valueOf

public static RoleOfForce 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 RoleOfForce 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 RoleOfForce getDefault()

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

Returns:

The default enum constant.