AtmosphericDragForce Class

Initializes a new instance as a copy of an existing instance.

Initializes a Vector describing the drag force on an object.

Gets or sets the drag coefficient of the object.

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 .

Gets or sets the object which calculates density at the object's location, note that this ScalarAtmosphericDensity also holds the central body and position data.

Gets the dimension of the values produced by the object. For example, Vectors would have a dimension of three, and Scalars of one. A PartialDerivativesEvaluator created by this type will have a "RowDimension" equal to this property, and a "ColumnDimension equal to the summation of the dimensions of the independent variables that this object is dependent on.

Gets the Vector representation of this force.

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.

Gets an enumeration indicating the nature of this force and whether it implicitly includes mass.

Gets or sets the cross-sectional area of the object.

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.

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 .

Build lists of principal and perturbation forces based on this model in order to create an overall resultant force.

Calculates the atmospheric drag force on an object. This low-level call is provided for convenience in simple use cases, in general you should call BuildForceEvaluator(ResultantForceBuilder, EvaluatorGroup) to produce a ForceEvaluator from this class that will model drag forces on an object over time.

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).

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).

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).

Clones this object using the specified context.

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.

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.

Determines whether the specified object is equal to the current object.

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.

Freezes this object. Further attempts to modify it will result in an ObjectFrozenException.

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.

Gets a hash code representing the definition of this object.

Gets an instance of an evaluator that can compute the force.

Gets an instance of an evaluator that can compute the force.

Serves as the default hash function.

Gets an evaluator that calculates the partial derivatives of the atmospheric drag force with respect to any of the independentVariables parameters that apply.

Gets the Type of the current instance.

Determines if this object has the same definition as another object.

Creates a shallow copy of the current Object.

Throws ObjectFrozenException if this object IsFrozen. This method should be called from any method or property that modifies this object.

Returns a string that represents the current object.