[base] #7 (subclass of process)

R/prj_porous_medium.R

+
+#===== r2ogs6_porous_medium =====
+
+
+#'r2ogs6_porous_medium
+#'@description tag: porous_medium
+#'@param id string | double:
+#'@param permeability list:
+#'@param porosity list:
+#'@param storage list:
+#'@param capillary_pressure r2ogs6_capillary_pressure:
+#'@param relative_permeability list:
+#'@export
+r2ogs6_porous_medium <- function(id,
+                                 permeability,
+                                 porosity,
+                                 storage,
+                                 capillary_pressure,
+                                 relative_permeability) {
+
+    # COerce input
+    id <- coerce_string_to_numeric(id)
+
+    new_r2ogs6_porous_medium(id,
+                             permeability,
+                             porosity,
+                             storage,
+                             capillary_pressure,
+                             relative_permeability)
+}
+
+
+new_r2ogs6_porous_medium <- function(id,
+                                     permeability,
+                                     porosity,
+                                     storage,
+                                     capillary_pressure,
+                                     relative_permeability) {
+
+    validate_is_number(id)
+
+    permeability <- validate_param_list(permeability,
+                                        c("permeability_tensor_entries",
+                                          "type"))
+
+    porosity <- validate_param_list(porosity,
+                                    c("porosity_parameter",
+                                      "type"))
+
+    storage <- validate_param_list(storage,
+                                   c("value",
+                                     "type"))
+
+    assertthat::assert_that(class(capillary_pressure) ==
+                                "r2ogs6_capillary_pressure")
+
+    assertthat::assert_that(is.list(relative_permeability))
+
+    for (i in seq_len(length(relative_permeability))) {
+        relative_permeability[[i]] <-
+            validate_param_list(relative_permeability[[i]],
+                                c("type",
+                                  "krel_min",
+                                  "m",
+                                  "smax",
+                                  "sr"))
+    }
+
+    names(relative_permeability) <- rep("relative_permeability",
+                                        length(relative_permeability))
+
+    structure(list(id = id,
+                   permeability = permeability,
+                   porosity = porosity,
+                   storage = storage,
+                   capillary_pressure = capillary_pressure,
+                   relative_permeability = relative_permeability,
+                   is_subclass = TRUE,
+                   attr_names = c("id"),
+                   flatten_on_exp = character()
+    ),
+    class = "r2ogs6_porous_medium"
+    )
+}
+
+
+#===== r2ogs6_capillary_pressure =====
+
+
+#'r2ogs6_capillary_pressure
+#'@description tag: capillary_pressure
+#'@param type string:
+#'@param pd Optional: string | double:
+#'@param sr Optional: string | double:
+#'@param smax Optional: string | double:
+#'@param m Optional: string | double:
+#'@param pc_max Optional: string | double:
+#'@param has_regularized Optional: string, "true" | "false":
+#'@param curve Optional: list:
+#'@export
+r2ogs6_capillary_pressure <- function(type,
+                                      pd = NULL,
+                                      sr = NULL,
+                                      smax = NULL,
+                                      m = NULL,
+                                      pc_max = NULL,
+                                      has_regularized = NULL,
+                                      curve = NULL) {
+
+    # Coerce input
+    pd <- coerce_string_to_numeric(pd)
+    sr <- coerce_string_to_numeric(sr)
+    smax <- coerce_string_to_numeric(smax)
+    m <- coerce_string_to_numeric(m)
+    pc_max <- coerce_string_to_numeric(pc_max)
+
+    new_r2ogs6_capillary_pressure(type,
+                                  pd,
+                                  sr,
+                                  smax,
+                                  m,
+                                  pc_max,
+                                  has_regularized,
+                                  curve)
+}
+
+
+new_r2ogs6_capillary_pressure <- function(type,
+                                          pd = NULL,
+                                          sr = NULL,
+                                          smax = NULL,
+                                          m = NULL,
+                                          pc_max = NULL,
+                                          has_regularized = NULL,
+                                          curve = NULL) {
+
+    validate_is_string(type)
+
+    validate_is_null_or_number(pd,
+                               sr,
+                               smax,
+                               m,
+                               pc_max)
+
+    validate_is_null_or_str_flag(has_regularized)
+
+    validate_is_null_or_param_list(curve, c("coords", "values"))
+
+    if(!is.null(curve)){
+        curve[[1]] <- coerce_string_to_numeric(curve[[1]], TRUE)
+        curve[[2]] <- coerce_string_to_numeric(curve[[2]], TRUE)
+
+        assertthat::assert_that(is.numeric(curve[[1]]))
+        assertthat::assert_that(is.numeric(curve[[2]]))
+    }
+
+    structure(list(type = type,
+                   pd = pd,
+                   sr = sr,
+                   smax = smax,
+                   m = m,
+                   pc_max = pc_max,
+                   has_regularized = has_regularized,
+                   curve = curve,
+                   is_subclass = TRUE,
+                   attr_names = character(),
+                   flatten_on_exp = character()
+    ),
+    class = "r2ogs6_capillary_pressure"
+    )
+}