From 24d8bcc56913f0c211e8b82173308a5849e7c12b Mon Sep 17 00:00:00 2001 From: renchao_lu <renchao.lu@gmail.com> Date: Sun, 30 May 2021 18:43:54 +0200 Subject: [PATCH] [Docu] add parameter documentation. --- .../prj/processes/process/StokesFlow/c_StokesFlow.md | 1 + .../process/StokesFlow/process_variables/i_process_variables.md | 1 + .../process/StokesFlow/process_variables/t_liquid_velocity.md | 1 + .../process/StokesFlow/process_variables/t_pressure.md | 1 + .../prj/processes/process/StokesFlow/t_coupling_scheme.md | 2 ++ .../prj/processes/process/StokesFlow/t_specific_body_force.md | 1 + 6 files changed, 7 insertions(+) create mode 100644 Documentation/ProjectFile/prj/processes/process/StokesFlow/c_StokesFlow.md create mode 100644 Documentation/ProjectFile/prj/processes/process/StokesFlow/process_variables/i_process_variables.md create mode 100644 Documentation/ProjectFile/prj/processes/process/StokesFlow/process_variables/t_liquid_velocity.md create mode 100644 Documentation/ProjectFile/prj/processes/process/StokesFlow/process_variables/t_pressure.md create mode 100644 Documentation/ProjectFile/prj/processes/process/StokesFlow/t_coupling_scheme.md create mode 100644 Documentation/ProjectFile/prj/processes/process/StokesFlow/t_specific_body_force.md diff --git a/Documentation/ProjectFile/prj/processes/process/StokesFlow/c_StokesFlow.md b/Documentation/ProjectFile/prj/processes/process/StokesFlow/c_StokesFlow.md new file mode 100644 index 00000000000..4f08146ce50 --- /dev/null +++ b/Documentation/ProjectFile/prj/processes/process/StokesFlow/c_StokesFlow.md @@ -0,0 +1 @@ +\copydoc ProcessLib::StokesFlow::StokesFlowProcess diff --git a/Documentation/ProjectFile/prj/processes/process/StokesFlow/process_variables/i_process_variables.md b/Documentation/ProjectFile/prj/processes/process/StokesFlow/process_variables/i_process_variables.md new file mode 100644 index 00000000000..8d1fb69af07 --- /dev/null +++ b/Documentation/ProjectFile/prj/processes/process/StokesFlow/process_variables/i_process_variables.md @@ -0,0 +1 @@ +List of process variable tags which specify the unknown variables of the Stokes equations being solved. diff --git a/Documentation/ProjectFile/prj/processes/process/StokesFlow/process_variables/t_liquid_velocity.md b/Documentation/ProjectFile/prj/processes/process/StokesFlow/process_variables/t_liquid_velocity.md new file mode 100644 index 00000000000..4551242ecd2 --- /dev/null +++ b/Documentation/ProjectFile/prj/processes/process/StokesFlow/process_variables/t_liquid_velocity.md @@ -0,0 +1 @@ +Process variable name for liquid velocity. diff --git a/Documentation/ProjectFile/prj/processes/process/StokesFlow/process_variables/t_pressure.md b/Documentation/ProjectFile/prj/processes/process/StokesFlow/process_variables/t_pressure.md new file mode 100644 index 00000000000..a2938dfe64e --- /dev/null +++ b/Documentation/ProjectFile/prj/processes/process/StokesFlow/process_variables/t_pressure.md @@ -0,0 +1 @@ +Process variable name for hydraulic pressure. diff --git a/Documentation/ProjectFile/prj/processes/process/StokesFlow/t_coupling_scheme.md b/Documentation/ProjectFile/prj/processes/process/StokesFlow/t_coupling_scheme.md new file mode 100644 index 00000000000..0a7b9eca1e5 --- /dev/null +++ b/Documentation/ProjectFile/prj/processes/process/StokesFlow/t_coupling_scheme.md @@ -0,0 +1,2 @@ +An optional input to select the coupling scheme. So far, only the monolithic +scheme is available for the stokes flow simulation, and this input can be omitted. diff --git a/Documentation/ProjectFile/prj/processes/process/StokesFlow/t_specific_body_force.md b/Documentation/ProjectFile/prj/processes/process/StokesFlow/t_specific_body_force.md new file mode 100644 index 00000000000..a5f80cbbd42 --- /dev/null +++ b/Documentation/ProjectFile/prj/processes/process/StokesFlow/t_specific_body_force.md @@ -0,0 +1 @@ +\copydoc ProcessLib::StokesFlow::StokesFlowProcessData::specific_body_force -- GitLab