API reference

• ogstools package
  • Execution
    • Execution.default
    • Execution.CONTAINER_SERIAL
    • Execution.CONTAINER_PARALLEL
    • Execution.__init__()
    • Execution.from_file()
    • Execution.from_id()
    • Execution.save()
    • Execution.env
    • Execution.container_path
    • Execution.container_prefix
    • Execution.cmd
    • Execution.from_default()
  • Log
    • Log.__init__()
    • Log.convergence_coupling_iteration()
    • Log.convergence_newton_iteration()
    • Log.simulation()
    • Log.simulation_termination()
    • Log.time_step()
    • Log.plot_convergence()
    • Log.plot_convergence_order()
  • MaterialManager
    • MaterialManager.__init__()
    • MaterialManager.set_material()
    • MaterialManager.get_material()
    • MaterialManager.filter()
  • MediaSet
    • MediaSet.__init__()
    • MediaSet.__getitem__()
    • MediaSet.keys()
    • MediaSet.values()
    • MediaSet.items()
    • MediaSet.to_dict()
    • MediaSet.get_by_id()
    • MediaSet.from_project()
    • MediaSet.validate()
    • MediaSet.validate_medium()
  • MeshSeries
    • MeshSeries.__init__()
    • MeshSeries.from_data()
    • MeshSeries.from_id()
    • MeshSeries.extend()
    • MeshSeries.resample_temporal()
    • MeshSeries.probe()
    • MeshSeries.interpolate()
    • MeshSeries.__getitem__()
    • MeshSeries.items()
    • MeshSeries.aggregate_temporal()
    • MeshSeries.clear_cache()
    • MeshSeries.closest_timestep()
    • MeshSeries.closest_timevalue()
    • MeshSeries.ip_tesselated()
    • MeshSeries.mesh()
    • MeshSeries.rawdata_file()
    • MeshSeries.mesh_interp()
    • MeshSeries.timevalues
    • MeshSeries.timesteps
    • MeshSeries.values()
    • MeshSeries.point_data
    • MeshSeries.cell_data
    • MeshSeries.field_data
    • MeshSeries.time_of_min()
    • MeshSeries.time_of_max()
    • MeshSeries.aggregate_spatial()
    • MeshSeries.probe_values()
    • MeshSeries.plot_line()
    • MeshSeries.plot_time_slice()
    • MeshSeries.mesh_func
    • MeshSeries.transform()
    • MeshSeries.scale()
    • MeshSeries.difference()
    • MeshSeries.compare()
    • MeshSeries.extract()
    • MeshSeries.save()
    • MeshSeries.remove_array()
  • Meshes
    • Meshes.__init__()
    • Meshes.num_partitions
    • Meshes.add_partitions()
    • Meshes.from_folder()
    • Meshes.__getitem__()
    • Meshes.from_files()
    • Meshes.from_file()
    • Meshes.from_id()
    • Meshes.from_gmsh()
    • Meshes.from_yaml()
    • Meshes.from_mesh()
    • Meshes.add_gml_subdomains()
    • Meshes.sort()
    • Meshes.save()
    • Meshes.validate()
    • Meshes.domain
    • Meshes.domain_name
    • Meshes.subdomains
    • Meshes.identify_subdomain()
    • Meshes.rename_subdomains()
    • Meshes.modify_names()
    • Meshes.rename_subdomains_legacy()
    • Meshes.create_metis()
    • Meshes.create_partitioning()
    • Meshes.plot()
    • Meshes.remove_material()
  • Model
    • Model.__init__()
    • Model.from_folder()
    • Model.from_id()
    • Model.save()
    • Model.run()
    • Model.controller()
    • Model.cmd
    • Model.plot_constraints()
  • Project
    • Project.__init__()
    • Project.prjfile
    • Project.from_folder()
    • Project.from_id()
    • Project.dependencies()
    • Project.dependencies_of_file()
    • Project.add_element()
    • Project.add_include()
    • Project.add_block()
    • Project.deactivate_property()
    • Project.deactivate_parameter()
    • Project.remove_element()
    • Project.replace_text()
    • Project.replace_block_by_include()
    • Project.replace_mesh()
    • Project.replace_parameter()
    • Project.replace_parameter_value()
    • Project.replace_phase_property_value()
    • Project.replace_medium_property_value()
    • Project.set()
    • Project.meshseries_file()
    • Project.run_model()
    • Project.write_input()
    • Project.save()
    • Project.property_dataframe()
    • Project.write_property_latextable()
    • Project.set_media()
    • Project.meshpaths()
    • Project.param_value_expression()
    • Project.constraints()
    • Project.constraints_labels()
  • Simulation
    • Simulation.Status
    • Simulation.from_id()
    • Simulation.from_folder()
    • Simulation.__init__()
    • Simulation.status
    • Simulation.status_str
    • Simulation.cmd
    • Simulation.log_file
    • Simulation.log
    • Simulation.meshseries_file
    • Simulation.meshseries
    • Simulation.save()
    • Simulation.restart()
  • Subpackages
    • ogstools.core namespace
      • Submodules
    • ogstools.feflowlib package
      • FeflowModel
      • assign_bulk_ids()
      • read_feflow()
      • remove_bulk_ids()
      • Submodules
    • ogstools.gmsh_tools package
      • cuboid()
      • rect()
      • remesh_with_triangles()
      • Submodules
    • ogstools.logparser package
      • analysis_convergence_coupling_iteration()
      • analysis_convergence_newton_iteration()
      • analysis_simulation()
      • analysis_simulation_termination()
      • analysis_time_step()
      • convergence_order_per_ts_iteration()
      • errors_per_ts_iteration()
      • fill_ogs_context()
      • model_and_clock_time()
      • ogs_regexes()
      • parse_file()
      • plot_convergence()
      • plot_convergence_order()
      • read_version()
      • time_step_vs_iterations()
      • time_step_vs_step_size_and_time()
      • Submodules
    • ogstools.materiallib package
      • Subpackages
    • ogstools.mesh package
      • check_datatypes()
      • depth()
      • difference()
      • difference_matrix()
      • difference_pairwise()
      • from_simulator()
      • ip_data_threshold()
      • ip_metadata()
      • node_reordering()
      • read()
      • save()
      • to_ip_mesh()
      • to_ip_point_cloud()
      • validate()
      • Subpackages
      • Submodules
    • ogstools.meshes package
      • Submodules
    • ogstools.meshseries package
      • Submodules
    • ogstools.msh2vtu package
    • ogstools.ogs6py package
      • Submodules
    • ogstools.physics package
      • Subpackages
    • ogstools.plot package
      • animate()
      • compute_levels()
      • contourf()
      • contourf_pv()
      • heatmap()
      • line()
      • quiver()
      • shape_on_top()
      • streamlines()
      • subplot()
      • Submodules
    • ogstools.studies package
      • Subpackages
    • ogstools.variables package
      • Matrix
      • Scalar
      • Variable
      • Vector
      • Submodules
    • ogstools.workflow package
      • jupyter_to_html()
      • jupytext_to_jupyter()
      • Submodules
  • Submodules
    • ogstools.definitions module