ogstools.ogs6py.timeloop module#

Distributed under a Modified BSD License.: See accompanying file LICENSE or http://www.opengeosys.org/project/license

class ogstools.ogs6py.timeloop.TimeLoop[source]#

Bases: BuildTree

Class managing the time loop in the project file.

__init__(tree)[source]#

add_process(**args)[source]#

Add a process section to timeloop.

Parameters#

process : str convergence_type : str abstol : str abstols : str reltol : str reltols : str norm_type : str nonlinear_solver_name : str time_discretization : str

set_stepping(**args)[source]#

Sets the time stepping.

Parameters#

type : str process : str process_count : int for staggered coupling t_initial : int or str initial_dt : float or str t_end : int or str repeat : int or str delta_t : float or str minimum_dt : float or str maximum_dt : float or str number_iterations : list multiplier : list dt_guess : float or str dt_min : float or str dt_max : float or str rel_dt_max : float or str rel_dt_min : float or str tol : float or str

add_output(**args)[source]#

Add output section.

Parameters#

type : str prefix : str suffix : str variables : list data_mode : str compress_output : str output_iteration_results: bool or str meshes : list or str repeat : list or str each_steps : list or str fixed_output_times : list or str

add_time_stepping_pair(**args)[source]#

Add a time stepping pair.

Parameters#

process : str process_count : int optional, for staggered coupling repeat : int or str or list delta_t : int or str or list

add_output_pair(**args)[source]#

Add an output pair.

Parameters#

repeat : int or str or list each_steps : int or str or list

add_global_process_coupling(**args)[source]#

Add a process section to the timeloop.

Parameters#

max_iter : str optional, needs to be specified once convergence_type : str abstol : str abstols : str reltol : str reltols : str norm_type : str local_coupling_processes : list with names local_coupling_processes_max_iter : str