propulsion_cycle
- class EngineElement
 Bases:
CommonBaseModelRepresents an individual element in the engine cycle.
- name
 The name of the engine element.
- Type:
 str
- options
 The options associated with the engine element.
- Type:
 dict, optional
Attributes:
__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 Inlet
 Bases:
EngineElementInlet conditions for the engine.
- mn
 Mach number.
- Type:
 Optional[float]
- ram_recovery
 Ram recovery factor.
- Type:
 Optional[float]
- area
 On-design frontal area.
- Type:
 Optional[float]
Attributes:
__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 Compressor
 Bases:
EngineElementCompressor component of the engine.
- mn
 Mach number.
- Type:
 Optional[float]
- map_data
 Map data for the compressor.
- Type:
 Optional[str]
- bleed_names
 Names of the bleed ports.
- Type:
 Optional[List[str]]
- map_extrap
 Flag to indicate if map extrapolation is used.
- Type:
 Optional[bool]
- pr_des
 Design condition pressure ratio
- Type:
 Optional[float]
- eff_des
 Design condition efficeincy
- Type:
 Optional[float]
Attributes:
__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 Turbine
 Bases:
EngineElementTurbine component of the engine.
- mn
 Mach number.
- Type:
 Optional[float]
- map_data
 Map data for the turbine.
- Type:
 Optional[str]
- bleed_names
 Names of the bleed ports.
- Type:
 Optional[List[str]]
- map_extrap
 Flag to indicate if map extrapolation is used.
- Type:
 Optional[bool]
- pr_des
 Design condition pressure ratio
- Type:
 Optional[float]
- effDes
 Design condition efficeincy
- Type:
 Optional[float]
Attributes:
__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 Splitter
 Bases:
EngineElementSplitter component of the engine.
- bpr
 Bypass ratio.
- Type:
 Optional[float]
- mn1
 Mach number for the first flow path.
- Type:
 Optional[float]
- mn2
 Mach number for the second flow path.
- Type:
 Optional[float]
- area1
 Area for the second flow path.
- Type:
 Optional[float]
- area2
 Area for the second flow path.
- Type:
 Optional[float]
Attributes:
__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 Duct
 Bases:
EngineElementDuct component of the engine.
- mn
 Mach number.
- Type:
 Optional[float]
- dp_qp
 Pressure drop ratio.
- Type:
 Optional[float]
Attributes:
__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 Bleed
 Bases:
EngineElementBleed output component
- bleed_names
 Names of the bleed connections associated
- Type:
 Optional[List[str]]
- statics
 If true calculate static properties
- Type:
 Optional[bool]
Attributes:
__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 Combustor
 Bases:
EngineElementCombustor component of the engine.
- fuel_type
 Type of fuel used.
- Type:
 Optional[str]
- mn
 Mach number.
- Type:
 Optional[float]
- dp_qp
 Pressure drop ratio.
- Type:
 Optional[float]
Attributes:
__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 Nozzle
 Bases:
EngineElementNozzle component of the engine.
- nozz_type
 Type of nozzle.
- Type:
 Optional[str]
- loss_coef
 Loss coefficient.
- Type:
 Optional[str]
- cv
 Discharge coefficient.
- Type:
 Optional[float]
Attributes:
__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 Shaft
 Bases:
EngineElementShaft component of the engine.
- num_ports
 Number of ports on the shaft.
- Type:
 Optional[int]
- nmech
 Mechanical speed in RPM.
- Type:
 Optional[float]
Attributes:
__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 PropulsionCycle
 Bases:
CommonBaseModelRepresents a complete engine cycle.
- name
 The name of the engine cycle.
- Type:
 str
- design
 Whether the engine cycle is in design mode.
- Type:
 bool
- thermo_method
 The thermodynamic method used in the engine cycle. Defaults to ‘CEA’.
- Type:
 str, optional
- thermo_data
 The thermodynamic data used in the engine cycle.
- Type:
 str, optional
- elements
 The list of engine elements in the engine cycle.
- Type:
 List[EngineElement]
- balance_components
 The list of balance components in the engine cycle.
- Type:
 List[BalanceComponent], optional
- global_connections
 The global connections in the engine cycle.
- Type:
 dict, optional
- flow_connections
 The flow connections in the engine cycle.
- Type:
 dict, optional
- solver_settings
 The solver settings for the engine cycle.
- Type:
 dict, optional
Attributes:
__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__
Classes
Bleed output component  | 
|
Combustor component of the engine.  | 
|
  | 
A base model providing common validation logic for all derived models.  | 
Compressor component of the engine.  | 
|
Duct component of the engine.  | 
|
Represents an individual element in the engine cycle.  | 
|
Inlet conditions for the engine.  | 
|
  | 
Generic type for annotating a type that is an instance of a given class.  | 
Nozzle component of the engine.  | 
|
Represents a complete engine cycle.  | 
|
  | 
Annotation used to mark a type as having duck-typing serialization behavior.  | 
Shaft component of the engine.  | 
|
Splitter component of the engine.  | 
|
Turbine component of the engine.  |