agi.foundation.celestial

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

Class ResultantForceBuilder

java.lang.Object

agi.foundation.celestial.ResultantForceBuilder

public class ResultantForceBuilder
extends Object

A tool used by ForceModel objects to add their RoleOfForce.PRINCIPAL and RoleOfForce.PERTURBATION forces to a list of forces in a resultant force.

Constructor Summary

Constructors

Constructor and Description
ResultantForceBuilder() Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
void	addForce(ForceEvaluator force) Adds the given force to either the PrincipalForces (get) or the PerturbationForces (get) based on its role.
ArrayList<ForceEvaluator>	getPerturbationForces() Gets a list of forces acting as RoleOfForce.PERTURBATION forces in the resultant.
ArrayList<ForceEvaluator>	getPrincipalForces() Gets a list of forces acting as RoleOfForce.PRINCIPAL forces in the resultant.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ResultantForceBuilder

public ResultantForceBuilder()

Initializes a new instance.

Method Detail

getPrincipalForces

public final ArrayList<ForceEvaluator> getPrincipalForces()

Gets a list of forces acting as RoleOfForce.PRINCIPAL forces in the resultant. A "principal" force is one which dominates the overall resultant and is usually simple to compute.

getPerturbationForces

public final ArrayList<ForceEvaluator> getPerturbationForces()

Gets a list of forces acting as RoleOfForce.PERTURBATION forces in the resultant. A "perturbation" force is one which represents a small addition to the overall resultant but is usually expensive to compute.

addForce

public final void addForce(@Nonnull
                           ForceEvaluator force)

Adds the given force to either the PrincipalForces (get) or the PerturbationForces (get) based on its role.

Parameters:

force - The force to add.