polaris.ocean.convergence.get_timestep_for_task

polaris.ocean.convergence.get_timestep_for_task(config, refinement_factor, refinement='both')[source]

Get the time step for a forward step in a convergence task

Parameters:
  • config (polaris.Config) – The config options for this task

  • refinement_factor (float) – The factor by which either resolution or time is refined for this step

  • refinement (str, optional) – Whether to refine in space, time or both

Returns:

resolution (float) – The resolution corresponding to the refinement_factor and convergence test type