Skip to contents

prj_time_stepping

prj_time_stepping.Rd

tag: time_stepping

Usage

prj_time_stepping(
  type,
  t_initial = NULL,
  t_end = NULL,
  timesteps = NULL,
  initial_dt = NULL,
  minimum_dt = NULL,
  maximum_dt = NULL,
  number_iterations = NULL,
  multiplier = NULL,
  dt_guess = NULL,
  dt_min = NULL,
  dt_max = NULL,
  rel_dt_min = NULL,
  rel_dt_max = NULL,
  tol = NULL
)

Arguments

type

string:

t_initial

Optional: string | double:

t_end

Optional: string | double:

timesteps

Optional: list:

initial_dt

Optional: string | double:

minimum_dt

Optional: string | double:

maximum_dt

Optional: string | double:

number_iterations

Optional: string | numeric:

multiplier

Optional: string | numeric:

dt_guess

Optional: string | double:

dt_min

Optional: string | double:

dt_max

Optional: string | double:

rel_dt_min

Optional: string | double:

rel_dt_max

Optional: string | double:

tol

Optional: string | double:

Examples

prj_time_stepping(
    type = "FixedTimeStepping",
    t_initial = 0,
    t_end = 10000,
    timesteps = list(pair = list(1000,
                                 delta_t = 10))
)
#> $type
#> [1] "FixedTimeStepping"
#> 
#> $t_initial
#> [1] 0
#> 
#> $t_end
#> [1] 10000
#> 
#> $timesteps
#> $timesteps$pair
#> $timesteps$pair$`repeat`
#> [1] 1000
#> 
#> $timesteps$pair$delta_t
#> [1] 10
#> 
#> 
#> 
#> $initial_dt
#> NULL
#> 
#> $minimum_dt
#> NULL
#> 
#> $maximum_dt
#> NULL
#> 
#> $number_iterations
#> NULL
#> 
#> $multiplier
#> NULL
#> 
#> $dt_guess
#> NULL
#> 
#> $dt_min
#> NULL
#> 
#> $dt_max
#> NULL
#> 
#> $rel_dt_min
#> NULL
#> 
#> $rel_dt_max
#> NULL
#> 
#> $tol
#> NULL
#> 
#> $xpath
#> [1] "time_loop/processes/process/time_stepping"
#> 
#> $attr_names
#> character(0)
#> 
#> $flatten_on_exp
#> [1] "number_iterations" "multiplier"       
#> 
#> attr(,"class")
#> [1] "prj_time_stepping"