prj_output — prj_output • r2ogs6

tag: output

Usage

prj_output(
  type,
  prefix,
  variables,
  suffix = NULL,
  timesteps = NULL,
  compress_output = NULL,
  data_mode = NULL,
  output_iteration_results = NULL,
  meshes = NULL,
  fixed_output_times = NULL,
  hdf = NULL,
  geometrical_sets = NULL
)

Arguments

type: string:
prefix: string:
variables: vector:
suffix: Optional: string:
timesteps: Optional:
compress_output: Optional: string: Should the output be compressed? Either "true" or "false"
data_mode: Optional: string:
output_iteration_results: Optional: string: Either "true" or "false"
meshes: Optional: list: A list of meshes
fixed_output_times: Optional: string | numeric:
hdf: Optional: numeric
geometrical_sets: Optional: list, prj_geometrical_set

Examples

prj_output(
    type = "VTK",
    prefix = "flow_free_expansion",
    variables = list(
        variable = "displacement",
        variable = "pressure"
    ),
    suffix = "_ts_{:timestep}_t_{:time}",
    timesteps = list(pair = list(1,
                                 each_steps = 1000))
)
#> $type
#> [1] "VTK"
#> 
#> $prefix
#> [1] "flow_free_expansion"
#> 
#> $variables
#> $variables$variable
#> [1] "displacement"
#> 
#> $variables$variable
#> [1] "pressure"
#> 
#> 
#> $suffix
#> [1] "_ts_{:timestep}_t_{:time}"
#> 
#> $timesteps
#> $timesteps$pair
#> $timesteps$pair$`repeat`
#> [1] 1
#> 
#> $timesteps$pair$each_steps
#> [1] 1000
#> 
#> 
#> 
#> $compress_output
#> NULL
#> 
#> $data_mode
#> NULL
#> 
#> $output_iteration_results
#> NULL
#> 
#> $meshes
#> NULL
#> 
#> $fixed_output_times
#> NULL
#> 
#> $hdf
#> NULL
#> 
#> $geometrical_sets
#> NULL
#> 
#> $xpath
#> [1] "time_loop/output"
#> 
#> $attr_names
#> character(0)
#> 
#> $flatten_on_exp
#> [1] "fixed_output_times"
#> 
#> attr(,"class")
#> [1] "prj_output"