agi.foundation.celestial

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

Class DragPlate

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.celestial.IndividualPlateModel

agi.foundation.celestial.DragPlate

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

Direct Known Subclasses:

DragBodyPlate, DragOneDofSolarPanelPlate, DragTwoDofSolarPanelPlate

public abstract class DragPlate
extends IndividualPlateModel

A model of a discrete surface element of a spacecraft that has a surface area, unit normal direction, and a drag coefficient.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DragPlate(DragPlate existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.
protected	DragPlate(String plateName, String groupName, double referenceArea, double dragCoefficient) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
protected abstract boolean	checkForSameDefinition(DragPlate other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected boolean	checkForSameDefinition(IndividualPlateModel 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.
double	getDragCoefficient() Gets the dimensionless drag coefficient of this plate.
abstract Scalar	getSwitchingScalar(Axes bodyAxes, Vector toSunVector, Vector velocity) Gets a scalar that is used to determine whether this plate is facing a direction within 90 degrees of the incident atmosphere direction at a given time.
void	setDragCoefficient(double value) Sets the dimensionless drag coefficient of this plate.

Methods inherited from class agi.foundation.celestial.IndividualPlateModel

checkForSameDefinition, getGroupName, getPlateName, getReferenceArea, getUnitNormalVector, setGroupName, setPlateName, setReferenceArea

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, clone, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, enumerateDependencies, 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

DragPlate

protected DragPlate(String plateName,
                    String groupName,
                    double referenceArea,
                    double dragCoefficient)

Initializes a new instance.

Parameters:

plateName - The name of the individual plate.

groupName - The name of the group of plates that contains this plate. (E.g. Body or SolarPanels.)

referenceArea - The surface area of this plate in meters squared.

dragCoefficient - The dimensionless drag coefficient of this plate.

DragPlate

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

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(DragPlate 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 DragPlate.checkForSameDefinition(agi.foundation.celestial.IndividualPlateModel) method.

Overrides:

computeCurrentDefinitionHashCode in class IndividualPlateModel

Returns:

The computed hash code.

getDragCoefficient

public final double getDragCoefficient()

Gets the dimensionless drag coefficient of this plate.

setDragCoefficient

public final void setDragCoefficient(double value)

Sets the dimensionless drag coefficient of this plate.

getSwitchingScalar

public abstract Scalar getSwitchingScalar(Axes bodyAxes,
                                          Vector toSunVector,
                                          Vector velocity)

Gets a scalar that is used to determine whether this plate is facing a direction within 90 degrees of the incident atmosphere direction at a given time.

DragBodyPlates do not produce drag when they are not facing the incoming atmosphere. The two types of drag solar panel plates produce drag on their back faces when their front faces are facing away from the incoming atmosphere.

Parameters:

bodyAxes - The attitude of the spacecraft containing this plate.

toSunVector - The direction to the Sun that is used to determine the pointing of Solar panel plates.

velocity - The velocity vector of the spacecraft that is used to determine the direction of the incoming atmosphere.

Returns:

A scalar that is used to determine whether this plate is facing the incoming atmosphere at a given time.