NPlateSolarRadiationForce Class

A medium-fidelity force model for solar radiation pressure on a spacecraft. The model requires that a spacecraft's attitude be specified by its body axes and that 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.

This model does not take into account the effect of plates physically blocking other plates from experiencing pressure if the blocked plates are behind them but pointing in the same direction. (This effect is sometimes called self-shadowing).

Inheritance Hierarchy

SystemObject
  AGI.Foundation.InfrastructureDefinitionalObject
    AGI.Foundation.CelestialForceModel
      AGI.Foundation.CelestialNPlateSolarRadiationForce

Namespace: AGI.Foundation.Celestial
Assembly: AGI.Foundation.OrbitPropagation (in AGI.Foundation.OrbitPropagation.dll) Version: 24.2.419.0 (24.2.419.0)

Syntax

C++

Copy

public class NPlateSolarRadiationForce : ForceModel

Public Class NPlateSolarRadiationForce
	Inherits ForceModel

public ref class NPlateSolarRadiationForce : public ForceModel

type NPlateSolarRadiationForce =  
    class
        inherit ForceModel
    end

The NPlateSolarRadiationForce type exposes the following members.

Constructors

	Name	Description
	NPlateSolarRadiationForce	Initializes a ForceModel describing the solar radiation pressure force on an object. The Luminosity property is set with a default value of SolarLuminosity2015IauResolutionB3. The NPlateModel, BodyAxes, and OccultationFactor properties must be set before creating an evaluator.
	NPlateSolarRadiationForce(NPlateSolarRadiationForce, CopyContext)	Initializes a new instance of the NPlateSolarRadiationForce class
	NPlateSolarRadiationForce(NPlateModel, Axes, ScalarOccultation)	Initializes a ForceModel describing the solar radiation pressure force on an object.
	NPlateSolarRadiationForce(NPlateModel, Axes, Point)	Initializes a ForceModel describing the solar radiation pressure force on an object.

Top

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 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 .
	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 solar luminosity used to model the solar radiation pressure. By default, this is set to SolarLuminosity2015IauResolutionB3.
	NPlateModel	Gets or sets a collection that models the spacecraft's body as a collection of individual plates with oriented surface areas, specular reflectivity coefficients, and diffuse reflectivity coefficients. All plates in this collection must be SolarRadiationPlates.
	OccultationFactor	Gets or sets the scalar modeling the amount of occultation at the location of the TargetPoint.
	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.

Top

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

Top

Reference

AGI.Foundation.Celestial Namespace