diff --git a/docs/documentation/analysis/ecological_assessment/basic-concepts.md b/docs/documentation/analysis/ecological_assessment/basic-concepts.md
index 0bc371d1f97ab1eb47c1c474abbe3f23204533d1..7d98ac79854701f6f0092b57a16d7059892ec8ab 100644
--- a/docs/documentation/analysis/ecological_assessment/basic-concepts.md
+++ b/docs/documentation/analysis/ecological_assessment/basic-concepts.md
@@ -1,18 +1,12 @@
# Basic concepts {#basic-concepts}
-This chapter provides some insight in the implemented calculation routines. The module is split into several submodules which are responsible to calculate parts of the ecological assessment. The following graph shows a rough overview of the module structure, with every end point standing for a submodule:
-<pre class='mermaid'>
- graph TD;
- A[ecological_assessment/src]-->C[standard_strategy]
- C-->D[emission_calculation]
- D-->F[life_cycle_emissions]
- F-->H[LCA_schaefer]
- D-->G[mission_emissions]
- C-->E[impact_calculation]
- E-->I[air_quality_index_schaefer]
- E-->J[climate_impact_dallara]
-</pre>
+This chapter provides some insight in the implemented calculation routines. The module is split into several submodules which are responsible to calculate parts of the ecological assessment. Following submodules are implemented:
-The next sections will describe the submodules in detail, with information about in- and outputs as well as calculation routines. If you'd like to get more information about the values named in the input xml files, you can have an look into the files and read the corresponding description.
+- [Mission Emissions](#mission-emissions)
+- [Life Cycle Emissions (Schaefer)](#lca-schaefer)
+- [Air Quality Index (Schaefer)](#aqi-schaefer)
+- [Climate Model (Dallara)](#climate-model-dallara)
+
+The next sections will describe the submodules in detail, with information about in- and outputs as well as calculation routines. If you'd like to get more information about the values named in the input xml files, you can have an look into the files and read the corresponding description. The inputs from configuration file are shown in their original format, so that you can check the default values and boundaries within this documentation.
## Mission Emissions {#mission-emissions}
The submodule _mission_emissions_ is the only part of _ecological\_assessment_ which can not be deactivated by the user, as its results are needed by all other submodules. It provides various options to calculate the emissions of kerosene or hydrogen-burning engines during a mission. Both the design and the study mission will be calculated (in the following, file names including *mission* will always mean *study_mission* and *design_mission*).
@@ -28,12 +22,7 @@ Taxiing | Take-off | Climb | Approach |
If the taxiing thrust can not be set (which happens sometimes because of a lack of engine data), you will see a warning and the engine will automatically set to idle conditions.
-Then, the main task of this submodule is executed: the emission calculation.
-
-#### Kerosene Emissions
-Kerosene combustion emissions will be calculated as following:
-
-The emissions of CO2, H2O, SO2, SO4 and (in a low fidelity approach) soot are considered to be proportional to the fuel flow. Therefore, they are calculated via
+Then, the main task of this submodule is executed: the emission calculation. Following formula is used for determination:
$ m_{emission} = EI \cdot m_{fuel}$,
@@ -43,7 +32,10 @@ where
- $ EI $: emission index $[\frac{kg_{emission}}{kg_{fuel}}]$
- $ m_{fuel} $: fuel mass $[kg]$
-Following emission indices are used:
+#### Kerosene Emissions
+Kerosene combustion emissions will be calculated as following:
+
+The emissions of CO2, H2O, SO2, SO4 and (in a low fidelity approach) soot are considered to be proportional to the fuel flow. Following emission indices are used:
Emission | EI [kg/kg] |
---------|------------|
@@ -55,9 +47,18 @@ Soot | 0.025e-3 |
All other emissions are considered to be non-proportional and are calculated with following methods:
-- For NOx emissions, there are a P3T3 Method \cite Nor03, Boeing Fuel Flow Method 2 \cite Sch13, and the calculation based on data generated by GasTurb available.
-- For HC as well as CO emissions, the DLR Omega method and Boeing Fuel Flow Method 2 \cite Sch13 are implemented. Additionally, there is the option to calculate the landing and takeoff cycle emissions based on constants provided by ICAO.
-- Soot emissions can be determined via a DLR correlation based on ICAO smoke numbers or a correlation by R.B. Whyte \cite Kug05. Alternatively, it can be assumed to be proportional to the consumed fuel.
+- For NOx emissions, there are
+ - a P3T3 Method \cite Nor03,
+ - Boeing Fuel Flow Method 2 \cite Sch13
+ - and the calculation based on data generated by GasTurb available.
+- For HC as well as CO emissions, the
+ - DLR Omega method
+ - and Boeing Fuel Flow Method 2 \cite Sch13 are implemented.
+ - Additionally, there is the option to calculate the landing and takeoff cycle emissions based on constants provided by ICAO.
+- Soot emissions can be determined via
+ - a DLR correlation based on ICAO smoke numbers
+ - or a correlation by R.B. Whyte \cite Kug05.
+ - Alternatively, it can be assumed to be proportional to the consumed fuel.
#### Hydrogen Combustion Emissions
When hydrogen is burned in an engine, only H2O and NOx emissions are produced. H2O is again assumed to be proportional to the fuel flow. For NOx emissions, there are two methods implemented. As the determination of NOx emissions when burning hydrogen is subject to great uncertainty, a the low-fidelity method of using constant emission indices for different flight phases is the default method. The emission indices were determined in \cite Koss22 for one engine type and are listed in this table:
@@ -81,25 +82,25 @@ For the mission emission calculation (including used libraries), the following p
```
├── requirements_and_specifications/
│ ├── general/
-│ │ ├── type
-│ │ └── model
+│ │ ├── type
+│ │ └── model
│ ├── mission_files/
│ │ ├── design_mission_file
│ │ └── study_mission_file
│ ├── design_specification/
-│ │ ├── configuration/
-│ │ │ ├── configuration_type
-│ │ │ └── aerodynamic_technologies
-│ │ ├── energy_carriers/
-│ │ | └── energy_carrier (ID="0")/
-│ │ | └── type
-│ | └── transport_task/
-│ | ├── cargo_definition/
-│ | | └── additional_cargo_mass
-│ | └── passenger_definition/
-│ | ├── total_number_passengers
-│ | ├── mass_per_passenger
-│ | └── luggage_mass_per_passenger
+│ │ ├── configuration/
+│ │ │ ├── configuration_type
+│ │ │ └── aerodynamic_technologies
+│ │ ├── energy_carriers/
+│ │ | └── energy_carrier (ID="0")/
+│ │ | └── type
+│ | └── transport_task/
+│ | ├── cargo_definition/
+│ | | └── additional_cargo_mass
+│ | └── passenger_definition/
+│ | ├── total_number_passengers
+│ | ├── mass_per_passenger
+│ | └── luggage_mass_per_passenger
│ ├── requirements/
│ │ └── top_level_aircraft_requirements/
│ │ ├── design_mission/
@@ -139,20 +140,40 @@ For the mission emission calculation (including used libraries), the following p
└── flights_per_year_study_mission
```
-In the `ecological_assessment_conf.xml`, next to the control settings block, you can set the emission calculation methods, relative humidity of the air and the duration of aircraft operation within the program settings:
-```
-standard_strategy/
-└── emission_calculation/
- ├── mission_emissions/
- │ └── emission_methods/
- │ ├── kerosene/
- │ │ ├── HC_method_selector
- │ │ ├── CO_method_selector
- │ │ ├── NOx_method_selector
- │ │ └── soot_method_selector
- │ └── hydrogen_combustion/
- │ └── NOx_method_selector
- └── relative_humidity
+In the `ecological_assessment_conf.xml`, next to the control settings block, you can set the emission calculation methods and relative humidity of the air within the program settings:
+```xml
+<standard_strategy description="Settings for standard strategy. Different methods can be used by defining them in this block.">
+ <emission_calculation description="Settings for the emission calculation">
+ <mission_emissions>
+ <emission_methods description="Methods for calculation of emission indices">
+ <kerosene description="Calculation methods for kerosene combustion emission indices">
+ <HC_method_selector description="Select method for calculation of hydrocarbon emission index. Selector: mode_0 (DLR Omega Method) / mode_1 (Boeing Fuel Flow Method 2) / mode_2 (ICAO Emission indices)">
+ <value>mode_0</value>
+ </HC_method_selector>
+ <CO_method_selector description="Select method for calculation of carbon monoxide emission index. Selector: mode_0 (DLR Omega Method) / mode_1 (Boeing Fuel Flow Method 2) / mode_2 (ICAO Emission indices)">
+ <value>mode_0</value>
+ </CO_method_selector>
+ <NOx_method_selector description="Select method for calculation of nitrogen oxide emission index. Selector: mode_0 (pressure and temperature dependent (P3T3) method by P.D.Norman) / mode_1 (Boeing Fuel Flow Method 2) / mode_2 (NOx values from GasTurb will be used)">
+ <value>mode_0</value>
+ </NOx_method_selector>
+ <soot_method_selector description="Select method for calculation of soot emission index. Selector: mode_0 (DLR correlation based on ICAO smoke number) / mode_1 (Correlation by R.B.Whyte) / mode_2 (Use constant factor defined in engine.xml)">
+ <value>mode_0</value>
+ </soot_method_selector>
+ </kerosene>
+ <hydrogen_combustion description="Calculation methods for hydrogen combustion emission indices">
+ <NOx_method_selector description="Select method for calculation of nitrogen oxide emission index. Selector: mode_0 (Use constant EI for different mission segments (Kossarev 2022)) / mode_1 (P3T3 correlation based on experiments by Marek 2005 and correction factor derived of kerosene P3T3 method)">
+ <value>mode_0</value>
+ </NOx_method_selector>
+ </hydrogen_combustion>
+ </emission_methods>
+ <relative_humidity description="Relative humidity of air">
+ <value>0.6</value>
+ <unit>1</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>1</upper_boundary>
+ </relative_humidity>
+ </mission_emissions>
+ </emission_calculation>
```
From `mission.xml`, the taxi time and mission range will be read :
@@ -169,7 +190,7 @@ And last but not least, the engine library will be used, so you can check the do
The central output of the mission submodule is the `ecological_assessment_results.xml` which you will find in the *aircraft\_exchange\_file\_directory/reporting/report_xml* directory. It contains all calculated emission masses. Additionally, there is a `...emissionspath.csv` file in the folder *aircraft_exchange_file_directory/mission_data/* including mission and engine data for every mission step. As described in [Module usage](#usage), an HTML report including plots with emission flows will be generated.
-## LCA Schaefer {#lca-schaefer}
+## Life Cycle Emissions (Schaefer) {#lca-schaefer}
The method is based on the dissertation by Katharina Schäfer (2011) \cite Sch17. It is highly recommended to refer to this work for detailed insights. The method calculates the energy demand and emissions across the aircraft's life cycle phases: development, production, operation, and end-of-life. The following image shows the processes considered.
@@ -452,48 +473,174 @@ Additionally, results from other Unicado tools are needed:
└── flights_per_year_study_mission
```
In the `ecological_assessment_conf.xml`, you can specify calculation modes and input parameters like testing hours for the different phases. Next to the control settings block, the following program settings can be set:
-```
-emission_calculation/
-└── life_cycle_emissions_methods/
- └── schaefer/
- ├── engine_mode_switch
- ├── engine_engineering_ratio
- ├── development_phase/
- │ ├── test_phase/
- │ │ ├── development_emission_setting
- │ │ └── aircraft_specs/
- │ │ ├── ETOPS_switch
- │ │ └── engine_options
- │ ├── wind_tunnel_test/
- │ │ └── test_hours
- │ ├── structural_test/
- │ │ ├── test_cycles
- │ │ └── number_of_structural_test_aircraft
- │ ├── system_test/
- │ │ ├── system_integration_test_hours
- │ │ └── iron_bird_test_hours
- │ ├── engine_test/
- │ │ ├── enable
- │ │ ├── number_of_new_engines
- │ │ ├── number_of_test_engines
- │ │ ├── rig_test/
- │ │ │ ├── test_hours
- │ │ │ └── max_continuous_thrust_percentage
- │ │ └── flying_testbed/
- │ │ ├── test_hours
- │ │ └── flying_testbed_engines/
- │ │ ├── engine_number
- │ │ └── flying_testbed_fuel_consumption_per_engine
- │ └── flight_test/
- │ ├── test_hours
- │ └── number_of_flight_test_aircraft
- ├── production_phase/
- │ ├── production_mode
- │ ├── primary_material_recycling_switch
- │ └── number_produced_aircraft
- └── end_of_life_phase/
- └── distance_to_end_of_life_site
-
+```xml
+<standard_strategy description="Settings for standard strategy. Different methods can be used by defining them in this block.">
+ <emission_calculation description="Settings for the emission calculation">
+ <life_cycle_emissions_methods description="Settings for life cylce emission calculation">
+ <schaefer description="Settings for the emission calculations according to K.Schäfer(2018)">
+ <engine_mode_switch description="Includes engine life cycle in calculation (Dev+Production+Maintenance+EoL). Switch: true (engine included) / false (engine not included)">
+ <value>true</value>
+ </engine_mode_switch>
+ <engine_engineering_ratio description="Engineering effort for engines relative to whole aircraft (derived from Micado CSR-02 costs)">
+ <value>0.2113</value>
+ <unit>1</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>1</upper_boundary>
+ </engine_engineering_ratio>
+ <development_phase description="Settings for the calculation of the development phase">
+ <test_phase description="Settings for calculation of test emissions">
+ <development_emission_setting description="Selects scope of development emission calculation. Selector: mode_0 (no development emissions) / mode_1 (development emissions without production/endOfLife emissions of test components) / mode_2 (development emissions with production/endOfLife emissions of test components)">
+ <value>mode_2</value>
+ </development_emission_setting>
+ <aircraft_specs description="Aircraft specifications needed for development calculations">
+ <ETOPS_switch description="Aircraft and engine(s) will be tested for ETOPS (Extended-range Twin-engine Operations Performance Standards) approval, engine test: additional 3000 test cycles (a 0.5h). Switch: true (test) / false (no test)">
+ <value>false</value>
+ </ETOPS_switch>
+ <engine_options description="Number of engine options for this aircraft">
+ <value>2</value>
+ <unit>1</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>10</upper_boundary>
+ </engine_options>
+ </aircraft_specs>
+ <wind_tunnel_test description="Settings for wind tunnel test">
+ <test_hours description="Number of wind tunnel hours in aircraft development">
+ <value>15000</value>
+ <unit>h</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>150000</upper_boundary>
+ </test_hours>
+ </wind_tunnel_test>
+ <structural_test description="Settings for structural test">
+ <test_cycles description="Number of tested flight cycles in aircraft development (twice the number of flight cycles for which the aircraft will be certified)">
+ <value>160000</value>
+ <unit>1</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>500000</upper_boundary>
+ </test_cycles>
+ <number_of_structural_test_aircraft description="Number of aircraft for structural tests">
+ <value>2</value>
+ <unit>1</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>10</upper_boundary>
+ </number_of_structural_test_aircraft>
+ </structural_test>
+ <system_test description="Settings for system tests">
+ <system_integration_test_hours description="Test hours at the system integration test rig">
+ <value>5000</value>
+ <unit>h</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>10000</upper_boundary>
+ </system_integration_test_hours>
+ <iron_bird_test_hours description="Test hours on the Iron-Bird test rig">
+ <value>5000</value>
+ <unit>h</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>10000</upper_boundary>
+ </iron_bird_test_hours>
+ </system_test>
+ <engine_test description="Specify engine tests">
+ <enable description="Switch to enable engine tests. Switch: true (engine tests on (only if new engine/s for aircraft has to be certified)) / false (engine tests off)">
+ <value>true</value>
+ </enable>
+ <number_of_new_engines description="Number of new engine(s) to be certified">
+ <value>1</value>
+ <unit>1</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>10</upper_boundary>
+ </number_of_new_engines>
+ <number_of_test_engines description="Number of engine for test rig (approx. 5) and flight test (approx. 1)">
+ <value>6</value>
+ <unit>1</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>100</upper_boundary>
+ </number_of_test_engines>
+ <rig_test>
+ <test_hours description="Test hours on the engine rig within aircraft development without/with ETOPS (Extended-range Twin-engine Operations Performance Standards) hours (s.inclETOPS)">
+ <value>1500</value>
+ <unit>h</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>15000</upper_boundary>
+ </test_hours>
+ <incl_ETOPS_switch description="Adds ETOPS (Extended-range Twin-engine Operations Performance Standards) certification in test hours. Switch: true (is included) / false (is not included)">
+ <value>false</value>
+ </incl_ETOPS_switch>
+ <max_continuous_thrust_percentage description="Percentage of test hours on the engine rig with Maximum Continuous Thrust in aircraft development">
+ <value>0.1</value>
+ <unit>1</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>1</upper_boundary>
+ </max_continuous_thrust_percentage>
+ </rig_test>
+ <flying_testbed description="Settings for the flying testbed ">
+ <test_hours description="Test hours on flying testbed aircraft development">
+ <value>225</value>
+ <unit>h</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>1000</upper_boundary>
+ </test_hours>
+ <flying_testbed_engines description="Information about the engine at the flying_test_bed_engines (!), not to be tested engine">
+ <engine_number description="Number of engines on flying testbed (without tested engine)">
+ <value>3</value>
+ <unit>1</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>20</upper_boundary>
+ </engine_number>
+ <flying_testbed_fuel_consumption_per_engine description="Fuel consumption of the flying testbed engines of (one!) engine in cruise flight">
+ <value>3000</value>
+ <unit>kg/h</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>10000</upper_boundary>
+ </flying_testbed_fuel_consumption_per_engine>
+ </flying_testbed_engines>
+ </flying_testbed>
+ </engine_test>
+ <flight_test description="Settings for the flight tests">
+ <test_hours description="Flight test hours in aircraft development for one / all Engine(s)-Option/s (s. incl_engine_options)">
+ <value>2500</value>
+ <unit>h</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>10000</upper_boundary>
+ <incl_engine_options description="Defines if all engine options are included in tests. Switch: true (include all engine options) / false (only one engine)">
+ <value>false</value>
+ </incl_engine_options>
+ </test_hours>
+ <number_of_flight_test_aircraft description="Number of aircraft for flight tests">
+ <value>6</value>
+ <unit>1</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>10</upper_boundary>
+ </number_of_flight_test_aircraft>
+ </flight_test>
+ </test_phase>
+ </development_phase>
+ <production_phase description="Settings for the calculation of the production phase">
+ <production_mode description="Selects the production calculation mode. Selector: mode_0 (material mode) / mode_1 (main parts mode)">
+ <value>mode_1</value>
+ </production_mode>
+ <primary_material_recycling_switch description="Enables primary material recycling. Switch: true (primary material will be recycled) / false (no recyling)">
+ <value>true</value>
+ </primary_material_recycling_switch>
+ <number_produced_aircraft description="Number of produced aircraft per programm">
+ <value>1500</value>
+ <unit>1</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>10000</upper_boundary>
+ </number_produced_aircraft>
+ </production_phase>
+ <operating_phase description="Settings for the calculation of the opeerating phase">
+ </operating_phase>
+ <end_of_life_phase description="Settings for the calculation of the end of life phase">
+ <distance_to_end_of_life_site description="Distance to be flown to the demolition location">
+ <value>1000</value>
+ <unit>NM</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>10000</upper_boundary>
+ </distance_to_end_of_life_site>
+ </end_of_life_phase>
+ </schaefer>
+ </life_cycle_emissions_methods>
+ </emission_calculation>
```
Other inputs are mission related. The design mission taxi time is needed and read from the *design_mission.xml*:
@@ -556,7 +703,7 @@ mission_emissions/
### Output data {#lca-schaefer-output}
The Method writes data to CSV files in the *aircraft\_exchange\_file\_directory/reporting/plots/csv_files* folder containing emissions, energy demand, fuel demand and GWP100 for all processes. Additionally, total emissions of the four phases are written to the `ecological_assessment_results.xml`. As described in [Usage of the ecological_assessment tool](#usage), an HTML report including a plot will be generated.
-## Air Quality Index Schaefer {#aqi-schaefer}
+## Air Quality Index (Schaefer) {#aqi-schaefer}
This method provides a single indicator - called the Air Quality Index (AQI) - for the assessment of air quality. The AQI can take values between 0 and 1, with 1 indicating that the allowable limits defined by ICAO are reached by all species. Therefore, low values are preferable.
### General principles {#aqi-schaefer-generalprinciples}
@@ -596,7 +743,7 @@ mission_emissions/
### Output data {#aqi-schaefer-output}
The submodule writes its calculation results into the HTML report located in *aircraft_exchange_file_directory/reporting/report_html*.
-## Climate Model Dallara {#climate-model-dallara}
+## Climate Model (Dallara) {#climate-model-dallara}
The climate model calculates key climate impact metrics: Radiative Forcing (RF), Absolute Global Warming Potential (AGWP), Absolute Global Temperature Potential (AGTP), and Average Temperature Response (ATR). The calculation methodology is derived from Dallara's work in 2011 \cite Dal11, providing a systematic approach to assess the environmental effects of various emissions.
The key metrics are:
@@ -724,19 +871,57 @@ From the aircraft exchange file following parameter are needed:
```
The submodule reads following data from the program settings in the configuration file:
```xml
-standard_strategy/
-└── impact_calculation/
- └── climate_model_methods/
- └── dallara/
- ├── fuel_factor_AIC
- ├── max_integration_period
- ├── devaluation_rate
- └── forcing_factors/
- ├── variations
- │ ├── aircraft_induced_cloudiness
- │ ├── short_lived_ozone
- │ └── methan_and_long_lived_ozone
- └── data_set_selector
+<standard_strategy description="Settings for standard strategy. Different methods can be used by defining them in this block.">
+ <impact_calculation description="Settings for impact calculation">
+ <climate_model_methods description="Settings for climate model">
+ <dallara description="Settings for the climate impact calculation according to E.Schwartz-Dallara(2011)">
+ <forcing_factors>
+ <data_set_selector description="Selects data set for forcing factor calculation. Selector: mode_0 (Data set by E.Schwartz-Dallara (2011)) / mode_1 (Data set by K.Dahlmann (2011))">
+ <value>mode_0</value>
+ </data_set_selector>
+ <variations description="Forcing factors (S_i_height) are within a certain likelihood range (Reference Dallara_2011_Metric for comparing...). Here you can vary the forcing factors.">
+ <aircraft_induced_cloudiness description="Variation of AIC forcing factor">
+ <value>1</value>
+ <unit>1</unit>
+ <lower_boundary>0.67</lower_boundary>
+ <upper_boundary>1.33</upper_boundary>
+ </aircraft_induced_cloudiness>
+ <short_lived_ozone description="Variation of short-lived ozone forcing factor">
+ <value>1</value>
+ <unit>1</unit>
+ <lower_boundary>0.67</lower_boundary>
+ <upper_boundary>1.33</upper_boundary>
+ </short_lived_ozone>
+ <methan_and_long_lived_ozone description="Variation of methan and long-live ozone forcing factor">
+ <value>1</value>
+ <unit>1</unit>
+ <lower_boundary>0.67</lower_boundary>
+ <upper_boundary>1.33</upper_boundary>
+ </methan_and_long_lived_ozone>
+ </variations>
+ </forcing_factors>
+ <fuel_factor_AIC description="Set a factor to scale radiative forcing of aircraft induced cloudiness (AIC) relative to kerosene depending on fuel type. liquidHydrogen=0.3...0.8">
+ <value>0.6</value>
+ <unit>1</unit>
+ <lower_boundary>0.3</lower_boundary>
+ <upper_boundary>1</upper_boundary>
+ </fuel_factor_AIC>
+ <max_integration_period description="Time over which radiative forcing is to be integrated">
+ <value>200</value>
+ <unit>a</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>1000</upper_boundary>
+ </max_integration_period>
+ <devaluation_rate description="Rate of devaluation of temperature response. Zero means, that postoperation impacts are equally important compared with impacts during operating years, higher values mean that temperature change each postoperation year is less important than the temperature change experienced the previous year">
+ <value>0.03</value>
+ <unit>1</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>10^10</upper_boundary>
+ </devaluation_rate>
+ </dallara>
+ </climate_model_methods>
+ </impact_calculation>
+</standard_strategy>
```
Additionally, the emission masses of the study missions are needed:
diff --git a/docs/documentation/analysis/ecological_assessment/software-architecture.md b/docs/documentation/analysis/ecological_assessment/software-architecture.md
index 2eca7fb47aac9ea333555babdd6e9c624a498c98..57dda6f05b189440c78e2a6f69d65976365fe30d 100644
--- a/docs/documentation/analysis/ecological_assessment/software-architecture.md
+++ b/docs/documentation/analysis/ecological_assessment/software-architecture.md
@@ -2,6 +2,19 @@
If you're interested in developing this module, reading this chapter could be helpful. It provides some insights into the software (folder) structure and shall help you to find a way around :flashlight:
+The following graph shows a rough overview of the module structure, with every end point standing for a submodule described in [Basic Concepts](basic-concepts.md):
+<pre class='mermaid'>
+ graph TD;
+ A[ecological_assessment/src]-->C[standard_strategy]
+ C-->D[emission_calculation]
+ D-->F[life_cycle_emissions]
+ F-->H[LCA_schaefer]
+ D-->G[mission_emissions]
+ C-->E[impact_calculation]
+ E-->I[air_quality_index_schaefer]
+ E-->J[climate_impact_dallara]
+</pre>
+
As you have for sure carefully read our [developer guide](https://unicado.pages.rwth-aachen.de/unicado.gitlab.io/get-involved/developer-installation/), you already know everything about the modularized structure of the UNICADO and the top, intermediate and low level of its modules. So, here is how the *ecological_assessment* tool looks like:
- On the top level, nothing fancy happens. Within the *src* directory, you will find the `main_ecological_assessment.cpp` which executes the module and the `ecolocical_assessment.cpp`/`ecolocical_assessment.h`, where the class EcologicalAssessment, which is inherited from the class Module, is defined. Therefor, it will run the functions `initialize`, `run`, `update`, `report` and `save` of the strategy. The save function will save and close the aircraft XML file and close the configuration file.
diff --git a/docs/documentation/analysis/ecological_assessment/usage.md b/docs/documentation/analysis/ecological_assessment/usage.md
index 605c1e3bb40d47a3e3affd392486286f6c490faa..483c52b44db8491b07bdf1774fcb4e1fed7161de 100644
--- a/docs/documentation/analysis/ecological_assessment/usage.md
+++ b/docs/documentation/analysis/ecological_assessment/usage.md
@@ -3,12 +3,35 @@ You have carefully read the [basic-concepts](basic-concepts.md) and feel ready t
## Prerequisites
1. It is assumed that you have the `UNICADO Package` installed, including the executables and UNICADO libraries. If you are a developer, you need to build the tool first (see [build instructions on the UNICADO website](https://unicado.pages.rwth-aachen.de/unicado.gitlab.io/developer/build/cpp/)).
-2. Fill out the configuration file `ecological_assessment_conf.xml`.
- - change at least in `control_settings`:
- - `aircraft_exchange_file_name` and `aircraft_exchange_file_directory` to your respective settings
+2. Fill out the configuration file `ecological_assessment_conf.xml`. Check and change if needed at least following settings:
+ - change in `control_settings`:
+ ```
+ control_settings/
+ ├── aircraft_exchange_file_name/
+ ├── aircraft_exchange_file_directory/
+ ├── console_output/
+ ├── plot_output/
+ │ └── enable/
+ ├── inkscape_path/
+ └── gnuplot_path/
+ ```
+ - set `aircraft_exchange_file_name` and `aircraft_exchange_file_directory` to your respective settings
- set `console_output` at least to `mode_1`
- - set `plot_output` to false (or define `inkscape_path` and `gnuplot_path`)
- - define in the `program_settings` which submodules you would like to execute
+ - set `plot_output` to false **or** define `inkscape_path` and `gnuplot_path`
+ - define in the `program_settings` which submodules you would like to execute:
+ ```
+ program_settings/
+ ├── strategy_selector/
+ └── standard_strategy/
+ ├── emission_calculation/
+ │ └── life_cycle_emissions_methods/
+ │ └── method/
+ └── impact_calculation/
+ ├── climate_model_methods/
+ │ └── method/
+ └── air_quality_methods/
+ └── method/
+ ```
- all other parameters can be left at default values
3. You need to provide all necessary input data. What is necessary depends on the chosen methods (or executed submodule). In general, you need a (shortened) project environment as described in [Seperate Tool Execution](https://unicado.pages.rwth-aachen.de/unicado.gitlab.io/tutorials/seperate-tool-execution/). The aircraft exchange file need to located at the path you defined in the configuration file. Here is an example with a CSMR-2020 in the projects directory:
@@ -131,17 +154,21 @@ After successful calculation, the aircraft exchange file will be updated, plots
27.01.2025 14:34:25 - CSS code written to style.css successfully.
27.01.2025 14:34:25 - Finish ecological_assessment
```
-You will find a `.log` file within the directory of the executable and an HTML report in the directory of `aircraft_exchange_file_directory/reporting/report_html`. Depending on your chosen methods, additional results are saved in
+You will find
-- `/aircraft_exchange_file/assessment/average_temperature_response`
-- and/or in the files you'll find in the `aircraft_exchange_file_directory/reporting/plots/` directory
-- and/or in the files you'll find in the `aircraft_exchange_file_directory/reporting/plots/csv_files` directory.
+- a `.log` file within the directory of the executable,
+- an HTML report in the directory of `aircraft_exchange_file_directory/reporting/report_html`,
+- an xml file in `aircraft_exchange_file_directory/reporting/report_xml`
+- and depending on your chosen methods, additional results are saved in
+ - `/aircraft_exchange_file/assessment/average_temperature_response`
+ - and/or in the files you'll find in the `aircraft_exchange_file_directory/reporting/plots/` directory
+ - and/or in the files you'll find in the `aircraft_exchange_file_directory/reporting/plots/csv_files` directory.
-Check the Output data sections of [basic concepts](basic-concepts.md) to see, which outputs you can expect.
+Check the Output data sections of [Basic Concepts](basic-concepts.md) to see, which outputs you can expect.
Be aware of the files' timestamp as there could be leftovers of earlier program executions!
## Changing user input
-If you want to adapt the tool's execution, you can modify the parameters within the configuration file. There, you can enable or disable specific aspects of the ecological assessment and select the methods to be used for the calculations. At the [basic concepts](basic-concepts.md), you can check which parameters are available. Start with changing only one parameter at once, so you can track the influence of this parameter!
+If you want to adapt the tool's execution, you can modify the parameters within the configuration file. There, you can enable or disable specific aspects of the ecological assessment and select the methods to be used for the calculations. At the [Basic Concepts](basic-concepts.md), you can check which parameters are available. Start with changing only one parameter at once, so you can track the influence of this parameter!
## Troubleshooting
If something does not work as expected: