From a2b9fa0e97f55863d701acfde468177b307e07d5 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Tue, 12 Nov 2024 09:08:44 +0000 Subject: [PATCH] GitHub Actions build openturns/otfmi 11793952139 --- .../dynamic_python.zip | Bin 8100 -> 8100 bytes .../plot_set.zip | Bin 6198 -> 6198 bytes .../plot_load_fmu.zip | Bin 4592 -> 4592 bytes .../plot_dyn_set.zip | Bin 6447 -> 6447 bytes .../static_python.zip | Bin 6440 -> 6440 bytes .../plot_fmu_exporter.zip | Bin 8278 -> 8278 bytes .../plot_init.zip | Bin 9133 -> 9133 bytes .../dynamic_jupyter.zip | Bin 15785 -> 15785 bytes .../plot_basics.zip | Bin 4275 -> 4275 bytes .../plot_dyn_basics.zip | Bin 8227 -> 8227 bytes .../plot_metamodel.py | 7 +- .../static_jupyter.zip | Bin 13144 -> 13144 bytes .../ot_to_fmu_jupyter.zip | Bin 9987 -> 9987 bytes .../plot_initialize.zip | Bin 8161 -> 8161 bytes .../plot_model_exporter.zip | Bin 8295 -> 8295 bytes .../plot_explore.zip | Bin 5722 -> 5722 bytes .../low_level_python.zip | Bin 7433 -> 7433 bytes .../auto_application_jupyter.zip | Bin 19656 -> 19650 bytes .../plot_simulate.zip | Bin 5424 -> 5424 bytes .../ot_to_fmu_python.zip | Bin 6586 -> 6586 bytes .../plot_cantilever_beam.zip | Bin 11113 -> 11113 bytes .../low_level_jupyter.zip | Bin 16422 -> 16422 bytes .../plot_dyn_init.zip | Bin 9233 -> 9233 bytes .../plot_metamodel.zip | Bin 20275 -> 20264 bytes .../plot_metamodel.ipynb | 2 +- .../auto_application_python.zip | Bin 11732 -> 11727 bytes ...otfmi.fmi.apply_initialization_script.html | 41 +-- .../fmi/otfmi.fmi.get_causality_str.html | 43 +-- .../fmi/otfmi.fmi.get_fixed_value.html | 41 +-- .../fmi/otfmi.fmi.get_name_variable.html | 43 +-- .../fmi/otfmi.fmi.get_start_value.html | 43 +-- .../fmi/otfmi.fmi.get_variability.html | 43 +-- .../_generated/fmi/otfmi.fmi.load_fmu.html | 41 +-- .../fmi/otfmi.fmi.parse_kwargs_simulate.html | 41 +-- .../fmi/otfmi.fmi.set_dict_value.html | 41 +-- .../_generated/fmi/otfmi.fmi.simulate.html | 41 +-- .../master/_generated/otfmi.FMUFunction.html | 261 +++++++++--------- .../otfmi.FMUPointToFieldFunction.html | 117 ++++---- .../_generated/otfmi.FunctionExporter.html | 53 ++-- .../otfmi.OpenTURNSFMUFunction.html | 77 +++--- ...tfmi.OpenTURNSFMUPointToFieldFunction.html | 63 ++--- ...a8abc0e88f57a224566d80ecebe3964367101a.svg | 2 +- ...496c4fdbeb2f04ddd496b3446f821b6e7b3e97.svg | 2 +- ...9af0b21e89cf6fb63a835b9c04cb0a3c39c31c.svg | 2 +- ...15162e8135a5b381cd18b1ba301471199dfed7.svg | 36 +++ ...43f099f5cce034a8ea7fe9398f7985fb0c80af.svg | 2 +- ...b909dea1ead80dd02c94ae1aab33603e9f41f5.svg | 2 +- ...2ace2160cc527f629b5b2926255445bbb6553b.svg | 2 +- ...68d36ff9b5215f90c1fca15e731aa7f194065a.svg | 2 +- ...ed575cfd930c8b22a79be9efd5346371741a29.svg | 2 +- ...ca5c0adb14329feaafb2e991ee778f7ee1b2bc.svg | 2 +- ...0a53c50e45b2b878a053c604ca9f3091998087.svg | 2 +- ...df892ffd2c37c34e251eb5d41cc28f30c2840d.svg | 14 +- ...a53be822771f7a0996f7227d659b983bb17e6f.svg | 2 +- ...0eb9535619eb9a76d4501fc9a5052479d3ad80.svg | 6 +- ...d14a9ff4ef076772e0c627a35fc77db98a40aa.svg | 2 +- ...1d52ff03cd30e7799e3af8441ea16792d993cf.svg | 2 +- ...6a1438e344753945996b5a8e6a964de12d448a.svg | 2 +- ...3ff319315666e00042a88b19362e98cea7d023.svg | 2 +- ...c640a4dc5381a4efe0671f66107d51c7563644.svg | 2 +- ...7f9a82d085c4eb7a0f69a85d4417f2e1d6d54f.svg | 2 +- ...4a2375b0d249062c025a443879120df3b3f9a0.svg | 2 +- ...68abfe0dfe4c76eaace9a2136c7b41aec75457.svg | 2 +- ...bfc66745a81cd4a5d7504f825ff35bac9c8508.svg | 2 +- ...1437cc1369fa698a934a87d4a6291e33b74db8.svg | 2 +- ...efba6c90a6a30fe67074897f85b9a7941cf535.svg | 6 +- ...39dd0b6d6922e26ee37784779cc509cc7d707d.svg | 2 +- ...5c646df505177ac04d3f64bccfc0744fcefeeb.svg | 4 +- ...f497de29e856a2bd1eb17141b8c920a7d096e3.svg | 2 +- ...ed5fa6e3f785771353d25f84ef62de96e3ac12.svg | 2 +- ...3d2521b2bf136e2b40dd418e46c1f7ec38ea38.svg | 2 +- ...b5dd69676cd04c2f1a71b37c379630f824426e.svg | 2 +- ...e9f34ac46df7e63f7c445b65adf5e3b35f46f8.svg | 2 +- ...912bc327cb163bed441bb541b5ce75902dee7f.svg | 2 +- ...683913f301d5b1778450f5fac31c0533df6489.svg | 2 +- ...a0c59f093a38248f9a9564b307b981fbeab356.svg | 4 +- ...72f2d7146c7929a2ac7b7edf97e6ce664abc5b.svg | 6 +- ...9702935d87e3486c3a496692ebf60713d5b548.svg | 2 +- ...269abbb4edf3f204abc71d79023d875f05e256.svg | 2 +- ...250096c0435219b09ec4b0f6d46fb1c18599b0.svg | 2 +- ...20b350dd30fc67780a93729365e7e6e62ddce1.svg | 2 +- ...b7bfe50bd7ae4c180c7f248a2af4c67fec1919.svg | 2 +- ...5a4add8dc940006b0ab443036be45ba1028d75.svg | 2 +- ...3cc7728de18d3907b9dcae1bcf7ada86b8d148.svg | 2 +- ...2f41c3ecb8198c9c09bd2a891e1b4e9fffcd02.svg | 2 +- .../plot_cantilever_beam.rst.txt | 2 +- .../auto_application/plot_metamodel.rst.txt | 15 +- .../dynamic/plot_dyn_basics.rst.txt | 2 +- .../dynamic/plot_dyn_init.rst.txt | 2 +- .../auto_example/dynamic/plot_dyn_set.rst.txt | 2 +- .../low_level/plot_initialize.rst.txt | 6 +- .../low_level/plot_simulate.rst.txt | 24 +- .../ot_to_fmu/plot_fmu_exporter.rst.txt | 4 +- .../ot_to_fmu/plot_model_exporter.rst.txt | 4 +- .../auto_example/static/plot_init.rst.txt | 2 +- .../auto_example/static/plot_set.rst.txt | 2 +- .../_sphinx_javascript_frameworks_compat.js | 17 +- otfmi/master/_static/basic.css | 83 +++--- otfmi/master/_static/doctools.js | 7 - otfmi/master/_static/documentation_options.js | 3 +- otfmi/master/_static/language_data.js | 9 +- otfmi/master/_static/searchtools.js | 226 +++++++++------ otfmi/master/_static/sphinx_highlight.js | 16 +- otfmi/master/api.html | 69 ++--- otfmi/master/application/application.html | 37 +-- otfmi/master/auto_application/index.html | 35 +-- .../plot_cantilever_beam.html | 44 +-- .../auto_application/plot_metamodel.html | 53 ++-- otfmi/master/auto_example/dynamic/index.html | 35 +-- .../auto_example/dynamic/plot_dyn_basics.html | 39 +-- .../auto_example/dynamic/plot_dyn_init.html | 39 +-- .../auto_example/dynamic/plot_dyn_set.html | 39 +-- .../master/auto_example/low_level/index.html | 35 +-- .../auto_example/low_level/plot_explore.html | 37 +-- .../low_level/plot_initialize.html | 47 ++-- .../auto_example/low_level/plot_load_fmu.html | 37 +-- .../auto_example/low_level/plot_simulate.html | 61 ++-- .../master/auto_example/ot_to_fmu/index.html | 35 +-- .../ot_to_fmu/plot_fmu_exporter.html | 51 ++-- .../ot_to_fmu/plot_model_exporter.html | 57 ++-- otfmi/master/auto_example/static/index.html | 35 +-- .../auto_example/static/plot_basics.html | 37 +-- .../master/auto_example/static/plot_init.html | 39 +-- .../master/auto_example/static/plot_set.html | 39 +-- otfmi/master/demo_persalys/use_persalys.html | 70 +++-- otfmi/master/example/index.html | 51 ++-- otfmi/master/fmus/deviation.html | 42 +-- otfmi/master/fmus/epid.html | 46 +-- otfmi/master/fmus/index.html | 37 +-- otfmi/master/genindex.html | 33 +-- otfmi/master/index.html | 48 ++-- otfmi/master/install.html | 37 +-- otfmi/master/search.html | 33 +-- otfmi/master/searchindex.js | 2 +- 134 files changed, 1495 insertions(+), 1378 deletions(-) create mode 100644 otfmi/master/_images/math/1715162e8135a5b381cd18b1ba301471199dfed7.svg diff --git a/otfmi/master/_downloads/08e3d5b9884283558aea733b3b4b72a3/dynamic_python.zip b/otfmi/master/_downloads/08e3d5b9884283558aea733b3b4b72a3/dynamic_python.zip index d32885238f9c04d1e0ef4430c5c3a858039bfcdc..83a92b97d75bfb83fcb578deea22238637716ee4 100644 GIT binary patch delta 64 zcmZ2tzr>z5z?+#xgaHIrc;sy4b>v_M(whT0!nnYURYImbAjafJa#mnkUfvc=$IH6{ E06oJK6#xJL delta 64 zcmZ2tzr>z5z?+#xgaHI}?9w;#I&v@r>CJ&0VO(IwDj`!I5M%NqIV&(NFK-K`CMqBJiH*rv_M(whT0!UaH#$*U!-!1N0VcK{~N4dVa+ delta 47 tcmZ2)wBCp}z?+#xgaHI}?9w;#I&v@r>CJ&0;Q}DWZVEToGI{^H(3%39O diff --git a/otfmi/master/_downloads/193bd6e1daa7cba3f562881aa290c635/static_python.zip b/otfmi/master/_downloads/193bd6e1daa7cba3f562881aa290c635/static_python.zip index 37d0c7a0ebe42db5c9f432a2a3b400161da0ec59..fd3a25fa7b76529c492c8238ee72a5cc0608cbe9 100644 GIT binary patch delta 64 zcmZ2sw8Drtz?+#xgaHIrc;sy4bz@-$(woCrTzSBZc>)*NL5#^o5|&_korF1CIs*t~_AIJb{bsAjae(2}>}&PQn~azmRYM E0O_s}#Q*>R diff --git a/otfmi/master/_downloads/2a9000e3e93f11242bf6dd1f40e3019b/plot_fmu_exporter.zip b/otfmi/master/_downloads/2a9000e3e93f11242bf6dd1f40e3019b/plot_fmu_exporter.zip index 1734f8f75e14b8f50e8b7a6198a9fef7eac117f0..8801830c370ba84336bef8f94486b3551bb75024 100644 GIT binary patch delta 47 xcmccSaLs`?z?+#xgaHIrdgN^6b?0GT?UA!NoF`A187MIMguFdSU^1724*)$D4ch7n9QZ%0{{~%3$XwI diff --git a/otfmi/master/_downloads/3bdd08436edb36ae32b494c73d067576/plot_init.zip b/otfmi/master/_downloads/3bdd08436edb36ae32b494c73d067576/plot_init.zip index a6f67ccc3a6cdaccc76cfec244df80d5aea47f37..268045cb6484f8da1bb99e8edda60583d3e48239 100644 GIT binary patch delta 47 tcmZ4MzSf;Lz?+#xgaHIrc;sy4b>(3O(wjqhu8V;fll7I&!E~mw3ji_W4YU9N delta 47 tcmZ4MzSf;Lz?+#xgaHI}?9w;#y7Djs>CK@$*Tq1L$@CLGEdZNs_K*lsxS8CIs*H@HEJ$%X=!U^-X84FLKE3lsnV diff --git a/otfmi/master/_downloads/51a9ad74d31db70485fc58f9917c37af/plot_dyn_basics.zip b/otfmi/master/_downloads/51a9ad74d31db70485fc58f9917c37af/plot_dyn_basics.zip index f5e10608e93ff624aac7b627c1220331b851acb4..c54e45ab878c1d91874cbd05ed5599036f0a0c41 100644 GIT binary patch delta 47 tcmZ4Nu-Jh&z?+#xgaHIrc;sy44dY@4(woz`3`9YU$us3`!SqdeF90aD4dws< delta 47 tcmZ4Nu-Jh&z?+#xgaHI}?9w;#hH)_i>CI_e2BILw{GhI4`NK7X=DSYZx~sDX;EWm E0LAE9yuF%bA*|J^yV7jk3t~EJtGmCWp)0g6Zk5;QJnXQ1I87MIMny3{>V6w27I{-K$4Y&XR delta 47 tcmcbmb4!Oez?+#xgaHI}?b0{$2D32(>CMS(1^gh!a^kw@MdNaVE};@9yuF%gV~r@dgN?QX4}REX2=N6Vq*r%Y~CsE%K~Cd=9IAl T$xL>Wu?5p@GS*=6BQmZ4r+^sN delta 81 zcmeCQ>a^kw@MdNaVE_SLyY!8`!EDSxdUG<{HZCwjMsOBHWT&_<3rJ)#r;HVtc9XFM N(`_==VETxRD*y|{6oLQ% diff --git a/otfmi/master/_downloads/ae411f350a3af31b84d54bc57bdac223/auto_application_jupyter.zip b/otfmi/master/_downloads/ae411f350a3af31b84d54bc57bdac223/auto_application_jupyter.zip index c19255e24f64a6c5e64e53d1f302fc41ac979e24..5bfc302b32c881f0b5ec7194dea627eab7c8d635 100644 GIT binary patch delta 204 zcmX>xlkw0@M)3e|W)=|!5Ln@n6S;@gG@Q$Tfq`qI_+m}*f}+%v%;b{H{JdfXTZP=z zlEmEnl+>Kbii*OMcWLrWKC3BZpPZkXmX?{EnVMG;oS0jXld7YDq)js>FVG06w=6Ly zGbIsZl3sFtZb4~DYLHQIa(+?jW`C`}tjxRsA5)OjcnN delta 273 zcmX>!lkvn%M(F@=W)=|!5YVwpk7S>)!BN0~fdPa?Cj0t`PcAXY+&EiaQ#dBCEHNiD zC9xzkKhL`;Gd(jeeewrQsrr~a1t7@GD<~}qNi8l3PRuRHN!3wE&QDEC%S_Hp&4UZ& zrj{h;=BK3Q#N=tlJ1g&SR%-VM8n>`JlO7o)lVY0Q4sXS0B@_?-Q#C6gP3?M88 U_A7)~(&#j~-$$2C!w19%05cm?xc~qF diff --git a/otfmi/master/_downloads/ae917bde98b8c6021e168382dbe0142f/plot_simulate.zip b/otfmi/master/_downloads/ae917bde98b8c6021e168382dbe0142f/plot_simulate.zip index c6ce9e1de1b57f9b2f206870c50d81d728fb040e..7c95e6b63af9976d8c071d9b8a2885f5a941cfb8 100644 GIT binary patch delta 47 ucmdm>wLyzFz?+#xgaHIrdgN^6oyEosq&Kf(`^yVrOkO2o4W?g+cmM!D?GGaW delta 47 tcmdm>wLyzFz?+#xgaHI}?b0{$&SGN*(wkSY{pAHQCa)5)2GcJ@JOCBr4EF#4 diff --git a/otfmi/master/_downloads/bd9b6f19fa0ecbd31f53bf012679bec4/ot_to_fmu_python.zip b/otfmi/master/_downloads/bd9b6f19fa0ecbd31f53bf012679bec4/ot_to_fmu_python.zip index 91c5df87565fb840a82ada71c055ee37bd6c1384..f24c6bf02feafd8c35c60a292a364e2c16414bdf 100644 GIT binary patch delta 47 xcmdmGyvvw3z?+#xgaHIrdgN^6b?0GT?UA!NoaZtRGf-f%uB1IkU~;~sHvlhE4Wj@6 delta 47 xcmdmGyvvw3z?+#xgaHI}?b0{$y7Mp_*rjg{=ef+o3>28GD`^iBn4B-^4FCma3wZzl diff --git a/otfmi/master/_downloads/c970258ba2affdcf61679aa303a851e7/plot_cantilever_beam.zip b/otfmi/master/_downloads/c970258ba2affdcf61679aa303a851e7/plot_cantilever_beam.zip index 998338b83c61bc3a3e3bc28408d8b2581d9ecfd4..db17e93dee27420149fc1e4b5a4552c2a9a2ceb0 100644 GIT binary patch delta 47 xcmaDE_A-n&z?+#xgaHJWdgN^6z01eE+#_f6TfV2#%s_$3SGAl#0+Xe*{Q+>95Cs4L delta 47 xcmaDE_A-n&z?+#xgaHJ!?9w;#-sNM~woBjqmhY)FGf-giRV^owz+@?He*i|l4ch-c*_zzklM-@ME#fFj&RJiH*0$x`;V UU^>d)0Zh-ew*x7de9ztk0QG3jAb09j-f0RR91 diff --git a/otfmi/master/_downloads/dbb0f6a42a3a1a8f63ba6212ea3ac005/plot_dyn_init.zip b/otfmi/master/_downloads/dbb0f6a42a3a1a8f63ba6212ea3ac005/plot_dyn_init.zip index 51cc3926aeac621784d15c79b8428aeba3f7605f..589b8fe2ab03d85af2314e71ea182ddc579377dc 100644 GIT binary patch delta 47 tcmbQ}G0}rJz?+#xgaHIrc;sy4HRfRk(wm)mT*X0*$=%AR<;HSOg^dX0RZ*x3u6EP diff --git a/otfmi/master/_downloads/df1e8e1b4e45de4d31f774cf50644962/plot_metamodel.zip b/otfmi/master/_downloads/df1e8e1b4e45de4d31f774cf50644962/plot_metamodel.zip index 61ac8c8eaa9f0b63d1e6c939fa6b141365b21fe6..38e133e91b35281f046ae471a2ffdf09e9462b2d 100644 GIT binary patch delta 327 zcmdlyk8#C3M)3e|W)=|!5LoV!6KS?G^RJp51B2Q|@kA;9f}+%v%;b{H{JdfXTZP=o z8|@`|xVXv^b23vBL86npq@?VU^HbB(GLth?^Gbpfa|?1(brg{FX>tV`0revE=q2ap z7L=Bx1{nn>=NF}J=9G?R=3N1_dJn56!#pjc^`WeZiI0)z{NC<(0iD5}&=wvp3b+(CqAU**5t7*3Y delta 413 zcmZ26k8$%nM)3e|W)=|!5YV7l30?NpXXhanVy-K zK6#ClR6Umh5M<^Rl$L~~7MBDk<`(3n>L?`Vr>3Q4CTFJR!G&^DOA>SQQ&MxdG`Rwe z6l@hR%+pKG&jp&38c>v)l9^nRS(aH+>6VyWl3%2u8Ep{DRZx_fSE3PUq{+plte~n2 zBtkMa%Sk&j^XdRy%RXU)qksVegTUq-xy723Ej@VHk=&UPlSi^cWAZd(@VZhJ;x8k0|1bHfW80# diff --git a/otfmi/master/_downloads/e51d19e05be8deca832f0608d0d761a0/plot_metamodel.ipynb b/otfmi/master/_downloads/e51d19e05be8deca832f0608d0d761a0/plot_metamodel.ipynb index 5978ef66e45..2ae9d9d80ef 100644 --- a/otfmi/master/_downloads/e51d19e05be8deca832f0608d0d761a0/plot_metamodel.ipynb +++ b/otfmi/master/_downloads/e51d19e05be8deca832f0608d0d761a0/plot_metamodel.ipynb @@ -248,7 +248,7 @@ }, "outputs": [], "source": [ - "projectFunction = ot.KarhunenLoeveProjection(resultKL)\ncoefficientSample = projectFunction(outputFMUTestSample)\n\nvalidationKriging = ot.MetaModelValidation(\n inputTestSample, coefficientSample, metamodel\n)\nQ2 = validationKriging.computePredictivityFactor()[0]\nprint(Q2)" + "projectFunction = ot.KarhunenLoeveProjection(resultKL)\ncoefficientSample = projectFunction(outputFMUTestSample)\npredictions = metamodel(inputTestSample)\n\nvalidation = ot.MetaModelValidation(coefficientSample, predictions)\nQ2 = validation.computeR2Score()[0]\nprint(Q2)" ] }, { diff --git a/otfmi/master/_downloads/fbf934e2102c03bb04ee24185435c5cd/auto_application_python.zip b/otfmi/master/_downloads/fbf934e2102c03bb04ee24185435c5cd/auto_application_python.zip index c954ce9e77f38626cf198756ae41b67fd24afd99..3cef42c153df9ab7dbe07085802cf0513775b594 100644 GIT binary patch delta 227 zcmcZ-eLh+|z?+#xgaHJWd*no#t<3zZCda^_woyD$%A}wuH6=5-Br`v+Six2yH?<@& zH$NpcMbAcwN1{nn>=NF}J=9G?RW?t%%vpHSvJ|8cNyCw(g8p#8tBB$+s dv1BzL0|N+)gWV4ymNbS=UZShTW~vL~0{}jLNf!VB delta 271 zcmX>feI;5tz?+#xgaHJ!?b0K!o#^Y;mIJbZSa5QJuE<7xPbnd;vc#Osl*E$E{5^vP?ar0Tg8fFLukptK|;wYVfWF}ENmRYxH?KQ%2aGdVLg4=$9OT9TNXpOTux zrO6d&q+qLnVV+)celF0Q)PSPYl+5Ik%(BdqO1H%1lKdhK&1i#Iu7aY>yb_H-BTX(Y zWd&7LAQ6(WSx(xKnOVy&eRGoBeLh|k=TG+2HBtadMNZrOV##Vg1_lro2YVAjENP6A Sn_MU-IeDk90GpLANDu(E@lpf; diff --git a/otfmi/master/_generated/fmi/otfmi.fmi.apply_initialization_script.html b/otfmi/master/_generated/fmi/otfmi.fmi.apply_initialization_script.html index aecd0c9a671..994f1bb50ec 100644 --- a/otfmi/master/_generated/fmi/otfmi.fmi.apply_initialization_script.html +++ b/otfmi/master/_generated/fmi/otfmi.fmi.apply_initialization_script.html @@ -1,29 +1,30 @@ - + - + otfmi.fmi.apply_initialization_script — otfmi documentation - - - - - - - - + + + + + + + + + + - - - - - - + + + + + @@ -115,13 +116,13 @@
-

otfmi.fmi.apply_initialization_script

+

otfmi.fmi.apply_initialization_script

-apply_initialization_script(model, path_script)
+apply_initialization_script(model, path_script)

Apply an initialization script to a model.

-
Parameters
+
Parameters:
modelPyfmi model object (pyfmi.fmi.FMUModelXXX).
path_scriptString, path to the script file.
@@ -140,7 +141,7 @@

otfmi.fmi.apply_initialization_script -

© Copyright 2017-2020 EDF-Phimeca. +

© Copyright 2017-2023 EDF-Phimeca. Last updated on Dec 31, 2020.

diff --git a/otfmi/master/_generated/fmi/otfmi.fmi.get_causality_str.html b/otfmi/master/_generated/fmi/otfmi.fmi.get_causality_str.html index 8a477b680de..b0869a0aa22 100644 --- a/otfmi/master/_generated/fmi/otfmi.fmi.get_causality_str.html +++ b/otfmi/master/_generated/fmi/otfmi.fmi.get_causality_str.html @@ -1,29 +1,30 @@ - + - + otfmi.fmi.get_causality_str — otfmi documentation - - - - - - - - + + + + + + + + + + - - - - - - + + + + + @@ -115,16 +116,16 @@
-

otfmi.fmi.get_causality_str

+

otfmi.fmi.get_causality_str

-get_causality_str(model, name)
+get_causality_str(model, name)

Get the causality of a variable (input, output, or other).

If the variable causality is “input” or “parameter”, its value can be modified using otfmi.fmi.set_dict_value. Setting the value of a variable with other causality is not possible (nonphysical).

-
Parameters
+
Parameters:
modelpyfmi.fmi.FMUModelXXX or str

Pyfmi model object or path to an FMU.

@@ -132,7 +133,7 @@

otfmi.fmi.get_causality_strReturns +
Returns:
causalitystr

Causality identifier

@@ -151,7 +152,7 @@

otfmi.fmi.get_causality_str -

© Copyright 2017-2020 EDF-Phimeca. +

© Copyright 2017-2023 EDF-Phimeca. Last updated on Dec 31, 2020.

diff --git a/otfmi/master/_generated/fmi/otfmi.fmi.get_fixed_value.html b/otfmi/master/_generated/fmi/otfmi.fmi.get_fixed_value.html index 9fdca9c1506..3e83e590c57 100644 --- a/otfmi/master/_generated/fmi/otfmi.fmi.get_fixed_value.html +++ b/otfmi/master/_generated/fmi/otfmi.fmi.get_fixed_value.html @@ -1,29 +1,30 @@ - + - + otfmi.fmi.get_fixed_value — otfmi documentation - - - - - - - - + + + + + + + + + + - - - - - - + + + + + @@ -115,14 +116,14 @@
-

otfmi.fmi.get_fixed_value

+

otfmi.fmi.get_fixed_value

-get_fixed_value(model)
+get_fixed_value(model)

Get the values of the variables with ‘fixed’ variability, ignoring aliases.

-
Parameters
+
Parameters:
modelPyfmi model object (pyfmi.fmi.FMUModelXXX) or path to an FMU.
@@ -140,7 +141,7 @@

otfmi.fmi.get_fixed_value -

© Copyright 2017-2020 EDF-Phimeca. +

© Copyright 2017-2023 EDF-Phimeca. Last updated on Dec 31, 2020.

diff --git a/otfmi/master/_generated/fmi/otfmi.fmi.get_name_variable.html b/otfmi/master/_generated/fmi/otfmi.fmi.get_name_variable.html index 7e7755fd07f..de9c48f4639 100644 --- a/otfmi/master/_generated/fmi/otfmi.fmi.get_name_variable.html +++ b/otfmi/master/_generated/fmi/otfmi.fmi.get_name_variable.html @@ -1,29 +1,30 @@ - + - + otfmi.fmi.get_name_variable — otfmi documentation - - - - - - - - + + + + + + + + + + - - - - - - + + + + + @@ -115,18 +116,18 @@
-

otfmi.fmi.get_name_variable

+

otfmi.fmi.get_name_variable

-get_name_variable(model, **kwargs)
+get_name_variable(model, **kwargs)

Get the list of variable names.

-
Parameters
+
Parameters:
modelPyfmi model object (pyfmi.fmi.FMUModelXXX) or path to an FMU.
-
Returns
+
Returns:
var_nameslist of str

Variable names

@@ -145,7 +146,7 @@

otfmi.fmi.get_name_variable -

© Copyright 2017-2020 EDF-Phimeca. +

© Copyright 2017-2023 EDF-Phimeca. Last updated on Dec 31, 2020.

diff --git a/otfmi/master/_generated/fmi/otfmi.fmi.get_start_value.html b/otfmi/master/_generated/fmi/otfmi.fmi.get_start_value.html index 358c386a6c2..7d9b1571587 100644 --- a/otfmi/master/_generated/fmi/otfmi.fmi.get_start_value.html +++ b/otfmi/master/_generated/fmi/otfmi.fmi.get_start_value.html @@ -1,29 +1,30 @@ - + - + otfmi.fmi.get_start_value — otfmi documentation - - - - - - - - + + + + + + + + + + - - - - - - + + + + + @@ -115,18 +116,18 @@
-

otfmi.fmi.get_start_value

+

otfmi.fmi.get_start_value

-get_start_value(model)
+get_start_value(model)

Get the values of the variables with a start value ignoring aliases.

-
Parameters
+
Parameters:
modelPyfmi model object (pyfmi.fmi.FMUModelXXX) or path to an FMU.
-
Returns
+
Returns:
start_varsdict of int/float

Names and values of start variables

@@ -145,7 +146,7 @@

otfmi.fmi.get_start_value -

© Copyright 2017-2020 EDF-Phimeca. +

© Copyright 2017-2023 EDF-Phimeca. Last updated on Dec 31, 2020.

diff --git a/otfmi/master/_generated/fmi/otfmi.fmi.get_variability.html b/otfmi/master/_generated/fmi/otfmi.fmi.get_variability.html index 4457d0c9277..d68e7fc0f93 100644 --- a/otfmi/master/_generated/fmi/otfmi.fmi.get_variability.html +++ b/otfmi/master/_generated/fmi/otfmi.fmi.get_variability.html @@ -1,29 +1,30 @@ - + - + otfmi.fmi.get_variability — otfmi documentation - - - - - - - - + + + + + + + + + + - - - - - - + + + + + @@ -115,19 +116,19 @@
-

otfmi.fmi.get_variability

+

otfmi.fmi.get_variability

-get_variability(model)
+get_variability(model)

Get the variability of the variables (constant, discrete, continuous, or other).

-
Parameters
+
Parameters:
modelPyfmi model object (pyfmi.fmi.FMUModelXXX) or path to an FMU.
-
Returns
+
Returns:
variabilitylist of int

FMI1: CONSTANT(0), PARAMETER(1), DISCRETE(2), CONTINUOUS(3), UNKNOWN(4)

FMI2: CONSTANT(0), FIXED(1), TUNABLE(2), DISCRETE(3), CONTINUOUS(4), UNKNOWN(5)

@@ -147,7 +148,7 @@

otfmi.fmi.get_variability -

© Copyright 2017-2020 EDF-Phimeca. +

© Copyright 2017-2023 EDF-Phimeca. Last updated on Dec 31, 2020.

diff --git a/otfmi/master/_generated/fmi/otfmi.fmi.load_fmu.html b/otfmi/master/_generated/fmi/otfmi.fmi.load_fmu.html index 01c12ea3cac..8869c033f3e 100644 --- a/otfmi/master/_generated/fmi/otfmi.fmi.load_fmu.html +++ b/otfmi/master/_generated/fmi/otfmi.fmi.load_fmu.html @@ -1,29 +1,30 @@ - + - + otfmi.fmi.load_fmu — otfmi documentation - - - - - - - - + + + + + + + + + + - - - - - - + + + + + @@ -115,13 +116,13 @@
-

otfmi.fmi.load_fmu

+

otfmi.fmi.load_fmu

-load_fmu(path_fmu, kind=None, **kwargs)
+load_fmu(path_fmu, kind=None, **kwargs)

Load and FMU.

-
Parameters
+
Parameters:
path_fmuString, path to the FMU file.
kindString, one of “ME” (model exchange) or “CS” (co-simulation)

select a kind of FMU if both are available. @@ -146,7 +147,7 @@

otfmi.fmi.load_fmu -

© Copyright 2017-2020 EDF-Phimeca. +

© Copyright 2017-2023 EDF-Phimeca. Last updated on Dec 31, 2020.

diff --git a/otfmi/master/_generated/fmi/otfmi.fmi.parse_kwargs_simulate.html b/otfmi/master/_generated/fmi/otfmi.fmi.parse_kwargs_simulate.html index c1000139919..0e1a1dba453 100644 --- a/otfmi/master/_generated/fmi/otfmi.fmi.parse_kwargs_simulate.html +++ b/otfmi/master/_generated/fmi/otfmi.fmi.parse_kwargs_simulate.html @@ -1,29 +1,30 @@ - + - + otfmi.fmi.parse_kwargs_simulate — otfmi documentation - - - - - - - - + + + + + + + + + + - - - - - - + + + + + @@ -115,14 +116,14 @@
-

otfmi.fmi.parse_kwargs_simulate

+

otfmi.fmi.parse_kwargs_simulate

-parse_kwargs_simulate(value_input=None, name_input=None, name_output=None, model=None, **kwargs)
+parse_kwargs_simulate(value_input=None, name_input=None, name_output=None, model=None, **kwargs)

Parse simulation keyword arguments and feed the simulate method of pyfmi’s object.

-
Parameters
+
Parameters:
value_inputVector or array-like with time steps as rows.
name_inputSequence of string

input names.

@@ -146,7 +147,7 @@

otfmi.fmi.parse_kwargs_simulate -

© Copyright 2017-2020 EDF-Phimeca. +

© Copyright 2017-2023 EDF-Phimeca. Last updated on Dec 31, 2020.

diff --git a/otfmi/master/_generated/fmi/otfmi.fmi.set_dict_value.html b/otfmi/master/_generated/fmi/otfmi.fmi.set_dict_value.html index c12bf0ba7d8..1c74e762cb9 100644 --- a/otfmi/master/_generated/fmi/otfmi.fmi.set_dict_value.html +++ b/otfmi/master/_generated/fmi/otfmi.fmi.set_dict_value.html @@ -1,29 +1,30 @@ - + - + otfmi.fmi.set_dict_value — otfmi documentation - - - - - - - - + + + + + + + + + + - - - - - - + + + + + @@ -115,13 +116,13 @@
-

otfmi.fmi.set_dict_value

+

otfmi.fmi.set_dict_value

-set_dict_value(model, dict_value)
+set_dict_value(model, dict_value)

Set values from a dictionary with variable names as keys.

-
Parameters
+
Parameters:
modelPyfmi model object (pyfmi.fmi.FMUModelXXX) or path to an FMU.
dict_valueDictionary, with variable names as keys.
@@ -140,7 +141,7 @@

otfmi.fmi.set_dict_value -

© Copyright 2017-2020 EDF-Phimeca. +

© Copyright 2017-2023 EDF-Phimeca. Last updated on Dec 31, 2020.

diff --git a/otfmi/master/_generated/fmi/otfmi.fmi.simulate.html b/otfmi/master/_generated/fmi/otfmi.fmi.simulate.html index 1ac523d4991..bad920e21fe 100644 --- a/otfmi/master/_generated/fmi/otfmi.fmi.simulate.html +++ b/otfmi/master/_generated/fmi/otfmi.fmi.simulate.html @@ -1,29 +1,30 @@ - + - + otfmi.fmi.simulate — otfmi documentation - - - - - - - - + + + + + + + + + + - - - - - - + + + + + @@ -115,13 +116,13 @@
-

otfmi.fmi.simulate

+

otfmi.fmi.simulate

-simulate(model, initialization_script=None, initialization_parameters=None, reset=True, **kwargs)
+simulate(model, initialization_script=None, initialization_parameters=None, reset=True, **kwargs)

Simulate an FMU.

-
Parameters
+
Parameters:
modelPyfmi model object (pyfmi.fmi.FMUModelXXX).
initialization_scriptString, path to the script file.
@@ -144,7 +145,7 @@

otfmi.fmi.simulate -

© Copyright 2017-2020 EDF-Phimeca. +

© Copyright 2017-2023 EDF-Phimeca. Last updated on Dec 31, 2020.

diff --git a/otfmi/master/_generated/otfmi.FMUFunction.html b/otfmi/master/_generated/otfmi.FMUFunction.html index f4e92083acc..247f398ddf5 100644 --- a/otfmi/master/_generated/otfmi.FMUFunction.html +++ b/otfmi/master/_generated/otfmi.FMUFunction.html @@ -1,29 +1,30 @@ - + - + FMUFunction — otfmi documentation - - - - - - - - + + + + + + + + + + - - - - - - + + + + + @@ -107,13 +108,13 @@
-

FMUFunction

+

FMUFunction

-class FMUFunction(*args)
+class FMUFunction(*args)

Define a Function from a FMU file.

-
Parameters
+
Parameters:
path_fmustr, path to the FMU file.
inputs_fmuSequence of str, default=None

Names of the variable from the fmu to be used as input variables. @@ -142,7 +143,7 @@

FMUFunctionAttributes +
Attributes:
thisown

The membership flag

@@ -151,10 +152,6 @@

FMUFunctionMethods

---- @@ -271,7 +268,7 @@

FMUFunction
-draw(*args)
+draw(*args)

Draw the output of function as a Graph.

Available usages:

draw(inputMarg, outputMarg, centralPoint, xiMin, xiMax, ptNb, scale)

@@ -281,12 +278,12 @@

FMUFunction -
Parameters
+
Parameters:
-
outputMarg, inputMargint, outputMarg, inputMarg \geq 0

outputMarg is the index of the marginal to draw as a function of the marginal +

outputMarg, inputMargint, outputMarg, inputMarg \geq 0

outputMarg is the index of the marginal to draw as a function of the marginal with index inputMarg.

-
firstInputMarg, secondInputMargint, firstInputMarg, secondInputMarg \geq 0

In the 2D case, the marginal outputMarg is drawn as a function of the +

firstInputMarg, secondInputMargint, firstInputMarg, secondInputMarg \geq 0

In the 2D case, the marginal outputMarg is drawn as a function of the two marginals with indexes firstInputMarg and secondInputMarg.

centralPointsequence of float

Central point with dimension equal to the input dimension of the function.

@@ -295,9 +292,9 @@

FMUFunctionsequence of float of dimension 2.

In the 2D case, define the intervals where the curves are plotted.

-
ptNbint ptNb > 0

The number of points to draw the curves.

+
ptNbint ptNb > 0

The number of points to draw the curves.

-
ptNbslist of int of dimension 2 ptNbs_k > 0, k=1,2

The number of points to draw the contour in the 2D case.

+
ptNbslist of int of dimension 2 ptNbs_k > 0, k=1,2

The number of points to draw the contour in the 2D case.

scalebool

scale indicates whether the logarithmic scale is used either for one or both axes:

__call__(*args)

Call self as a function.

 ---- @@ -205,10 +202,10 @@

FMUPointToFieldFunction
-getCallsNumber()
+getCallsNumber()

Get the number of calls of the function.

-
Returns
+
Returns:
callsNumberint

Counts the number of times the function has been called since its creation.

@@ -220,10 +217,10 @@

FMUPointToFieldFunction
-getClassName()
+getClassName()

Accessor to the object’s name.

-
Returns
+
Returns:
class_namestr

The object class name (object.__class__.__name__).

@@ -234,10 +231,10 @@

FMUPointToFieldFunction
-getId()
+getId()

Accessor to the object’s id.

-
Returns
+
Returns:
idint

Internal unique identifier.

@@ -248,10 +245,10 @@

FMUPointToFieldFunction
-getImplementation()
+getImplementation()

Accessor to the underlying implementation.

-
Returns
+
Returns:
implImplementation

A copy of the underlying implementation object.

@@ -262,10 +259,10 @@

FMUPointToFieldFunction
-getInputDescription()
+getInputDescription()

Get the description of the input vector.

-
Returns
+
Returns:
inputDescriptionDescription

Description of the input vector.

@@ -276,12 +273,12 @@

FMUPointToFieldFunction
-getInputDimension()
+getInputDimension()

Get the dimension of the input vector.

-
Returns
+
Returns:
-
dint

Dimension d of the input vector.

+
dint

Dimension d of the input vector.

@@ -290,19 +287,19 @@

FMUPointToFieldFunction
-getMarginal(*args)
+getMarginal(*args)

Get the marginal(s) at given indice(s).

-
Parameters
+
Parameters:
-
iint or list of ints, 0 \leq i < d

Indice(s) of the marginal(s) to be extracted.

+
iint or list of ints, 0 \leq i < d

Indice(s) of the marginal(s) to be extracted.

-
Returns
+
Returns:
functionPointToFieldFunction

The initial function restricted to the concerned marginal(s) at the indice(s) -i.

+i.

@@ -311,10 +308,10 @@

FMUPointToFieldFunction
-getName()
+getName()

Accessor to the object’s name.

-
Returns
+
Returns:
namestr

The name of the object.

@@ -325,10 +322,10 @@

FMUPointToFieldFunction
-getOutputDescription()
+getOutputDescription()

Get the description of the output field values.

-
Returns
+
Returns:
outputDescriptionDescription

Description of the output field values.

@@ -339,12 +336,12 @@

FMUPointToFieldFunction
-getOutputDimension()
+getOutputDimension()

Get the dimension of the output field values.

-
Returns
+
Returns:
-
d’int

Dimension d' of the output field values.

+
d’int

Dimension d' of the output field values.

@@ -353,12 +350,12 @@

FMUPointToFieldFunction
-getOutputMesh()
+getOutputMesh()

Get the output mesh.

-
Returns
+
Returns:
-
outputMeshMesh

The mesh \cM_{N'} of the output field.

+
outputMeshMesh

The mesh \cM_{N'} of the output field.

@@ -367,10 +364,10 @@

FMUPointToFieldFunction
-setInputDescription(inputDescription)
+setInputDescription(inputDescription)

Set the description of the input vector.

-
Parameters
+
Parameters:
inputDescriptionsequence of str

Description of the input vector.

@@ -381,10 +378,10 @@

FMUPointToFieldFunction
-setName(name)
+setName(name)

Accessor to the object’s name.

-
Parameters
+
Parameters:
namestr

The name of the object.

@@ -395,10 +392,10 @@

FMUPointToFieldFunction
-setOutputDescription(outputDescription)
+setOutputDescription(outputDescription)

Set the description of the output field values.

-
Parameters
+
Parameters:
outputDescriptionsequence of str

Description of the output field values.

@@ -409,7 +406,7 @@

FMUPointToFieldFunction
-property thisown
+property thisown

The membership flag

@@ -425,7 +422,7 @@

FMUPointToFieldFunction
-

© Copyright 2017-2020 EDF-Phimeca. +

© Copyright 2017-2023 EDF-Phimeca. Last updated on Dec 31, 2020.

diff --git a/otfmi/master/_generated/otfmi.FunctionExporter.html b/otfmi/master/_generated/otfmi.FunctionExporter.html index 4cbad1a47ca..122e08c980b 100644 --- a/otfmi/master/_generated/otfmi.FunctionExporter.html +++ b/otfmi/master/_generated/otfmi.FunctionExporter.html @@ -1,29 +1,30 @@ - + - + FunctionExporter — otfmi documentation - - - - - - - - + + + + + + + + + + - - - - - - + + + + + @@ -106,13 +107,13 @@
-

FunctionExporter

+

FunctionExporter

-class FunctionExporter(*args)
+class FunctionExporter(*args)

Fonction export.

-
Parameters
+
Parameters:
functionopenturns.Function or openturns.PointToFieldFunction

Function to export. Temporal functions (PointToFieldFunction with mesh dimension=1) can only be exported @@ -125,10 +126,6 @@

FunctionExporterMethods

__call__(*args)

Call self as a function.

---- @@ -140,13 +137,13 @@

FunctionExporter
-export_fmu(fmu_path, fmuType='me', mode='pyprocess', verbose=False)
+export_fmu(fmu_path, fmuType='me', mode='pyprocess', verbose=False)

Export the Modelica model as FMU.

Requires CMake, a C compiler and omc the OpenModelica compiler. If the model does not already exist, or if the existing model uses OMEdit connectors, the model is (re)created.

-
Parameters
+
Parameters:
fmu_pathstr

Path to the generated .fmu file.

@@ -166,12 +163,12 @@

FunctionExporter
-export_model(model_path, gui=False, verbose=False, binary=True, mode='pyprocess', move=True)
+export_model(model_path, gui=False, verbose=False, binary=True, mode='pyprocess', move=True)

Export to model file (.mo).

Requires CMake, a C/C++ compiler. Unlike export_fmu, field functions (temporal models) cannot be exported.

-
Parameters
+
Parameters:
model_pathstr

Path to the generated .mo file. The model name is taken from the base name.

@@ -215,7 +212,7 @@

FunctionExporter -

© Copyright 2017-2020 EDF-Phimeca. +

© Copyright 2017-2023 EDF-Phimeca. Last updated on Dec 31, 2020.

diff --git a/otfmi/master/_generated/otfmi.OpenTURNSFMUFunction.html b/otfmi/master/_generated/otfmi.OpenTURNSFMUFunction.html index 7ccef88278d..b2e34c79aa0 100644 --- a/otfmi/master/_generated/otfmi.OpenTURNSFMUFunction.html +++ b/otfmi/master/_generated/otfmi.OpenTURNSFMUFunction.html @@ -1,29 +1,30 @@ - + - + OpenTURNSFMUFunction — otfmi documentation - - - - - - - - + + + + + + + + + + - - - - - - + + + + + @@ -107,13 +108,13 @@
-

OpenTURNSFMUFunction

+

OpenTURNSFMUFunction

-class OpenTURNSFMUFunction(*args)
+class OpenTURNSFMUFunction(*args)

Define a Function from a FMU file.

-
Parameters
+
Parameters:
path_fmustr, path to the FMU file.
inputs_fmuSequence of str, default=None

Names of the variable from the fmu to be used as input variables. @@ -147,10 +148,6 @@

OpenTURNSFMUFunction

Methods

export_fmu(fmu_path[, fmuType, mode, verbose])

Export the Modelica model as FMU.

---- @@ -195,46 +192,46 @@

OpenTURNSFMUFunction
-getFMUInputDescription()
+getFMUInputDescription()

Get the list of input variable names.

-getFMUOutputDescription()
+getFMUOutputDescription()

Get the list of output variable names.

-getInputDescription()
+getInputDescription()

Input description accessor.

-getInputDimension()
+getInputDimension()

Input dimension accessor.

-getOutputDescription()
+getOutputDescription()

Output description accessor.

-getOutputDimension()
+getOutputDimension()

Output dimension accessor.

-initialize(initialization_script=None)
+initialize(initialization_script=None)

Initialize the FMU, using initialization script if available.

-
Parameters
+
Parameters:
initialization_scriptString (optional), path to the initialization
script.
@@ -245,10 +242,10 @@

OpenTURNSFMUFunction
-load_fmu(path_fmu, kind=None, **kwargs)
+load_fmu(path_fmu, kind=None, **kwargs)

Load an FMU.

-
Parameters
+
Parameters:
path_fmuString, path to the FMU file.
kindString, one of “ME” (model exchange) or “CS” (co-simulation)

Select a kind of FMU if both are available. @@ -266,22 +263,22 @@

OpenTURNSFMUFunction
-setInputDescription(descIn)
+setInputDescription(descIn)

Input description accessor.

-setOutputDescription(descOut)
+setOutputDescription(descOut)

Output description accessor.

-simulate(value_input=None, reset=True, **kwargs)
+simulate(value_input=None, reset=True, **kwargs)

Simulate the fmu.

-
Parameters
+
Parameters:
value_inputVector of input values.
resetBoolean, toggle resetting the FMU prior to simulation. True by
@@ -297,10 +294,10 @@

OpenTURNSFMUFunction
-simulate_sample(list_value_input, **kwargs)
+simulate_sample(list_value_input, **kwargs)

Simulate the FMU multiple times.

-
Parameters
+
Parameters:
list_value_inputSequence of vectors of input values.
Additional keyword arguments are passed on to the ‘simulate’ method of
@@ -322,7 +319,7 @@

OpenTURNSFMUFunction
-

© Copyright 2017-2020 EDF-Phimeca. +

© Copyright 2017-2023 EDF-Phimeca. Last updated on Dec 31, 2020.

diff --git a/otfmi/master/_generated/otfmi.OpenTURNSFMUPointToFieldFunction.html b/otfmi/master/_generated/otfmi.OpenTURNSFMUPointToFieldFunction.html index ae8aba3c737..c4b136b76eb 100644 --- a/otfmi/master/_generated/otfmi.OpenTURNSFMUPointToFieldFunction.html +++ b/otfmi/master/_generated/otfmi.OpenTURNSFMUPointToFieldFunction.html @@ -1,29 +1,30 @@ - + - + OpenTURNSFMUPointToFieldFunction — otfmi documentation - - - - - - - - + + + + + + + + + + - - - - - - + + + + + @@ -107,17 +108,13 @@
-

OpenTURNSFMUPointToFieldFunction

+

OpenTURNSFMUPointToFieldFunction

-class OpenTURNSFMUPointToFieldFunction(*args)
+class OpenTURNSFMUPointToFieldFunction(*args)

Define a PointToFieldFunction from a FMU file.

Methods

__call__(X, **kwargs)

Call self as a function.

---- @@ -140,10 +137,6 @@

OpenTURNSFMUPointToFieldFunction -

--- @@ -170,22 +163,22 @@

OpenTURNSFMUPointToFieldFunction
-getFMUInputDescription()
+getFMUInputDescription()

Get the list of input variable names.

-getFMUOutputDescription()
+getFMUOutputDescription()

Get the list of output variable names.

-initialize(initialization_script=None)
+initialize(initialization_script=None)

Initialize the FMU, using initialization script if available.

-
Parameters
+
Parameters:
initialization_scriptString (optional), path to the initialization
script.
@@ -196,10 +189,10 @@

OpenTURNSFMUPointToFieldFunction
-load_fmu(path_fmu, kind=None, **kwargs)
+load_fmu(path_fmu, kind=None, **kwargs)

Load an FMU.

-
Parameters
+
Parameters:
path_fmuString, path to the FMU file.
kindString, one of “ME” (model exchange) or “CS” (co-simulation)

Select a kind of FMU if both are available. @@ -217,10 +210,10 @@

OpenTURNSFMUPointToFieldFunction
-simulate(value_input=None, reset=True, **kwargs)
+simulate(value_input=None, reset=True, **kwargs)

Simulate the fmu.

-
Parameters
+
Parameters:
value_inputVector of input values.
resetBoolean, toggle resetting the FMU prior to simulation. True by
@@ -246,7 +239,7 @@

OpenTURNSFMUPointToFieldFunction -

© Copyright 2017-2020 EDF-Phimeca. +

© Copyright 2017-2023 EDF-Phimeca. Last updated on Dec 31, 2020.

diff --git a/otfmi/master/_images/math/04a8abc0e88f57a224566d80ecebe3964367101a.svg b/otfmi/master/_images/math/04a8abc0e88f57a224566d80ecebe3964367101a.svg index 39dc667ece4..e75b6095d7f 100644 --- a/otfmi/master/_images/math/04a8abc0e88f57a224566d80ecebe3964367101a.svg +++ b/otfmi/master/_images/math/04a8abc0e88f57a224566d80ecebe3964367101a.svg @@ -1,5 +1,5 @@ - + diff --git a/otfmi/master/_images/math/11496c4fdbeb2f04ddd496b3446f821b6e7b3e97.svg b/otfmi/master/_images/math/11496c4fdbeb2f04ddd496b3446f821b6e7b3e97.svg index 4e086caacb4..7c8c4a44608 100644 --- a/otfmi/master/_images/math/11496c4fdbeb2f04ddd496b3446f821b6e7b3e97.svg +++ b/otfmi/master/_images/math/11496c4fdbeb2f04ddd496b3446f821b6e7b3e97.svg @@ -1,5 +1,5 @@ - + diff --git a/otfmi/master/_images/math/129af0b21e89cf6fb63a835b9c04cb0a3c39c31c.svg b/otfmi/master/_images/math/129af0b21e89cf6fb63a835b9c04cb0a3c39c31c.svg index 40596c731aa..c4ec1ca5cf5 100644 --- a/otfmi/master/_images/math/129af0b21e89cf6fb63a835b9c04cb0a3c39c31c.svg +++ b/otfmi/master/_images/math/129af0b21e89cf6fb63a835b9c04cb0a3c39c31c.svg @@ -1,5 +1,5 @@ - + diff --git a/otfmi/master/_images/math/1715162e8135a5b381cd18b1ba301471199dfed7.svg b/otfmi/master/_images/math/1715162e8135a5b381cd18b1ba301471199dfed7.svg new file mode 100644 index 00000000000..e8be23039f2 --- /dev/null +++ b/otfmi/master/_images/math/1715162e8135a5b381cd18b1ba301471199dfed7.svg @@ -0,0 +1,36 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/otfmi/master/_images/math/1a43f099f5cce034a8ea7fe9398f7985fb0c80af.svg b/otfmi/master/_images/math/1a43f099f5cce034a8ea7fe9398f7985fb0c80af.svg index 39dc667ece4..e75b6095d7f 100644 --- a/otfmi/master/_images/math/1a43f099f5cce034a8ea7fe9398f7985fb0c80af.svg +++ b/otfmi/master/_images/math/1a43f099f5cce034a8ea7fe9398f7985fb0c80af.svg @@ -1,5 +1,5 @@ - + diff --git a/otfmi/master/_images/math/24b909dea1ead80dd02c94ae1aab33603e9f41f5.svg b/otfmi/master/_images/math/24b909dea1ead80dd02c94ae1aab33603e9f41f5.svg index 7325d72bfc4..8c4405d951b 100644 --- a/otfmi/master/_images/math/24b909dea1ead80dd02c94ae1aab33603e9f41f5.svg +++ b/otfmi/master/_images/math/24b909dea1ead80dd02c94ae1aab33603e9f41f5.svg @@ -1,5 +1,5 @@ - + diff --git a/otfmi/master/_images/math/292ace2160cc527f629b5b2926255445bbb6553b.svg b/otfmi/master/_images/math/292ace2160cc527f629b5b2926255445bbb6553b.svg index 212606cc515..cc9eac5bdd3 100644 --- a/otfmi/master/_images/math/292ace2160cc527f629b5b2926255445bbb6553b.svg +++ b/otfmi/master/_images/math/292ace2160cc527f629b5b2926255445bbb6553b.svg @@ -1,5 +1,5 @@ - + diff --git a/otfmi/master/_images/math/2b68d36ff9b5215f90c1fca15e731aa7f194065a.svg b/otfmi/master/_images/math/2b68d36ff9b5215f90c1fca15e731aa7f194065a.svg index d39b03d62d1..370b74d0763 100644 --- a/otfmi/master/_images/math/2b68d36ff9b5215f90c1fca15e731aa7f194065a.svg +++ b/otfmi/master/_images/math/2b68d36ff9b5215f90c1fca15e731aa7f194065a.svg @@ -1,5 +1,5 @@ - + diff --git a/otfmi/master/_images/math/2ded575cfd930c8b22a79be9efd5346371741a29.svg b/otfmi/master/_images/math/2ded575cfd930c8b22a79be9efd5346371741a29.svg index 099d90e2366..eb32d010bdf 100644 --- a/otfmi/master/_images/math/2ded575cfd930c8b22a79be9efd5346371741a29.svg +++ b/otfmi/master/_images/math/2ded575cfd930c8b22a79be9efd5346371741a29.svg @@ -1,5 +1,5 @@ - + diff --git a/otfmi/master/_images/math/38ca5c0adb14329feaafb2e991ee778f7ee1b2bc.svg b/otfmi/master/_images/math/38ca5c0adb14329feaafb2e991ee778f7ee1b2bc.svg index 9342dd5595b..9e6b5915511 100644 --- a/otfmi/master/_images/math/38ca5c0adb14329feaafb2e991ee778f7ee1b2bc.svg +++ b/otfmi/master/_images/math/38ca5c0adb14329feaafb2e991ee778f7ee1b2bc.svg @@ -1,5 +1,5 @@ - + diff --git a/otfmi/master/_images/math/450a53c50e45b2b878a053c604ca9f3091998087.svg b/otfmi/master/_images/math/450a53c50e45b2b878a053c604ca9f3091998087.svg index 9d17c402998..9dc5db3d4cf 100644 --- a/otfmi/master/_images/math/450a53c50e45b2b878a053c604ca9f3091998087.svg +++ b/otfmi/master/_images/math/450a53c50e45b2b878a053c604ca9f3091998087.svg @@ -1,5 +1,5 @@ - + diff --git a/otfmi/master/_images/math/63df892ffd2c37c34e251eb5d41cc28f30c2840d.svg b/otfmi/master/_images/math/63df892ffd2c37c34e251eb5d41cc28f30c2840d.svg index 55abecd0e94..73dfcc0a9ed 100644 --- a/otfmi/master/_images/math/63df892ffd2c37c34e251eb5d41cc28f30c2840d.svg +++ b/otfmi/master/_images/math/63df892ffd2c37c34e251eb5d41cc28f30c2840d.svg @@ -1,19 +1,19 @@ - + - - - - - - + + + + + + diff --git a/otfmi/master/_images/math/67a53be822771f7a0996f7227d659b983bb17e6f.svg b/otfmi/master/_images/math/67a53be822771f7a0996f7227d659b983bb17e6f.svg index be466904f91..9c2dbb63ef7 100644 --- a/otfmi/master/_images/math/67a53be822771f7a0996f7227d659b983bb17e6f.svg +++ b/otfmi/master/_images/math/67a53be822771f7a0996f7227d659b983bb17e6f.svg @@ -1,5 +1,5 @@ - + diff --git a/otfmi/master/_images/math/6f0eb9535619eb9a76d4501fc9a5052479d3ad80.svg b/otfmi/master/_images/math/6f0eb9535619eb9a76d4501fc9a5052479d3ad80.svg index d8812d63be9..29ac3e1c379 100644 --- a/otfmi/master/_images/math/6f0eb9535619eb9a76d4501fc9a5052479d3ad80.svg +++ b/otfmi/master/_images/math/6f0eb9535619eb9a76d4501fc9a5052479d3ad80.svg @@ -1,16 +1,16 @@ - + + + - - diff --git a/otfmi/master/_images/math/70d14a9ff4ef076772e0c627a35fc77db98a40aa.svg b/otfmi/master/_images/math/70d14a9ff4ef076772e0c627a35fc77db98a40aa.svg index 19a8599e77b..ac9812f7caf 100644 --- a/otfmi/master/_images/math/70d14a9ff4ef076772e0c627a35fc77db98a40aa.svg +++ b/otfmi/master/_images/math/70d14a9ff4ef076772e0c627a35fc77db98a40aa.svg @@ -1,5 +1,5 @@ - + diff --git a/otfmi/master/_images/math/741d52ff03cd30e7799e3af8441ea16792d993cf.svg b/otfmi/master/_images/math/741d52ff03cd30e7799e3af8441ea16792d993cf.svg index f946e30e774..bc59d7f7e74 100644 --- a/otfmi/master/_images/math/741d52ff03cd30e7799e3af8441ea16792d993cf.svg +++ b/otfmi/master/_images/math/741d52ff03cd30e7799e3af8441ea16792d993cf.svg @@ -1,5 +1,5 @@ - + diff --git a/otfmi/master/_images/math/7e6a1438e344753945996b5a8e6a964de12d448a.svg b/otfmi/master/_images/math/7e6a1438e344753945996b5a8e6a964de12d448a.svg index 90b4b4c6a39..179ef146837 100644 --- a/otfmi/master/_images/math/7e6a1438e344753945996b5a8e6a964de12d448a.svg +++ b/otfmi/master/_images/math/7e6a1438e344753945996b5a8e6a964de12d448a.svg @@ -1,5 +1,5 @@ - + diff --git a/otfmi/master/_images/math/823ff319315666e00042a88b19362e98cea7d023.svg b/otfmi/master/_images/math/823ff319315666e00042a88b19362e98cea7d023.svg index 331e54fc61a..00eba38f96c 100644 --- a/otfmi/master/_images/math/823ff319315666e00042a88b19362e98cea7d023.svg +++ b/otfmi/master/_images/math/823ff319315666e00042a88b19362e98cea7d023.svg @@ -1,5 +1,5 @@ - + diff --git a/otfmi/master/_images/math/88c640a4dc5381a4efe0671f66107d51c7563644.svg b/otfmi/master/_images/math/88c640a4dc5381a4efe0671f66107d51c7563644.svg index 2e0610208fd..1851c8ce998 100644 --- a/otfmi/master/_images/math/88c640a4dc5381a4efe0671f66107d51c7563644.svg +++ b/otfmi/master/_images/math/88c640a4dc5381a4efe0671f66107d51c7563644.svg @@ -1,5 +1,5 @@ - + diff --git a/otfmi/master/_images/math/8f7f9a82d085c4eb7a0f69a85d4417f2e1d6d54f.svg b/otfmi/master/_images/math/8f7f9a82d085c4eb7a0f69a85d4417f2e1d6d54f.svg index d2cb7647edc..374793c6f3f 100644 --- a/otfmi/master/_images/math/8f7f9a82d085c4eb7a0f69a85d4417f2e1d6d54f.svg +++ b/otfmi/master/_images/math/8f7f9a82d085c4eb7a0f69a85d4417f2e1d6d54f.svg @@ -1,5 +1,5 @@ - + diff --git a/otfmi/master/_images/math/914a2375b0d249062c025a443879120df3b3f9a0.svg b/otfmi/master/_images/math/914a2375b0d249062c025a443879120df3b3f9a0.svg index 92c39aa048e..5dbda852b5a 100644 --- a/otfmi/master/_images/math/914a2375b0d249062c025a443879120df3b3f9a0.svg +++ b/otfmi/master/_images/math/914a2375b0d249062c025a443879120df3b3f9a0.svg @@ -1,5 +1,5 @@ - + diff --git a/otfmi/master/_images/math/9268abfe0dfe4c76eaace9a2136c7b41aec75457.svg b/otfmi/master/_images/math/9268abfe0dfe4c76eaace9a2136c7b41aec75457.svg index 933c5bcb168..e75698a6869 100644 --- a/otfmi/master/_images/math/9268abfe0dfe4c76eaace9a2136c7b41aec75457.svg +++ b/otfmi/master/_images/math/9268abfe0dfe4c76eaace9a2136c7b41aec75457.svg @@ -1,5 +1,5 @@ - + diff --git a/otfmi/master/_images/math/95bfc66745a81cd4a5d7504f825ff35bac9c8508.svg b/otfmi/master/_images/math/95bfc66745a81cd4a5d7504f825ff35bac9c8508.svg index ff7138ab465..5cd216a670c 100644 --- a/otfmi/master/_images/math/95bfc66745a81cd4a5d7504f825ff35bac9c8508.svg +++ b/otfmi/master/_images/math/95bfc66745a81cd4a5d7504f825ff35bac9c8508.svg @@ -1,5 +1,5 @@ - + diff --git a/otfmi/master/_images/math/9f1437cc1369fa698a934a87d4a6291e33b74db8.svg b/otfmi/master/_images/math/9f1437cc1369fa698a934a87d4a6291e33b74db8.svg index e900b6b0e00..e5f8ba5dd32 100644 --- a/otfmi/master/_images/math/9f1437cc1369fa698a934a87d4a6291e33b74db8.svg +++ b/otfmi/master/_images/math/9f1437cc1369fa698a934a87d4a6291e33b74db8.svg @@ -1,5 +1,5 @@ - + diff --git a/otfmi/master/_images/math/9fefba6c90a6a30fe67074897f85b9a7941cf535.svg b/otfmi/master/_images/math/9fefba6c90a6a30fe67074897f85b9a7941cf535.svg index dcea2dc5f2c..2c35c83c86c 100644 --- a/otfmi/master/_images/math/9fefba6c90a6a30fe67074897f85b9a7941cf535.svg +++ b/otfmi/master/_images/math/9fefba6c90a6a30fe67074897f85b9a7941cf535.svg @@ -1,11 +1,11 @@ - + - - + + diff --git a/otfmi/master/_images/math/ac39dd0b6d6922e26ee37784779cc509cc7d707d.svg b/otfmi/master/_images/math/ac39dd0b6d6922e26ee37784779cc509cc7d707d.svg index e6fcd321428..52f82d78f76 100644 --- a/otfmi/master/_images/math/ac39dd0b6d6922e26ee37784779cc509cc7d707d.svg +++ b/otfmi/master/_images/math/ac39dd0b6d6922e26ee37784779cc509cc7d707d.svg @@ -1,5 +1,5 @@ - + diff --git a/otfmi/master/_images/math/ae5c646df505177ac04d3f64bccfc0744fcefeeb.svg b/otfmi/master/_images/math/ae5c646df505177ac04d3f64bccfc0744fcefeeb.svg index 0bb70fe6fb6..94365ad3e8d 100644 --- a/otfmi/master/_images/math/ae5c646df505177ac04d3f64bccfc0744fcefeeb.svg +++ b/otfmi/master/_images/math/ae5c646df505177ac04d3f64bccfc0744fcefeeb.svg @@ -1,9 +1,9 @@ - + - + diff --git a/otfmi/master/_images/math/b0f497de29e856a2bd1eb17141b8c920a7d096e3.svg b/otfmi/master/_images/math/b0f497de29e856a2bd1eb17141b8c920a7d096e3.svg index 0f20c824bb4..a79266cc930 100644 --- a/otfmi/master/_images/math/b0f497de29e856a2bd1eb17141b8c920a7d096e3.svg +++ b/otfmi/master/_images/math/b0f497de29e856a2bd1eb17141b8c920a7d096e3.svg @@ -1,5 +1,5 @@ - + diff --git a/otfmi/master/_images/math/b2ed5fa6e3f785771353d25f84ef62de96e3ac12.svg b/otfmi/master/_images/math/b2ed5fa6e3f785771353d25f84ef62de96e3ac12.svg index 76c24d6e947..475600d537f 100644 --- a/otfmi/master/_images/math/b2ed5fa6e3f785771353d25f84ef62de96e3ac12.svg +++ b/otfmi/master/_images/math/b2ed5fa6e3f785771353d25f84ef62de96e3ac12.svg @@ -1,5 +1,5 @@ - + diff --git a/otfmi/master/_images/math/be3d2521b2bf136e2b40dd418e46c1f7ec38ea38.svg b/otfmi/master/_images/math/be3d2521b2bf136e2b40dd418e46c1f7ec38ea38.svg index 6c374c08d49..8bcdc68b922 100644 --- a/otfmi/master/_images/math/be3d2521b2bf136e2b40dd418e46c1f7ec38ea38.svg +++ b/otfmi/master/_images/math/be3d2521b2bf136e2b40dd418e46c1f7ec38ea38.svg @@ -1,5 +1,5 @@ - + diff --git a/otfmi/master/_images/math/c3b5dd69676cd04c2f1a71b37c379630f824426e.svg b/otfmi/master/_images/math/c3b5dd69676cd04c2f1a71b37c379630f824426e.svg index e9856837450..2a2d2db79eb 100644 --- a/otfmi/master/_images/math/c3b5dd69676cd04c2f1a71b37c379630f824426e.svg +++ b/otfmi/master/_images/math/c3b5dd69676cd04c2f1a71b37c379630f824426e.svg @@ -1,5 +1,5 @@ - + diff --git a/otfmi/master/_images/math/c4e9f34ac46df7e63f7c445b65adf5e3b35f46f8.svg b/otfmi/master/_images/math/c4e9f34ac46df7e63f7c445b65adf5e3b35f46f8.svg index 88b43be52b5..7c00b5014c8 100644 --- a/otfmi/master/_images/math/c4e9f34ac46df7e63f7c445b65adf5e3b35f46f8.svg +++ b/otfmi/master/_images/math/c4e9f34ac46df7e63f7c445b65adf5e3b35f46f8.svg @@ -1,5 +1,5 @@ - + diff --git a/otfmi/master/_images/math/c7912bc327cb163bed441bb541b5ce75902dee7f.svg b/otfmi/master/_images/math/c7912bc327cb163bed441bb541b5ce75902dee7f.svg index a4b877a0fba..b7a24782c77 100644 --- a/otfmi/master/_images/math/c7912bc327cb163bed441bb541b5ce75902dee7f.svg +++ b/otfmi/master/_images/math/c7912bc327cb163bed441bb541b5ce75902dee7f.svg @@ -1,5 +1,5 @@ - + diff --git a/otfmi/master/_images/math/cb683913f301d5b1778450f5fac31c0533df6489.svg b/otfmi/master/_images/math/cb683913f301d5b1778450f5fac31c0533df6489.svg index b1fe78234d8..8a3b5d97351 100644 --- a/otfmi/master/_images/math/cb683913f301d5b1778450f5fac31c0533df6489.svg +++ b/otfmi/master/_images/math/cb683913f301d5b1778450f5fac31c0533df6489.svg @@ -1,5 +1,5 @@ - + diff --git a/otfmi/master/_images/math/d3a0c59f093a38248f9a9564b307b981fbeab356.svg b/otfmi/master/_images/math/d3a0c59f093a38248f9a9564b307b981fbeab356.svg index d722e93488a..00978768653 100644 --- a/otfmi/master/_images/math/d3a0c59f093a38248f9a9564b307b981fbeab356.svg +++ b/otfmi/master/_images/math/d3a0c59f093a38248f9a9564b307b981fbeab356.svg @@ -1,9 +1,9 @@ - + - + diff --git a/otfmi/master/_images/math/d672f2d7146c7929a2ac7b7edf97e6ce664abc5b.svg b/otfmi/master/_images/math/d672f2d7146c7929a2ac7b7edf97e6ce664abc5b.svg index a79698ab6b1..3437fe59132 100644 --- a/otfmi/master/_images/math/d672f2d7146c7929a2ac7b7edf97e6ce664abc5b.svg +++ b/otfmi/master/_images/math/d672f2d7146c7929a2ac7b7edf97e6ce664abc5b.svg @@ -1,13 +1,13 @@ - + + + - - diff --git a/otfmi/master/_images/math/dd9702935d87e3486c3a496692ebf60713d5b548.svg b/otfmi/master/_images/math/dd9702935d87e3486c3a496692ebf60713d5b548.svg index a9f9f0778ae..7a6e9533a90 100644 --- a/otfmi/master/_images/math/dd9702935d87e3486c3a496692ebf60713d5b548.svg +++ b/otfmi/master/_images/math/dd9702935d87e3486c3a496692ebf60713d5b548.svg @@ -1,5 +1,5 @@ - + diff --git a/otfmi/master/_images/math/de269abbb4edf3f204abc71d79023d875f05e256.svg b/otfmi/master/_images/math/de269abbb4edf3f204abc71d79023d875f05e256.svg index c64fd8fbbdb..4dfb2605486 100644 --- a/otfmi/master/_images/math/de269abbb4edf3f204abc71d79023d875f05e256.svg +++ b/otfmi/master/_images/math/de269abbb4edf3f204abc71d79023d875f05e256.svg @@ -1,5 +1,5 @@ - + diff --git a/otfmi/master/_images/math/e6250096c0435219b09ec4b0f6d46fb1c18599b0.svg b/otfmi/master/_images/math/e6250096c0435219b09ec4b0f6d46fb1c18599b0.svg index 19b0224c17b..5e9e92b75bf 100644 --- a/otfmi/master/_images/math/e6250096c0435219b09ec4b0f6d46fb1c18599b0.svg +++ b/otfmi/master/_images/math/e6250096c0435219b09ec4b0f6d46fb1c18599b0.svg @@ -1,5 +1,5 @@ - + diff --git a/otfmi/master/_images/math/ea20b350dd30fc67780a93729365e7e6e62ddce1.svg b/otfmi/master/_images/math/ea20b350dd30fc67780a93729365e7e6e62ddce1.svg index 88e3d2ccf7d..42690af7b09 100644 --- a/otfmi/master/_images/math/ea20b350dd30fc67780a93729365e7e6e62ddce1.svg +++ b/otfmi/master/_images/math/ea20b350dd30fc67780a93729365e7e6e62ddce1.svg @@ -1,5 +1,5 @@ - + diff --git a/otfmi/master/_images/math/eeb7bfe50bd7ae4c180c7f248a2af4c67fec1919.svg b/otfmi/master/_images/math/eeb7bfe50bd7ae4c180c7f248a2af4c67fec1919.svg index e9cd569cd48..98a0bd5b8e2 100644 --- a/otfmi/master/_images/math/eeb7bfe50bd7ae4c180c7f248a2af4c67fec1919.svg +++ b/otfmi/master/_images/math/eeb7bfe50bd7ae4c180c7f248a2af4c67fec1919.svg @@ -1,5 +1,5 @@ - + diff --git a/otfmi/master/_images/math/f75a4add8dc940006b0ab443036be45ba1028d75.svg b/otfmi/master/_images/math/f75a4add8dc940006b0ab443036be45ba1028d75.svg index 19621238c66..c35104c05fe 100644 --- a/otfmi/master/_images/math/f75a4add8dc940006b0ab443036be45ba1028d75.svg +++ b/otfmi/master/_images/math/f75a4add8dc940006b0ab443036be45ba1028d75.svg @@ -1,5 +1,5 @@ - + diff --git a/otfmi/master/_images/math/f83cc7728de18d3907b9dcae1bcf7ada86b8d148.svg b/otfmi/master/_images/math/f83cc7728de18d3907b9dcae1bcf7ada86b8d148.svg index eba622d613a..cc82fcc4d57 100644 --- a/otfmi/master/_images/math/f83cc7728de18d3907b9dcae1bcf7ada86b8d148.svg +++ b/otfmi/master/_images/math/f83cc7728de18d3907b9dcae1bcf7ada86b8d148.svg @@ -1,5 +1,5 @@ - + diff --git a/otfmi/master/_images/math/ff2f41c3ecb8198c9c09bd2a891e1b4e9fffcd02.svg b/otfmi/master/_images/math/ff2f41c3ecb8198c9c09bd2a891e1b4e9fffcd02.svg index 4d6ede34c90..b9ab501e6bf 100644 --- a/otfmi/master/_images/math/ff2f41c3ecb8198c9c09bd2a891e1b4e9fffcd02.svg +++ b/otfmi/master/_images/math/ff2f41c3ecb8198c9c09bd2a891e1b4e9fffcd02.svg @@ -1,5 +1,5 @@ - + diff --git a/otfmi/master/_sources/auto_application/plot_cantilever_beam.rst.txt b/otfmi/master/_sources/auto_application/plot_cantilever_beam.rst.txt index 3ce79fa0718..102b39103f8 100644 --- a/otfmi/master/_sources/auto_application/plot_cantilever_beam.rst.txt +++ b/otfmi/master/_sources/auto_application/plot_cantilever_beam.rst.txt @@ -285,7 +285,7 @@ Is this probability low or not ? It depends on your context 🙂 .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 3.791 seconds) + **Total running time of the script:** (0 minutes 3.718 seconds) .. _sphx_glr_download_auto_application_plot_cantilever_beam.py: diff --git a/otfmi/master/_sources/auto_application/plot_metamodel.rst.txt b/otfmi/master/_sources/auto_application/plot_metamodel.rst.txt index a6910e5e011..de6796349c0 100644 --- a/otfmi/master/_sources/auto_application/plot_metamodel.rst.txt +++ b/otfmi/master/_sources/auto_application/plot_metamodel.rst.txt @@ -403,18 +403,17 @@ mean error on the field is acceptable. We validate the Kriging (using the Karhunen-Loeve coefficients of the test sample): -.. GENERATED FROM PYTHON SOURCE LINES 214-224 +.. GENERATED FROM PYTHON SOURCE LINES 214-223 .. code-block:: Python projectFunction = ot.KarhunenLoeveProjection(resultKL) coefficientSample = projectFunction(outputFMUTestSample) + predictions = metamodel(inputTestSample) - validationKriging = ot.MetaModelValidation( - inputTestSample, coefficientSample, metamodel - ) - Q2 = validationKriging.computePredictivityFactor()[0] + validation = ot.MetaModelValidation(coefficientSample, predictions) + Q2 = validation.computeR2Score()[0] print(Q2) @@ -430,14 +429,14 @@ sample): -.. GENERATED FROM PYTHON SOURCE LINES 225-229 +.. GENERATED FROM PYTHON SOURCE LINES 224-228 The predictivity factor is very close to 1, which is satisfying. Further statistical tests exist in `OpenTURNS `_ to assert the quality of the obtained metamodel. -.. GENERATED FROM PYTHON SOURCE LINES 231-242 +.. GENERATED FROM PYTHON SOURCE LINES 230-241 ---------------------- @@ -454,7 +453,7 @@ etc. .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 0.735 seconds) + **Total running time of the script:** (0 minutes 0.730 seconds) .. _sphx_glr_download_auto_application_plot_metamodel.py: diff --git a/otfmi/master/_sources/auto_example/dynamic/plot_dyn_basics.rst.txt b/otfmi/master/_sources/auto_example/dynamic/plot_dyn_basics.rst.txt index d9d6d1fe0e6..49126a4b0af 100644 --- a/otfmi/master/_sources/auto_example/dynamic/plot_dyn_basics.rst.txt +++ b/otfmi/master/_sources/auto_example/dynamic/plot_dyn_basics.rst.txt @@ -624,7 +624,7 @@ Visualize the time evolution of the ``infected`` over time, depending on the .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 0.175 seconds) + **Total running time of the script:** (0 minutes 0.177 seconds) .. _sphx_glr_download_auto_example_dynamic_plot_dyn_basics.py: diff --git a/otfmi/master/_sources/auto_example/dynamic/plot_dyn_init.rst.txt b/otfmi/master/_sources/auto_example/dynamic/plot_dyn_init.rst.txt index 7c5921ed055..4cff13c1419 100644 --- a/otfmi/master/_sources/auto_example/dynamic/plot_dyn_init.rst.txt +++ b/otfmi/master/_sources/auto_example/dynamic/plot_dyn_init.rst.txt @@ -229,7 +229,7 @@ Visualize the time evolution of the ``infected`` over time, depending on the .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 0.168 seconds) + **Total running time of the script:** (0 minutes 0.169 seconds) .. _sphx_glr_download_auto_example_dynamic_plot_dyn_init.py: diff --git a/otfmi/master/_sources/auto_example/dynamic/plot_dyn_set.rst.txt b/otfmi/master/_sources/auto_example/dynamic/plot_dyn_set.rst.txt index 3e0262e36b0..b33b3ce7040 100644 --- a/otfmi/master/_sources/auto_example/dynamic/plot_dyn_set.rst.txt +++ b/otfmi/master/_sources/auto_example/dynamic/plot_dyn_set.rst.txt @@ -181,7 +181,7 @@ access to the PyFMI model. We can hence access all PyFMI's object methods: .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 0.064 seconds) + **Total running time of the script:** (0 minutes 0.063 seconds) .. _sphx_glr_download_auto_example_dynamic_plot_dyn_set.py: diff --git a/otfmi/master/_sources/auto_example/low_level/plot_initialize.rst.txt b/otfmi/master/_sources/auto_example/low_level/plot_initialize.rst.txt index d84b5966b7e..da4b4f7c1c4 100644 --- a/otfmi/master/_sources/auto_example/low_level/plot_initialize.rst.txt +++ b/otfmi/master/_sources/auto_example/low_level/plot_initialize.rst.txt @@ -101,7 +101,7 @@ The beam length can be required directly in the ``simulate`` function: .. code-block:: none Simulation interval : 0.0 - 1.0 seconds. - Elapsed simulation time: 0.011681658999975753 seconds. + Elapsed simulation time: 0.011465236999981698 seconds. L = 300 F = 25000 y = 18.75 @@ -176,7 +176,7 @@ designated script, then simulates the FMU. .. code-block:: none Simulation interval : 0.0 - 1.0 seconds. - Elapsed simulation time: 0.012213257000041722 seconds. + Elapsed simulation time: 0.01184610600000724 seconds. L = 300 F = 25000 y = 18.75 @@ -187,7 +187,7 @@ designated script, then simulates the FMU. .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 0.057 seconds) + **Total running time of the script:** (0 minutes 0.056 seconds) .. _sphx_glr_download_auto_example_low_level_plot_initialize.py: diff --git a/otfmi/master/_sources/auto_example/low_level/plot_simulate.rst.txt b/otfmi/master/_sources/auto_example/low_level/plot_simulate.rst.txt index ec47bd92286..1c6e69e2f00 100644 --- a/otfmi/master/_sources/auto_example/low_level/plot_simulate.rst.txt +++ b/otfmi/master/_sources/auto_example/low_level/plot_simulate.rst.txt @@ -87,7 +87,7 @@ employed: .. code-block:: none Simulation interval : 0 - 1.0 seconds. - Elapsed simulation time: 0.011963037000043641 seconds. + Elapsed simulation time: 0.011409133000029215 seconds. y = 22.5 @@ -129,25 +129,25 @@ length L: .. code-block:: none Simulation interval : 0.0 - 1.0 seconds. - Elapsed simulation time: 0.011800311999991209 seconds. + Elapsed simulation time: 0.011713799999995445 seconds. Simulation interval : 0.0 - 1.0 seconds. - Elapsed simulation time: 0.011737203999985013 seconds. + Elapsed simulation time: 0.011339383000006364 seconds. Simulation interval : 0.0 - 1.0 seconds. - Elapsed simulation time: 0.011603782999998202 seconds. + Elapsed simulation time: 0.011396659000013187 seconds. Simulation interval : 0.0 - 1.0 seconds. - Elapsed simulation time: 0.011774081999988084 seconds. + Elapsed simulation time: 0.011423528999955579 seconds. Simulation interval : 0.0 - 1.0 seconds. - Elapsed simulation time: 0.011647925999966446 seconds. + Elapsed simulation time: 0.011411737000003086 seconds. Simulation interval : 0.0 - 1.0 seconds. - Elapsed simulation time: 0.011724299000036353 seconds. + Elapsed simulation time: 0.011422046000006958 seconds. Simulation interval : 0.0 - 1.0 seconds. - Elapsed simulation time: 0.011699973999952817 seconds. + Elapsed simulation time: 0.011402511000028426 seconds. Simulation interval : 0.0 - 1.0 seconds. - Elapsed simulation time: 0.011741020999977536 seconds. + Elapsed simulation time: 0.011396627999999964 seconds. Simulation interval : 0.0 - 1.0 seconds. - Elapsed simulation time: 0.011759734999998273 seconds. + Elapsed simulation time: 0.01136045200001945 seconds. Simulation interval : 0.0 - 1.0 seconds. - Elapsed simulation time: 0.011609414000020024 seconds. + Elapsed simulation time: 0.011462139999991905 seconds. @@ -161,7 +161,7 @@ length L: .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 0.220 seconds) + **Total running time of the script:** (0 minutes 0.216 seconds) .. _sphx_glr_download_auto_example_low_level_plot_simulate.py: diff --git a/otfmi/master/_sources/auto_example/ot_to_fmu/plot_fmu_exporter.rst.txt b/otfmi/master/_sources/auto_example/ot_to_fmu/plot_fmu_exporter.rst.txt index 65ce5e3c79e..3531e1ef76e 100644 --- a/otfmi/master/_sources/auto_example/ot_to_fmu/plot_fmu_exporter.rst.txt +++ b/otfmi/master/_sources/auto_example/ot_to_fmu/plot_fmu_exporter.rst.txt @@ -89,7 +89,7 @@ We create the FMU constructor and the folder in which save the FMU: .. code-block:: none - /tmp/tmpjblz1gad/myExponential.fmu + /tmp/tmp070ao6p4/myExponential.fmu @@ -168,7 +168,7 @@ output corresponds to the exponential of the sine signal. .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 5.204 seconds) + **Total running time of the script:** (0 minutes 5.051 seconds) .. _sphx_glr_download_auto_example_ot_to_fmu_plot_fmu_exporter.py: diff --git a/otfmi/master/_sources/auto_example/ot_to_fmu/plot_model_exporter.rst.txt b/otfmi/master/_sources/auto_example/ot_to_fmu/plot_model_exporter.rst.txt index 675a6893cab..940294df85a 100644 --- a/otfmi/master/_sources/auto_example/ot_to_fmu/plot_model_exporter.rst.txt +++ b/otfmi/master/_sources/auto_example/ot_to_fmu/plot_model_exporter.rst.txt @@ -87,7 +87,7 @@ We create the model constructor and the folder in which save the model: .. code-block:: none - /tmp/tmp3jdc8qem/myExponential.mo + /tmp/tmp2sx2t5ua/myExponential.mo @@ -180,7 +180,7 @@ Note that faster export modes are available with the "mode" keyword, depending o .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 0.383 seconds) + **Total running time of the script:** (0 minutes 0.374 seconds) .. _sphx_glr_download_auto_example_ot_to_fmu_plot_model_exporter.py: diff --git a/otfmi/master/_sources/auto_example/static/plot_init.rst.txt b/otfmi/master/_sources/auto_example/static/plot_init.rst.txt index 5dd89b00f6a..f0b3f0f5587 100644 --- a/otfmi/master/_sources/auto_example/static/plot_init.rst.txt +++ b/otfmi/master/_sources/auto_example/static/plot_init.rst.txt @@ -212,7 +212,7 @@ model: .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 0.264 seconds) + **Total running time of the script:** (0 minutes 0.260 seconds) .. _sphx_glr_download_auto_example_static_plot_init.py: diff --git a/otfmi/master/_sources/auto_example/static/plot_set.rst.txt b/otfmi/master/_sources/auto_example/static/plot_set.rst.txt index d153215040a..a22a8c1d17a 100644 --- a/otfmi/master/_sources/auto_example/static/plot_set.rst.txt +++ b/otfmi/master/_sources/auto_example/static/plot_set.rst.txt @@ -150,7 +150,7 @@ access to the PyFMI model. We can hence access all PyFMI's object methods: .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 0.078 seconds) + **Total running time of the script:** (0 minutes 0.079 seconds) .. _sphx_glr_download_auto_example_static_plot_set.py: diff --git a/otfmi/master/_static/_sphinx_javascript_frameworks_compat.js b/otfmi/master/_static/_sphinx_javascript_frameworks_compat.js index 8549469dc29..81415803ec2 100644 --- a/otfmi/master/_static/_sphinx_javascript_frameworks_compat.js +++ b/otfmi/master/_static/_sphinx_javascript_frameworks_compat.js @@ -1,20 +1,9 @@ -/* - * _sphinx_javascript_frameworks_compat.js - * ~~~~~~~~~~ - * - * Compatability shim for jQuery and underscores.js. - * - * WILL BE REMOVED IN Sphinx 6.0 - * xref RemovedInSphinx60Warning +/* Compatability shim for jQuery and underscores.js. * + * Copyright Sphinx contributors + * Released under the two clause BSD licence */ -/** - * select a different prefix for underscore - */ -$u = _.noConflict(); - - /** * small helper function to urldecode strings * diff --git a/otfmi/master/_static/basic.css b/otfmi/master/_static/basic.css index eeb0519a69b..7ebbd6d07bb 100644 --- a/otfmi/master/_static/basic.css +++ b/otfmi/master/_static/basic.css @@ -1,12 +1,5 @@ /* - * basic.css - * ~~~~~~~~~ - * * Sphinx stylesheet -- basic theme. - * - * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * */ /* -- main layout ----------------------------------------------------------- */ @@ -115,15 +108,11 @@ img { /* -- search page ----------------------------------------------------------- */ ul.search { - margin: 10px 0 0 20px; - padding: 0; + margin-top: 10px; } ul.search li { - padding: 5px 0 5px 20px; - background-image: url(file.png); - background-repeat: no-repeat; - background-position: 0 7px; + padding: 5px 0; } ul.search li a { @@ -236,17 +225,11 @@ div.body p, div.body dd, div.body li, div.body blockquote { a.headerlink { visibility: hidden; } -a.brackets:before, -span.brackets > a:before{ - content: "["; -} -a.brackets:after, -span.brackets > a:after { - content: "]"; +a:visited { + color: #551A8B; } - h1:hover > a.headerlink, h2:hover > a.headerlink, h3:hover > a.headerlink, @@ -334,11 +317,17 @@ aside.sidebar { p.sidebar-title { font-weight: bold; } + +nav.contents, +aside.topic, div.admonition, div.topic, blockquote { clear: left; } /* -- topics ---------------------------------------------------------------- */ + +nav.contents, +aside.topic, div.topic { border: 1px solid #ccc; padding: 7px; @@ -377,6 +366,8 @@ div.body p.centered { div.sidebar > :last-child, aside.sidebar > :last-child, +nav.contents > :last-child, +aside.topic > :last-child, div.topic > :last-child, div.admonition > :last-child { margin-bottom: 0; @@ -384,6 +375,8 @@ div.admonition > :last-child { div.sidebar::after, aside.sidebar::after, +nav.contents::after, +aside.topic::after, div.topic::after, div.admonition::after, blockquote::after { @@ -608,19 +601,27 @@ ol.simple p, ul.simple p { margin-bottom: 0; } -dl.footnote > dt, -dl.citation > dt { + +aside.footnote > span, +div.citation > span { float: left; - margin-right: 0.5em; } - -dl.footnote > dd, -dl.citation > dd { +aside.footnote > span:last-of-type, +div.citation > span:last-of-type { + padding-right: 0.5em; +} +aside.footnote > p { + margin-left: 2em; +} +div.citation > p { + margin-left: 4em; +} +aside.footnote > p:last-of-type, +div.citation > p:last-of-type { margin-bottom: 0em; } - -dl.footnote > dd:after, -dl.citation > dd:after { +aside.footnote > p:last-of-type:after, +div.citation > p:last-of-type:after { content: ""; clear: both; } @@ -636,10 +637,6 @@ dl.field-list > dt { padding-left: 0.5em; padding-right: 5px; } -dl.field-list > dt:after { - content: ":"; -} - dl.field-list > dd { padding-left: 0.5em; @@ -666,6 +663,16 @@ dd { margin-left: 30px; } +.sig dd { + margin-top: 0px; + margin-bottom: 0px; +} + +.sig dl { + margin-top: 0px; + margin-bottom: 0px; +} + dl > dd:last-child, dl > dd:last-child > :last-child { margin-bottom: 0; @@ -734,6 +741,14 @@ abbr, acronym { cursor: help; } +.translated { + background-color: rgba(207, 255, 207, 0.2) +} + +.untranslated { + background-color: rgba(255, 207, 207, 0.2) +} + /* -- code displays --------------------------------------------------------- */ pre { diff --git a/otfmi/master/_static/doctools.js b/otfmi/master/_static/doctools.js index 527b876ca63..0398ebb9f03 100644 --- a/otfmi/master/_static/doctools.js +++ b/otfmi/master/_static/doctools.js @@ -1,12 +1,5 @@ /* - * doctools.js - * ~~~~~~~~~~~ - * * Base JavaScript utilities for all Sphinx HTML documentation. - * - * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * */ "use strict"; diff --git a/otfmi/master/_static/documentation_options.js b/otfmi/master/_static/documentation_options.js index b57ae3b8393..7e4c114f212 100644 --- a/otfmi/master/_static/documentation_options.js +++ b/otfmi/master/_static/documentation_options.js @@ -1,5 +1,4 @@ -var DOCUMENTATION_OPTIONS = { - URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), +const DOCUMENTATION_OPTIONS = { VERSION: '', LANGUAGE: 'en', COLLAPSE_INDEX: false, diff --git a/otfmi/master/_static/language_data.js b/otfmi/master/_static/language_data.js index 2e22b06ab13..c7fe6c6fafa 100644 --- a/otfmi/master/_static/language_data.js +++ b/otfmi/master/_static/language_data.js @@ -1,19 +1,12 @@ /* - * language_data.js - * ~~~~~~~~~~~~~~~~ - * * This script contains the language-specific data used by searchtools.js, * namely the list of stopwords, stemmer, scorer and splitter. - * - * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * */ var stopwords = ["a", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "near", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with"]; -/* Non-minified version is copied as a separate JS file, is available */ +/* Non-minified version is copied as a separate JS file, if available */ /** * Porter Stemmer diff --git a/otfmi/master/_static/searchtools.js b/otfmi/master/_static/searchtools.js index e89e34d4e77..2c774d17aff 100644 --- a/otfmi/master/_static/searchtools.js +++ b/otfmi/master/_static/searchtools.js @@ -1,12 +1,5 @@ /* - * searchtools.js - * ~~~~~~~~~~~~~~~~ - * * Sphinx JavaScript utilities for the full-text search. - * - * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * */ "use strict"; @@ -20,7 +13,7 @@ if (typeof Scorer === "undefined") { // and returns the new score. /* score: result => { - const [docname, title, anchor, descr, score, filename] = result + const [docname, title, anchor, descr, score, filename, kind] = result return score }, */ @@ -47,6 +40,14 @@ if (typeof Scorer === "undefined") { }; } +// Global search result kind enum, used by themes to style search results. +class SearchResultKind { + static get index() { return "index"; } + static get object() { return "object"; } + static get text() { return "text"; } + static get title() { return "title"; } +} + const _removeChildren = (element) => { while (element && element.lastChild) element.removeChild(element.lastChild); }; @@ -57,16 +58,20 @@ const _removeChildren = (element) => { const _escapeRegExp = (string) => string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string -const _displayItem = (item, searchTerms) => { +const _displayItem = (item, searchTerms, highlightTerms) => { const docBuilder = DOCUMENTATION_OPTIONS.BUILDER; - const docUrlRoot = DOCUMENTATION_OPTIONS.URL_ROOT; const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX; const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX; const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY; + const contentRoot = document.documentElement.dataset.content_root; - const [docName, title, anchor, descr, score, _filename] = item; + const [docName, title, anchor, descr, score, _filename, kind] = item; let listItem = document.createElement("li"); + // Add a class representing the item's type: + // can be used by a theme's CSS selector for styling + // See SearchResultKind for the class names. + listItem.classList.add(`kind-${kind}`); let requestUrl; let linkUrl; if (docBuilder === "dirhtml") { @@ -75,28 +80,35 @@ const _displayItem = (item, searchTerms) => { if (dirname.match(/\/index\/$/)) dirname = dirname.substring(0, dirname.length - 6); else if (dirname === "index/") dirname = ""; - requestUrl = docUrlRoot + dirname; + requestUrl = contentRoot + dirname; linkUrl = requestUrl; } else { // normal html builders - requestUrl = docUrlRoot + docName + docFileSuffix; + requestUrl = contentRoot + docName + docFileSuffix; linkUrl = docName + docLinkSuffix; } let linkEl = listItem.appendChild(document.createElement("a")); linkEl.href = linkUrl + anchor; linkEl.dataset.score = score; linkEl.innerHTML = title; - if (descr) + if (descr) { listItem.appendChild(document.createElement("span")).innerHTML = " (" + descr + ")"; + // highlight search terms in the description + if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js + highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); + } else if (showSearchSummary) fetch(requestUrl) .then((responseData) => responseData.text()) .then((data) => { if (data) listItem.appendChild( - Search.makeSearchSummary(data, searchTerms) + Search.makeSearchSummary(data, searchTerms, anchor) ); + // highlight search terms in the summary + if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js + highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); }); Search.output.appendChild(listItem); }; @@ -108,27 +120,46 @@ const _finishSearch = (resultCount) => { "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories." ); else - Search.status.innerText = _( - `Search finished, found ${resultCount} page(s) matching the search query.` - ); + Search.status.innerText = Documentation.ngettext( + "Search finished, found one page matching the search query.", + "Search finished, found ${resultCount} pages matching the search query.", + resultCount, + ).replace('${resultCount}', resultCount); }; const _displayNextItem = ( results, resultCount, - searchTerms + searchTerms, + highlightTerms, ) => { // results left, load the summary and display it // this is intended to be dynamic (don't sub resultsCount) if (results.length) { - _displayItem(results.pop(), searchTerms); + _displayItem(results.pop(), searchTerms, highlightTerms); setTimeout( - () => _displayNextItem(results, resultCount, searchTerms), + () => _displayNextItem(results, resultCount, searchTerms, highlightTerms), 5 ); } // search finished, update title and status message else _finishSearch(resultCount); }; +// Helper function used by query() to order search results. +// Each input is an array of [docname, title, anchor, descr, score, filename, kind]. +// Order the results by score (in opposite order of appearance, since the +// `_displayNextItem` function uses pop() to retrieve items) and then alphabetically. +const _orderResultsByScoreThenName = (a, b) => { + const leftScore = a[4]; + const rightScore = b[4]; + if (leftScore === rightScore) { + // same score: sort alphabetically + const leftTitle = a[1].toLowerCase(); + const rightTitle = b[1].toLowerCase(); + if (leftTitle === rightTitle) return 0; + return leftTitle > rightTitle ? -1 : 1; // inverted is intentional + } + return leftScore > rightScore ? 1 : -1; +}; /** * Default splitQuery function. Can be overridden in ``sphinx.search`` with a @@ -152,13 +183,26 @@ const Search = { _queued_query: null, _pulse_status: -1, - htmlToText: (htmlString) => { + htmlToText: (htmlString, anchor) => { const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html'); - htmlElement.querySelectorAll(".headerlink").forEach((el) => { el.remove() }); + for (const removalQuery of [".headerlink", "script", "style"]) { + htmlElement.querySelectorAll(removalQuery).forEach((el) => { el.remove() }); + } + if (anchor) { + const anchorContent = htmlElement.querySelector(`[role="main"] ${anchor}`); + if (anchorContent) return anchorContent.textContent; + + console.warn( + `Anchored content block not found. Sphinx search tries to obtain it via DOM query '[role=main] ${anchor}'. Check your theme or template.` + ); + } + + // if anchor not specified or not found, fall back to main content const docContent = htmlElement.querySelector('[role="main"]'); - if (docContent !== undefined) return docContent.textContent; + if (docContent) return docContent.textContent; + console.warn( - "Content block not found. Sphinx search tries to obtain it via '[role=main]'. Could you check your theme or template." + "Content block not found. Sphinx search tries to obtain it via DOM query '[role=main]'. Check your theme or template." ); return ""; }, @@ -211,6 +255,7 @@ const Search = { searchSummary.classList.add("search-summary"); searchSummary.innerText = ""; const searchList = document.createElement("ul"); + searchList.setAttribute("role", "list"); searchList.classList.add("search"); const out = document.getElementById("search-results"); @@ -231,16 +276,7 @@ const Search = { else Search.deferQuery(query); }, - /** - * execute search (requires search index to be loaded) - */ - query: (query) => { - const filenames = Search._index.filenames; - const docNames = Search._index.docnames; - const titles = Search._index.titles; - const allTitles = Search._index.alltitles; - const indexEntries = Search._index.indexentries; - + _parseQuery: (query) => { // stem the search terms and add them to the correct list const stemmer = new Stemmer(); const searchTerms = new Set(); @@ -276,22 +312,40 @@ const Search = { // console.info("required: ", [...searchTerms]); // console.info("excluded: ", [...excludedTerms]); - // array of [docname, title, anchor, descr, score, filename] - let results = []; + return [query, searchTerms, excludedTerms, highlightTerms, objectTerms]; + }, + + /** + * execute search (requires search index to be loaded) + */ + _performSearch: (query, searchTerms, excludedTerms, highlightTerms, objectTerms) => { + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const titles = Search._index.titles; + const allTitles = Search._index.alltitles; + const indexEntries = Search._index.indexentries; + + // Collect multiple result groups to be sorted separately and then ordered. + // Each is an array of [docname, title, anchor, descr, score, filename, kind]. + const normalResults = []; + const nonMainIndexResults = []; + _removeChildren(document.getElementById("search-progress")); - const queryLower = query.toLowerCase(); + const queryLower = query.toLowerCase().trim(); for (const [title, foundTitles] of Object.entries(allTitles)) { - if (title.toLowerCase().includes(queryLower) && (queryLower.length >= title.length/2)) { + if (title.toLowerCase().trim().includes(queryLower) && (queryLower.length >= title.length/2)) { for (const [file, id] of foundTitles) { - let score = Math.round(100 * queryLower.length / title.length) - results.push([ + const score = Math.round(Scorer.title * queryLower.length / title.length); + const boost = titles[file] === title ? 1 : 0; // add a boost for document titles + normalResults.push([ docNames[file], titles[file] !== title ? `${titles[file]} > ${title}` : title, id !== null ? "#" + id : "", null, - score, + score + boost, filenames[file], + SearchResultKind.title, ]); } } @@ -300,46 +354,48 @@ const Search = { // search for explicit entries in index directives for (const [entry, foundEntries] of Object.entries(indexEntries)) { if (entry.includes(queryLower) && (queryLower.length >= entry.length/2)) { - for (const [file, id] of foundEntries) { - let score = Math.round(100 * queryLower.length / entry.length) - results.push([ + for (const [file, id, isMain] of foundEntries) { + const score = Math.round(100 * queryLower.length / entry.length); + const result = [ docNames[file], titles[file], id ? "#" + id : "", null, score, filenames[file], - ]); + SearchResultKind.index, + ]; + if (isMain) { + normalResults.push(result); + } else { + nonMainIndexResults.push(result); + } } } } // lookup as object objectTerms.forEach((term) => - results.push(...Search.performObjectSearch(term, objectTerms)) + normalResults.push(...Search.performObjectSearch(term, objectTerms)) ); // lookup as search terms in fulltext - results.push(...Search.performTermsSearch(searchTerms, excludedTerms)); + normalResults.push(...Search.performTermsSearch(searchTerms, excludedTerms)); // let the scorer override scores with a custom scoring function - if (Scorer.score) results.forEach((item) => (item[4] = Scorer.score(item))); - - // now sort the results by score (in opposite order of appearance, since the - // display function below uses pop() to retrieve items) and then - // alphabetically - results.sort((a, b) => { - const leftScore = a[4]; - const rightScore = b[4]; - if (leftScore === rightScore) { - // same score: sort alphabetically - const leftTitle = a[1].toLowerCase(); - const rightTitle = b[1].toLowerCase(); - if (leftTitle === rightTitle) return 0; - return leftTitle > rightTitle ? -1 : 1; // inverted is intentional - } - return leftScore > rightScore ? 1 : -1; - }); + if (Scorer.score) { + normalResults.forEach((item) => (item[4] = Scorer.score(item))); + nonMainIndexResults.forEach((item) => (item[4] = Scorer.score(item))); + } + + // Sort each group of results by score and then alphabetically by name. + normalResults.sort(_orderResultsByScoreThenName); + nonMainIndexResults.sort(_orderResultsByScoreThenName); + + // Combine the result groups in (reverse) order. + // Non-main index entries are typically arbitrary cross-references, + // so display them after other results. + let results = [...nonMainIndexResults, ...normalResults]; // remove duplicate search results // note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept @@ -353,14 +409,19 @@ const Search = { return acc; }, []); - results = results.reverse(); + return results.reverse(); + }, + + query: (query) => { + const [searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms] = Search._parseQuery(query); + const results = Search._performSearch(searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms); // for debugging //Search.lastresults = results.slice(); // a copy // console.info("search results:", Search.lastresults); // print the results - _displayNextItem(results, results.length, searchTerms); + _displayNextItem(results, results.length, searchTerms, highlightTerms); }, /** @@ -424,6 +485,7 @@ const Search = { descr, score, filenames[match[0]], + SearchResultKind.object, ]); }; Object.keys(objects).forEach((prefix) => @@ -458,14 +520,18 @@ const Search = { // add support for partial matches if (word.length > 2) { const escapedWord = _escapeRegExp(word); - Object.keys(terms).forEach((term) => { - if (term.match(escapedWord) && !terms[word]) - arr.push({ files: terms[term], score: Scorer.partialTerm }); - }); - Object.keys(titleTerms).forEach((term) => { - if (term.match(escapedWord) && !titleTerms[word]) - arr.push({ files: titleTerms[word], score: Scorer.partialTitle }); - }); + if (!terms.hasOwnProperty(word)) { + Object.keys(terms).forEach((term) => { + if (term.match(escapedWord)) + arr.push({ files: terms[term], score: Scorer.partialTerm }); + }); + } + if (!titleTerms.hasOwnProperty(word)) { + Object.keys(titleTerms).forEach((term) => { + if (term.match(escapedWord)) + arr.push({ files: titleTerms[term], score: Scorer.partialTitle }); + }); + } } // no match but word was a required one @@ -488,9 +554,8 @@ const Search = { // create the mapping files.forEach((file) => { - if (fileMap.has(file) && fileMap.get(file).indexOf(word) === -1) - fileMap.get(file).push(word); - else fileMap.set(file, [word]); + if (!fileMap.has(file)) fileMap.set(file, [word]); + else if (fileMap.get(file).indexOf(word) === -1) fileMap.get(file).push(word); }); }); @@ -531,6 +596,7 @@ const Search = { null, score, filenames[file], + SearchResultKind.text, ]); } return results; @@ -541,8 +607,8 @@ const Search = { * search summary for a given text. keywords is a list * of stemmed words. */ - makeSearchSummary: (htmlText, keywords) => { - const text = Search.htmlToText(htmlText); + makeSearchSummary: (htmlText, keywords, anchor) => { + const text = Search.htmlToText(htmlText, anchor); if (text === "") return null; const textLower = text.toLowerCase(); diff --git a/otfmi/master/_static/sphinx_highlight.js b/otfmi/master/_static/sphinx_highlight.js index aae669d7ea6..8a96c69a194 100644 --- a/otfmi/master/_static/sphinx_highlight.js +++ b/otfmi/master/_static/sphinx_highlight.js @@ -29,14 +29,19 @@ const _highlight = (node, addItems, text, className) => { } span.appendChild(document.createTextNode(val.substr(pos, text.length))); + const rest = document.createTextNode(val.substr(pos + text.length)); parent.insertBefore( span, parent.insertBefore( - document.createTextNode(val.substr(pos + text.length)), + rest, node.nextSibling ) ); node.nodeValue = val.substr(0, pos); + /* There may be more occurrences of search term in this node. So call this + * function recursively on the remaining fragment. + */ + _highlight(rest, addItems, text, className); if (isInSVG) { const rect = document.createElementNS( @@ -140,5 +145,10 @@ const SphinxHighlight = { }, }; -_ready(SphinxHighlight.highlightSearchWords); -_ready(SphinxHighlight.initEscapeListener); +_ready(() => { + /* Do not call highlightSearchWords() when we are on the search page. + * It will highlight words from the *previous* search query. + */ + if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords(); + SphinxHighlight.initEscapeListener(); +}); diff --git a/otfmi/master/api.html b/otfmi/master/api.html index 9abe3ec5276..47e11ae3a45 100644 --- a/otfmi/master/api.html +++ b/otfmi/master/api.html @@ -1,29 +1,30 @@ - + - + API documentation — otfmi documentation - - - - - - - - + + + + + + + + + + - - - - - - + + + + + @@ -122,20 +123,16 @@
-

API documentation

+

API documentation

Otfmi facilitates the analysis of FMUs at a given time step and/or over time (static versus dynamic analyses).

-

Static analysis

+

Static analysis

The class FMUFunction wraps the FMU in an openturns.Function. Its output corresponds to the FMU’s output at its last simulation time. When the FMU is static (i.e. its output is time-independent), the value of the last simulation time is indifferent.

__call__(X)

Call self as a function.

getInputDescription
---- @@ -144,10 +141,6 @@

Static analysis -

--- @@ -156,14 +149,10 @@

Static analysis -

Dynamic analysis

+

Dynamic analysis

The class FMUPointToFieldFunction wraps the FMU in an openturns.PointToFieldFunction. Its output is a openturns.Field gathering the outputs as function of time.

FMUFunction([path_fmu, inputs_fmu, ...])

Define a Function from a FMU file.

OpenTURNSFMUFunction(path_fmu[, inputs_fmu, ...])

Define a Function from a FMU file.
---- @@ -173,10 +162,6 @@

Dynamic analysis -

--- @@ -185,13 +170,9 @@

Dynamic analysis -

Common low-level functions

+

Common low-level functions

The submodule otfmi.fmi gathers a set of useful functions, employed by the (higher-level) classes mentionned above.

FMUPointToFieldFunction(mesh[, path_fmu, ...])

Define a PointToFieldFunction from a FMU file.

OpenTURNSFMUPointToFieldFunction(mesh, path_fmu)

Define a PointToFieldFunction from a FMU file.
---- @@ -227,13 +208,9 @@

Common low-level functions -

From OpenTURNS to FMI

+

From OpenTURNS to FMI

OTFMI can also export an OpenTURNS function in a Modelica source model (.mo) or Functional Mock-up Unit (.fmu).

fmi.load_fmu(path_fmu[, kind])

Load and FMU.
---- @@ -251,7 +228,7 @@

From OpenTURNS to FMI
-

© Copyright 2017-2020 EDF-Phimeca. +

© Copyright 2017-2023 EDF-Phimeca. Last updated on Dec 31, 2020.

diff --git a/otfmi/master/application/application.html b/otfmi/master/application/application.html index 5102d92958a..3d342a40fdc 100644 --- a/otfmi/master/application/application.html +++ b/otfmi/master/application/application.html @@ -1,29 +1,30 @@ - + - + Applications — otfmi documentation - - - - - - - - + + + + + + + + + + - - - - - - + + + + + @@ -97,7 +98,7 @@
-

Applications

+

Applications

Otfmi bridges the physics of the model (in FMI format) with the universe of OpenTURNS probabilistic analyses.

In the following applications, advanced computer experiments are performed on the FMUs.

@@ -118,7 +119,7 @@

Applications -

© Copyright 2017-2020 EDF-Phimeca. +

© Copyright 2017-2023 EDF-Phimeca. Last updated on Dec 31, 2020.

diff --git a/otfmi/master/auto_application/index.html b/otfmi/master/auto_application/index.html index 7118c480187..e0118f560de 100644 --- a/otfmi/master/auto_application/index.html +++ b/otfmi/master/auto_application/index.html @@ -1,29 +1,30 @@ - + - + <no title> — otfmi documentation - - - - - - - - + + + + + + + + + + - - - - - - + + + + + @@ -118,7 +119,7 @@
-

© Copyright 2017-2020 EDF-Phimeca. +

© Copyright 2017-2023 EDF-Phimeca. Last updated on Dec 31, 2020.

diff --git a/otfmi/master/auto_application/plot_cantilever_beam.html b/otfmi/master/auto_application/plot_cantilever_beam.html index 6e9376db31f..bd51b326368 100644 --- a/otfmi/master/auto_application/plot_cantilever_beam.html +++ b/otfmi/master/auto_application/plot_cantilever_beam.html @@ -1,29 +1,30 @@ - + - + Estimate the probability of a threshold excedance — otfmi documentation - - - - - - - - + + + + + + + + + + - - - - - - + + + + + @@ -104,11 +105,12 @@ to download the full example code.

-

Estimate the probability of a threshold excedance

+

Estimate the probability of a threshold excedance

A load is applied to a cantilever beam. For construction reasons, the beam must not exceed a bending of 30 cm. The load (F), beam Young’s modulus (E), length (L) and section modulus (I) are uncertain.

-alternate text +alternate text +

See the cantilever beam model here.

@@ -151,7 +153,7 @@

We assume that the random variables E, F, L and I are dependent and associated with a gaussian copula which correlation matrix:

-

\begin{pmatrix} +<p><img src=Total running time of the script: (0 minutes 3.791 seconds)

+

Total running time of the script: (0 minutes 3.718 seconds)

-plot dyn init

Total running time of the script: (0 minutes 0.168 seconds)

+plot dyn init

Total running time of the script: (0 minutes 0.169 seconds)

-

Total running time of the script: (0 minutes 0.064 seconds)

+

Total running time of the script: (0 minutes 0.063 seconds)

-

Total running time of the script: (0 minutes 0.057 seconds)

+

Total running time of the script: (0 minutes 0.056 seconds)
-

Load an FMU

+

Load an FMU

First, retrieve the path to the example FMU deviation.fmu.

import pyfmi
 import otfmi.example.utility
@@ -217,7 +218,7 @@
   

 
   

-    
© Copyright 2017-2020 EDF-Phimeca.
+    
© Copyright 2017-2023 EDF-Phimeca.
       Last updated on Dec 31, 2020.
       

   

diff --git a/otfmi/master/auto_example/low_level/plot_simulate.html b/otfmi/master/auto_example/low_level/plot_simulate.html
index 94060da5638..3e964d441b7 100644
--- a/otfmi/master/auto_example/low_level/plot_simulate.html
+++ b/otfmi/master/auto_example/low_level/plot_simulate.html
@@ -1,29 +1,30 @@
 
-
+
 
-  
+  
 
   
   Simulate an FMU — otfmi  documentation
-      
-      
-      
-      
-      
-      
-      
-      
+      
+      
+      
+      
+      
+      
+      
+      
+
+  
     
   
   
-        
-        
-        
-        
-        
-        
+        
+        
+        
+        
+        
     
     
     
@@ -112,7 +113,7 @@
 to download the full example code.
-

Simulate an FMU

+

Simulate an FMU

The Otfmi simulate function instanciates, initializes and simulates the FMU.

First, retrieve and load the FMU deviation.fmu.

@@ -146,7 +147,7 @@ 
Simulation interval    : 0 - 1.0 seconds.
-Elapsed simulation time: 0.011963037000043641 seconds.
+Elapsed simulation time: 0.011409133000029215 seconds.
 y = 22.5
@@ -166,25 +167,25 @@ plot simulate
Simulation interval    : 0.0 - 1.0 seconds.
-Elapsed simulation time: 0.011800311999991209 seconds.
+Elapsed simulation time: 0.011713799999995445 seconds.
 Simulation interval    : 0.0 - 1.0 seconds.
-Elapsed simulation time: 0.011737203999985013 seconds.
+Elapsed simulation time: 0.011339383000006364 seconds.
 Simulation interval    : 0.0 - 1.0 seconds.
-Elapsed simulation time: 0.011603782999998202 seconds.
+Elapsed simulation time: 0.011396659000013187 seconds.
 Simulation interval    : 0.0 - 1.0 seconds.
-Elapsed simulation time: 0.011774081999988084 seconds.
+Elapsed simulation time: 0.011423528999955579 seconds.
 Simulation interval    : 0.0 - 1.0 seconds.
-Elapsed simulation time: 0.011647925999966446 seconds.
+Elapsed simulation time: 0.011411737000003086 seconds.
 Simulation interval    : 0.0 - 1.0 seconds.
-Elapsed simulation time: 0.011724299000036353 seconds.
+Elapsed simulation time: 0.011422046000006958 seconds.
 Simulation interval    : 0.0 - 1.0 seconds.
-Elapsed simulation time: 0.011699973999952817 seconds.
+Elapsed simulation time: 0.011402511000028426 seconds.
 Simulation interval    : 0.0 - 1.0 seconds.
-Elapsed simulation time: 0.011741020999977536 seconds.
+Elapsed simulation time: 0.011396627999999964 seconds.
 Simulation interval    : 0.0 - 1.0 seconds.
-Elapsed simulation time: 0.011759734999998273 seconds.
+Elapsed simulation time: 0.01136045200001945 seconds.
 Simulation interval    : 0.0 - 1.0 seconds.
-Elapsed simulation time: 0.011609414000020024 seconds.
+Elapsed simulation time: 0.011462139999991905 seconds.
@@ -192,7 +193,7 @@
- avoid the for loop on the points of the design of experiment,
- automatic formatting of the simulation outputs.
-

Total running time of the script: (0 minutes 0.220 seconds)

+

Total running time of the script: (0 minutes 0.216 seconds)

-
/tmp/tmpjblz1gad/myExponential.fmu
+
/tmp/tmp070ao6p4/myExponential.fmu
 

 

 
We export the OpenTURNS function as a Model Exchange FMU.
@@ -179,20 +180,22 @@ 
FMU generation
 

-
FMU validation

+
FMU validation

 
We import the in OpenModelica GUI. We connect the wrapper to an input sine signal
 (Modelica.Blocks.Sources.Sine) and to an output block (Modelica.Blocks.Interfaces.RealOutput):

-alternate text
+alternate text
+
 
We simulate the model on 1 second, with 50 time steps. We can verify that y
 output corresponds to the exponential of the sine signal.

-alternate text
+alternate text
+
 

 
Warning

 
Compared to native Modelica functions, the included OpenTURNS function is
 slow. Using the FMU, 11 seconds of simulation were required for 50 time
 steps (i.e. 50 function calls).

 

-
Total running time of the script: (0 minutes 5.204 seconds)

+
Total running time of the script: (0 minutes 5.051 seconds)

 
 

-
Export a function as Modelica model

+
Export a function as Modelica model

 
otfmi.FunctionExporter enables to export OpenTURNS functions as Modelica model.
 The main interest is to use OpenTURNS metamodels in a simulation environment.

 
Currently, the inclusion of a metamodel in
@@ -123,7 +124,7 @@
 this paper).

 

 

-
Model generation

+
Model generation

 
First, we create the OpenTURNS function to export as Modelica model.

 
import openturns as ot
 import otfmi
@@ -146,7 +147,7 @@ 
Model generationprint(model_path)
 

 

-
/tmp/tmp3jdc8qem/myExponential.mo
+
/tmp/tmp2sx2t5ua/myExponential.mo
 

 

 
We create the FunctionExporter instance and export the exponential function.
@@ -169,22 +170,26 @@ 
Model generation
 

-
Model validation

+
Model validation

 
We import this model in OpenModelica GUI. We can check the Modelica code:

-alternate text
+alternate text
+
 

 
Note

 
The path to the C-wrapper is hard-coded in the model.

 

 
We can also check the connectors position:

-alternate text
+alternate text
+
 
We connect the wrapper to an input sine signal
 (Modelica.Blocks.Sources.Sine) and to an output block
 (Modelica.Blocks.Interfaces.RealOutput):

-alternate text
+alternate text
+
 
We simulate the model on 1 second, with 50 time steps. We can verify that y
 output corresponds to the exponential of the sine signal.

-alternate text
+alternate text
+
 

 
Warning

 
⚠️ Compared to native Modelica functions, the included OpenTURNS function is
@@ -192,7 +197,7 @@ 
Model validationTotal running time of the script: (0 minutes 0.383 seconds)

+
Total running time of the script: (0 minutes 0.374 seconds)

 
 

-
FMUFunction basics

+
FMUFunction basics

 
FMUFunction enables to use OpenTURNS’ high
 level algorithms by wrapping the FMU into an openturns.Function object.

 

@@ -178,7 +179,7 @@
   

 
   

-    
© Copyright 2017-2020 EDF-Phimeca.
+    
© Copyright 2017-2023 EDF-Phimeca.
       Last updated on Dec 31, 2020.
       

   

diff --git a/otfmi/master/auto_example/static/plot_init.html b/otfmi/master/auto_example/static/plot_init.html
index 8504882fd62..16cd05aa820 100644
--- a/otfmi/master/auto_example/static/plot_init.html
+++ b/otfmi/master/auto_example/static/plot_init.html
@@ -1,29 +1,30 @@
 
-
+
 
-  
+  
 
   
   Initialize FMUFunction — otfmi  documentation
-      
-      
-      
-      
-      
-      
-      
-      
+      
+      
+      
+      
+      
+      
+      
+      
+
+  
     
   
   
-        
-        
-        
-        
-        
-        
+        
+        
+        
+        
+        
     
     
     
@@ -111,7 +112,7 @@
 to download the full example code.

 

 

-
Initialize FMUFunction

+
Initialize FMUFunction

 
The interest of using FMUs in Python lies in the ease to change its input
 / parameter values. This notably enables to study the behavior of the FMU
 with uncertain inputs / parameters.

@@ -207,7 +208,7 @@
 view.ShowAll()
 

 

-y PDF
Total running time of the script: (0 minutes 0.264 seconds)

+y PDF
Total running time of the script: (0 minutes 0.260 seconds)

 
-
Total running time of the script: (0 minutes 0.078 seconds)

+
Total running time of the script: (0 minutes 0.079 seconds)

FunctionExporter(function[, start])

Fonction export.