Click or drag to resize

ScalarAtmosphericDensity Class

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

Namespace:  AGI.Foundation.Celestial
Assembly:  AGI.Foundation.OrbitPropagation (in AGI.Foundation.OrbitPropagation.dll) Version: 19.1.398.0 (19.1.398.0)
Syntax
public abstract class ScalarAtmosphericDensity : Scalar

The ScalarAtmosphericDensity type exposes the following members.

Constructors
  NameDescription
Protected methodScalarAtmosphericDensity

Initializes a Scalar representing atmospheric density.

TargetPoint and SolarGeophysicalData must be set before an evaluator is created.

Protected methodScalarAtmosphericDensity(Point, SolarGeophysicalData)
Initializes a Scalar representing atmospheric density using the target point and solar-geophysical data.
Protected methodScalarAtmosphericDensity(ScalarAtmosphericDensity, CopyContext)
Initializes a new instance as a copy of an existing instance.
Protected methodScalarAtmosphericDensity(Point, SolarGeophysicalData, CentralBody, Vector)
Initializes a Scalar representing atmospheric density using the target point and solar-geophysical data.
Top
Properties
  NameDescription
Public propertyCentralBody
Gets or sets the central body of the atmosphere described by the density model. This is set to the Earth by default.
Public propertyIsFrozen
Gets a value indicating whether this object is frozen. A frozen object cannot be modified and an ObjectFrozenException will be thrown if an attempt is made to do so.
(Inherited from DefinitionalObject.)
Public propertyLowerHeightLimit
Gets the lower bound of the height (in meters above the ellipsoid) for which the density model is valid.
Public propertySolarGeophysicalData
Gets or sets the solar and magnetic flux information.
Public propertyTargetPoint
Gets or sets the target point describing the time-varying position at which density is to be calculated.
Public propertyUpperHeightLimit
Gets the upper bound of the height (in meters above the ellipsoid) above which the density model will return a value of zero.
Public propertyVectorToSun
Gets or 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 to the Sun 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.
Top
Methods
  NameDescription
Public methodAdd(Double)
Adds a fixed scalar to this one.
(Inherited from Scalar.)
Public methodAdd(Scalar)
Adds another scalar to this one.
(Inherited from Scalar.)
Protected methodCheckForSameDefinition(DefinitionalObject)
Checks to determine if another instance has the same definition as this instance and returns 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 for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
(Inherited from Scalar.)
Protected methodCheckForSameDefinition(Scalar)
Checks to determine if another instance has the same definition as this instance and returns 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 for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
(Overrides ScalarCheckForSameDefinition(Scalar).)
Protected methodCheckForSameDefinition(ScalarAtmosphericDensity)
Checks to determine if another instance has the same definition as this instance and returns 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 for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
Public methodClone
Clones this object using the specified context.
(Inherited from DefinitionalObject.)
Protected methodComputeCurrentDefinitionHashCode
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 CheckForSameDefinition(DefinitionalObject) method.
(Overrides ScalarComputeCurrentDefinitionHashCode.)
Public methodCreateScalarDerivative
Constructs a scalar which represents a derivative of this scalar.
(Inherited from Scalar.)
Public methodDivide(Double)
Divides this scalar (numerator) by a fixed value (denominator).
(Inherited from Scalar.)
Public methodDivide(Scalar)
Divides this scalar (numerator) by another one (denominator).
(Inherited from Scalar.)
Public methodEnumerateDependencies
Enumerates the dependencies of this object by calling EnumerateT(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.
(Overrides DefinitionalObjectEnumerateDependencies(DependencyEnumerator).)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFreeze
Freezes this object. Further attempts to modify it will result in an ObjectFrozenException.
(Inherited from DefinitionalObject.)
Protected methodFreezeAggregatedObjects
Called by 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.
(Inherited from DefinitionalObject.)
Public methodGetDefinitionHashCode
Gets a hash code representing the definition of this object.
(Inherited from DefinitionalObject.)
Public methodGetEvaluator
Gets an evaluator that can be used to find the value of this scalar function at a given JulianDate.
(Inherited from Scalar.)
Public methodGetEvaluator(EvaluatorGroup)
Gets an evaluator that can be used to find the value of this scalar function at a given JulianDate. Adds the evaluator to the EvaluatorGroup.
(Inherited from Scalar.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsSameDefinition
Determines if this object has the same definition as another object.
(Inherited from DefinitionalObject.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodMultiply(Double)
Multiplies this scalar with a fixed value.
(Inherited from Scalar.)
Public methodMultiply(Scalar)
Multiplies another scalar with this one.
(Inherited from Scalar.)
Public methodPower
Raises this scalar to the given fixed exponent.
(Inherited from Scalar.)
Public methodSetApparentSunPosition
Configures the VectorToSun to use the apparent displacement from the CentralBody to the Sun.
Public methodSetTrueSunPosition
Configures the VectorToSun to use the true displacement from the CentralBody to the Sun.
Public methodSubtract(Double)
Subtracts a fixed scalar from this one.
(Inherited from Scalar.)
Public methodSubtract(Scalar)
Subtracts another scalar from this one.
(Inherited from Scalar.)
Protected methodThrowIfFrozen
Throws ObjectFrozenException if this object IsFrozen. This method should be called from any method or property that modifies this object.
(Inherited from DefinitionalObject.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also