' + + '' + + _("Hide Search Matches") + + "
" + ) + ); + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords: () => { + document + .querySelectorAll("#searchbox .highlight-link") + .forEach((el) => el.remove()); + document + .querySelectorAll("span.highlighted") + .forEach((el) => el.classList.remove("highlighted")); + localStorage.removeItem("sphinx_highlight_terms") + }, + + initEscapeListener: () => { + // only install a listener if it is really needed + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return; + if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) { + SphinxHighlight.hideSearchWords(); + event.preventDefault(); + } + }); + }, +}; + +_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/docs/api/iapws.html b/docs/api/iapws.html new file mode 100644 index 0000000..83f0d1b --- /dev/null +++ b/docs/api/iapws.html @@ -0,0 +1,158 @@ + + + + + + + +iapws.h: Main C header for the whole library.
/**
+ * @file iapws.h
+ * @brief Main C header for the IAPWS library.
+ */
+#ifndef IAPWS_H
+#define IAPWS_H
+#include "iapws_version.h"
+#include "iapws_g704.h"
+#include "iapws_r283.h"
+#endif
+
iapws_r283.h: C header.
/**
+ * @file iapws_r283.h
+ * @brief C header for the module iapws_r283.
+ */
+
+#ifndef IAPWS_R283_H
+#define IAPWS_R283_H
+
+#if _MSC_VER
+#define ADD_IMPORT __declspec(dllimport)
+#else
+#define ADD_IMPORT
+#endif
+
+ADD_IMPORT extern const double iapws_r283_capi_Tc_H2O;
+ADD_IMPORT extern const double iapws_r283_capi_Tc_D2O;
+
+ADD_IMPORT extern const double iapws_r283_capi_pc_H2O;
+ADD_IMPORT extern const double iapws_r283_capi_pc_D2O;
+
+ADD_IMPORT extern const double iapws_r283_capi_rhoc_H2O;
+ADD_IMPORT extern const double iapws_r283_capi_rhoc_D2O;
+
+#endif
+
iapws_g704.h: C header.
/**
+ * @file iapws_g704.h
+ * @brief C header for the module iapws_g704.
+ */
+
+#ifndef IAPWS_G704_H
+#define IAPWS_G704_H
+
+extern void iapws_g704_capi_kh(double *T, char *gas, int heavywater, double *k, int size_gas, size_t size_T);
+extern void iapws_g704_capi_kd(double *T, char *gas, int heavywater, double *k, int size_gas, size_t size_T);
+extern int iapws_g704_capi_ngases(int heavywater);
+extern char **iapws_g704_capi_gases(int heavywater);
+extern char *iapws_g704_capi_gases2(int heavywater);
+
+#endif
+
C extension wrapping the iapws_r283 module of the Fortran iapws library.
+The constants are defined as in the C header without +the prefix iapws_r283_capi_.
+C extension wrapping the iapws_g704 module of the Fortran iapws library.
+gases(heavywater: bool) –> tuple
+Get the available gases.
+gases(heavywater: bool) –> str
+Get the available gases as a string.
+kd(T: array, gas, heavywater: bool) –> mview
+Get the vapor-liquid constant for gas in H2O or D2O for T. If gas not found returns NaNs
+kh(T: array, gas: str, heavywater :bool) –> mview
+Get the Henry constant for gas in H2O or D2O for T. If gas not found returns NaNs
+gases(heavywater: bool) –> int
+Get the number of available gases.
+This is the documentation of the Fortran code.
+Go back to the main documentation click here
+File | Description |
---|---|
iapws.f90 | |
iapws_g704.f90 | |
iapws_g704_capi.f90 | |
iapws_r283.f90 | |
iapws_r283_capi.f90 | |
iapws_r797.f90 | |
iapws_version.f90 | |
iapws_version_capi.f90 |