FiniteManeuverSegmentCreateOutOfFuelStoppingCondition Method (Scalar, String, Boolean) |
Creates a
ScalarStoppingCondition that will stop when the fuel amount becomes 0.
By default, the tolerance of the returned condition will be 1e-10.
Namespace:
AGI.Foundation.SegmentPropagation
Assembly:
AGI.Foundation.SegmentPropagation (in AGI.Foundation.SegmentPropagation.dll) Version: 24.3.420.0 (24.3.420.0)
Syntax public static ScalarStoppingCondition CreateOutOfFuelStoppingCondition(
Scalar fuelAmount,
string stoppingConditionIdentification,
bool stopPropagation
)
Public Shared Function CreateOutOfFuelStoppingCondition (
fuelAmount As Scalar,
stoppingConditionIdentification As String,
stopPropagation As Boolean
) As ScalarStoppingCondition
public:
static ScalarStoppingCondition^ CreateOutOfFuelStoppingCondition(
Scalar^ fuelAmount,
String^ stoppingConditionIdentification,
bool stopPropagation
)
static member CreateOutOfFuelStoppingCondition :
fuelAmount : Scalar *
stoppingConditionIdentification : string *
stopPropagation : bool -> ScalarStoppingCondition
Parameters
- fuelAmount
- Type: AGI.Foundation.GeometryScalar
The amount of fuel, often the
IntegrationValue of a
PropagationScalar. - stoppingConditionIdentification
- Type: SystemString
A name for the StoppingCondition. - stopPropagation
- Type: SystemBoolean
Indicates if the StoppingCondition actually stops propagation, or if it
should only indicate when fuel runs out but allow propagation to continue with 0 fuel remaining.
Return Value
Type:
ScalarStoppingConditionA
ScalarStoppingCondition that will stop when the fuel amount becomes 0.
See Also