From 22264acdc0d9617fd7bf110e42fa5fd27f0dbff8 Mon Sep 17 00:00:00 2001 From: "Dmitry Yu. Naumov" <github@naumov.de> Date: Mon, 20 Aug 2018 16:58:30 +0200 Subject: [PATCH] [doc] RichardsMechanics prj tag docu. --- .../process/RICHARDS_MECHANICS/c_RICHARDS_MECHANICS.md | 1 + .../processes/process/RICHARDS_MECHANICS/constitutive_relation | 1 + .../process_variables/i_process_variables.md | 2 ++ .../RICHARDS_MECHANICS/process_variables/t_displacement.md | 1 + .../process/RICHARDS_MECHANICS/process_variables/t_pressure.md | 1 + .../processes/process/RICHARDS_MECHANICS/t_biot_coefficient.md | 1 + .../processes/process/RICHARDS_MECHANICS/t_coupling_scheme.md | 2 ++ .../prj/processes/process/RICHARDS_MECHANICS/t_dimension.md | 1 + .../process/RICHARDS_MECHANICS/t_fluid_bulk_modulus.md | 1 + .../process/RICHARDS_MECHANICS/t_intrinsic_permeability.md | 1 + .../process/RICHARDS_MECHANICS/t_material_property.md | 3 +++ .../process/RICHARDS_MECHANICS/t_solid_bulk_modulus.md | 1 + .../processes/process/RICHARDS_MECHANICS/t_solid_density.md | 1 + .../process/RICHARDS_MECHANICS/t_specific_body_force.md | 1 + .../prj/processes/process/RICHARDS_MECHANICS/t_temperature.md | 1 + 15 files changed, 19 insertions(+) create mode 100644 Documentation/ProjectFile/prj/processes/process/RICHARDS_MECHANICS/c_RICHARDS_MECHANICS.md create mode 120000 Documentation/ProjectFile/prj/processes/process/RICHARDS_MECHANICS/constitutive_relation create mode 100644 Documentation/ProjectFile/prj/processes/process/RICHARDS_MECHANICS/process_variables/i_process_variables.md create mode 100644 Documentation/ProjectFile/prj/processes/process/RICHARDS_MECHANICS/process_variables/t_displacement.md create mode 100644 Documentation/ProjectFile/prj/processes/process/RICHARDS_MECHANICS/process_variables/t_pressure.md create mode 100644 Documentation/ProjectFile/prj/processes/process/RICHARDS_MECHANICS/t_biot_coefficient.md create mode 100644 Documentation/ProjectFile/prj/processes/process/RICHARDS_MECHANICS/t_coupling_scheme.md create mode 100644 Documentation/ProjectFile/prj/processes/process/RICHARDS_MECHANICS/t_dimension.md create mode 100644 Documentation/ProjectFile/prj/processes/process/RICHARDS_MECHANICS/t_fluid_bulk_modulus.md create mode 100644 Documentation/ProjectFile/prj/processes/process/RICHARDS_MECHANICS/t_intrinsic_permeability.md create mode 100644 Documentation/ProjectFile/prj/processes/process/RICHARDS_MECHANICS/t_material_property.md create mode 100644 Documentation/ProjectFile/prj/processes/process/RICHARDS_MECHANICS/t_solid_bulk_modulus.md create mode 100644 Documentation/ProjectFile/prj/processes/process/RICHARDS_MECHANICS/t_solid_density.md create mode 100644 Documentation/ProjectFile/prj/processes/process/RICHARDS_MECHANICS/t_specific_body_force.md create mode 100644 Documentation/ProjectFile/prj/processes/process/RICHARDS_MECHANICS/t_temperature.md diff --git a/Documentation/ProjectFile/prj/processes/process/RICHARDS_MECHANICS/c_RICHARDS_MECHANICS.md b/Documentation/ProjectFile/prj/processes/process/RICHARDS_MECHANICS/c_RICHARDS_MECHANICS.md new file mode 100644 index 00000000000..41fe949e97d --- /dev/null +++ b/Documentation/ProjectFile/prj/processes/process/RICHARDS_MECHANICS/c_RICHARDS_MECHANICS.md @@ -0,0 +1 @@ +\copydoc ProcessLib::RichardsMechanics::RichardsMechanicsProcess diff --git a/Documentation/ProjectFile/prj/processes/process/RICHARDS_MECHANICS/constitutive_relation b/Documentation/ProjectFile/prj/processes/process/RICHARDS_MECHANICS/constitutive_relation new file mode 120000 index 00000000000..cfcb5e03bbe --- /dev/null +++ b/Documentation/ProjectFile/prj/processes/process/RICHARDS_MECHANICS/constitutive_relation @@ -0,0 +1 @@ +../../../../material/solid/constitutive_relation \ No newline at end of file diff --git a/Documentation/ProjectFile/prj/processes/process/RICHARDS_MECHANICS/process_variables/i_process_variables.md b/Documentation/ProjectFile/prj/processes/process/RICHARDS_MECHANICS/process_variables/i_process_variables.md new file mode 100644 index 00000000000..6d4cf72a74c --- /dev/null +++ b/Documentation/ProjectFile/prj/processes/process/RICHARDS_MECHANICS/process_variables/i_process_variables.md @@ -0,0 +1,2 @@ +The process variables for pressure and displacement. +The order of the pressure variable must be one lower than that of displacement. diff --git a/Documentation/ProjectFile/prj/processes/process/RICHARDS_MECHANICS/process_variables/t_displacement.md b/Documentation/ProjectFile/prj/processes/process/RICHARDS_MECHANICS/process_variables/t_displacement.md new file mode 100644 index 00000000000..b6d5f29924d --- /dev/null +++ b/Documentation/ProjectFile/prj/processes/process/RICHARDS_MECHANICS/process_variables/t_displacement.md @@ -0,0 +1 @@ +Process variable name for displacement. diff --git a/Documentation/ProjectFile/prj/processes/process/RICHARDS_MECHANICS/process_variables/t_pressure.md b/Documentation/ProjectFile/prj/processes/process/RICHARDS_MECHANICS/process_variables/t_pressure.md new file mode 100644 index 00000000000..7b0ec27a7a6 --- /dev/null +++ b/Documentation/ProjectFile/prj/processes/process/RICHARDS_MECHANICS/process_variables/t_pressure.md @@ -0,0 +1 @@ +Process variable name for liquid pressure. diff --git a/Documentation/ProjectFile/prj/processes/process/RICHARDS_MECHANICS/t_biot_coefficient.md b/Documentation/ProjectFile/prj/processes/process/RICHARDS_MECHANICS/t_biot_coefficient.md new file mode 100644 index 00000000000..ca3b8ec9a25 --- /dev/null +++ b/Documentation/ProjectFile/prj/processes/process/RICHARDS_MECHANICS/t_biot_coefficient.md @@ -0,0 +1 @@ +\copydoc ProcessLib::RichardsMechanics::RichardsMechanicsProcessData::biot_coefficient diff --git a/Documentation/ProjectFile/prj/processes/process/RICHARDS_MECHANICS/t_coupling_scheme.md b/Documentation/ProjectFile/prj/processes/process/RICHARDS_MECHANICS/t_coupling_scheme.md new file mode 100644 index 00000000000..9cf0a794a49 --- /dev/null +++ b/Documentation/ProjectFile/prj/processes/process/RICHARDS_MECHANICS/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 RICHARDS_MECHANICS, and this input can be omitted. diff --git a/Documentation/ProjectFile/prj/processes/process/RICHARDS_MECHANICS/t_dimension.md b/Documentation/ProjectFile/prj/processes/process/RICHARDS_MECHANICS/t_dimension.md new file mode 100644 index 00000000000..fe666ef74ad --- /dev/null +++ b/Documentation/ProjectFile/prj/processes/process/RICHARDS_MECHANICS/t_dimension.md @@ -0,0 +1 @@ +Displacement vector dimension. The displacement dimension must be equal to the mesh dimension. diff --git a/Documentation/ProjectFile/prj/processes/process/RICHARDS_MECHANICS/t_fluid_bulk_modulus.md b/Documentation/ProjectFile/prj/processes/process/RICHARDS_MECHANICS/t_fluid_bulk_modulus.md new file mode 100644 index 00000000000..8e49cce94f4 --- /dev/null +++ b/Documentation/ProjectFile/prj/processes/process/RICHARDS_MECHANICS/t_fluid_bulk_modulus.md @@ -0,0 +1 @@ +\copydoc ProcessLib::RichardsMechanics::RichardsMechanicsProcessData::fluid_bulk_modulus diff --git a/Documentation/ProjectFile/prj/processes/process/RICHARDS_MECHANICS/t_intrinsic_permeability.md b/Documentation/ProjectFile/prj/processes/process/RICHARDS_MECHANICS/t_intrinsic_permeability.md new file mode 100644 index 00000000000..f945fe4d68f --- /dev/null +++ b/Documentation/ProjectFile/prj/processes/process/RICHARDS_MECHANICS/t_intrinsic_permeability.md @@ -0,0 +1 @@ +\copydoc ProcessLib::RichardsMechanics::RichardsMechanicsProcessData::intrinsic_permeability diff --git a/Documentation/ProjectFile/prj/processes/process/RICHARDS_MECHANICS/t_material_property.md b/Documentation/ProjectFile/prj/processes/process/RICHARDS_MECHANICS/t_material_property.md new file mode 100644 index 00000000000..51c6657bc85 --- /dev/null +++ b/Documentation/ProjectFile/prj/processes/process/RICHARDS_MECHANICS/t_material_property.md @@ -0,0 +1,3 @@ +Material properties of the fluid and the porous medium. Current implementation +uses the +[RichardsFlow process material properties](\ref ogs_file_param__prj__processes__process__RICHARDS_FLOW__material_property). diff --git a/Documentation/ProjectFile/prj/processes/process/RICHARDS_MECHANICS/t_solid_bulk_modulus.md b/Documentation/ProjectFile/prj/processes/process/RICHARDS_MECHANICS/t_solid_bulk_modulus.md new file mode 100644 index 00000000000..a26676ff0f6 --- /dev/null +++ b/Documentation/ProjectFile/prj/processes/process/RICHARDS_MECHANICS/t_solid_bulk_modulus.md @@ -0,0 +1 @@ +\copydoc ProcessLib::RichardsMechanics::RichardsMechanicsProcessData::solid_bulk_modulus diff --git a/Documentation/ProjectFile/prj/processes/process/RICHARDS_MECHANICS/t_solid_density.md b/Documentation/ProjectFile/prj/processes/process/RICHARDS_MECHANICS/t_solid_density.md new file mode 100644 index 00000000000..439b9cd75c0 --- /dev/null +++ b/Documentation/ProjectFile/prj/processes/process/RICHARDS_MECHANICS/t_solid_density.md @@ -0,0 +1 @@ +\copydoc ProcessLib::RichardsMechanics::RichardsMechanicsProcessData::solid_density diff --git a/Documentation/ProjectFile/prj/processes/process/RICHARDS_MECHANICS/t_specific_body_force.md b/Documentation/ProjectFile/prj/processes/process/RICHARDS_MECHANICS/t_specific_body_force.md new file mode 100644 index 00000000000..1263b236869 --- /dev/null +++ b/Documentation/ProjectFile/prj/processes/process/RICHARDS_MECHANICS/t_specific_body_force.md @@ -0,0 +1 @@ +\copydoc ProcessLib::RichardsMechanics::RichardsMechanicsProcessData::specific_body_force diff --git a/Documentation/ProjectFile/prj/processes/process/RICHARDS_MECHANICS/t_temperature.md b/Documentation/ProjectFile/prj/processes/process/RICHARDS_MECHANICS/t_temperature.md new file mode 100644 index 00000000000..8d7da2e9d6c --- /dev/null +++ b/Documentation/ProjectFile/prj/processes/process/RICHARDS_MECHANICS/t_temperature.md @@ -0,0 +1 @@ +\copydoc ProcessLib::RichardsMechanics::RichardsMechanicsProcessData::temperature -- GitLab