From 68eadcd1817966f88111fd21b50adb9aaa36a400 Mon Sep 17 00:00:00 2001 From: Christoph Lehmann <christoph.lehmann@ufz.de> Date: Thu, 8 Aug 2024 15:15:43 +0200 Subject: [PATCH] [doc] Added documentation for new prj file setting --- .../MFront/library/a_path_is_relative_to_prj_file.md | 5 +++++ .../solid/constitutive_relation/MFront/library/i_library.md | 3 +++ .../material/solid/constitutive_relation/MFront/t_library.md | 3 --- 3 files changed, 8 insertions(+), 3 deletions(-) create mode 100644 Documentation/ProjectFile/material/solid/constitutive_relation/MFront/library/a_path_is_relative_to_prj_file.md create mode 100644 Documentation/ProjectFile/material/solid/constitutive_relation/MFront/library/i_library.md delete mode 100644 Documentation/ProjectFile/material/solid/constitutive_relation/MFront/t_library.md diff --git a/Documentation/ProjectFile/material/solid/constitutive_relation/MFront/library/a_path_is_relative_to_prj_file.md b/Documentation/ProjectFile/material/solid/constitutive_relation/MFront/library/a_path_is_relative_to_prj_file.md new file mode 100644 index 00000000000..b8e64afb9bd --- /dev/null +++ b/Documentation/ProjectFile/material/solid/constitutive_relation/MFront/library/a_path_is_relative_to_prj_file.md @@ -0,0 +1,5 @@ +This setting modifies where the shared library containing the MFront behaviour will be looked for. + +The default setting of `true` should work for almost all use cases. `false` is used for some special tests in OGS's test suite. + +See also the documentation of the \ref ogs_file_param__material__solid__constitutive_relation__MFront__library "<code><library></code>" tag. diff --git a/Documentation/ProjectFile/material/solid/constitutive_relation/MFront/library/i_library.md b/Documentation/ProjectFile/material/solid/constitutive_relation/MFront/library/i_library.md new file mode 100644 index 00000000000..a4b2d88090f --- /dev/null +++ b/Documentation/ProjectFile/material/solid/constitutive_relation/MFront/library/i_library.md @@ -0,0 +1,3 @@ +Path of the shared library containing the material model. + +Relative paths are interpreted relative to the project directory unless \ref ogs_file_attr__material__solid__constitutive_relation__MFront__library__path_is_relative_to_prj_file "<code>path_is_relative_to_prj_file</code>" is set to `false`, in which case the library path/name is used verbatim and will be searched based on the operating system's library lookup rules. diff --git a/Documentation/ProjectFile/material/solid/constitutive_relation/MFront/t_library.md b/Documentation/ProjectFile/material/solid/constitutive_relation/MFront/t_library.md deleted file mode 100644 index 5e87a14f113..00000000000 --- a/Documentation/ProjectFile/material/solid/constitutive_relation/MFront/t_library.md +++ /dev/null @@ -1,3 +0,0 @@ -Path of the shared library containing the material model. - -Relative paths are interpreted relative to the project directory. -- GitLab