[docs] Update documentation

NAMESPACE

@@ -40,6 +40,7 @@ export(prj_linear_solver)
 export(prj_local_coordinate_system)
 export(prj_material_property)
 export(prj_medium)
+export(prj_micro_porosity)
 export(prj_nonlinear_solver)
 export(prj_output)
 export(prj_parameter)

man/prj_deactivated_subdomain.Rd

@@ -4,18 +4,27 @@
 \alias{prj_deactivated_subdomain}
 \title{prj_deactivated_subdomain}
 \usage{
-prj_deactivated_subdomain(time_interval, material_ids)
+prj_deactivated_subdomain(
+  material_ids,
+  time_interval = NULL,
+  time_curve = NULL,
+  line_segment = NULL
+)
 }
 \arguments{
-\item{time_interval}{list, numeric:}
-
 \item{material_ids}{string | double:}
+
+\item{time_interval}{Optional: list, numeric:}
+
+\item{time_curve}{Optional:}
+
+\item{line_segment}{Optional:}
 }
 \description{
 tag: deactivated_subdomain
 }
 \examples{
-prj_deactivated_subdomain(time_interval = list(start = "0",
-                                                  end = "1"),
-                             material_ids = 1)
+prj_deactivated_subdomain(material_ids = 0,
+                          time_interval = list(start = "0.51",
+                                               end = "1.0"))
 }

man/prj_micro_porosity.Rd

+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/prj_process.R
+\name{prj_micro_porosity}
+\alias{prj_micro_porosity}
+\title{prj_micro_porosity}
+\usage{
+prj_micro_porosity(mass_exchange_coefficient, nonlinear_solver)
+}
+\arguments{
+\item{mass_exchange_coefficient}{Required:}
+
+\item{nonlinear_solver}{Required:}
+}
+\description{
+tag: micro_porosity
+}

man/prj_ph_property.Rd

@@ -9,50 +9,38 @@ prj_ph_property(
   type,
   value = NULL,
   reference_value = NULL,
-  initial_porosity = NULL,
-  minimal_porosity = NULL,
-  maximal_porosity = NULL,
-  parameter_name = NULL,
-  exponents = NULL,
   offset = NULL,
   exponent = NULL,
+  parameter_name = NULL,
   swelling_pressures = NULL,
+  exponents = NULL,
   lower_saturation_limit = NULL,
   upper_saturation_limit = NULL,
-  intrinsic_permeabilities = NULL,
   ...
 )
 }
 \arguments{
-\item{name}{string: Property name}
-
-\item{type}{string: Property type}
-
-\item{value}{Optional: string | double: ...}
-
-\item{reference_value}{Optional: string | double:}
-
-\item{initial_porosity}{Optional: string:}
+\item{name}{string:}
 
-\item{minimal_porosity}{Optional: string | double:}
+\item{type}{string:}
 
-\item{maximal_porosity}{Optional: string | double:}
+\item{value}{Optional:}
 
-\item{parameter_name}{Optional: string:}
+\item{reference_value}{Optional:}
 
-\item{exponents}{Optional: string | numeric:}
+\item{offset}{Optional:}
 
-\item{offset}{Optional: string | double:}
+\item{exponent}{Optional:}
 
-\item{exponent}{Optional: list:}
+\item{parameter_name}{Optional:}
 
-\item{swelling_pressures}{Optional: string | numeric:}
+\item{swelling_pressures}{Optional:}
 
-\item{lower_saturation_limit}{Optional: string | double:}
+\item{exponents}{Optional:}
 
-\item{upper_saturation_limit}{Optional: string | double:}
+\item{lower_saturation_limit}{Optional:}
 
-\item{intrinsic_permeabilities}{Optional: string | numeric:}
+\item{upper_saturation_limit}{Optional:}
 
 \item{...}{independent_variable}
 }
@@ -61,6 +49,6 @@ tag: property
 }
 \examples{
 prj_ph_property(name = "porosity",
-                   type = "Constant",
-                   value = 0.3)
+                type = "Constant",
+                value = 0.3)
 }

man/prj_pr_property.Rd

@@ -12,14 +12,18 @@ prj_pr_property(
   exponent = NULL,
   residual_liquid_saturation = NULL,
   residual_gas_saturation = NULL,
+  initial_porosity = NULL,
+  minimal_porosity = NULL,
+  maximal_porosity = NULL,
   p_b = NULL,
   independent_variable = NULL,
   curve = NULL,
   minimum_relative_permeability_liquid = NULL,
+  cutoff_value = NULL,
+  lambda = NULL,
+  min_relative_permeability = NULL,
   initial_permeability = NULL,
   maximum_permeability = NULL,
-  lambda = NULL,
-  cutoff_value = NULL,
   intrinsic_permeability = NULL,
   initial_aperture = NULL,
   mean_frac_distance = NULL,
@@ -34,10 +38,9 @@ prj_pr_property(
   b2 = NULL,
   b3 = NULL,
   minimum_permeability = NULL,
-  initial_porosity = NULL,
   entry_pressure = NULL,
-  min_relative_permeability_liquid = NULL,
-  min_relative_permeability_gas = NULL
+  intrinsic_permeabilities = NULL,
+  exponents = NULL
 )
 }
 \arguments{
@@ -55,6 +58,12 @@ prj_pr_property(
 
 \item{residual_gas_saturation}{Optional:}
 
+\item{initial_porosity}{Optional:}
+
+\item{minimal_porosity}{Optional:}
+
+\item{maximal_porosity}{Optional:}
+
 \item{p_b}{Optional:}
 
 \item{independent_variable}{Optional:}
@@ -63,13 +72,15 @@ prj_pr_property(
 
 \item{minimum_relative_permeability_liquid}{Optional:}
 
-\item{initial_permeability}{Optional:}
-
-\item{maximum_permeability}{Optional:}
+\item{cutoff_value}{Optional:}
 
 \item{lambda}{Optional:}
 
-\item{cutoff_value}{Optional:}
+\item{min_relative_permeability}{Optional:}
+
+\item{initial_permeability}{Optional:}
+
+\item{maximum_permeability}{Optional:}
 
 \item{intrinsic_permeability}{Optional:}
 
@@ -99,19 +110,17 @@ prj_pr_property(
 
 \item{minimum_permeability}{Optional:}
 
-\item{initial_porosity}{Optional:}
-
 \item{entry_pressure}{Optional:}
 
-\item{min_relative_permeability_liquid}{Optional:}
+\item{intrinsic_permeabilities}{Optional:}
 
-\item{min_relative_permeability_gas}{Optional:}
+\item{exponents}{Optional:}
 }
 \description{
 tag: property
 }
 \examples{
 prj_pr_property(name = "reference_temperature",
-                   type = "Constant",
-                   value = 293.15)
+                type = "Constant",
+                value = 293.15)
 }

man/prj_process.Rd

@@ -14,10 +14,6 @@ prj_process(
   solid_density = NULL,
   dimension = NULL,
   coupling_scheme = NULL,
-  reference_solid_density = NULL,
-  linear_thermal_expansion_coefficient = NULL,
-  specific_heat_capacity = NULL,
-  thermal_conductivity = NULL,
   darcy_gravity = NULL,
   reference_temperature = NULL,
   fracture_model = NULL,
@@ -73,6 +69,8 @@ prj_process(
   density_solid = NULL,
   latent_heat_evaporation = NULL,
   pf_irrv = NULL,
+  micro_porosity = NULL,
+  explicit_hm_coupling_in_unsaturated_zone = NULL,
   ...
 )
 }
@@ -95,14 +93,6 @@ prj_process(
 
 \item{coupling_scheme}{Optional:}
 
-\item{reference_solid_density}{Optional:}
-
-\item{linear_thermal_expansion_coefficient}{Optional:}
-
-\item{specific_heat_capacity}{Optional:}
-
-\item{thermal_conductivity}{Optional:}
-
 \item{darcy_gravity}{Optional:}
 
 \item{reference_temperature}{Optional:}
@@ -213,6 +203,10 @@ prj_process(
 
 \item{pf_irrv}{Optional:}
 
+\item{micro_porosity}{Optional:}
+
+\item{explicit_hm_coupling_in_unsaturated_zone}{Optional:}
+
 \item{...}{Optional: fracture_properties, constitutive_relation}
 }
 \description{