agi.foundation.celestial

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

Class SolarRadiationBoundaryMitigation

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.propagators.advanced.PropagationStateCorrector

agi.foundation.celestial.SolarRadiationBoundaryMitigation

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

public class SolarRadiationBoundaryMitigation
extends PropagationStateCorrector

Corrects for eclipse crossings during satellite propagation.

Constructor Summary

Constructors

Modifier	Constructor and Description
	SolarRadiationBoundaryMitigation(PropagationPointElement statePosition, CentralBody centralBody, double gravitationalParameter, SimpleSolarRadiationForce forceToCorrect, Scalar mass) Creates an instance.
protected	SolarRadiationBoundaryMitigation(SolarRadiationBoundaryMitigation existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.

Method Summary

Modifier and Type	Method and Description
protected boolean	checkForSameDefinition(PropagationStateCorrector other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected boolean	checkForSameDefinition(SolarRadiationBoundaryMitigation other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
Object	clone(CopyContext context) Clones this object using the specified context.
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.
CentralBody	getCentralBody() Gets the CentralBody (get / set) to use for the two-body gravity correction and as an eclipsing body to monitor for boundary crossings.
PropagationStateCorrectionEvaluator	getCorrectionEvaluator() This method creates an evaluator to calculate the post integration correction.
PropagationStateCorrectionEvaluator	getCorrectionEvaluator(EvaluatorGroup group) This method creates an evaluator to calculate the post integration correction.
SimpleSolarRadiationForce	getForceToCorrect() Gets the SimpleSolarRadiationForce to perform boundary mitigation on.
double	getGravitationalParameter() Gets the gravitational parameter to use for the two-body gravity correction.
Scalar	getMass() Gets the Scalar describing the mass of the object being corrected.
PropagationPointElement	getStatePosition() Gets the position element of the object that is being corrected.
void	setCentralBody(CentralBody value) Sets the CentralBody (get / set) to use for the two-body gravity correction and as an eclipsing body to monitor for boundary crossings.
void	setForceToCorrect(SimpleSolarRadiationForce value) Sets the SimpleSolarRadiationForce to perform boundary mitigation on.
void	setGravitationalParameter(double value) Sets the gravitational parameter to use for the two-body gravity correction.
void	setMass(Scalar value) Sets the Scalar describing the mass of the object being corrected.
void	setStatePosition(PropagationPointElement value) Sets the position element of the object that is being corrected.

Methods inherited from class agi.foundation.propagators.advanced.PropagationStateCorrector

checkForSameDefinition

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, freeze, freezeAggregatedObjects, 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

SolarRadiationBoundaryMitigation

public SolarRadiationBoundaryMitigation(PropagationPointElement statePosition,
                                        CentralBody centralBody,
                                        double gravitationalParameter,
                                        SimpleSolarRadiationForce forceToCorrect,
                                        Scalar mass)

Creates an instance.

Parameters:

statePosition - The position element of the object that is being corrected.

centralBody - The CentralBody (get / set) to use as an eclipsing body and as the source of two body gravity.

gravitationalParameter - The gravitational parameter of the central body. WorldGeodeticSystem1984.GravitationalParameter is recommended as the default value.

forceToCorrect - The existing solar radiation force to use as a basis for the SRPBoundary mitigation.

mass - The scalar describing the mass of the object being corrected.

SolarRadiationBoundaryMitigation

protected SolarRadiationBoundaryMitigation(@Nonnull
                                           SolarRadiationBoundaryMitigation 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

clone

public Object clone(CopyContext context)

Clones this object using the specified context.

This method should be implemented to call a copy constructor on the class of the object being cloned. The copy constructor should take the CopyContext as a parameter in addition to the existing instance to copy. The copy constructor should first call CopyContext.addObjectMapping(T, T) to identify the newly constructed instance as a copy of the existing instance. It should then copy all fields, using CopyContext.updateReference(T) to copy any reference fields.

A typical implementation of ICloneWithContext:

public static class MyClass implements ICloneWithContext {
    public MyClass(MyClass existingInstance, CopyContext context) {
        context.addObjectMapping(existingInstance, this);
        someReference = context.updateReference(existingInstance.someReference);
    }

    @Override
    public final Object clone(CopyContext context) {
        return new MyClass(this, context);
    }

    private Object someReference;
}

In general, all fields that are reference types should be copied with a call to CopyContext.updateReference(T). There are a couple of exceptions:

1. Fields that are aggregate parts of the object should always be copied. A referenced object is an aggregate if properties or methods on the object being copied can modify the externally-visible value of the referenced object.
2. If the semantics of the referenced object require that it have a single parent, owner, context, etc., and the object being copied is that parent, owner, or context, then the referenced object should always be copied.

If one of these exceptions applies, the CopyContext should be given an opportunity to update the reference before the reference is copied explicitly. Use CopyContext.updateReference(T) to update the reference. If CopyContext.updateReference(T) returns the original object, indicating that the context does not have a replacement registered, then copy the object manually by invoking a Clone method, a copy constructor, or by manually constructing a new instance and copying the values.

alwaysCopy = context.updateReference(existingInstance.alwaysCopy);
if (existingInstance.alwaysCopy != null && alwaysCopy == existingInstance.alwaysCopy) {
    alwaysCopy = (AlwaysCopy) existingInstance.alwaysCopy.clone(context);
}

If you are implementing an evaluator (a class that implements IEvaluator), the IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) method shares some responsibilities with the copy context constructor. Code duplication can be avoided by doing the following:

1. For references to other evaluators ONLY, simply assign the reference in the constructor instead of calling CopyContext.updateReference(T). You should still call CopyContext.updateReference(T) on any references to non-evaluators.
2. Call IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as the last line in the constructor and pass it the same CopyContext passed to the constructor.
3. Implement IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as normal. See the reference documentation for IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) for more information on implementing that method.

public MyClass(MyClass existingInstance, CopyContext context) {
    super(existingInstance, context);
    someReference = context.updateReference(existingInstance.someReference);
    evaluatorReference = existingInstance.evaluatorReference;
    updateEvaluatorReferences(context);
}

@Override
public void updateEvaluatorReferences(CopyContext context) {
    evaluatorReference = context.updateReference(evaluatorReference);
}

@Override
public Object clone(CopyContext context) {
    return new MyClass(this, context);
}

private Object someReference;
private IEvaluator evaluatorReference;

Specified by:

clone in interface ICloneWithContext

Specified by:

clone in class DefinitionalObject

Parameters:

context - The context to use to perform the copy.

Returns:

A new instance which is a copy of this object.

checkForSameDefinition

protected final boolean checkForSameDefinition(PropagationStateCorrector 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 PropagationStateCorrector

Parameters:

other - The other instance to compare to this one.

Returns:

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

checkForSameDefinition

protected boolean checkForSameDefinition(@Nullable
                                         SolarRadiationBoundaryMitigation 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 SolarRadiationBoundaryMitigation.checkForSameDefinition(agi.foundation.propagators.advanced.PropagationStateCorrector) method.

Overrides:

computeCurrentDefinitionHashCode in class PropagationStateCorrector

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.

getStatePosition

public final PropagationPointElement getStatePosition()

Gets the position element of the object that is being corrected.

setStatePosition

public final void setStatePosition(PropagationPointElement value)

Sets the position element of the object that is being corrected.

getGravitationalParameter

public final double getGravitationalParameter()

Gets the gravitational parameter to use for the two-body gravity correction. WorldGeodeticSystem1984.GravitationalParameter is recommended as the default value.

setGravitationalParameter

public final void setGravitationalParameter(double value)

Sets the gravitational parameter to use for the two-body gravity correction. WorldGeodeticSystem1984.GravitationalParameter is recommended as the default value.

getForceToCorrect

public final SimpleSolarRadiationForce getForceToCorrect()

Gets the SimpleSolarRadiationForce to perform boundary mitigation on.

setForceToCorrect

public final void setForceToCorrect(SimpleSolarRadiationForce value)

Sets the SimpleSolarRadiationForce to perform boundary mitigation on.

getCentralBody

public final CentralBody getCentralBody()

Gets the CentralBody (get / set) to use for the two-body gravity correction and as an eclipsing body to monitor for boundary crossings.

setCentralBody

public final void setCentralBody(CentralBody value)

Sets the CentralBody (get / set) to use for the two-body gravity correction and as an eclipsing body to monitor for boundary crossings.

getMass

public final Scalar getMass()

Gets the Scalar describing the mass of the object being corrected.

setMass

public final void setMass(Scalar value)

Sets the Scalar describing the mass of the object being corrected.

getCorrectionEvaluator

@Nonnull
public PropagationStateCorrectionEvaluator getCorrectionEvaluator()

This method creates an evaluator to calculate the post integration correction.

Specified by:

getCorrectionEvaluator in class PropagationStateCorrector

Returns:

A type that evaluates post integration correction.

getCorrectionEvaluator

public PropagationStateCorrectionEvaluator getCorrectionEvaluator(EvaluatorGroup group)

This method creates an evaluator to calculate the post integration correction.

Specified by:

getCorrectionEvaluator in class PropagationStateCorrector

Parameters:

group - The group with which to associate the new evaluator. By grouping evaluators that are often evaluated at the same Julian dates, common computations can be performed only once for the entire group instead of multiple times for each evaluator.

Returns:

A type that evaluates post integration correction.