Merge to public repo (#1)

* Initialization of matGasFlow

.gitignore

@@ -0,0 +1,38 @@
+# Windows default autosave extension
+*.asv
+
+# OSX / *nix default autosave extension
+*.m~
+
+# Compiled MEX binaries (all platforms)
+*.mex*
+
+# Packaged app and toolbox files
+*.mlappinstall
+*.mltbx
+
+# Generated helpsearch folders
+helpsearch*/
+
+# Simulink code generation folders
+slprj/
+sccprj/
+
+# Matlab code generation folders
+codegen/
+
+# Simulink autosave extension
+*.autosave
+
+# Octave session info
+octave-workspace
+
+*.xlsx
+*.tap
+*.log
+*.shp
+*.dbf
+*.shx
+*_EXPORT*
+
+

AUTHORS

@@ -0,0 +1,13 @@
+Copyright (c) 2020-2021, Power Systems Engineering Research Center (PSERC)
+
+Primary developer:
+- Marcel Kurth (m.kurth@iaew.rwth-aachen.de)
+
+Other contributors:
+- Marie-Sophie Heidi Braun
+- Andreas Blank
+- Andreas Rhein
+- Sarah Nesti
+- Longye Zheng
+- Marvin Hippler
+

CITATION

@@ -0,0 +1,13 @@
+An open source publication is being planned as well as the publication of a
+paper. Until then, we request that publications derived from the use of
+MATGASFLOW explicitly acknowledge that fact by citing the the software as
+follows:
+
+    Marcel Kurth (2021). matGasFlow (Version 0.0.2) [Software]. Institute for
+        High Voltage Equipment and Grids, Digitalization and Energy
+        Economics (IAEW), RWTH Aachen University.
+
+In the interest of facilitating research reproducibility and thereby
+increasing the value of your MATGASFLOW-related research publications, we
+strongly encourage you to also publish, whenever possible, all of the
+code and data required to generate the results you are publishing.

Data/Fluid Data/gasMix_library.csv

@@ -0,0 +1,15 @@
+gas;H_Gas_NorthSea;H_Gas_Mix;H_Gas_Russia;H_Gas_Holland;H_Gas_GERG2008;L_Gas_Verbund;L_Gas_WeserEms;TENP_North;TENP_South;H2
+"CH4";0.9047;0.9107;0.9638;0.8439;0.9207;0.8432;0.8442;0.9174;0.9256;0
+"C2H6";0.0603;0.0552;0.0271;0.036;0.0463;0.0363;0.0358;0.0497;0.0452;0
+"C3H8";0.0054;0.0052;0.0012;0.0054;0.0035;0.0056;0.0053;0.0071;0.0064;0
+"n_C4H10";0.0006;0.0007;0.0002;0.0009;0.0004;0.001;0.001;0.001;0.001;0
+"iso_C4H10";0.0008;0.0008;0.0004;0.0009;0.0003;0.001;0.0009;0.0013;0.0011;0
+"n_C5H12";0.0001;0.0001;0;0.0002;0;0.0002;0.0002;0.0002;0.0002;0
+"iso_C5H12";0.0002;0.0002;0;0.0003;0.0001;0.0003;0.0003;0.0003;0.0003;0
+"neo_C5H12";0;0;0;0.0001;0;0;0.0001;0;0;0
+"C6H14";0.0002;0.0002;0.0001;0.0005;0;0.0006;0.0005;0.0003;0.0003;0
+"CO";0;0;0;0;0;0;0;0;0;0
+"H2";0;0;0;0;0;0;0;0;0;1
+"H2S";0;0;0;0;0;0;0;0;0;0
+"N2";0.0087;0.0101;0.0035;0.0978;0.009;0.0976;0.0978;0.0094;0.0087;0
+"CO2";0.019;0.0168;0.0037;0.014;0.0197;0.0142;0.0139;0.0133;0.0112;0

Data/Fluid Data/pure_gas_properties.csv

@@ -0,0 +1,14 @@
+gas;M;V_m_n;rho_n;Z_n;sum_factor;p_c;T_c;V_m_c;Z_c;a;b;c;d;C_s;eta_0;H_s_n;H_i_n;omega
+"CH4";0.016043;0.02236;0.717486583184258;0.9976;0.04886;4599000;190.56;9.86e-05;0.286;17.451;0.060459;1.117e-06;-7.205e-09;164;1.02e-05;39831000;35894000;0.011
+"C2H6";0.03007;0.02219;1.35511491662911;0.99;0.0997;4872000;305.32;0.0001455;0.279;5.351;0.177669;-6.8701e-05;8.514e-09;252;8.6e-06;70333000;64382000;NaN
+"C3H8";0.044097;0.021941;2.00979900642633;0.9789;0.1465;4248000;369.83;0.0002;0.276;-5.058;0.308503;-0.000161779;3.3309e-08;278;7.5e-06;101142000;93118000;0.153
+"n_C4H10";0.058123;0.021455;2.70906548590072;0.9572;0.2022;3796000;425.12;0.000255;0.274;-0.05;0.387045;-0.000200824;4.061e-08;358;6.9e-06;134115000;123857000;0.199
+"iso_C4H10";0.058123;0.021473;2.70679457923904;0.958;0.1885;3640000;407.85;0.0002627;0.278;-0.05;0.387045;-0.000200824;4.061e-08;330;6.9e-06;133574000;122325000;0.183
+"n_C5H12";0.07215;0.02058;3.50583090379009;0.918;0.2586;3370000;469.7;0.000311;0.268;0.414;0.480298;-0.000255002;5.2815e-08;383;6.2e-06;171840000;159000000;0.199
+"iso_C5H12";0.07215;0.02058;3.50583090379009;0.918;0.2458;3370000;469.7;0.000311;0.268;0.414;0.480298;-0.000255002;5.2815e-08;383;6.2e-06;167530000;154990000;0.183
+"neo_C5H12";0.07215;0.02058;3.50583090379009;0.918;0.2245;3370000;469.7;0.000311;0.268;0.414;0.480298;-0.000255002;5.2815e-08;383;6.2e-06;166430000;153930000;NaN
+"C6H14";0.086177;0.01999;4.31100550275138;0.892;0.3319;3025000;507.6;0.000368;0.264;1.79;0.570497;-0.000306009;6.3994e-08;436;5.9e-06;209820000;194410000;NaN
+"H2";0.0020159;0.022428;0.0898831817371143;1.0006;-0.01;1315000;33.19;6.69289508632138e-05;0.319;29.066;-0.000837;2.012e-06;0;72;8.44e-06;12745000;10782000;-0.216
+"H2S";0.034082;0.02219;1.53591707976566;0.99;0.1006;8937000;373.25;9.85028901734104e-05;0.283665637557992;28.719;0.016117;3.284e-06;-2.653e-09;331;1.168e-05;25327000;23343000;NaN
+"N2";0.0280134;0.0224049;1.25032470575633;0.9995;0.0214;3398000;126.2;9.01e-05;0.289;27.296;0.00523;-4e-09;0;102;1.658e-05;0;0;-0.039
+"CO2";0.0440095;0.0222569;1.97734185803054;0.9933;0.0821;7374000;304.12;9.407e-05;0.274;21.556;0.063697;-4.0505e-05;9.678e-09;273;1.383e-05;0;0;0.239

Data/Gas_Networks/Belgium/Belgium_T_env.csv

@@ -0,0 +1 @@
+283

Data/Gas_Networks/Belgium/Belgium_bus.csv

@@ -0,0 +1,23 @@
+bus_ID;name;area_ID;p_i__barg;slack_bus;P_th_i;T_i_source;p_i_min;p_i_max;x_coord;y_coord
+1;"Zeebrugge";1;NaN;NaN;-4961352517.6848;283;1;78;3.1833;51.3328
+2;"Dubzele";1;NaN;NaN;-3594562803.9117;283;1;78;3.2853;51.2509
+3;"Brugge";1;NaN;NaN;1676606793.53881;283;31;81;3.2492;51.1196
+4;"Zomergem";1;NaN;NaN;0;283;1;78;3.5173;51.1101
+5;"Loenhout";1;NaN;NaN;-2054035887.94955;283;1;81;4.8338;51.3944
+6;"Antwerpen";1;NaN;NaN;1726245994.16426;283;31;81;4.4476;51.1448
+7;"Gent";1;NaN;NaN;2249169297.30475;283;31;67.2;3.8546;51.0278
+8;"Voeren";2;55;1;-8277764628.43667;283;51;67.2;5.6821;50.7575
+9;"Berneau ein";2;NaN;NaN;0;283;1;67.2;5.6097;50.7291
+10;"Berneau aus";1;NaN;NaN;0;283;31;67.2;5.6097;50.7291
+11;"Li�ge";1;NaN;NaN;2723737172.24976;283;1;67.2;5.5535;50.5522
+12;"Warnand";1;NaN;NaN;0;283;1;67.2;5.238;50.61
+13;"Namur";1;NaN;NaN;907627107.987705;283;1;67.2;4.7864;50.3825
+14;"Anderlues";1;NaN;NaN;-513508971.987387;283;1;67.2;4.1626;50.5925
+15;"P�ronnes";1;NaN;NaN;-410807177.589908;283;1;67.2;4.0098;50.537
+16;"Mons";1;NaN;NaN;2930424533.47468;283;1;67.2;3.7717;50.5311
+17;"Blaregnies";1;NaN;NaN;6682463422.12919;283;51;67.2;3.7951;50.321
+18;"Wanze";1;NaN;NaN;0;283;1;67.2;5.2081;50.4229
+19;"Sinsin ein";1;NaN;NaN;0;283;1;67.2;5.2392;50.2439
+20;"Sinsin aus";3;NaN;NaN;0;283;1;64;5.2392;50.2439
+21;"Arlon";3;NaN;NaN;94999159.8176663;283;1;67.2;5.7132;49.6947
+22;"P�tange";3;NaN;NaN;821184650.872059;283;26;67.2;5.7881;49.5572

Data/Gas_Networks/Belgium/Belgium_comp.csv

@@ -0,0 +1,3 @@
+comp_ID;comp_name;from_bus_ID;to_bus_ID;in_service;p_out__barg;gas_powered;eta_s;eta_drive;P_max;T_controlled;T_to_bus
+1;"Berneau";9;10;1;66.2;1;0.6538;0.34;20888000;1;300
+2;"Sinsin";19;20;1;63;0;0.6856;0.34;3356000;1;300

Data/Gas_Networks/Belgium/Belgium_gasMix.csv

@@ -0,0 +1 @@
+"H_Gas_Mix"

Data/Gas_Networks/Belgium/Belgium_name.csv

@@ -0,0 +1 @@
+"Belgium"

Data/Gas_Networks/Belgium/Belgium_pipe.csv

@@ -0,0 +1,25 @@
+pipe_ID;from_bus_ID;to_bus_ID;in_service;area_ID;L_ij;D_ij;k_ij;T_env_ij
+1;1;2;1;1;4000;0.89;5e-05;283
+2;1;2;1;1;4000;0.89;5e-05;283
+3;2;3;1;1;6000;0.89;5e-05;283
+4;2;3;1;1;6000;0.89;5e-05;283
+5;3;4;1;1;26000;0.89;5e-05;283
+6;5;6;1;1;43000;0.5901;5e-05;283
+7;6;7;1;1;29000;0.5901;5e-05;283
+8;7;4;1;1;19000;0.5901;5e-05;283
+9;4;15;1;1;55000;0.89;5e-05;283
+10;8;9;1;2;5000;0.89;5e-05;283
+11;8;9;1;2;5000;0.3955;5e-05;283
+12;10;11;1;1;20000;0.89;5e-05;283
+13;10;11;1;1;20000;0.3955;5e-05;283
+14;11;12;1;1;25000;0.89;5e-05;283
+15;11;12;1;1;25000;0.3955;5e-05;283
+16;12;13;1;1;42000;0.89;5e-05;283
+17;13;14;1;1;40000;0.89;5e-05;283
+18;14;15;1;1;5000;0.89;5e-05;283
+19;15;16;1;1;10000;0.89;5e-05;283
+20;16;17;1;1;25000;0.89;5e-05;283
+21;12;18;1;1;10500;0.3955;5e-05;283
+22;18;19;1;1;26000;0.3155;5e-05;283
+23;20;21;1;3;98000;0.3155;5e-05;283
+24;21;22;1;3;6000;0.3155;5e-05;283

Data/Gas_Networks/Belgium_Wolf/Belgium_Wolf_T_env.csv

@@ -0,0 +1 @@
+281.15

Data/Gas_Networks/Belgium_Wolf/Belgium_Wolf_bus.csv

@@ -0,0 +1,22 @@
+bus_ID;name;area_ID;p_i__barg;V_dot_n_i__m3_per_day;T_i_source;p_i_WOLF;p_i_min;p_i_max;T_i_min;T_i_max;x_coord;y_coord
+1;"Zeebrugge";1;NaN;-10911288;283;56.822887;30;80;273;353;3.1833;51.3328
+2;"Dubzele";1;NaN;-8400000;283;56.793487;30;80;273;353;3.2853;51.2509
+3;"Brugge";1;NaN;3918000;283;56.655143;30;80;273;353;3.2492;51.1196
+4;"Zomergem";1;NaN;0;283;55.108114;30;80;273;353;3.5173;51.1101
+5;"Loenhout";1;NaN;-2814712;283;54.02749;30;80;273;353;4.8338;51.3944
+6;"Antwerpen";1;NaN;4034000;283;53.277058;30;80;273;353;4.4476;51.1448
+7;"Gent";1;NaN;5256000;283;53.372622;30;80;273;353;3.8546;51.0278
+8;"Voeren";1;NaN;-22012000;283;60.851968;30;80;273;353;5.6821;50.7575
+9;"Berneau";1;NaN;0;283;60.407217;30;80;273;353;5.6097;50.7291
+10;"Li�ge";1;NaN;6365000;283;58.593877;30;80;273;353;5.5535;50.5522
+11;"Warnand";1;NaN;0;283;57.41852;30;80;273;353;5.238;50.61
+12;"Namur";1;NaN;2120000;283;55.51499;30;80;273;353;4.7864;50.3825
+13;"Anderlues";1;NaN;-1200000;283;54.187918;30;80;273;353;4.1626;50.5925
+14;"P�ronnes";1;NaN;-960000;283;53.9823;30;80;273;353;4.0098;50.537
+15;"Mons";1;NaN;6848000;283;52.653023;30;80;273;353;3.7717;50.5311
+16;"Blaregnies";1;50;15616000;283;51;30;80;273;353;3.7951;50.321
+17;"Wanze";1;NaN;0;283;56.62325;30;80;273;353;5.2081;50.4229
+18;"Sinsin in";1;NaN;0;283;NaN;30;80;273;353;5.2392;50.2439
+19;"Sinsin out";2;NaN;0;283;64;30;80;273;353;5.2392;50.2439
+20;"Arlon";2;NaN;222000;283;36.744537;30;80;273;353;5.7132;49.6947
+21;"P�tange";2;NaN;1919000;283;34.842225;25;80;273;353;5.7881;49.5572

Data/Gas_Networks/Belgium_Wolf/Belgium_Wolf_comp.csv

@@ -0,0 +1,2 @@
+comp_ID;comp_name;from_bus_ID;to_bus_ID;in_service;p_out__barg;gas_powered;eta_s;eta_drive;P_max;V_dot_n_i_comp;P_el_comp;T_controlled;Q_dot_cooler;T_to_bus;V_dot_n_i_cooler
+2;"Sinsin";18;19;1;63;0;0.6856;0.34;3356000;NaN;NaN;1;NaN;350;NaN

Data/Gas_Networks/Belgium_Wolf/Belgium_Wolf_gasMix.csv

@@ -0,0 +1 @@
+"H_Gas_Mix"

Data/Gas_Networks/Belgium_Wolf/Belgium_Wolf_name.csv

@@ -0,0 +1 @@
+"Belgium_Wolf"

Data/Gas_Networks/Belgium_Wolf/Belgium_Wolf_pipe.csv

@@ -0,0 +1,25 @@
+pipe_ID;from_bus_ID;to_bus_ID;in_service;L_ij;D_ij;k_ij;T_env_ij;V_dot_n_ij__m3_per_day_WOLF
+1;1;2;1;4000;0.89;5e-05;283;5455644
+2;1;2;1;4000;0.89;5e-05;283;5455644
+3;2;3;1;6000;0.89;5e-05;283;9655644
+4;2;3;1;6000;0.89;5e-05;283;9655644
+5;3;4;1;26000;0.89;5e-05;283;15393288
+6;5;6;1;43000;0.5901;5e-05;283;2814712
+7;6;7;1;29000;0.5901;5e-05;283;-1219288
+8;7;4;1;19000;0.5901;5e-05;283;-6475288
+9;4;14;1;55000;0.89;5e-05;283;8918000
+10;8;9;1;5000;0.89;5e-05;283;19618224
+11;8;9;1;5000;0.3955;5e-05;283;2393776
+12;9;10;1;20000;0.89;5e-05;283;19618224
+13;9;10;1;20000;0.3955;5e-05;283;2393776
+14;10;11;1;25000;0.89;5e-05;283;13945409
+15;10;11;1;25000;0.3955;5e-05;283;1701591
+16;11;12;1;42000;0.89;5e-05;283;13506000
+17;12;13;1;40000;0.89;5e-05;283;11386000
+18;13;14;1;5000;0.89;5e-05;283;12586000
+19;14;15;1;10000;0.89;5e-05;283;22464000
+20;15;16;1;25000;0.89;5e-05;283;15616000
+21;11;17;1;10500;0.3955;5e-05;283;2141000
+22;17;18;1;26000;0.3155;1e-05;283;2141000
+23;19;20;1;98000;0.3155;1e-05;283;2141000
+24;20;21;1;6000;0.3155;1e-05;283;1919000

Data/Gas_Networks/Cerbe/Cerbe_T_env.csv

@@ -0,0 +1 @@
+283

Data/Gas_Networks/Cerbe/Cerbe_bus.csv

@@ -0,0 +1,15 @@
+bus_ID;p_i__barg;slack_bus;V_dot_n_i;T_i_source;x_coord;y_coord
+1;0.03;1;-0.612800000001995;293.15;0;0
+2;NaN;NaN;0.0239000000000768;NaN;1;0
+3;NaN;NaN;0.0511000000010796;NaN;2;0
+4;NaN;NaN;0.0325000000010547;NaN;3;0
+5;NaN;NaN;0.0200000000000479;NaN;4;0
+6;NaN;NaN;0.0567000000001944;NaN;5;0
+7;NaN;NaN;0.0600000000006321;NaN;4;1
+8;NaN;NaN;0.0561000000001148;NaN;3;1
+9;NaN;NaN;0.0649999999996672;NaN;2;1
+10;NaN;NaN;0.00280000000004578;NaN;1;1
+11;NaN;NaN;0.0546999999991151;NaN;1;2
+12;NaN;NaN;0.0338999999996123;NaN;2;2
+13;NaN;NaN;0.0728000000007018;NaN;4;2
+14;NaN;NaN;0.0832999999996524;NaN;2;3

Data/Gas_Networks/Cerbe/Cerbe_gasMix.csv

@@ -0,0 +1 @@
+"H_Gas_Mix"

Data/Gas_Networks/Cerbe/Cerbe_name.csv

@@ -0,0 +1 @@
+"Cerbe"

Data/Gas_Networks/Cerbe/Cerbe_pipe.csv

@@ -0,0 +1,16 @@
+pipe_ID;from_bus_ID;to_bus_ID;in_service;L_ij;D_ij;k_ij;T_env_ij
+1;1;2;1;26;0.3;0.0005;283
+2;2;3;1;80;0.25;0.0005;283
+3;3;4;1;144;0.25;0.0005;283
+4;4;5;1;192;0.25;0.0005;283
+5;5;6;1;106;0.15;0.0005;283
+6;2;10;1;96;0.3;0.0005;283
+7;10;9;1;148;0.25;0.0005;283
+8;9;8;1;80;0.2;0.0005;283
+9;8;7;1;76;0.15;0.0005;283
+10;5;7;1;68;0.15;0.0005;283
+11;7;13;1;240;0.15;0.0005;283
+12;12;13;1;106;0.15;0.0005;283
+13;11;12;1;108;0.25;0.0005;283
+14;12;14;1;172;0.2;0.0005;283
+15;10;11;1;170;0.25;0.0005;283

LICENSE

@@ -1,13 +1,24 @@
+The code in matGasFlow is distributed under the BSD 3-Clause License
+below. The CSV files of matGasFlow gas network models distributed with
+matGasFlow are not covered by the BSD license. The data has been converted
+from data available from public sources.
+
+The following is the official license notice:
+
+--------------------------------------------------------------------------
+
 BSD 3-Clause License
 
-Copyright (c) 2021, IAEW at RWTH Aachen University
+Copyright (c) 2020-2021, Institute for High Voltage Equipment and Grids,
+Digitalization and Energy Economics (IAEW), RWTH Aachen University,
+Marcel Kurth and other contributors (see AUTHORS for details)
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:
 
-1. Redistributions of source code must retain the above copyright notice, this
-   list of conditions and the following disclaimer.
+1. Redistributions of source code must retain the above copyright notice,
+   this list of conditions and the following disclaimer.
 
 2. Redistributions in binary form must reproduce the above copyright notice,
    this list of conditions and the following disclaimer in the documentation

Modules/check_and_init_GN/check_GN_T_env.m

@@ -0,0 +1,28 @@
+function GN = check_GN_T_env(GN)
+%CHECK_GN_T_ENV Check environmental Temperature
+%   GN = check_GN_T_env(GN)
+%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%   Copyright (c) 2020-2021, High Voltage Equipment and Grids,
+%       Digitalization and Energy Economics (IAEW),
+%       RWTH Aachen University, Marcel Kurth
+%   All rights reserved.
+%   Contact: Marcel Kurth (m.kurth@iaew.rwth-aachen.de)
+%   This script is part of matGasFlow.
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+if isfield(GN,'T_env')
+    if ~all(size(GN.T_env) == [1,1]) || ~isa(GN.T_env,'double')
+        error('GN.T_env must be one double value')
+    elseif GN.T_env < 0
+        error(['GN.T_env must be one double value greater than 0 Kelvin. GN.T_env = ', num2str(GN.T_env)])
+    elseif GN.T_env > 373
+        warning(['GN.T_env is very large: GN.T_env = ',num2str(GN.T_env)])
+    end
+else
+    GN.T_env = 283.15;
+    warning('T_env is missing. The environmental temperature is set to the default value 283.15 K.')
+end
+
+end
+