Skip to content
Snippets Groups Projects
Commit 26d3bead authored by Johannes Boog's avatar Johannes Boog
Browse files

[doc] update function docs

parent bf544c66
No related branches found
No related tags found
1 merge request!55[base] update package to OGS6.4.2
...@@ -45,7 +45,11 @@ prj_pr_property( ...@@ -45,7 +45,11 @@ prj_pr_property(
minimum_permeability = NULL, minimum_permeability = NULL,
entry_pressure = NULL, entry_pressure = NULL,
intrinsic_permeabilities = NULL, intrinsic_permeabilities = NULL,
exponents = NULL exponents = NULL,
jacobian_factor = NULL,
dry_thermal_conductivity = NULL,
wet_thermal_conductivity = NULL,
...
) )
} }
\arguments{ \arguments{
...@@ -130,6 +134,14 @@ prj_pr_property( ...@@ -130,6 +134,14 @@ prj_pr_property(
\item{intrinsic_permeabilities}{Optional:} \item{intrinsic_permeabilities}{Optional:}
\item{exponents}{Optional:} \item{exponents}{Optional:}
\item{jacobian_factor}{Optional:}
\item{dry_thermal_conductivity}{Optional:}
\item{wet_thermal_conductivity}{Optional:}
\item{...}{dvalue}
} }
\description{ \description{
tag: property tag: property
......
...@@ -66,8 +66,6 @@ prj_process( ...@@ -66,8 +66,6 @@ prj_process(
solute_dispersivity_longitudinal = NULL, solute_dispersivity_longitudinal = NULL,
solute_dispersivity_transverse = NULL, solute_dispersivity_transverse = NULL,
molecular_diffusion_coefficient = NULL, molecular_diffusion_coefficient = NULL,
density_solid = NULL,
latent_heat_evaporation = NULL,
pf_irrv = NULL, pf_irrv = NULL,
micro_porosity = NULL, micro_porosity = NULL,
explicit_hm_coupling_in_unsaturated_zone = NULL, explicit_hm_coupling_in_unsaturated_zone = NULL,
...@@ -79,6 +77,10 @@ prj_process( ...@@ -79,6 +77,10 @@ prj_process(
tabular_file = NULL, tabular_file = NULL,
temperature_field = NULL, temperature_field = NULL,
use_stokes_brinkman_form = NULL, use_stokes_brinkman_form = NULL,
energy_split_model = NULL,
softening_curve = NULL,
characteristic_length = NULL,
coupling_scheme_parameter = NULL,
... ...
) )
} }
...@@ -205,10 +207,6 @@ prj_process( ...@@ -205,10 +207,6 @@ prj_process(
\item{molecular_diffusion_coefficient}{Optional:} \item{molecular_diffusion_coefficient}{Optional:}
\item{density_solid}{Optional:}
\item{latent_heat_evaporation}{Optional:}
\item{pf_irrv}{Optional:} \item{pf_irrv}{Optional:}
\item{micro_porosity}{Optional:} \item{micro_porosity}{Optional:}
...@@ -231,6 +229,14 @@ prj_process( ...@@ -231,6 +229,14 @@ prj_process(
\item{use_stokes_brinkman_form}{Optional: character} \item{use_stokes_brinkman_form}{Optional: character}
\item{energy_split_model}{Optional: string}
\item{softening_curve}{Optional: string}
\item{characteristic_length}{Optional: double}
\item{coupling_scheme_parameter}{Optional: double}
\item{...}{Optional: fracture_properties, constitutive_relation} \item{...}{Optional: fracture_properties, constitutive_relation}
} }
\description{ \description{
......
...@@ -12,7 +12,8 @@ prj_process_variable( ...@@ -12,7 +12,8 @@ prj_process_variable(
boundary_conditions = NULL, boundary_conditions = NULL,
source_terms = NULL, source_terms = NULL,
mesh = NULL, mesh = NULL,
deactivated_subdomains = NULL deactivated_subdomains = NULL,
compensate_non_equilibrium_initial_residuum = NULL
) )
} }
\arguments{ \arguments{
...@@ -31,6 +32,8 @@ prj_process_variable( ...@@ -31,6 +32,8 @@ prj_process_variable(
\item{mesh}{Optional: string: list:} \item{mesh}{Optional: string: list:}
\item{deactivated_subdomains}{Optional: list, prj_deactivated_subdomain:} \item{deactivated_subdomains}{Optional: list, prj_deactivated_subdomain:}
\item{compensate_non_equilibrium_initial_residuum}{Optional: string}
} }
\description{ \description{
tag: process_variable tag: process_variable
......
...@@ -10,7 +10,8 @@ prj_source_term( ...@@ -10,7 +10,8 @@ prj_source_term(
geometrical_set = NULL, geometrical_set = NULL,
geometry = NULL, geometry = NULL,
mesh = NULL, mesh = NULL,
source_term_object = NULL source_term_object = NULL,
flush_stdout = NULL
) )
} }
\arguments{ \arguments{
...@@ -25,6 +26,8 @@ prj_source_term( ...@@ -25,6 +26,8 @@ prj_source_term(
\item{mesh}{Optional: string:} \item{mesh}{Optional: string:}
\item{source_term_object}{Optional: string:} \item{source_term_object}{Optional: string:}
\item{flush_stdout}{Optional: string:}
} }
\description{ \description{
tag: source_term tag: source_term
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment