From eaccdcabc16d8563d0e4a2211b8028f28adf0ad0 Mon Sep 17 00:00:00 2001
From: Thomas Fischer <thomas.fischer@ufz.de>
Date: Fri, 11 Dec 2020 09:42:11 +0100
Subject: [PATCH] [Docu] Fix doxygen warnings.
---
.../process_variable/source_terms/source_term/Line/c_Line.md | 1 -
.../source_terms/source_term/Line/t_parameter.md | 4 ----
.../source_terms/source_term/Volumetric/c_Volumetric.md | 3 ++-
ProcessLib/SourceTerms/CreateVolumetricSourceTerm.cpp | 2 ++
4 files changed, 4 insertions(+), 6 deletions(-)
delete mode 100644 Documentation/ProjectFile/prj/process_variables/process_variable/source_terms/source_term/Line/c_Line.md
delete mode 100644 Documentation/ProjectFile/prj/process_variables/process_variable/source_terms/source_term/Line/t_parameter.md
diff --git a/Documentation/ProjectFile/prj/process_variables/process_variable/source_terms/source_term/Line/c_Line.md b/Documentation/ProjectFile/prj/process_variables/process_variable/source_terms/source_term/Line/c_Line.md
deleted file mode 100644
index cc2721738f6..00000000000
--- a/Documentation/ProjectFile/prj/process_variables/process_variable/source_terms/source_term/Line/c_Line.md
+++ /dev/null
@@ -1 +0,0 @@
-Declares a source term that is defined on a line shaped domain.
diff --git a/Documentation/ProjectFile/prj/process_variables/process_variable/source_terms/source_term/Line/t_parameter.md b/Documentation/ProjectFile/prj/process_variables/process_variable/source_terms/source_term/Line/t_parameter.md
deleted file mode 100644
index b8886c8623f..00000000000
--- a/Documentation/ProjectFile/prj/process_variables/process_variable/source_terms/source_term/Line/t_parameter.md
+++ /dev/null
@@ -1,4 +0,0 @@
-The name of the parameter that defines the value that should be used for the source
-term. The parameter have to defined on the line domain.
-
-The user should carefully check which physical quantity that parameter is.
diff --git a/Documentation/ProjectFile/prj/process_variables/process_variable/source_terms/source_term/Volumetric/c_Volumetric.md b/Documentation/ProjectFile/prj/process_variables/process_variable/source_terms/source_term/Volumetric/c_Volumetric.md
index 731c3267827..ec9c46386ba 100644
--- a/Documentation/ProjectFile/prj/process_variables/process_variable/source_terms/source_term/Volumetric/c_Volumetric.md
+++ b/Documentation/ProjectFile/prj/process_variables/process_variable/source_terms/source_term/Volumetric/c_Volumetric.md
@@ -1,3 +1,4 @@
-Declares a source term that is defined on the entire domain.
+Declares a source term that is defined on a sub-domain (volumetric) with the
+same dimensionality d or on a 1d (line mesh) sub-domain.
The user should carefully check which physical quantity that parameter is.
diff --git a/ProcessLib/SourceTerms/CreateVolumetricSourceTerm.cpp b/ProcessLib/SourceTerms/CreateVolumetricSourceTerm.cpp
index 0acf5a373fc..08f0a45f605 100644
--- a/ProcessLib/SourceTerms/CreateVolumetricSourceTerm.cpp
+++ b/ProcessLib/SourceTerms/CreateVolumetricSourceTerm.cpp
@@ -30,11 +30,13 @@ std::unique_ptr<SourceTerm> createVolumetricSourceTerm(
auto const type = config.peekConfigParameter<std::string>("type");
if (type == "Line")
{
+ //! \ogs_file_param{prj__process_variables__process_variable__source_terms__source_term__type}
config.checkConfigParameter("type", "Line");
DBUG("Constructing LineSourceTerm from config.");
}
else
{
+ //! \ogs_file_param{prj__process_variables__process_variable__source_terms__source_term__type}
config.checkConfigParameter("type", "Volumetric");
DBUG("Constructing VolumetricSourceTerm from config.");
}
--
GitLab