Skip to contents

prj_tl_process

prj_tl_process.Rd

tag: process (parent: time_loop, NOT processes!)

Usage

prj_tl_process(
  ref,
  nonlinear_solver,
  convergence_criterion,
  time_discretization,
  time_stepping,
  compensate_non_equilibrium_initial_residuum = NULL
)

Arguments

ref

string: References a prj_process object by name

nonlinear_solver

string:

convergence_criterion

prj_convergence_criterion:

time_discretization

vector:

time_stepping

prj_time_stepping:

compensate_non_equilibrium_initial_residuum

string: Optional: Either "true" or "false"

Examples

prj_tl_process(
    ref = "HM",
    nonlinear_solver = "basic_newton",
    convergence_criterion = prj_convergence_criterion(
        type = "DeltaX",
        norm_type = "NORM2",
        reltol = 1e-08
    ),
    time_discretization = list(type = "BackwardEuler"),
    time_stepping = prj_time_stepping(
        type = "FixedTimeStepping",
        t_initial = 0,
        t_end = 10000,
        timesteps = list(pair = list(1000,
                                     delta_t = 10))
    )
)
#> $ref
#> [1] "HM"
#> 
#> $nonlinear_solver
#> [1] "basic_newton"
#> 
#> $convergence_criterion
#> $type
#> [1] "DeltaX"
#> 
#> $norm_type
#> [1] "NORM2"
#> 
#> $abstol
#> NULL
#> 
#> $reltol
#> [1] 1e-08
#> 
#> $abstols
#> NULL
#> 
#> $reltols
#> NULL
#> 
#> $xpath
#> [1] "time_loop/processes/process/convergence_criterion"                           
#> [2] "time_loop/global_process_coupling/convergence_criteria/convergence_criterion"
#> 
#> $attr_names
#> character(0)
#> 
#> $flatten_on_exp
#> [1] "abstols" "reltols"
#> 
#> attr(,"class")
#> [1] "prj_convergence_criterion"
#> 
#> $time_discretization
#> $time_discretization$type
#> [1] "BackwardEuler"
#> 
#> 
#> $time_stepping
#> $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"
#> 
#> $compensate_non_equilibrium_initial_residuum
#> NULL
#> 
#> $xpath
#> [1] "time_loop/processes/process"
#> 
#> $attr_names
#> [1] "ref"
#> 
#> $flatten_on_exp
#> character(0)
#> 
#> attr(,"class")
#> [1] "prj_tl_process"