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

[doc] update of classes prj_chemical_system and prj_process

parent 4eb2a54c
No related branches found
No related tags found
1 merge request!56[base] add OGS v643 parameters to prj_process
......@@ -22,6 +22,7 @@ export(ogs6_run_simulation)
export(prj_borehole_heat_exchanger)
export(prj_boundary_condition)
export(prj_capillary_pressure)
export(prj_chemical_reaction)
export(prj_chemical_system)
export(prj_com_property)
export(prj_component)
......
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/prj_chemical_system.R
\name{prj_chemical_reaction}
\alias{prj_chemical_reaction}
\title{prj_chemical_reaction}
\usage{
prj_chemical_reaction(
stoichiometric_coefficients,
reaction_type,
first_order_rate_constant
)
}
\arguments{
\item{stoichiometric_coefficients}{numeric:}
\item{reaction_type}{string:}
\item{first_order_rate_constant}{double:}
}
\description{
tag: chemical_reaction
}
......@@ -6,27 +6,32 @@
\usage{
prj_chemical_system(
chemical_solver,
database,
solution,
mesh = NULL,
mesh,
linear_solver = NULL,
database = NULL,
solution = NULL,
knobs = NULL,
kinetic_reactants = NULL,
rates = NULL,
equilibrium_reactants = NULL,
surface = NULL,
user_punch = NULL,
linear_solver = NULL,
exchangers = NULL
use_high_precision = NULL,
exchangers = NULL,
chemical_reactions = NULL,
number_of_components = NULL
)
}
\arguments{
\item{chemical_solver}{string:}
\item{chemical_solver}{string: Either "Phreeqc" or "SelfContained".}
\item{mesh}{string:}
\item{database}{string:}
\item{linear_solver}{Optional: string:}
\item{solution}{prj_solution:}
\item{database}{string: Required if chemical_solver == "Phreeqc" .}
\item{mesh}{Optional: string:}
\item{solution}{prj_solution: Required if chemical_solver == "Phreeqc".}
\item{knobs}{Optional: list:}
......@@ -40,9 +45,15 @@ prj_chemical_system(
\item{user_punch}{Optional:}
\item{linear_solver}{Optional:}
\item{use_high_precision}{Optional:}
\item{exchangers}{Optional: prj_exchangers}
\item{chemical_reactions}{list: Required if
chemical_solver == "SelfContained".}
\item{number_of_components}{integer: Required if
chemical_solver == "SelfContained".}
}
\description{
tag: chemical_system
......@@ -50,6 +61,7 @@ tag: chemical_system
\examples{
prj_chemical_system(
chemical_solver = "Phreeqc",
linear_solver = "general_linear_solver",
database = "PSINA_12_07_110615_DAV_s.dat",
solution = prj_solution(
temperature = 25,
......
......@@ -81,6 +81,8 @@ prj_process(
softening_curve = NULL,
characteristic_length = NULL,
coupling_scheme_parameter = NULL,
numerical_stabilization = NULL,
aperture_size = NULL,
...
)
}
......@@ -237,6 +239,10 @@ prj_process(
\item{coupling_scheme_parameter}{Optional: double}
\item{numerical_stabilization}{Optional: list}
\item{aperture_size}{Optional: list}
\item{...}{Optional: fracture_properties, constitutive_relation}
}
\description{
......
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