Documentation for engine?

[1ozturkbe]

Hey @mayork, the engine paper is great but the documentation about how to integrate the engine into other models is minimal at the moment. Do you have plans to write a quick-start of sorts? I think that would be huge in making turbofan into a really awesome SP model.

[mayork]

Not planning to do that

On Nov 7, 2017, at 11:56, Berk Ozturk notifications@github.com wrote:

Hey @mayork, the engine paper is great but the documentation about how to integrate the engine into other models is minimal at the moment. Do you have plans to write a quick-start of sorts? I think that would be huge in making turbofan into a really awesome SP model.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub, or mute the thread.

[mayork]

@1ozturkbe below is a list of things you have to do to link the engine model to an aircraft model. I don't know how/don't have time to make a read the docs but you could probably just update the SPaircraft read the docs to include these items. It's pretty straightforward overall and demonstrated in both SP_aircraft.py and https://github.com/convexengineering/turbofan/blob/master/turbofan/engine_flight_profile_integration.py

To integrate the engine you need to do a few things:

• link the engine weight in the engine model to the engine weight in your airplane model
• link the thrust requirement in your aircraft model to the engine's thrust
• link engine sizing variables to the LG model (if used)
  • link engine model TSFC and thrust to fuel burn equations in your aircraft model
• link engine fan area to VT engine out sizing constraint
• link engine fan and LPC diameter to the nacelle drag constraints
• link engine weight to nacelle weight equation
• add engine to aircraft CG model
• link engine atmospheric state variables to the state variables in your aircraft model through something like our statelinking model
• link mach numbers (M2) in the engine model to the flight mach number for each segment

also obviously need to make sure the engine model is vectorized the same way as the aircraft performance model

[1ozturkbe]

hey @mayork, thanks for the list. I do not have time for this at the moment (and probaly won't until after February), so I will keep the issue open until I have time.