Class in Zendir.Classes | Inherits from PhysicalObject
Declaration
class FuelInterconnect;Description
Represents a passive fuel interconnect that bonds to a local fuel object (source, consumer, valve, or pump) and pairs with another interconnect to form a fuel transfer bridge. The interconnect handles cross-spacecraft fuel transfer when root spacecraft are docked, same-spacecraft routing, and vent-to-space behavior when the link is not established or flow cannot pass through.
Properties
| Declared | Description |
|---|---|
| CumulativeTransferredMass | Cumulative mass that has flowed through this interconnect since creation, in kilograms.Accumulated by the solver each tick based on . |
| EffectiveFlowRate | The effective flow rate currently passing through this interconnect in kilograms per second.This value is calculated and set by the FuelSystem each simulation tick based on link state,valve constraints, and port configurations. This is a read-only output. |
| IsBidirectional | When true, the interconnect allows flow in both directions through the linked pair.When false (default), flow direction is determined by pressure differential or pump direction.Bidirectional mode is useful when flow direction may vary based on tank levels or active pumping. |
| Out_FuelFlowMsg | Flow-state telemetry for this interconnect when part of a linked transfer path. |
| Out_VentCommandForceMsg | Body-frame force command written by the fuel system when this interconnect vents to space; consumed by. |
| Out_VentCommandTorqueMsg | Body-frame torque command written by the fuel system when this interconnect vents to space; consumed by. |
| RequirePositivePressureDifferential | When true, linked-interconnect transfer from servicer to receiver requires the supply tank ullage pressureto exceed the receiver ullage pressure (both need for comparison). |
| SpecificImpulse | Effective specific impulse (seconds) used to convert vent mass flow to thrust when fuel ventsto space. Thrust magnitude is Isp * EffectiveFlowRate * g0 (same convention as cold-gas thrusters).Direction: exhaust leaves along the interconnect’s local axis; reaction force on the body is theopposite of the exhaust direction. When zero, venting still removes mass but produces no thrust. |
| VentToSpaceWhenUnconnected | When true (default), fuel may vent to space when the interconnect has no linked peer, or when linkedto another interconnect but is false (e.g. undocked cross-docking). |
| Inherited | Description |
|---|---|
| Behaviours | A collection of behaviours attached to this object. |
| CenterOfMassB_B | The center of mass of the component in respect to the body frame (B) of the component. This is isolated from anychildren and exists in isolation. |
| CenterOfMassDot_LB_B | The center of mass time-derivative of the component within its own local coordinates. This does not include anyof the sub-components and exists in isolation. |
| CenterOfMassDotB_B | The center of mass time-derivative of the component relative to the body frame (B). This does not include any ofthe sub-components and exists in isolation. |
| CenterOfMassL_L | The center of mass of the component within its own local coordinates. This does not include any of thesub-components and exists in isolation. |
| CenterOfMassPrime_LB_B | The center of mass general-derivative of the component within its own local coordinates. This does not includeany of the sub-components and exists in isolation. |
| CenterOfMassPrimeB_B | [m/s] The center of mass general-derivative of the component relative to the body frame (B). This does notinclude any of the sub-components and exists in isolation. |
| Children | A collection of children attached to this object. |
| DCM_BN | The rotational DCM matrix between the body frame (B) at the top of this component chain and the inertial frame (N). |
| DCM_LB | The rotational DCM matrix between the component frame of this object (L) relative to the body frame (B). |
| DCM_LN | The DCM rotational matrix of the component relative to the inertial origin (N) of the world. |
| DCM_LP | The DCM matrix of the component in the parent’s frame (P), taken from the Component Transform (PL). |
| IsEnabled | Is true if the object is currently enabled. |
| LocalForward | The direction of the transform frame’s forward vector, which is along the Y axis. |
| LocalRight | The direction of the transform frame’s right vector, which is along the X axis. |
| LocalUp | The direction of the transform frame’s up vector, which is along the Z axis. |
| Mass | The component mass defined in the object. This is independent of any parent or children objects and exists inisolation. |
| MassDot | The component mass time-derivative defined in the object. This is independent of any parent or children objectsand exists in isolation. |
| Models | A collection of models attached to this object. |
| MomentOfInertia_LB | The moment of inertia of the component, measured at the local center of mass, represented with its own localcoordinates. This does not include any of the sub-components and exists in isolation. |
| MomentOfInertiaB_B | The moment of inertia of this component, measured in the body frame relative to the parented body. This isindependent of any children and exists in isolation. |
| MomentOfInertiaPrime_LB | The derivative of the moment of inertia of the component, measured at the local center of mass, represented withits own local coordinates. This does not include any of the sub-components and exists in isolation. |
| MomentOfInertiaPrimeB_B | The derivative of the moment of inertia of the component, represented in the body frame (B). This is independentand exists in isolation. |
| Name | The display name or tag of this object. |
| Out_ComponentMassMsg | The component mass message defines the set of mass properties and states of the system within this componentlocally. This is independent of any parent or children properties or objects. |
| Out_TransformMsg | This defines the base transform message that stores the state of the transform of this object. |
| Parent | The currently attached parent object (if any). |
| Position | [m] The position of the object relative to the parent or to world origin, if no parent exists. |
| Position_BN_N | The position of the body (the root parent B) in the inertial frame relative to the inertial point (N). |
| Position_LB_B | The position of the component relative to the root object of this hierarchy. This is in the inertial frame and ifthe component is the root object, then there will be no position. |
| Position_LN_N | The position of the inertial world space. This position is derived from the world’s transform (N). |
| Position_LP_P | The position of the object relative to the parented object (P). If there is no parent object, then this will bein the inertial frame. |
| Root | The root object in the parent chain. |
| Rotation | [-] The rotation of the object relative to the parent or to the world origin, if no parent exists. |
| Thermal | [TEMPORARY] A reference to the thermal model that is attached to this object. This will allow the object to havethermal properties and be able to be used in thermal simulations. |
Methods
| Declared | Description |
|---|---|
| CanFlowThroughLink | Determines whether fuel can flow through the linked interconnect connection.For cross-spacecraft links, the root spacecraft must be physically docked.For same-spacecraft links, the interconnects simply need to be linked.If either side has a bonded valve, that valve must be at least partially open. |
| ConnectConsumer | Connects a to this interconnect’s local side.Clears any other local bond first. |
| ConnectPump | Connects a to this interconnect’s local side.Clears any other local bond first. |
| ConnectSource | Connects a to this interconnect’s local side.Clears any other local bond first. |
| ConnectValve | Connects a to this interconnect’s local side via the valve’s Inlet port.For source→valve→interconnect topologies, the interconnect receives flow from the valve’s inlet side.Clears any other local bond first. |
| Disconnect | Disconnects this interconnect from its local bond.Clears all local references and zeroes vent thrust command outputs. |
| IsCrossSpacecraft | Determines whether this is a cross-spacecraft link (linked peer on a different root spacecraft). |
| IsPhysicallyDocked | Checks if this interconnect is physically docked to its linked peer (ignores valve state). |
| Link | Links this interconnect to another interconnect for bidirectional fuel transfer operations.IMPORTANT: This method ONLY accepts FuelInterconnect. This enforces the requirement thatcross-spacecraft fuel transfer must always go through paired interconnects, ensuring propervent-to-space behavior when undocked.Same-spacecraft routing: Both interconnects share the same root spacecraft. Internal fuelrouting through interconnect pairs within a single spacecraft.Cross-spacecraft transfer: Interconnects on different root spacecraft. Fuel flows only whenthe spacecraft are physically docked (). |
| Unlink | Unlinks this interconnect from its linked partner interconnect.This clears the bidirectional link between the two interconnects. Both interconnects will havetheir LinkedInterconnect reference set to null after this operation. |
| Inherited | Description |
|---|---|
| AddObject | Returns a new simulation object with the specified type. |
| Attach | Attempts to attach this object to a new parent. This will only work if the current object is no parented to anyother object. |
| ContainsModelWithID | Returns true if an attached model satisfies the specified ID. |
| ContainsModelWithType | Returns true if an attached model satisfies the specified type. |
| Detach | This is an action to detach the current object from its parent, if it exists and move it to another object or tojust exist within the simulation. |
| FindBehavioursWithType | Returns all attached behaviours that satisfies the specified type. |
| FindBehaviourWithID | Returns an attached behaviour that satisfies the specified ID. |
| FindBehaviourWithType | Returns an attached behaviour that satisfies the specified type. |
| FindChildrenWithType | Returns all attached children that satisfies the specified type. |
| FindChildWithID | Returns an attached child that satisfies the specified ID. |
| FindChildWithType | Returns an attached child that satisfies the specified type. |
| FindModelsWithType | Returns all attached models that satisfies the specified type. |
| FindModelWithID | Returns an attached model that satisfies the specified ID. |
| FindModelWithType | Returns an attached model that satisfies the specified type. |
| FindParentWithID | Returns an attached parent that satisfies the specified ID. |
| FindParentWithType | Returns an attached parent that satisfies the specified type. |
| FindRootWithID | Returns a root object that satisfies the specified ID. |
| FindRootWithType | Returns a root object that satisfies the specified type. |
| GetModel | Returns a valid assigned model with the specified type. |
| GetWorldForward | [DEPRECATED] THIS FUNCTION WILL BE REMOVED AND SHOULD NOT BE USED. |
| GetWorldRight | [DEPRECATED] THIS FUNCTION WILL BE REMOVED AND SHOULD NOT BE USED. |
| GetWorldTransform | Returns the world transform of the object which is relative to the parent. If no parent exists, this will be thetransform of the object in world space. |
| GetWorldUp | [DEPRECATED] THIS FUNCTION WILL BE REMOVED AND SHOULD NOT BE USED. |
| ReadBodyTransform | This method will reset the dirty flag on the mass so that it has been read successfully and is valid. |
| SetWorldTransform | [DEPRECATED] THIS FUNCTION WILL BE REMOVED AND SHOULD NOT BE USED. |
| UpdateMassProperties | Updates the mass properties of the current physical object at a particular time. |