ogs6py.classes.timeloop

Copyright (c) 2012-2021, OpenGeoSys Community (http://www.opengeosys.org)
Distributed under a Modified BSD License.

See accompanying file LICENSE or http://www.opengeosys.org/project/license

class ogs6py.classes.timeloop.TimeLoop

Bases: BuildTree

Class managing the time loop in the project file

add_output(**args)

Add output section.

Parameters:

  • type (str) –

  • prefix (str) –

  • suffix (str) –

  • variables (list or str) –

  • data_mode (str) –

  • compress_output (str) –

  • output_iteration_results (bool or str) –

  • meshes (str) –

  • repeat (list or str) –

  • each_steps (list or str) –

  • fixed_output_times (list or str) –

add_output_pair(**args)

add an output pair

Parameters:

  • repeat (int or str) –

  • each_steps (int or str) –

add_process(**args)

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) –

add_time_stepping_pair(**args)

add a time stepping pair

Parameters:

  • repeat (int or str) –

  • delta_t (int or str) –

classmethod populate_tree(tag, text='', attr=None, children=None)

method to create dictionary from an xml entity

set_stepping(**args)

Sets the time stepping

Parameters:

  • type (str) –

  • process (str) –

  • t_initial (int 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) –

property tree