Skip to content
Snippets Groups Projects

Add documentation for systems_design

Merged Add documentation for systems_design
documentation/add_systems_design_documentation into develop
Merged Ellen Seabrooke requested to merge documentation/add_systems_design_documentation into develop
Compare
and
9 files
+ 4141
− 4
Compare changes
  • Side-by-side
  • Inline
Files
9
systems_design/doc/content/getting_started.md 0 → 100644
+ 151
− 0
Last comment by Ellen Seabrooke
# Getting Started
This guide will show you how to use **systems_design**, which requires you to define a [system architecture](\ref defining_architecture) and to define [specific parameters for each system](systems.md) in the the configuration file `systems_design_conf.xml` (also _configXML_). Since the required power of the systems is calculated for each mission step, **systems_design** requires a mission file (e.g. `design_mission.xml`). Additionally, input parameters from the aircraft exchange file (or _acXML_) from the following areas are required:
* paths to mission files
* overall masses (MTOM, OME, MME, wing loading)
* performance data (maximum operating velocity, maximum operating mach number, maximum operating altitude, design range)
* landing gear
* wing
* empennage
* fuselage
* nacelles
* tank
* propulsion
* number of flight and cabin crew
**systems_design** has three modes, which are explained [here](\ref modes) in more detail. The mode can be selected in `module_configuration_file/program_settings/mission_mode` and defines which mission file is used for the calculation of the required power (design, study or requirement mission). For the design mission the systems are also sized, i.e. their masses are calculated.
\anchor defining_architecture
## Defining the System Architecture
The system architecture is defined in the _configXML_ of systemsDesign in the node `module_configuration_file/program_settings/aircraft_systems`. Here the systems are grouped into consumer (or sink) systems, conducting systems, and source systems. (This grouping is also used during calculation.) Energy sinks are systems that consume energy. The environmental control system is considered separately to iterate between the heat created by the systems and the sizing of the environmental control system. Energy sources provide energy. Energy conductors conduct electric or hydraulic energy or bleed air. Virtual systems are used for adding systems that will not be designed (for example if there are no sizing methods implemented for this system). For each group the number of systems in the group is defined, followed by the individual system description. A minimal example of the architecture definition is given below.
```xml
<aircraft_systems>
<energy_sinks>
<number_of_sinks description="Number of energy sinks">
<value>1</value>
<default>20</default>
</number_of_sinks>
<system ID="0">
<system_description description="Type of furnishing system">
<value>conventionalFurnishing</value>
</system_description>
<operating_switch description="Switch whether the system is operated. Switch: true (on) / false (off, mass is determined anyway!)">
<value>true</value>
<default>true</default>
</operating_switch>
</system>
</energy_sinks>
<environmental_control_system>
<system_description Unit="-" description="Type of environmental control system (ECS)">
<value>conventionalECS</value>
</system_description>
<operating_switch description="Switch whether the system is operated. Switch: true (on) / false (off, mass is determined anyway!)">
<value>true</value>
<default>true</default>
</operating_switch>
</environmental_control_system>
<energy_sources>
<number_of_sources description="Number of energy sources">
<value>1</value>
<default>1</default>
</number_of_sources>
<system ID="0">
<system_description description="Type of propulsion system">
<value>conventionalPropulsion</value>
</system_description>
<operating_switch description="Switch whether the system is operated. Switch: true (on) / false (off, mass is determined anyway!)">
<value>true</value>
<default>true</default>
</operating_switch>
</system>
</energy_sources>
<energy_conductors>
<number_of_conductors description="Number of energy conductor systems">
<value>2</value>
<default>3</default>
</number_of_conductors>
<system ID="0">
<system_description description="Type of system">
<value>BleedAirSystem</value>
</system_description>
<operating_switch description="Switch whether the system is operated. Switch: true (on) / false (off, mass is determined anyway!)">
<value>true</value>
<default>true</default>
</operating_switch>
</system>
<system ID="1">
<system_description description="Type of system">
<value>ElectricSystem</value>
</system_description>
<operating_switch description="Switch whether the system is operated. Switch: true (on) / false (off, mass is determined anyway!)">
<value>true</value>
<default>true</default>
</operating_switch>
</system>
</energy_conductors>
<virtual_systems>
<number_of_virtual_systems description="Number of energy systems">
<value>0</value>
<default>0</default>
</number_of_virtual_systems>
</virtual_systems>
</aircraft_systems>
```
By including or excluding these systems, you can choose which systems are implemented. By default the following systems are included in the architecture (name for configXML given in brackets):
* energy sinks:
* [conventional furnishing system](\ref ATA25-furnishing) (conventionalFurnishing)
* [conventional fuel system](\ref ATA28-fuel) (conventionalFuel)
* [conventional ice and rain protection system](\ref ATA30-ice-conventional) (conventionalIceRainProtection)
* [conventional lighting system](\ref ATA33-lighting) (conventionalLighting)
* [conventional fire protection system](\ref ATA26-fire) (conventionalFireProtection)
* [conventional oxygen system](\ref ATA35-oxygen) (conventionalOxygenSystem)
* [conventional landing gear system](\ref ATA32-gear) (conventionalGear)
* [conventional flight control system](\ref ATA27-flight-control) (conventionalFlightControl)
* [remaining consumer systems](\ref ATAXX-remaining) (reminingConsumers)
* [environmental control system](\ref ATA21-ECS) (conventionalECS)
* energy sources:
* [conventional propulsion](\ref ATA70-engine) (conventionalPropulsion)
* [conventional APU](\ref ATA49-APU) (conventionalAPU)
* energy conductors:
* [bleed air system](\ref ATA36-bleed) (BleedAirSystem)
* [hydraulic system](\ref ATA29-hydraulic) (HydraulicSystem)
* [electric system](\ref ATA24-electric) (ElectricSystem)
Some systems have several implementations (e.g. ATA30 has a conventional and an electric implementation). Which one is used is specified by the node `system_description`. Sticking to the ATA30 example, the conventional implementation would be set like this:
```xml
<system ID="2">
<system_description description="Type of system ice and rain protection system (conventional or electrical)">
<value>conventionalIceRainProtection</value>
</system_description>
<operating_switch description="Switch whether the system is operated 1: on, 0: off (the mass is also determined for a switched off system!)">
<value>1</value>
<default>1</default>
</operating_switch>
</system>
```
To include an electrical ice and rain protection system `system_description/value` can be changed to `electricalIceRainProtection`. **Important**: The name must match those expected by `standardSystemsDesign::initializeSystems()`.
Additionally, [system-specific parameters](systems.md) can be set in the node `<system_constants>` of the _configXML_. Apart from the specific parameters, a power source is defined for each system. One or more power sources can be defined to power the system. The operation factor of each power source defines the percentage of power it delivers. The type defines the energy type (hydraulic, electric, bleed). The source ID refers to the conductor system, not to the power source itself. This means that in the example below the system is power 100% through the electric conductor system 1.
```xml
<shaft_power_sources description="Sources for possible existing shaft power consumption">
<number_of_power_sources description="Number of power sources">
<value>1</value>
</number_of_power_sources>
<power_source ID="0" description="system description of the power source">
<operation_factor description="Percentage of performance provided by this source">
<value>1.0</value>
<unit>-</unit>
</operation_factor>
<type description="Type of power source (Hydraulic, Electric, Engine, APU)">
<value>Electric</value>
</type>
<source_ID description="ID of the energy source">
<value>1</value>
</source_ID>
</power_source>
</shaft_power_sources>
```
## Output
**systems_design** will generate a report containing system masses (if run in sizing mode) and the electric, hydraulic and bleed air power profile over the mission for each system. Additionally, the section `systems` of the component design in the _acXML_ is updated (if **systems_design** was run in design mode) and the bleed air and shaft power offtakes from the engine for each mission step are written to the mission file (for any mode).