SimpleSolarRadiationForce Class |
Namespace: AGI.Foundation.Celestial
The SimpleSolarRadiationForce type exposes the following members.
Name | Description | |
---|---|---|
SimpleSolarRadiationForce | Initializes a new instance. The Luminosity property is set to a ScalarFixed with a value of SolarLuminosity2015IauResolutionB3. CoefficientOfReflectivityType is set to CoefficientOfReflectivityType.RadiationPressure. The OccultationFactor, CoefficientOfReflectivity, and ReferenceArea properties must be set before an Evaluator is created. | |
SimpleSolarRadiationForce(SimpleSolarRadiationForce, CopyContext) | Initializes a new instance as a copy of an existing instance. | |
SimpleSolarRadiationForce(Point, Scalar, Scalar) |
Creates a instance based on the given target point and its coefficients.
| |
SimpleSolarRadiationForce(ScalarOccultation, Scalar, Scalar) |
Creates a instance based on a given ScalarOccultation and the coefficients of reflectivity.
|
Name | Description | |
---|---|---|
CoefficientOfReflectivity |
Gets or sets the coefficient of reflectivity. To set the
CoefficientOfReflectivityType see the
CoefficientOfReflectivityType property.
| |
CoefficientOfReflectivityType |
Gets or sets the CoefficientOfReflectivityType,
which is set to RadiationPressure
by default. In order to set the value of the Coefficient of Reflectivity see
CoefficientOfReflectivity.
| |
DefinedInAxes |
Gets the axes in which this force is defined. For solar radiation, the axes are taken from the
inertial frame of the IlluminatingBody on the OccultationFactor.
If the OccultationFactor property is , then this property will also return .
| |
Dimension |
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.
| |
ForceVector |
Gets the Vector representation of this force.
(Inherited from ForceModel.) | |
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.) | |
Luminosity |
Gets or sets the Scalar describing the solar luminosity.
By default this is set to a ScalarFixed
with the value of SolarLuminosity2015IauResolutionB3.
| |
OccultationFactor |
Gets or sets the scalar modeling the amount of occultation at the target position.
This scalar also holds the Point and other data.
| |
ReferenceArea |
Gets or sets the Scalar representing the normalized
area of the surface.
| |
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 solar radiation is applied from the TargetPoint of the OccultationFactor.
If the OccultationFactor property is , then this property will also return .
| |
VectorType |
Gets the RadiationVectorType from the VectorType of the OccultationFactor.
If the OccultationFactor property is , then
this property will return CorrectForLightTimeDelayAndAberration.
|
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(SimpleSolarRadiationForce) |
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.) | |
GetPartialDerivativesEvaluator |
Gets an evaluator that calculates the partial derivatives of the solar radiation force
with respect to any of the independentVariables parameters that apply, generally the position.
| |
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.) |