public class SimpleSolarRadiationForce extends ForceModel implements IPartialDifferentiable
Modifier | Constructor and Description |
---|---|
|
SimpleSolarRadiationForce()
Initializes a new instance.
|
|
SimpleSolarRadiationForce(Point targetPoint,
Scalar reflectivityCoefficient,
Scalar referenceArea)
Creates a instance based on the given target point and its coefficients.
|
|
SimpleSolarRadiationForce(ScalarOccultation occultationFactor,
Scalar reflectivityCoefficient,
Scalar referenceArea)
Creates a instance based on a given
ScalarOccultation and the coefficients of reflectivity. |
protected |
SimpleSolarRadiationForce(SimpleSolarRadiationForce existingInstance,
CopyContext context)
Initializes a new instance as a copy of an existing instance.
|
Modifier and Type | Method and Description |
---|---|
void |
buildForceEvaluator(ResultantForceBuilder builder,
EvaluatorGroup group)
Build lists of principal and perturbation forces based on this model in order to create
an overall resultant force.
|
protected boolean |
checkForSameDefinition(ForceModel other)
Checks to determine if another instance has the same definition as this instance and
returns
true if it does. |
protected boolean |
checkForSameDefinition(SimpleSolarRadiationForce other)
Checks to determine if another instance has the same definition as this instance and
returns
true if it does. |
Object |
clone(CopyContext context)
Clones this object using the specified context.
|
protected int |
computeCurrentDefinitionHashCode()
Computes a hash code based on the current properties of this object.
|
void |
enumerateDependencies(DependencyEnumerator enumerator)
Enumerates the dependencies of this object by calling
DependencyEnumerator#enumerate(T) for each object that this object directly depends upon. |
Scalar |
getCoefficientOfReflectivity()
Gets the coefficient of reflectivity.
|
CoefficientOfReflectivityType |
getCoefficientOfReflectivityType()
Gets the
CoefficientOfReflectivityType ,
which is set to CoefficientOfReflectivityType.RADIATION_PRESSURE
by default. |
Axes |
getDefinedInAxes()
Gets the axes in which this force is defined.
|
int |
getDimension()
Gets the dimension of the values produced by the object.
|
Scalar |
getLuminosity()
Gets the Scalar describing the solar luminosity.
|
ScalarOccultation |
getOccultationFactor()
Gets the scalar modeling the amount of occultation at the target position.
|
PartialDerivativesEvaluator |
getPartialDerivativesEvaluator(List<IPartialDifferentiable> independentVariables,
EvaluatorGroup group)
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. |
Scalar |
getReferenceArea()
Gets the
Scalar representing the normalized
area of the surface. |
Point |
getTargetPoint()
|
RadiationVectorType |
getVectorType()
|
void |
setCoefficientOfReflectivity(Scalar value)
Sets the coefficient of reflectivity.
|
void |
setCoefficientOfReflectivityType(CoefficientOfReflectivityType value)
Sets the
CoefficientOfReflectivityType ,
which is set to CoefficientOfReflectivityType.RADIATION_PRESSURE
by default. |
void |
setLuminosity(Scalar value)
Sets the Scalar describing the solar luminosity.
|
void |
setOccultationFactor(ScalarOccultation value)
Sets the scalar modeling the amount of occultation at the target position.
|
void |
setReferenceArea(Scalar value)
Sets the
Scalar representing the normalized
area of the surface. |
checkForSameDefinition, freezeAggregatedObjects, getForceEvaluator, getForceEvaluator, getForceVector, getKind, getRole
areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, freeze, getCollectionHashCode, getCollectionHashCode, getCollectionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDictionaryHashCode, getIsFrozen, isSameDefinition, throwIfFrozen
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getDefinitionHashCode, isSameDefinition
public SimpleSolarRadiationForce()
Initializes a new instance. The Luminosity
(get
/ set
) property is set to a
ScalarFixed
with a value of Constants.SolarLuminosity2015IauResolutionB3
.
CoefficientOfReflectivityType
(get
/ set
) is set to
CoefficientOfReflectivityType.RadiationPressure
.
The OccultationFactor
(get
/ set
), CoefficientOfReflectivity
(get
/ set
),
and ReferenceArea
(get
/ set
) properties must be set before an Evaluator is created.
public SimpleSolarRadiationForce(Point targetPoint, Scalar reflectivityCoefficient, Scalar referenceArea)
targetPoint
- The target point used to define the geometry required for the
ScalarOccultation
, including the SunCentralBody
as the
illuminating body and the EarthCentralBody
and MoonCentralBody
as occluding bodies.reflectivityCoefficient
- The reflectivity coefficient of the satellite.referenceArea
- The reference area of the satellite used to model radiation pressure.public SimpleSolarRadiationForce(ScalarOccultation occultationFactor, Scalar reflectivityCoefficient, Scalar referenceArea)
ScalarOccultation
and the coefficients of reflectivity.occultationFactor
- The ScalarOccultation
that models the occultation of the sun.reflectivityCoefficient
- The reflectivity coefficient of the satellite.referenceArea
- The reference area of the satellite used to model radiation pressure.protected SimpleSolarRadiationForce(@Nonnull SimpleSolarRadiationForce existingInstance, @Nonnull CopyContext context)
See ICloneWithContext.clone(CopyContext)
for more information about how to implement this constructor
in a derived class.
existingInstance
- The existing instance to copy.context
- A CopyContext
that controls the depth of the copy.ArgumentNullException
- Thrown when existingInstance
or context
is null
.public Object clone(CopyContext context)
This method should be implemented to call a copy constructor on the class of the
object being cloned. The copy constructor should take the CopyContext
as a parameter
in addition to the existing instance to copy. The copy constructor should first call
CopyContext.addObjectMapping(T, T)
to identify the newly constructed instance
as a copy of the existing instance. It should then copy all fields, using
CopyContext.updateReference(T)
to copy any reference fields.
A typical implementation of ICloneWithContext
:
public static class MyClass implements ICloneWithContext {
public MyClass(MyClass existingInstance, CopyContext context) {
context.addObjectMapping(existingInstance, this);
someReference = context.updateReference(existingInstance.someReference);
}
@Override
public final Object clone(CopyContext context) {
return new MyClass(this, context);
}
private Object someReference;
}
In general, all fields that are reference types should be copied with a call to
CopyContext.updateReference(T)
. There are a couple of exceptions:
If one of these exceptions applies, the CopyContext
should be given an opportunity
to update the reference before the reference is copied explicitly. Use
CopyContext.updateReference(T)
to update the reference. If CopyContext.updateReference(T)
returns
the original object, indicating that the context does not have a replacement registered,
then copy the object manually by invoking a Clone method, a copy constructor, or by manually
constructing a new instance and copying the values.
alwaysCopy = context.updateReference(existingInstance.alwaysCopy);
if (existingInstance.alwaysCopy != null && alwaysCopy == existingInstance.alwaysCopy) {
alwaysCopy = (AlwaysCopy) existingInstance.alwaysCopy.clone(context);
}
If you are implementing an evaluator (a class that implements IEvaluator
), the
IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext)
method shares some responsibilities with the
copy context constructor. Code duplication can be avoided by doing the following:
CopyContext.updateReference(T)
. You should still call CopyContext.updateReference(T)
on any references to
non-evaluators.
IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext)
as the last line in the constructor and pass it the
same CopyContext
passed to the constructor.
IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext)
as normal. See the reference documentation for
IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext)
for more information on implementing that method.
public MyClass(MyClass existingInstance, CopyContext context) {
super(existingInstance, context);
someReference = context.updateReference(existingInstance.someReference);
evaluatorReference = existingInstance.evaluatorReference;
updateEvaluatorReferences(context);
}
@Override
public void updateEvaluatorReferences(CopyContext context) {
evaluatorReference = context.updateReference(evaluatorReference);
}
@Override
public Object clone(CopyContext context) {
return new MyClass(this, context);
}
private Object someReference;
private IEvaluator evaluatorReference;
clone
in interface ICloneWithContext
clone
in class DefinitionalObject
context
- The context to use to perform the copy.protected final boolean checkForSameDefinition(ForceModel other)
true
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 false
for all derived-class instances.
Derived classes should check the type of other
to preserve the symmetric nature of IEquatableDefinition.isSameDefinition(java.lang.Object)
.checkForSameDefinition
in class ForceModel
other
- The other instance to compare to this one.true
if the two objects are defined equivalently; otherwise false
.protected boolean checkForSameDefinition(SimpleSolarRadiationForce other)
true
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 false
for all derived-class instances.
Derived classes should check the type of other
to preserve the symmetric nature of IEquatableDefinition.isSameDefinition(java.lang.Object)
.other
- The other instance to compare to this one.true
if the two objects are defined equivalently; otherwise false
.protected int computeCurrentDefinitionHashCode()
SimpleSolarRadiationForce.checkForSameDefinition(agi.foundation.celestial.ForceModel)
method.computeCurrentDefinitionHashCode
in class ForceModel
public void enumerateDependencies(DependencyEnumerator enumerator)
DependencyEnumerator#enumerate(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.enumerateDependencies
in interface IEnumerateDependencies
enumerateDependencies
in class ForceModel
enumerator
- The enumerator that is informed of the dependencies of this object.public final int getDimension()
Vectors
would have a dimension of three, and Scalars
of one. A PartialDerivativesEvaluator
created by this type will have a RowDimension
(get
) equal to this
property, and a ColumnDimension
(get
) equal to the summation
of the dimensions of the independent variables that this object is dependent on.getDimension
in interface IPartialDifferentiable
public final ScalarOccultation getOccultationFactor()
public final void setOccultationFactor(ScalarOccultation value)
public final Point getTargetPoint()
public final Scalar getCoefficientOfReflectivity()
CoefficientOfReflectivityType
see the
CoefficientOfReflectivityType
(get
/ set
) property.public final void setCoefficientOfReflectivity(Scalar value)
CoefficientOfReflectivityType
see the
CoefficientOfReflectivityType
(get
/ set
) property.public final Axes getDefinedInAxes()
@Nonnull public final CoefficientOfReflectivityType getCoefficientOfReflectivityType()
CoefficientOfReflectivityType
,
which is set to CoefficientOfReflectivityType.RADIATION_PRESSURE
by default. In order to set the value of the Coefficient of Reflectivity see
CoefficientOfReflectivity
(get
/ set
).public final void setCoefficientOfReflectivityType(@Nonnull CoefficientOfReflectivityType value)
CoefficientOfReflectivityType
,
which is set to CoefficientOfReflectivityType.RADIATION_PRESSURE
by default. In order to set the value of the Coefficient of Reflectivity see
CoefficientOfReflectivity
(get
/ set
).public final Scalar getReferenceArea()
Scalar
representing the normalized
area of the surface.public final void setReferenceArea(Scalar value)
Scalar
representing the normalized
area of the surface.@Nonnull public final RadiationVectorType getVectorType()
RadiationVectorType
from the VectorType
(get
/ set
) of the OccultationFactor
(get
/ set
).
If the OccultationFactor
(get
/ set
) property is null
, then
this property will return RadiationVectorType.CORRECT_FOR_LIGHT_TIME_DELAY_AND_ABERRATION
.public final Scalar getLuminosity()
ScalarFixed
with the value of Constants.SolarLuminosity2015IauResolutionB3
.public final void setLuminosity(Scalar value)
ScalarFixed
with the value of Constants.SolarLuminosity2015IauResolutionB3
.public void buildForceEvaluator(ResultantForceBuilder builder, EvaluatorGroup group)
buildForceEvaluator
in class ForceModel
builder
- The builder object containing the lists and additional information
on the Axes
in which the overall resultant is defined.group
- The evaluator group in which to create evaluators.PropertyInvalidException
- Thrown when Luminosity
(get
/ set
), CoefficientOfReflectivity
(get
/ set
), OccultationFactor
(get
/ set
) or ReferenceArea
(get
/ set
) is null
.public final PartialDerivativesEvaluator getPartialDerivativesEvaluator(List<IPartialDifferentiable> independentVariables, EvaluatorGroup group)
independentVariables
parameters that apply, generally the position.getPartialDerivativesEvaluator
in interface IPartialDifferentiable
independentVariables
- The list of IPartialDifferentiable
representing the independent
variables that the created partial derivative evaluator calculates partials with respect to.group
- The evaluator group to contain the evaluator.PartialDerivativesEvaluator
.