NPlateAtmosphericDragForce Class |
A medium-fidelity force model for atmospheric drag on a spacecraft. The model requires that a spacecraft's attitude be specified by its body axes, the spacecraft's body and solar panels be modeled by an N-Plate model that contains a model for each outward facing surface of the spacecraft, and the atmospheric density is modeled by a density model.
This model does not take into account the effect of plates physically blocking other plates from experiencing drag if the blocked plates are behind them but pointing in the same direction.
Inheritance HierarchySystemObject
AGI.Foundation.InfrastructureDefinitionalObject
AGI.Foundation.CelestialForceModel
AGI.Foundation.CelestialNPlateAtmosphericDragForce
AGI.Foundation.InfrastructureDefinitionalObject
AGI.Foundation.CelestialForceModel
AGI.Foundation.CelestialNPlateAtmosphericDragForce
Namespace: AGI.Foundation.Celestial
Assembly: AGI.Foundation.OrbitPropagation (in AGI.Foundation.OrbitPropagation.dll) Version: 24.1.418.0 (24.1.418.0)
SyntaxThe NPlateAtmosphericDragForce type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | NPlateAtmosphericDragForce | Initializes a ForceModel describing the atmospheric drag force on an object. The NPlateModel, BodyAxes, Density, and IlluminatingBody properties must be set before creating an evaluator. |
 | NPlateAtmosphericDragForce(NPlateAtmosphericDragForce, CopyContext) | Initializes a new instance of the NPlateAtmosphericDragForce class |
| NPlateAtmosphericDragForce(NPlateModel, Axes, ScalarAtmosphericDensity, CentralBody) |
Initializes a ForceModel describing the atmospheric drag force on an object.
|
Properties| Name | Description | |
|---|---|---|
 | BodyAxes |
Gets or sets the axes defining the orientation of the spacecraft body.
|
| DefinedInAxes |
Gets the Axes in which this force is defined. For drag, the Axes are
taken from the fixed frame of the CentralBody used for the Density.
Also note that while the drag force is defined in the fixed frame, forces are considered to be "inertial"
for the purposes of Newtonian kinematics, and no kinematic transformation apart from a simple rotation
is necessary when converting to an inertial frame.
If the Density property is , then this property will also return .
|
| Density |
Gets or sets the atmospheric model used to calculate density at the location of the TargetPoint.
|
| ForceVector |
Gets the Vector representation of this force.
(Inherited from ForceModel.) |
| IlluminatingBody |
Gets or sets the body that is used to determine the direction that solar panel plates face (typically, the Sun).
|
| IsFrozen |
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.) |
| Kind |
Gets an enumeration indicating the nature of this force and whether it implicitly
includes mass.
(Inherited from ForceModel.) |
| NPlateModel |
Gets or sets a collection that models the spacecraft's body as a collection of individual plates with oriented surface areas and drag coefficients.
All plates in this collection must be DragPlates.
|
| Role |
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.
(Inherited from ForceModel.) |
| TargetPoint |
Gets the point at which the drag is applied from the TargetPoint of the Density.
If the Density property is , then this property will also return .
|
Methods| Name | Description | |
|---|---|---|
| BuildForceEvaluator |
Build lists of principal and perturbation forces based on this model in order to create
an overall resultant force.
(Overrides ForceModelBuildForceEvaluator(ResultantForceBuilder, EvaluatorGroup).) |
| CheckForSameDefinition(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 ForceModel.) |
| CheckForSameDefinition(ForceModel) |
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 ForceModelCheckForSameDefinition(ForceModel).) |
| CheckForSameDefinition(NPlateAtmosphericDragForce) |
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).
|
| Clone |
Clones this object using the specified context.
(Overrides DefinitionalObjectClone(CopyContext).) |
| 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
CheckForSameDefinition(DefinitionalObject) method.
(Overrides ForceModelComputeCurrentDefinitionHashCode.) |
| EnumerateDependencies |
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 ForceModelEnumerateDependencies(DependencyEnumerator).) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| Freeze |
Freezes this object. Further attempts to modify it will result
in an ObjectFrozenException.
(Inherited from DefinitionalObject.) |
| FreezeAggregatedObjects |
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 ForceModel.) |
| GetDefinitionHashCode |
Gets a hash code representing the definition of this object.
(Inherited from DefinitionalObject.) |
| GetForceEvaluator |
Gets an instance of an evaluator that can compute the force.
(Inherited from ForceModel.) |
| GetForceEvaluator(EvaluatorGroup) |
Gets an instance of an evaluator that can compute the force.
(Inherited from ForceModel.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| IsSameDefinition |
Determines if this object has the same definition as another object.
(Inherited from DefinitionalObject.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ThrowIfFrozen |
Throws ObjectFrozenException if this object IsFrozen.
This method should be called from any method or property that modifies this object.
(Inherited from DefinitionalObject.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See Also