From d87fc5b54eb338251a023659aadf827143eea1c5 Mon Sep 17 00:00:00 2001 From: zty <ichbinzty@gmail.com> Date: Sun, 31 Mar 2019 23:26:27 +0200 Subject: [PATCH] [doc] THM tags documentation. --- .../process/THERMO_HYDRO_MECHANICS/c_THERMO_HYDRO_MECHANICS.md | 1 + .../process_variables/i_process_variables.md | 1 + .../THERMO_HYDRO_MECHANICS/process_variables/t_displacement.md | 1 + .../THERMO_HYDRO_MECHANICS/process_variables/t_pressure.md | 1 + .../THERMO_HYDRO_MECHANICS/process_variables/t_temperature.md | 1 + .../process/THERMO_HYDRO_MECHANICS/t_biot_coefficient.md | 1 + .../process/THERMO_HYDRO_MECHANICS/t_coupling_scheme.md | 2 ++ .../prj/processes/process/THERMO_HYDRO_MECHANICS/t_dimension.md | 1 + .../processes/process/THERMO_HYDRO_MECHANICS/t_fluid_density.md | 1 + .../THERMO_HYDRO_MECHANICS/t_fluid_specific_heat_capacity.md | 1 + .../THERMO_HYDRO_MECHANICS/t_fluid_thermal_conductivity.md | 1 + .../process/THERMO_HYDRO_MECHANICS/t_fluid_viscosity.md | 1 + .../t_fluid_volumetric_thermal_expansion_coefficient.md | 1 + .../process/THERMO_HYDRO_MECHANICS/t_intrinsic_permeability.md | 1 + .../prj/processes/process/THERMO_HYDRO_MECHANICS/t_porosity.md | 1 + .../process/THERMO_HYDRO_MECHANICS/t_reference_temperature.md | 1 + .../processes/process/THERMO_HYDRO_MECHANICS/t_solid_density.md | 1 + .../t_solid_linear_thermal_expansion_coefficient.md | 1 + .../THERMO_HYDRO_MECHANICS/t_solid_specific_heat_capacity.md | 1 + .../THERMO_HYDRO_MECHANICS/t_solid_thermal_conductivity.md | 1 + .../process/THERMO_HYDRO_MECHANICS/t_specific_body_force.md | 1 + .../process/THERMO_HYDRO_MECHANICS/t_specific_storage.md | 1 + 22 files changed, 23 insertions(+) create mode 100644 Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/c_THERMO_HYDRO_MECHANICS.md create mode 100644 Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/process_variables/i_process_variables.md create mode 100644 Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/process_variables/t_displacement.md create mode 100644 Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/process_variables/t_pressure.md create mode 100644 Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/process_variables/t_temperature.md create mode 100644 Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_biot_coefficient.md create mode 100644 Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_coupling_scheme.md create mode 100644 Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_dimension.md create mode 100644 Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_fluid_density.md create mode 100644 Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_fluid_specific_heat_capacity.md create mode 100644 Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_fluid_thermal_conductivity.md create mode 100644 Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_fluid_viscosity.md create mode 100644 Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_fluid_volumetric_thermal_expansion_coefficient.md create mode 100644 Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_intrinsic_permeability.md create mode 100644 Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_porosity.md create mode 100644 Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_reference_temperature.md create mode 100644 Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_solid_density.md create mode 100644 Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_solid_linear_thermal_expansion_coefficient.md create mode 100644 Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_solid_specific_heat_capacity.md create mode 100644 Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_solid_thermal_conductivity.md create mode 100644 Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_specific_body_force.md create mode 100644 Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_specific_storage.md diff --git a/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/c_THERMO_HYDRO_MECHANICS.md b/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/c_THERMO_HYDRO_MECHANICS.md new file mode 100644 index 00000000000..11e90e8358e --- /dev/null +++ b/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/c_THERMO_HYDRO_MECHANICS.md @@ -0,0 +1 @@ +Coupled thermo-hydro-mechanical process. It is implemented monolithically. diff --git a/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/process_variables/i_process_variables.md b/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/process_variables/i_process_variables.md new file mode 100644 index 00000000000..7b74dddccb1 --- /dev/null +++ b/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/process_variables/i_process_variables.md @@ -0,0 +1 @@ +The process variables for displacement, pressure and temperature. diff --git a/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/process_variables/t_displacement.md b/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/process_variables/t_displacement.md new file mode 100644 index 00000000000..b6d5f29924d --- /dev/null +++ b/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/process_variables/t_displacement.md @@ -0,0 +1 @@ +Process variable name for displacement. diff --git a/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/process_variables/t_pressure.md b/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/process_variables/t_pressure.md new file mode 100644 index 00000000000..36a6d4b8b7a --- /dev/null +++ b/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/process_variables/t_pressure.md @@ -0,0 +1 @@ +Process variable name for pressure. diff --git a/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/process_variables/t_temperature.md b/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/process_variables/t_temperature.md new file mode 100644 index 00000000000..f6efd419ab8 --- /dev/null +++ b/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/process_variables/t_temperature.md @@ -0,0 +1 @@ +Process variable name for temperature. diff --git a/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_biot_coefficient.md b/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_biot_coefficient.md new file mode 100644 index 00000000000..2db4bbf0267 --- /dev/null +++ b/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_biot_coefficient.md @@ -0,0 +1 @@ +Biot coefficient. diff --git a/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_coupling_scheme.md b/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_coupling_scheme.md new file mode 100644 index 00000000000..703141a127a --- /dev/null +++ b/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_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 THERMO_HYDRO_MECHANICS, and this input can be omitted. diff --git a/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_dimension.md b/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_dimension.md new file mode 100644 index 00000000000..fe666ef74ad --- /dev/null +++ b/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_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/THERMO_HYDRO_MECHANICS/t_fluid_density.md b/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_fluid_density.md new file mode 100644 index 00000000000..722affa8a46 --- /dev/null +++ b/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_fluid_density.md @@ -0,0 +1 @@ +\copydoc ProcessLib::ThermoHydroMechanics::ThermoHydroMechanicsProcessData::fluid_density diff --git a/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_fluid_specific_heat_capacity.md b/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_fluid_specific_heat_capacity.md new file mode 100644 index 00000000000..024bf06abff --- /dev/null +++ b/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_fluid_specific_heat_capacity.md @@ -0,0 +1 @@ +Fluid specific heat capacity is the heat capacity per unit mass of the fluid. diff --git a/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_fluid_thermal_conductivity.md b/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_fluid_thermal_conductivity.md new file mode 100644 index 00000000000..75fd9758ed5 --- /dev/null +++ b/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_fluid_thermal_conductivity.md @@ -0,0 +1 @@ +Fluid thermal conductivity, the property of fluid to conduct heat. diff --git a/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_fluid_viscosity.md b/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_fluid_viscosity.md new file mode 100644 index 00000000000..f49c37cdbfa --- /dev/null +++ b/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_fluid_viscosity.md @@ -0,0 +1 @@ +\copydoc ProcessLib::ThermoHydroMechanics::ThermoHydroMechanicsProcessData::fluid_viscosity diff --git a/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_fluid_volumetric_thermal_expansion_coefficient.md b/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_fluid_volumetric_thermal_expansion_coefficient.md new file mode 100644 index 00000000000..440f6d0f314 --- /dev/null +++ b/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_fluid_volumetric_thermal_expansion_coefficient.md @@ -0,0 +1 @@ +Volumetric thermal expansion coefficient of fluid. diff --git a/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_intrinsic_permeability.md b/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_intrinsic_permeability.md new file mode 100644 index 00000000000..9559792cd80 --- /dev/null +++ b/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_intrinsic_permeability.md @@ -0,0 +1 @@ +Permeability of porous medium. diff --git a/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_porosity.md b/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_porosity.md new file mode 100644 index 00000000000..418fdcc6bc1 --- /dev/null +++ b/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_porosity.md @@ -0,0 +1 @@ +Porosity of porous medium. diff --git a/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_reference_temperature.md b/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_reference_temperature.md new file mode 100644 index 00000000000..6951343d385 --- /dev/null +++ b/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_reference_temperature.md @@ -0,0 +1 @@ +Reference temperature for the thermal part of thermo-hydro-mechanical process. diff --git a/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_solid_density.md b/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_solid_density.md new file mode 100644 index 00000000000..197239040b3 --- /dev/null +++ b/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_solid_density.md @@ -0,0 +1 @@ +Solid density. diff --git a/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_solid_linear_thermal_expansion_coefficient.md b/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_solid_linear_thermal_expansion_coefficient.md new file mode 100644 index 00000000000..38eaff68a74 --- /dev/null +++ b/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_solid_linear_thermal_expansion_coefficient.md @@ -0,0 +1 @@ +Solid linear expansion in one dimension. diff --git a/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_solid_specific_heat_capacity.md b/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_solid_specific_heat_capacity.md new file mode 100644 index 00000000000..1696adff39d --- /dev/null +++ b/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_solid_specific_heat_capacity.md @@ -0,0 +1 @@ +Specific heat capacity, the heat capacity per unit mass of a material. diff --git a/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_solid_thermal_conductivity.md b/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_solid_thermal_conductivity.md new file mode 100644 index 00000000000..0d0a26a1212 --- /dev/null +++ b/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_solid_thermal_conductivity.md @@ -0,0 +1 @@ +Solid thermal conductivity, the property of solid to conduct heat. diff --git a/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_specific_body_force.md b/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_specific_body_force.md new file mode 100644 index 00000000000..b6b5fbd2f14 --- /dev/null +++ b/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_specific_body_force.md @@ -0,0 +1 @@ +Specific body forces that are used to apply gravitational forces, a vector of size equal to the displacement dimension. \ No newline at end of file diff --git a/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_specific_storage.md b/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_specific_storage.md new file mode 100644 index 00000000000..af55c27a7ae --- /dev/null +++ b/Documentation/ProjectFile/prj/processes/process/THERMO_HYDRO_MECHANICS/t_specific_storage.md @@ -0,0 +1 @@ +Volumetric average specific storage of porous medium and fluid phases. -- GitLab