Class in Zendir.Classes | Inherits from StateEffector
Declaration
class FuelSource;Description
Base class for ‘FuelSource’ types. This component is a container for fuel and applies energy momentum contributions to the spacecraft. It also calculates the mass flow between components.
Properties
| Declared | Description |
|---|---|
| Amount | The current stored fuel. |
| Capacity | The maximum storage capacity. |
| DesiredIngoingFlowRate | The ingoing flow rate desired by the fuel source. This value is written in positive values. |
| DryMass | The mass of the tank without fuel. |
| InitialFuelMass | The initial mass of the fuel before consumption. Used for certain fuel models. |
| InitialPosition_LB_L | Initial position vector from the body to tank (L) point in body frame components. Thisis the same as ‘R_TcT_TInit’ using the tank point T. |
| IsThermallyShutoff | Training-grade thermal band: true while transfer into this tank should be halted due to temperature limits. |
| MaxAllowableTemperature | When > 0 and a is present, ullage gas temperature abovethis value (K) latches thermal shutoff and blocks incoming transfer until restart. |
| MaximumOutgoingFlowRate | The maximum outgoing flow rate of the fuel source. |
| ModelType | The current fuel model type being used for the fuel source |
| Out_FuelAmountMsg | An output status message for the fuel source |
| OutgoingFlowRate | The outgoing flow rate desired by the fuel source. This value is written in negative values. |
| ProvidedIngoingFlowRate | The ingoing flow rate provided by other fuel nodes. This value is written in positive values. |
| RestartTemperature | After thermal shutoff, transfer may resume when ullage temperature falls to this value (K) or below. |
| TankLength | Length of the tank. |
| TankRadius | Radius of the cylindrical tank. |
| TotalFlowRate | The total ingoing and outgoing flow rate of the fuel source. |
| 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). |
| Force_B | Force that the state effector applies to the body (B) frame. |
| In_BodyMassMsg | Message for incoming body mass state from the root object. |
| 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. |
| Torque_LB_B | Torque that the state effector applies to the body about the bodyframe (B). |
| Torque_LC_B | Torque that the state effector applies to the body about thecenter of mass (C). |
Methods
| Declared | Description |
|---|---|
| ConnectFuelConsumerModel | Connects the fuel consumer to this fuel source via the FuelBus. |
| ConnectFuelSource | Connects this fuel source to another fuel source via the FuelBus (bidirectional). |
| ConnectPump | Connects this fuel source to a pump’s port via the FuelBus. |
| ConnectThermalToBus | Convenience radiative link from this tank’s to a bus/structurefor training-grade refueling thermals. Sets tank emissivity to(e.g. 0.024 for MLI) and uses a radiation connection. |
| ConnectValve | Connects this fuel source to a valve’s inlet port via the FuelBus. |
| DisconnectFuelConsumerModel | Disconnects the fuel consumer from this fuel source via the FuelBus. |
| DisconnectFuelSource | Disconnects the connection to the fuel source from this fuel source via the FuelBus. |
| DisconnectPump | Disconnects this fuel source from a pump via the FuelBus. |
| DisconnectValve | Disconnects this fuel source from a valve via the FuelBus. |
| GetConnectedFuelConsumers | An array of the connected fuel consuming models, FuelConsumerModel, connected to this Fuel Source. |
| GetConnectedFuelSources | An array of other FuelSources connected to this Fuel Source. |
| 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. |
| CalculateForceTorqueOnBody | Calculates the Force and Torque of the object due to the State Effector |
| 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. |
| ModifyStates | Modifies any state values after integration |
| 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. |
| WriteOutputStateMessages | Writes state messages after integration |