systems_parameters

Vehicle Systems module for aircraft system modeling.

This module provides Pydantic models for representing various aspects of aircraft systems, including functional blocks, data signals, physical characteristics, and system attributes.

class SignalType

Bases: str, Enum

Enumeration of signal types.

Methods:

`__repr__`()	Return repr(self).
`__str__`()	Return str(self).
`__new__`(value)
`__format__`(format_spec)	Returns format using actual value type unless __str__ has been overridden.

__repr__(): Return repr(self).

__str__(): Return str(self).

__new__(value)

__format__(format_spec): Returns format using actual value type unless __str__ has been overridden.

class SignalDirection

Bases: str, Enum

Enumeration of signal directions.

Methods:

`__repr__`()	Return repr(self).
`__str__`()	Return str(self).
`__new__`(value)
`__format__`(format_spec)	Returns format using actual value type unless __str__ has been overridden.

__repr__(): Return repr(self).

__str__(): Return str(self).

__new__(value)

__format__(format_spec): Returns format using actual value type unless __str__ has been overridden.

class FunctionalBlock

Bases: BaseModel

Represents a functional block in the system diagram.

block_id

Unique identifier for the block.

Type:: str

name

Name of the functional block.

Type:: str

description

Brief description of the block’s function.

Type:: str

inputs

List of input signal names.

Type:: List[str]

outputs

List of output signal names.

Type:: List[str]

Attributes:

__pydantic_setattr_handlers__

__setattr__ handlers.

__pydantic_setattr_handlers__: ClassVar[Dict[str, Callable[[BaseModel, str, Any], None]]] = {}: __setattr__ handlers. Memoizing the handlers leads to a dramatic performance improvement in __setattr__

class DataSignal

Bases: BaseModel

Represents a data signal in the system.

name

Name of the signal.

Type:: str

type

Type of the signal.

Type:: SignalType

direction

Direction of the signal.

Type:: SignalDirection

source

Source of the signal (system or component ID).

Type:: str

destination

Destination of the signal (system or component ID).

Type:: str

description

Brief description of the signal.

Type:: str

Attributes:

__pydantic_setattr_handlers__

__setattr__ handlers.

__pydantic_setattr_handlers__: ClassVar[Dict[str, Callable[[BaseModel, str, Any], None]]] = {}: __setattr__ handlers. Memoizing the handlers leads to a dramatic performance improvement in __setattr__

class PhysicalCharacteristics

Bases: BaseModel

Physical characteristics of the system.

weight

Weight in kilograms.

Type:: float

dimensions

Dimensions in meters (length, width, height).

Type:: Dict[str, float]

volume

Volume in cubic meters.

Type:: float

center_of_gravity

Center of gravity coordinates (x, y, z) in meters.

Type:: Dict[str, float]

Methods:

`validate_dimensions`(v)	Validate that dimensions include length, width, and height.
`validate_cog`(v)	Validate that center of gravity includes x, y, and z coordinates.

Attributes:

__pydantic_setattr_handlers__

__setattr__ handlers.

classmethod validate_dimensions(v)

Validate that dimensions include length, width, and height.

Parameters:: v (Dict[str, float])
Return type:: Dict[str, float]

classmethod validate_cog(v)

Validate that center of gravity includes x, y, and z coordinates.

Parameters:: v (Dict[str, float])
Return type:: Dict[str, float]

__pydantic_setattr_handlers__: ClassVar[Dict[str, Callable[[BaseModel, str, Any], None]]] = {}: __setattr__ handlers. Memoizing the handlers leads to a dramatic performance improvement in __setattr__

class FluidFlowCharacteristics

Bases: BaseModel

Represents the flow characteristics of a working fluid in the system.

fluid_type

Type of fluid (e.g., “Hydraulic Oil”, “Fuel”, “Coolant”).

Type:: str

flow_rate

Nominal flow rate in liters per minute.

Type:: float

max_pressure

Maximum operating pressure in pascals.

Type:: float

min_pressure

Minimum operating pressure in pascals.

Type:: float

temperature_range

Operating temperature range in Celsius (min, max).

Type:: Tuple[float, float]

viscosity

Kinematic viscosity in centistokes at operating temperature.

Type:: float

density

Fluid density in kg/m³ at operating temperature.

Type:: float

Methods:

validate_temperature_range(v)

Validate that the minimum temperature is less than the maximum temperature.

Attributes:

__pydantic_setattr_handlers__

__setattr__ handlers.

classmethod validate_temperature_range(v)

Validate that the minimum temperature is less than the maximum temperature.

Parameters:: v (Tuple[float, float])
Return type:: Tuple[float, float]

__pydantic_setattr_handlers__: ClassVar[Dict[str, Callable[[BaseModel, str, Any], None]]] = {}: __setattr__ handlers. Memoizing the handlers leads to a dramatic performance improvement in __setattr__

class CoolingRequirements

Bases: BaseModel

Cooling requirements for the system.

method

Cooling method (e.g., “Air”, “Liquid”, “Conduction”).

Type:: str

heat_dissipation

Heat dissipation in watts.

Type:: float

max_operating_temperature

Maximum operating temperature in Celsius.

Type:: float

Attributes:

__pydantic_setattr_handlers__

__setattr__ handlers.

__pydantic_setattr_handlers__: ClassVar[Dict[str, Callable[[BaseModel, str, Any], None]]] = {}: __setattr__ handlers. Memoizing the handlers leads to a dramatic performance improvement in __setattr__

class PowerRequirements

Bases: BaseModel

Power requirements for the system.

voltage

Required voltage in volts.

Type:: float

current

Required current in amperes.

Type:: float

frequency

Required frequency in Hz, if applicable.

Type:: Optional[float]

power_type

Type of power (e.g., “AC”, “DC”).

Type:: str

peak_power

Peak power consumption in watts.

Type:: float

average_power

Average power consumption in watts.

Type:: float

Attributes:

__pydantic_setattr_handlers__

__setattr__ handlers.

__pydantic_setattr_handlers__: ClassVar[Dict[str, Callable[[BaseModel, str, Any], None]]] = {}: __setattr__ handlers. Memoizing the handlers leads to a dramatic performance improvement in __setattr__

class SystemAttributes

Bases: BaseModel

Attributes specific to an aircraft system.

functional_blocks

List of functional blocks in the system.

Type:: List[FunctionalBlock]

data_signals

List of data signals in the system.

Type:: List[DataSignal]

physical_characteristics

Physical characteristics of the system.

Type:: PhysicalCharacteristics

cooling_requirements

Cooling requirements for the system.

Type:: CoolingRequirements

power_requirements

Power requirements for the system.

Type:: PowerRequirements

fluid_flow

Fluid flow characteristics, if applicable.

Type:: Optional[FluidFlowCharacteristics]

Attributes:

__pydantic_setattr_handlers__

__setattr__ handlers.

__pydantic_setattr_handlers__: ClassVar[Dict[str, Callable[[BaseModel, str, Any], None]]] = {}: __setattr__ handlers. Memoizing the handlers leads to a dramatic performance improvement in __setattr__

class System

Bases: BaseModel

Represents an aircraft system.

wbs_id

Work Breakdown Structure ID.

Type:: str

mil_std_881f_reference

Reference to MIL-STD-881F.

Type:: str

name

Name of the system.

Type:: str

type

Type of the item (always “System” for this class).

Type:: Literal[“System”]

attributes

Specific attributes of the system.

Type:: SystemAttributes

components

List of component WBS IDs that make up this system.

Type:: List[str]

Methods:

type_must_be_system(v)

Validate that the type is always 'System'.

Attributes:

__pydantic_setattr_handlers__

__setattr__ handlers.

classmethod type_must_be_system(v)

Validate that the type is always ‘System’.

Parameters:: v (str)
Return type:: str

__pydantic_setattr_handlers__: ClassVar[Dict[str, Callable[[BaseModel, str, Any], None]]] = {}: __setattr__ handlers. Memoizing the handlers leads to a dramatic performance improvement in __setattr__

Classes

`CoolingRequirements`	Cooling requirements for the system.
`DataSignal`	Represents a data signal in the system.
`FluidFlowCharacteristics`	Represents the flow characteristics of a working fluid in the system.
`FunctionalBlock`	Represents a functional block in the system diagram.
`PhysicalCharacteristics`	Physical characteristics of the system.
`PowerRequirements`	Power requirements for the system.
`SignalDirection`	Enumeration of signal directions.
`SignalType`	Enumeration of signal types.
`System`	Represents an aircraft system.
`SystemAttributes`	Attributes specific to an aircraft system.