agi.foundation.celestial

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

Class ScalarAtmosphericDensity

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.geometry.Scalar

agi.foundation.celestial.ScalarAtmosphericDensity

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

Direct Known Subclasses:

ScalarDensityJacchia1970, ScalarDensityJacchiaRoberts, ScalarDensityMsis2000, ScalarDensityMsis86, ScalarDensityMsis90

public abstract class ScalarAtmosphericDensity
extends Scalar

Abstract base class for all atmospheric models used to calculate density.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ScalarAtmosphericDensity() Initializes a Scalar representing atmospheric density.
protected	ScalarAtmosphericDensity(Point targetPoint, SolarGeophysicalData solarGeophysicalData) Initializes a Scalar representing atmospheric density using the target point and solar-geophysical data.
protected	ScalarAtmosphericDensity(Point targetPoint, SolarGeophysicalData solarGeophysicalData, CentralBody centralBody, Vector sunVector) Initializes a Scalar representing atmospheric density using the target point and solar-geophysical data.
protected	ScalarAtmosphericDensity(ScalarAtmosphericDensity 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(Scalar other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected abstract boolean	checkForSameDefinition(ScalarAtmosphericDensity 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.
CentralBody	getCentralBody() Gets the central body of the atmosphere described by the density model.
abstract double	getLowerHeightLimit() Gets the lower bound of the height (in meters above the ellipsoid) for which the density model is valid.
SolarGeophysicalData	getSolarGeophysicalData() Gets the solar and magnetic flux information.
Point	getTargetPoint() Gets the target point describing the time-varying position at which density is to be calculated.
abstract double	getUpperHeightLimit() Gets the upper bound of the height (in meters above the ellipsoid) above which the density model will return a value of zero.
Vector	getVectorToSun() Gets the vector to the sun to use for modeling the effects of solar radiation on the atmosphere.
void	setApparentSunPosition() Configures the VectorToSun (get / set) to use the apparent displacement from the CentralBody (get / set) to the Sun (get).
void	setCentralBody(CentralBody value) Sets the central body of the atmosphere described by the density model.
void	setSolarGeophysicalData(SolarGeophysicalData value) Sets the solar and magnetic flux information.
void	setTargetPoint(Point value) Sets the target point describing the time-varying position at which density is to be calculated.
void	setTrueSunPosition() Configures the VectorToSun (get / set) to use the true displacement from the CentralBody (get / set) to the Sun (get).
abstract void	setUpperHeightLimit(double value) Sets the upper bound of the height (in meters above the ellipsoid) above which the density model will return a value of zero.
void	setVectorToSun(Vector value) Sets the vector to the sun to use for modeling the effects of solar radiation on the atmosphere.

Methods inherited from class agi.foundation.geometry.Scalar

add, add, add, add, add, checkForSameDefinition, createScalarDerivative, divide, divide, divide, divide, divide, getEvaluator, getEvaluator, multiply, multiply, multiply, multiply, multiply, power, subtract, subtract, subtract, subtract, subtract, toScalar

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, clone, 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

ScalarAtmosphericDensity

protected ScalarAtmosphericDensity()

Initializes a Scalar representing atmospheric density.

TargetPoint (get / set) and SolarGeophysicalData (get / set) must be set before an evaluator is created.

ScalarAtmosphericDensity

protected ScalarAtmosphericDensity(Point targetPoint,
                                   SolarGeophysicalData solarGeophysicalData)

Initializes a Scalar representing atmospheric density using the target point and solar-geophysical data.

Parameters:

targetPoint - The target point of the density calculations.

solarGeophysicalData - Solar and magnetic flux information.

ScalarAtmosphericDensity

protected ScalarAtmosphericDensity(Point targetPoint,
                                   SolarGeophysicalData solarGeophysicalData,
                                   CentralBody centralBody,
                                   Vector sunVector)

Initializes a Scalar representing atmospheric density using the target point and solar-geophysical data.

Parameters:

targetPoint - The target point of the density calculations.

solarGeophysicalData - Solar and magnetic flux information.

centralBody - The body whose atmosphere to model. Usually this is the Earth (get).

sunVector - The vector to use when modeling the direction to the sun with respect to the principal frame of the CentralBody (get / set).

ScalarAtmosphericDensity

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

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(ScalarAtmosphericDensity 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 ScalarAtmosphericDensity.checkForSameDefinition(agi.foundation.geometry.Scalar) method.

Overrides:

computeCurrentDefinitionHashCode in class Scalar

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.

getLowerHeightLimit

public abstract double getLowerHeightLimit()

Gets the lower bound of the height (in meters above the ellipsoid) for which the density model is valid.

getUpperHeightLimit

public abstract double getUpperHeightLimit()

Gets the upper bound of the height (in meters above the ellipsoid) above which the density model will return a value of zero.

setUpperHeightLimit

public abstract void setUpperHeightLimit(double value)

Sets the upper bound of the height (in meters above the ellipsoid) above which the density model will return a value of zero.

getTargetPoint

public final Point getTargetPoint()

Gets the target point describing the time-varying position at which density is to be calculated.

setTargetPoint

public final void setTargetPoint(Point value)

Sets the target point describing the time-varying position at which density is to be calculated.

getVectorToSun

public final Vector getVectorToSun()

Gets the vector to the sun to use for modeling the effects of solar radiation on the atmosphere. By default, this is set to represent the apparent displacement from the Earth (get) to the Sun (get) based on light time delay and aberration from the relative motion of the celestial bodies. Setting this to use the true displacement will be slightly less accurate but take less time to compute. However, not all density models will use the Sun's position.

setVectorToSun

public final void setVectorToSun(Vector value)

Sets the vector to the sun to use for modeling the effects of solar radiation on the atmosphere. By default, this is set to represent the apparent displacement from the Earth (get) to the Sun (get) based on light time delay and aberration from the relative motion of the celestial bodies. Setting this to use the true displacement will be slightly less accurate but take less time to compute. However, not all density models will use the Sun's position.

setApparentSunPosition

public final void setApparentSunPosition()

Configures the VectorToSun (get / set) to use the apparent displacement from the CentralBody (get / set) to the Sun (get).

setTrueSunPosition

public final void setTrueSunPosition()

Configures the VectorToSun (get / set) to use the true displacement from the CentralBody (get / set) to the Sun (get).

getSolarGeophysicalData

public final SolarGeophysicalData getSolarGeophysicalData()

Gets the solar and magnetic flux information.

setSolarGeophysicalData

public final void setSolarGeophysicalData(SolarGeophysicalData value)

Sets the solar and magnetic flux information.

getCentralBody

public CentralBody getCentralBody()

Gets the central body of the atmosphere described by the density model. This is set to the Earth (get) by default.

setCentralBody

public void setCentralBody(CentralBody value)

Sets the central body of the atmosphere described by the density model. This is set to the Earth (get) by default.