agi.foundation.propagators.advanced

(agi.foundation.models-2024r2.jar)

Class PropagationStateElement

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.propagators.advanced.PropagationStateElement

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

Direct Known Subclasses:

PropagationEulerianAxes, PropagationPointElement, PropagationScalar, PropagationVector, StateTransitionMatrix

public abstract class PropagationStateElement
extends DefinitionalObject

Represents a portion of a combined state used during numerical integration.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PropagationStateElement() Initializes a new instance.
protected	PropagationStateElement(PropagationStateElement existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.

Method Summary

Modifier and Type	Method and Description
protected boolean	checkForSameDefinition(DefinitionalObject other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected abstract boolean	checkForSameDefinition(PropagationStateElement other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected int	computeCurrentDefinitionHashCode() Computes a hash code based on the current properties of this object.
abstract PropagationStateElementConverter	getConverter(EvaluatorGroup group, Motion1<int[]> stateInputIndices) Gets an instance of an output type which can convert the output of propagation back into the native type of this state element.
abstract PropagationStateElementEvaluator	getDerivatives(EvaluatorGroup group) This is used by the NumericalPropagatorDefinition to obtain an instance of a state element evaluator that can compute the derivatives of this element of the state during propagation.
abstract int	getDimension() Gets the number of parameters (per Order (get)) within this element.
String	getIdentification() Gets the string identifying this instance in the overall output.
boolean	getIncludeHighestDerivativeInOutput() Gets a value indicating whether to include the derivative computed at each step with the output.
abstract int	getOrder() Gets the order of the differential equation corresponding to this element.
abstract PropagationStateParameter	getStateParameter() Gets a parameter which represents the state during propagation.
IUpdatePriorToStep	getStateUpdater(EvaluatorGroup group) By default this method returns null.
void	setIdentification(String value) Sets the string identifying this instance in the overall output.
void	setIncludeHighestDerivativeInOutput(boolean value) Sets a value indicating whether to include the derivative computed at each step with the output.
abstract void	setStateParameter(PropagationStateParameter value) Sets a parameter which represents the state during propagation.

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, clone, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, enumerateDependencies, freeze, freezeAggregatedObjects, getCollectionHashCode, getCollectionHashCode, getCollectionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDictionaryHashCode, getIsFrozen, isSameDefinition, throwIfFrozen

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PropagationStateElement

protected PropagationStateElement()

Initializes a new instance.

PropagationStateElement

protected PropagationStateElement(@Nonnull
                                  PropagationStateElement existingInstance,
                                  @Nonnull
                                  CopyContext context)

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

See ICloneWithContext.clone(CopyContext) for more information about how to implement this constructor in a derived class.

Parameters:

existingInstance - The existing instance to copy.

context - A CopyContext that controls the depth of the copy.

Throws:

ArgumentNullException - Thrown when existingInstance or context is null.

Method Detail

checkForSameDefinition

protected final boolean checkForSameDefinition(DefinitionalObject other)

Checks to determine if another instance has the same definition as this instance and returns 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).

Specified by:

checkForSameDefinition in class DefinitionalObject

Parameters:

other - The other instance to compare to this one.

Returns:

true if the two objects are defined equivalently; otherwise false.

checkForSameDefinition

protected abstract boolean checkForSameDefinition(PropagationStateElement other)

Checks to determine if another instance has the same definition as this instance and returns 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).

Parameters:

other - The other instance to compare to this one.

Returns:

true if the two objects are defined equivalently; otherwise false.

computeCurrentDefinitionHashCode

protected int 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 PropagationStateElement.checkForSameDefinition(agi.foundation.infrastructure.DefinitionalObject) method.

Overrides:

computeCurrentDefinitionHashCode in class DefinitionalObject

Returns:

The computed hash code.

getIdentification

public final String getIdentification()

Gets the string identifying this instance in the overall output.

setIdentification

public final void setIdentification(String value)

Sets the string identifying this instance in the overall output.

getDimension

public abstract int getDimension()

Gets the number of parameters (per Order (get)) within this element.

getOrder

public abstract int getOrder()

Gets the order of the differential equation corresponding to this element.

getIncludeHighestDerivativeInOutput

public final boolean getIncludeHighestDerivativeInOutput()

Gets a value indicating whether to include the derivative computed at each step with the output. If this is true, the output converted from the raw state will contain the derivative associated with the Order (get) of the differential equation.

setIncludeHighestDerivativeInOutput

public final void setIncludeHighestDerivativeInOutput(boolean value)

Sets a value indicating whether to include the derivative computed at each step with the output. If this is true, the output converted from the raw state will contain the derivative associated with the Order (get) of the differential equation.

getStateParameter

public abstract PropagationStateParameter getStateParameter()

Gets a parameter which represents the state during propagation. In general, users should never need to explicitly set this property. It should only be set when multiple NumericalPropagator objects are running in the same EvaluatorGroup, such as when elements of a state require additional instances of a NumericalPropagator inside their implementation in order to produce their values. In such cases, it may be necessary to distinguish between the state of the exterior propagator and the state of the interior propagator. In these cases, it is up to the user to ensure that both the state and all of its elements are configured with the same parameter. Otherwise, the state will throw an exception when creating its propagator.

setStateParameter

public abstract void setStateParameter(PropagationStateParameter value)

Sets a parameter which represents the state during propagation. In general, users should never need to explicitly set this property. It should only be set when multiple NumericalPropagator objects are running in the same EvaluatorGroup, such as when elements of a state require additional instances of a NumericalPropagator inside their implementation in order to produce their values. In such cases, it may be necessary to distinguish between the state of the exterior propagator and the state of the interior propagator. In these cases, it is up to the user to ensure that both the state and all of its elements are configured with the same parameter. Otherwise, the state will throw an exception when creating its propagator.

getConverter

@Nonnull
public abstract PropagationStateElementConverter getConverter(@Nonnull
                                                                        EvaluatorGroup group,
                                                                        @Nonnull
                                                                        Motion1<int[]> stateInputIndices)

Gets an instance of an output type which can convert the output of propagation back into the native type of this state element. This method is also responsible for configuring the state parameter and the state input indices on any parameterized geometry types used by this element. Each parameterized geometry type will have a static configuration method which will allow it to configure itself in a particular EvaluatorGroup.

Parameters:

group - The evaluator group in which to configure the parameters.

stateInputIndices - The set of indices corresponding to the location of each value or derivative of this state element in the overall state.

Returns:

The output instance associated with this state element.

getDerivatives

@Nonnull
public abstract PropagationStateElementEvaluator getDerivatives(@Nonnull
                                                                          EvaluatorGroup group)

This is used by the NumericalPropagatorDefinition to obtain an instance of a state element evaluator that can compute the derivatives of this element of the state during propagation. It cannot be used outside of a NumericalPropagator as the geometry for the propagation state will be unavailable.

Parameters:

group - The group in which to create the evaluator and its dependents.

Returns:

The evaluator that can compute the derivatives of this element of the state.

getStateUpdater

@Nullable
public IUpdatePriorToStep getStateUpdater(@Nonnull
                                                     EvaluatorGroup group)

By default this method returns null. If a concrete base class of this type represents an element that has special behavior that takes place each time step prior to propagation, then override this method to produce an IUpdatePriorToStep object that the NumericalPropagator will call every time step.

Parameters:

group - The EvaluatorGroup the state updater will be part of.

Returns:

Null