agi.foundation.celestial

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

Class ForceModel

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.celestial.ForceModel

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

Direct Known Subclasses:

AtmosphericDragForce, ConstantForce, ContinuousThrustForceModel, IersTechnicalNote36RelativisticCorrectionForce, NPlateAtmosphericDragForce, NPlateSolarRadiationForce, SimpleSolarRadiationForce, SphericalHarmonicGravity, ThirdBodyGravity, TwoBodyGravity

public abstract class ForceModel
extends DefinitionalObject

Represents a Newtonian force which can be used to specify the equations of motion for a mass body located by a PropagationNewtonianPoint.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ForceModel(ForceModel existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.
protected	ForceModel(RoleOfForce role, KindOfForce kind) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
abstract void	buildForceEvaluator(ResultantForceBuilder builder, EvaluatorGroup group) Build lists of principal and perturbation forces based on this model in order to create an overall resultant force.
protected boolean	checkForSameDefinition(DefinitionalObject other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected abstract boolean	checkForSameDefinition(ForceModel other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected int	computeCurrentDefinitionHashCode() Computes a hash code based on the current properties of this object.
void	enumerateDependencies(DependencyEnumerator enumerator) Enumerates the dependencies of this object by calling DependencyEnumerator#enumerate(T) for each object that this object directly depends upon.
protected void	freezeAggregatedObjects() Called by DefinitionalObject.freeze() to also freeze any objects that are considered to be a part of this object.
ForceEvaluator	getForceEvaluator() Gets an instance of an evaluator that can compute the force.
ForceEvaluator	getForceEvaluator(EvaluatorGroup group) Gets an instance of an evaluator that can compute the force.
Vector	getForceVector() Gets the Vector representation of this force.
KindOfForce	getKind() Gets an enumeration indicating the nature of this force and whether it implicitly includes mass.
RoleOfForce	getRole() Gets the role that this force plays in a combined resultant force.

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, clone, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, freeze, getCollectionHashCode, getCollectionHashCode, getCollectionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDictionaryHashCode, getIsFrozen, isSameDefinition, throwIfFrozen

Methods inherited from class java.lang.Object

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

Constructor Detail

ForceModel

protected ForceModel(@Nonnull
                     RoleOfForce role,
                     @Nonnull
                     KindOfForce kind)

Initializes a new instance.

Parameters:

kind - The nature of the force and whether it implicitly includes mass.

role - The role the force plays in a combined resultant force.

ForceModel

protected ForceModel(@Nonnull
                     ForceModel existingInstance,
                     @Nonnull
                     CopyContext context)

Initializes a new instance as a copy of an existing instance.

See ICloneWithContext.clone(CopyContext) for more information about how to implement this constructor in a derived class.

Parameters:

existingInstance - The existing instance to copy.

context - A CopyContext that controls the depth of the copy.

Throws:

ArgumentNullException - Thrown when existingInstance or context is null.

Method Detail

checkForSameDefinition

protected final boolean checkForSameDefinition(DefinitionalObject other)

Checks to determine if another instance has the same definition as this instance and returns true if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return false for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IEquatableDefinition.isSameDefinition(java.lang.Object).

Specified by:

checkForSameDefinition in class DefinitionalObject

Parameters:

other - The other instance to compare to this one.

Returns:

true if the two objects are defined equivalently; otherwise false.

checkForSameDefinition

protected abstract boolean checkForSameDefinition(ForceModel other)

Checks to determine if another instance has the same definition as this instance and returns true if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return false for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IEquatableDefinition.isSameDefinition(java.lang.Object).

Parameters:

other - The other instance to compare to this one.

Returns:

true if the two objects are defined equivalently; otherwise false.

computeCurrentDefinitionHashCode

protected int computeCurrentDefinitionHashCode()

Computes a hash code based on the current properties of this object. Derived classes MUST override this method and compute a hash code that combines: a unique hash code seed, the base implementation result, and the hash codes of all new fields introduced by the derived class which are used in the ForceModel.checkForSameDefinition(agi.foundation.infrastructure.DefinitionalObject) method.

Overrides:

computeCurrentDefinitionHashCode in class DefinitionalObject

Returns:

The computed hash code.

enumerateDependencies

public void enumerateDependencies(DependencyEnumerator enumerator)

Enumerates the dependencies of this object by calling DependencyEnumerator#enumerate(T) for each object that this object directly depends upon. Derived classes which contain additional dependencies MUST override this method, call the base implementation, and enumerate dependencies introduced by the derived class.

Specified by:

enumerateDependencies in interface IEnumerateDependencies

Overrides:

enumerateDependencies in class DefinitionalObject

Parameters:

enumerator - The enumerator that is informed of the dependencies of this object.

freezeAggregatedObjects

protected void freezeAggregatedObjects()

Called by DefinitionalObject.freeze() to also freeze any objects that are considered to be a part of this object. Derived classes which contain additional aggregated objects MUST override this method, call the base implementation, and freeze aggregated objects introduced by the derived class. The objects that need to be frozen in this method are frequently created in this object's constructor and are not settable via properties.

Overrides:

freezeAggregatedObjects in class DefinitionalObject

getForceVector

@Nonnull
public Vector getForceVector()

Gets the Vector representation of this force.

getKind

@Nonnull
public final KindOfForce getKind()

Gets an enumeration indicating the nature of this force and whether it implicitly includes mass.

getRole

@Nonnull
public final RoleOfForce getRole()

Gets the role that this force plays in a combined resultant force. In particular, it indicates whether this force is dominant and easy to compute or whether it is a small perturbation that is expensive to compute.

getForceEvaluator

@Nonnull
public final ForceEvaluator getForceEvaluator()

Gets an instance of an evaluator that can compute the force.

Returns:

The evaluator that computes the force.

getForceEvaluator

@Nonnull
public ForceEvaluator getForceEvaluator(@Nonnull
                                                  EvaluatorGroup group)

Gets an instance of an evaluator that can compute the force.

Parameters:

group - The group in which to create the evaluator and its dependents.

Returns:

The evaluator that computes the force.

Throws:

ArgumentNullException - Thrown when group is null.

buildForceEvaluator

public abstract void buildForceEvaluator(@Nonnull
                                         ResultantForceBuilder builder,
                                         @Nonnull
                                         EvaluatorGroup group)

Build lists of principal and perturbation forces based on this model in order to create an overall resultant force.

Parameters:

builder - The builder object containing the lists and additional information on the Axes in which the overall resultant is defined.

group - The evaluator group in which to create evaluators.