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 cc2721738f63d5796b3233579f5a97760f3f8507..0000000000000000000000000000000000000000 --- 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 b8886c8623f3ce72d8e2b8e4e3fff3856546d6b1..0000000000000000000000000000000000000000 --- 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 731c3267827f90ec1dc97888000bf3cca46f6bac..ec9c46386ba7c3e97c45e18c293f4c9cf43cbedf 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 0acf5a373fc676aeaf56ca372dd41ae8caaa87a8..08f0a45f6054a9509c2ef0e428055c9bec17774b 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."); }