From 37bc65dd3690c524cc533c4bb4666792dff9f17e Mon Sep 17 00:00:00 2001
From: Dmitri Naumov <github@naumov.de>
Date: Sat, 30 Jun 2018 13:03:32 +0200
Subject: [PATCH] [doc] Add <meshes>/<mesh> tags descriptions.
---
Applications/ApplicationsLib/ProjectData.cpp | 5 +++++
Documentation/ProjectFile/prj/meshes/i_meshes.md | 1 +
.../prj/meshes/mesh/a_axially_symmetric.md | 1 +
.../ProjectFile/prj/meshes/mesh/i_mesh.md | 1 +
.../NonuniformDirichlet/t_mesh.md | 8 --------
.../boundary_condition/NonuniformNeumann/t_mesh.md | 8 --------
.../boundary_condition/t_mesh.md | 10 ++++++++++
.../source_terms/source_term/t_mesh.md | 10 ++++++++++
.../process_variables/process_variable/t_mesh.md | 1 +
ProcessLib/ProcessVariable.cpp | 14 ++++++++++++++
10 files changed, 43 insertions(+), 16 deletions(-)
create mode 100644 Documentation/ProjectFile/prj/meshes/i_meshes.md
create mode 100644 Documentation/ProjectFile/prj/meshes/mesh/a_axially_symmetric.md
create mode 100644 Documentation/ProjectFile/prj/meshes/mesh/i_mesh.md
delete mode 100644 Documentation/ProjectFile/prj/process_variables/process_variable/boundary_conditions/boundary_condition/NonuniformDirichlet/t_mesh.md
delete mode 100644 Documentation/ProjectFile/prj/process_variables/process_variable/boundary_conditions/boundary_condition/NonuniformNeumann/t_mesh.md
create mode 100644 Documentation/ProjectFile/prj/process_variables/process_variable/boundary_conditions/boundary_condition/t_mesh.md
create mode 100644 Documentation/ProjectFile/prj/process_variables/process_variable/source_terms/source_term/t_mesh.md
create mode 100644 Documentation/ProjectFile/prj/process_variables/process_variable/t_mesh.md
diff --git a/Applications/ApplicationsLib/ProjectData.cpp b/Applications/ApplicationsLib/ProjectData.cpp
index 8c02236fc3a..8d2a41815e4 100644
--- a/Applications/ApplicationsLib/ProjectData.cpp
+++ b/Applications/ApplicationsLib/ProjectData.cpp
@@ -122,6 +122,11 @@ std::unique_ptr<MeshLib::Mesh> readSingleMesh(
mesh_file.c_str());
}
+#ifdef DOXYGEN_DOCU_ONLY
+ //! \ogs_file_attr{prj__meshes__mesh__axially_symmetric}
+ mesh_config_parameter.getConfigAttributeOptional<bool>("axially_symmetric");
+#endif // DOXYGEN_DOCU_ONLY
+
if (auto const axially_symmetric =
//! \ogs_file_attr{prj__mesh__axially_symmetric}
mesh_config_parameter.getConfigAttributeOptional<bool>(
diff --git a/Documentation/ProjectFile/prj/meshes/i_meshes.md b/Documentation/ProjectFile/prj/meshes/i_meshes.md
new file mode 100644
index 00000000000..83466e46826
--- /dev/null
+++ b/Documentation/ProjectFile/prj/meshes/i_meshes.md
@@ -0,0 +1 @@
+External mesh file names for the process variables and the boundary conditions.
diff --git a/Documentation/ProjectFile/prj/meshes/mesh/a_axially_symmetric.md b/Documentation/ProjectFile/prj/meshes/mesh/a_axially_symmetric.md
new file mode 100644
index 00000000000..576add64edc
--- /dev/null
+++ b/Documentation/ProjectFile/prj/meshes/mesh/a_axially_symmetric.md
@@ -0,0 +1 @@
+\ogs_missing_documentation
diff --git a/Documentation/ProjectFile/prj/meshes/mesh/i_mesh.md b/Documentation/ProjectFile/prj/meshes/mesh/i_mesh.md
new file mode 100644
index 00000000000..11ed78b9ec0
--- /dev/null
+++ b/Documentation/ProjectFile/prj/meshes/mesh/i_mesh.md
@@ -0,0 +1 @@
+Information about input mesh.
diff --git a/Documentation/ProjectFile/prj/process_variables/process_variable/boundary_conditions/boundary_condition/NonuniformDirichlet/t_mesh.md b/Documentation/ProjectFile/prj/process_variables/process_variable/boundary_conditions/boundary_condition/NonuniformDirichlet/t_mesh.md
deleted file mode 100644
index b448b3494b3..00000000000
--- a/Documentation/ProjectFile/prj/process_variables/process_variable/boundary_conditions/boundary_condition/NonuniformDirichlet/t_mesh.md
+++ /dev/null
@@ -1,8 +0,0 @@
-Path to the surface mesh vtu file.
-
-The surface mesh must contain a nodal integer-valued field (unsigned 64bit)
-named \c OriginalSubsurfaceNodeIDs. That field establishes the mapping between
-the nodes of the surface mesh to some notes in the bulk mesh.
-\warning It is not checked if the surface mesh and the bulk mesh correspond to each
-other; in particular it is not checked if surface and bulk nodes coincide and if
-surface elements coincide with the faces of bulk elements.
diff --git a/Documentation/ProjectFile/prj/process_variables/process_variable/boundary_conditions/boundary_condition/NonuniformNeumann/t_mesh.md b/Documentation/ProjectFile/prj/process_variables/process_variable/boundary_conditions/boundary_condition/NonuniformNeumann/t_mesh.md
deleted file mode 100644
index b448b3494b3..00000000000
--- a/Documentation/ProjectFile/prj/process_variables/process_variable/boundary_conditions/boundary_condition/NonuniformNeumann/t_mesh.md
+++ /dev/null
@@ -1,8 +0,0 @@
-Path to the surface mesh vtu file.
-
-The surface mesh must contain a nodal integer-valued field (unsigned 64bit)
-named \c OriginalSubsurfaceNodeIDs. That field establishes the mapping between
-the nodes of the surface mesh to some notes in the bulk mesh.
-\warning It is not checked if the surface mesh and the bulk mesh correspond to each
-other; in particular it is not checked if surface and bulk nodes coincide and if
-surface elements coincide with the faces of bulk elements.
diff --git a/Documentation/ProjectFile/prj/process_variables/process_variable/boundary_conditions/boundary_condition/t_mesh.md b/Documentation/ProjectFile/prj/process_variables/process_variable/boundary_conditions/boundary_condition/t_mesh.md
new file mode 100644
index 00000000000..4a4b6835fe9
--- /dev/null
+++ b/Documentation/ProjectFile/prj/process_variables/process_variable/boundary_conditions/boundary_condition/t_mesh.md
@@ -0,0 +1,10 @@
+Name of the surface mesh where the boundary condition will be defined.
+
+The surface mesh must contain a nodal integer-valued field (unsigned 64bit)
+named \c bulk_node_ids, and a cell field named \c bulk_element_ids. These fields
+establish the mapping between the nodes of the surface mesh to the nodes in the
+bulk mesh.
+
+\warning It is not checked if the surface mesh and the bulk mesh
+correspond to each other; in particular it is not checked if surface and bulk
+nodes coincide and if surface elements coincide with the faces of bulk elements.
diff --git a/Documentation/ProjectFile/prj/process_variables/process_variable/source_terms/source_term/t_mesh.md b/Documentation/ProjectFile/prj/process_variables/process_variable/source_terms/source_term/t_mesh.md
new file mode 100644
index 00000000000..e43f1eb6a0a
--- /dev/null
+++ b/Documentation/ProjectFile/prj/process_variables/process_variable/source_terms/source_term/t_mesh.md
@@ -0,0 +1,10 @@
+Name of the mesh where the source term will be applied.
+
+The surface mesh must contain a nodal integer-valued field (unsigned 64bit)
+named \c bulk_node_ids, and a cell field named \c bulk_element_ids. These fields
+establish the mapping between the nodes of the surface mesh to the nodes in the
+bulk mesh.
+
+\warning It is not checked if the surface mesh and the bulk mesh
+correspond to each other; in particular it is not checked if surface and bulk
+nodes coincide and if surface elements coincide with the faces of bulk elements.
diff --git a/Documentation/ProjectFile/prj/process_variables/process_variable/t_mesh.md b/Documentation/ProjectFile/prj/process_variables/process_variable/t_mesh.md
new file mode 100644
index 00000000000..591ede39bca
--- /dev/null
+++ b/Documentation/ProjectFile/prj/process_variables/process_variable/t_mesh.md
@@ -0,0 +1 @@
+A mesh name for the process variable's domain of definition.
diff --git a/ProcessLib/ProcessVariable.cpp b/ProcessLib/ProcessVariable.cpp
index 679261b1f92..7525dfe08b9 100644
--- a/ProcessLib/ProcessVariable.cpp
+++ b/ProcessLib/ProcessVariable.cpp
@@ -30,6 +30,12 @@ MeshLib::Mesh const& findMeshInConfig(
//
std::string mesh_name; // Either given directly in <mesh> or constructed
// from <geometrical_set>_<geometry>.
+
+#ifdef DOXYGEN_DOCU_ONLY
+ //! \ogs_file_param{prj__process_variables__process_variable__source_terms__source_term__mesh}
+ config.getConfigParameterOptional<std::string>("mesh");
+#endif // DOXYGEN_DOCU_ONLY
+
auto optional_mesh_name =
//! \ogs_file_param{prj__process_variables__process_variable__boundary_conditions__boundary_condition__mesh}
config.getConfigParameterOptional<std::string>("mesh");
@@ -40,6 +46,14 @@ MeshLib::Mesh const& findMeshInConfig(
else
{
// Looking for the mesh created before for the given geometry.
+
+#ifdef DOXYGEN_DOCU_ONLY
+ //! \ogs_file_param{prj__process_variables__process_variable__source_terms__source_term__geometrical_set}
+ config.getConfigParameterOptional<std::string>("geometrical_set");
+ //! \ogs_file_param{prj__process_variables__process_variable__source_terms__source_term__geometry}
+ config.getConfigParameter<std::string>("geometry");
+#endif // DOXYGEN_DOCU_ONLY
+
auto const geometrical_set_name =
//! \ogs_file_param{prj__process_variables__process_variable__boundary_conditions__boundary_condition__geometrical_set}
config.getConfigParameter<std::string>("geometrical_set");
--
GitLab