Enhancements in Mission module

[christophe-david]

Closes #404.

• Documentation has been updated. Preview here
  • Description of mission definition and segments has been update
  • A section has been added about extensibility. Description of FlightPoint class has been moved in there.
• FlightSegment._get_gamma_and_acceleration() now take a FlightPoint as input, to allow the calculation to depend on more parameters than mass, drag and thrust
• a parameter with a variable as value can now be associated to a unit and a default value that will be used in the OpenMDAO input declaration (and be in generated input data file)
• a target parameter can be declared as relative to the start point of the segment by prefixing the parameter name with delta_
• when setting a parameter, a minus sign can be put before a variable name to get the opposite value (can be useful with relative values)
• a parameter can now be set at route or mission level
• dISA can now be set in mission definition file with isa_offset
• taxi-out and takeoff are now set in mission definition file:
  • mission starting point (altitude, speed, mass) can now be set using the "start" segment
  • the mass input of the mission can be set using the "mass input" segment. This segment can be anywhere in the mission, though it is expected that fuel consumption in previous segments is mass-independent.
• a mission phase can now contain other phases
• if a segment parameter (dataclass field) is an array or a list, the associated variable in mission file will be declared with shape_by_conn=True

[codecov[bot]]

Codecov Report

Merging #430 (65186b4) into master (dd7269d) will increase coverage by 0.03%. The diff coverage is 91.20%.

@@            Coverage Diff             @@
##           master     #430      +/-   ##
==========================================
+ Coverage   89.47%   89.51%   +0.03%     
==========================================
  Files          73       81       +8     
  Lines        4437     4777     +340     
  Branches      714      787      +73     
==========================================
+ Hits         3970     4276     +306     
- Misses        338      357      +19     
- Partials      129      144      +15     

Impacted Files	Coverage Δ
.../models/performances/mission/openmdao/link_mtow.py	88.88% <ø> (ø)
src/fastoad/model_base/datacls.py	75.00% <75.00%> (ø)
...sion_definition/mission_builder/mission_builder.py	87.36% <87.36%> (ø)
...performances/mission/openmdao/mission_component.py	88.13% <88.13%> (ø)
...stoad/models/performances/mission/segments/base.py	91.66% <88.63%> (-1.63%)	:arrow_down:
...s/performances/mission/segments/altitude_change.py	89.39% <88.88%> (-0.32%)	:arrow_down:
...oad/models/performances/mission/segments/cruise.py	96.38% <89.47%> (-0.36%)	:arrow_down:
src/fastoad/openmdao/variables/variable.py	92.48% <90.00%> (+1.42%)	:arrow_up:
...dels/performances/mission/segments/speed_change.py	90.00% <90.90%> (+1.11%)	:arrow_up:
...ion_definition/mission_builder/input_definition.py	91.66% <91.66%> (ø)
... and 20 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.