Skip to contents

OGS6_Ensemble

OGS6_Ensemble.Rd

Constructor for the OGS6_Ensemble base class

Active bindings

dp_parameters

Getter for private parameter '.dp_parameters'

parameter_percs

Getter for private parameter '.parameter_percs'

parameter_values

Getter for private parameter '.parameter_values'

ens_path

Getter for private parameter '.ens_path'

ensemble

Getter for private parameter '.ensemble'

Methods

Public methods

Method new()

Creates new OGS6_Ensemble object

Usage

OGS6_Ensemble$new(
  ogs6_obj,
  parameters,
  sequential_mode = FALSE,
  percentages_mode = TRUE
)

Arguments

ogs6_obj

OGS6: A simulation object.

parameters

list(sublist, length(sublist) == 2): The first element of a sublist references an OGS6 parameter, the second one is a list or vector of values. Note that the second elements of the sublists must have the same length.

sequential_mode

flag: Defaults to `FALSE`

percentages_mode

flag: Defaults to `TRUE`

Method print()

Overrides default printing behaviour

Usage

OGS6_Ensemble$print()

Method run_simulation()

Runs the simulation. This calls r2ogs6::ogs6_run_simulation() internally. For ensembles, output will always be written to logfiles.

Usage

OGS6_Ensemble$run_simulation(parallel = FALSE, overwrite = T, verbose = F)

Arguments

parallel

flag: Should the function be run in parallel? This is implementented via the 'parallel' package.

overwrite

flag: Should existing files be overwritten?

verbose

flag

Method get_point_data()

Wrapper for `OGS6_pvd$get_point_data()` Returns combined dataframe with extra `name` and / or `perc` column depending on if `sequential_mode` and / or `percentages_mode` were used.

Usage

OGS6_Ensemble$get_point_data(
  pvd_id = 1,
  point_ids,
  keys,
  start_at_timestep,
  end_at_timestep
)

Arguments

pvd_id

number: Optional: Which .pvd to consider in OGS6$pvds. Defaults to 1.

point_ids

numeric: Optional: Point IDs. Defaults to all.

keys

character: Optional: `Name` attributes of `DataArray` elements. Defaults to all.

start_at_timestep

number: Optional: Timestep to start at. Defaults to first timestep.

end_at_timestep

number: Optional: Timestep to end at. Defaults to last timestep.

Method clone()

The objects of this class are cloneable with this method.

Usage

OGS6_Ensemble$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.