API Reference

---

Class

Parameters: Group input parameters.

Class Methods

• __init__

  
                              def __init__(self, params):
          
                                  self.readers = {}
                                  self.object_init = {}
                                  self.simulation_run = {}
                                  self.classify(params)
                              

• classify

  
                              def classify(self, params):
  
                                  for key, value in params.items():
                                      if key in ["temperature", "current", "bathymetry", "readerbuffer"]:
                                          self.readers[key] = value
                                      elif key == "decaytype":
                                          self.object_init["decay_type"] = value
                                      elif key == "initialvelocity":
                                          self.object_init["initial_velocity"] = value
                                      elif key == "advection":
                                          self.object_init["deactivate_horizontal_advection"] = value
                                      elif key == "fragmentation":
                                          self.object_init["deactivate_fragmentation"] = value
                                      elif key in ["loglevel", "starttime", "ffunction", "vertical_velocity_type"]:
                                          self.object_init[key] = value
                                      elif key == "timestep":
                                          self.simulation_run["time_step"] = value
                                      elif key == "timestepoutput":
                                          self.simulation_run["time_step_output"] = value
                                      elif key in ["steps", "outfile", "export_variables"]:
                                          self.simulation_run[key] = value
                                      else:
                                          raise Warning("Got an unexpected parameter: " + key)