From 91a5834dd701211f929fd25419dc34561ce3b4e7 Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Fri, 14 Feb 2025 09:15:20 +0100 Subject: Initialize dev docs --- docs/dev/reference/create_deg_func.html | 148 ++++++++++++++++++++++++++++++++ 1 file changed, 148 insertions(+) create mode 100644 docs/dev/reference/create_deg_func.html (limited to 'docs/dev/reference/create_deg_func.html') diff --git a/docs/dev/reference/create_deg_func.html b/docs/dev/reference/create_deg_func.html new file mode 100644 index 00000000..4c66c02b --- /dev/null +++ b/docs/dev/reference/create_deg_func.html @@ -0,0 +1,148 @@ + +Create degradation functions for known analytical solutions — create_deg_func • mkin + Skip to contents + + +
+
+
+ +

Create degradation functions for known analytical solutions

+ Source: R/create_deg_func.R +
create_deg_func.Rd
+
+ +
+

Create degradation functions for known analytical solutions

+
+ +
+

Usage

+ 
create_deg_func(spec, use_of_ff = c("min", "max"))
+
+ +
+

Arguments

+ + +
spec
+

List of model specifications as contained in mkinmod objects

+ + +
use_of_ff
+

Minimum or maximum use of formation fractions

+ +
+
+

Value

+

Degradation function to be attached to mkinmod objects

+
+ +
+

Examples

+ 

+SFO_SFO <- mkinmod(
+  parent = mkinsub("SFO", "m1"),
+  m1 = mkinsub("SFO"))
+#> Temporary DLL for differentials generated and loaded
+FOCUS_D <- subset(FOCUS_2006_D, value != 0) # to avoid warnings
+fit_1 <- mkinfit(SFO_SFO, FOCUS_D, solution_type = "analytical", quiet = TRUE)
+# \dontrun{
+fit_2 <- mkinfit(SFO_SFO, FOCUS_D, solution_type = "deSolve", quiet = TRUE)
+if (require(rbenchmark))
+  benchmark(
+    analytical = mkinfit(SFO_SFO, FOCUS_D, solution_type = "analytical", quiet = TRUE),
+    deSolve = mkinfit(SFO_SFO, FOCUS_D, solution_type = "deSolve", quiet = TRUE),
+    replications = 2)
+#> Loading required package: rbenchmark
+#>         test replications elapsed relative user.self sys.self user.child
+#> 1 analytical            2   0.249    1.000     0.249        0          0
+#> 2    deSolve            2   0.307    1.233     0.306        0          0
+#>   sys.child
+#> 1         0
+#> 2         0
+  DFOP_SFO <- mkinmod(
+    parent = mkinsub("DFOP", "m1"),
+    m1 = mkinsub("SFO"))
+#> Temporary DLL for differentials generated and loaded
+  benchmark(
+    analytical = mkinfit(DFOP_SFO, FOCUS_D, solution_type = "analytical", quiet = TRUE),
+    deSolve = mkinfit(DFOP_SFO, FOCUS_D, solution_type = "deSolve", quiet = TRUE),
+    replications = 2)
+#>         test replications elapsed relative user.self sys.self user.child
+#> 1 analytical            2   0.391    1.000     0.391        0          0
+#> 2    deSolve            2   0.543    1.389     0.542        0          0
+#>   sys.child
+#> 1         0
+#> 2         0
+# }
+
+
+
+ + +
+ + + + + + + -- cgit v1.2.1