API reference

ogstools package

ogstools.cli()

Allows access to ogs binary tools via python and performs checks to see if OGS is installed correctly.

Example cli().vtkdiff(“file1.vtu”, “file2.vtu”)

Returns:

A CLI object that supports ogs command line tools.

Return type:

Any

ogstools.status(verbose=False)

Checks if OGS is installed correctly. It prints detailed error message if OGS is not installed correctly.

param verbose:

If verbose is True it prints always the status of related environment variables. (OGS_BIN_PATH, PATH, virtual environment)

Returns:

True if OGS is installed correctly, False otherwise.

Return type:

bool

Subpackages

• ogstools.feflowlib package
  • assign_bulk_ids()
  • FeflowModel
    • FeflowModel.__init__()
    • FeflowModel.ogs_bulk_mesh
    • FeflowModel.process
    • FeflowModel.material_properties
    • FeflowModel.setup_prj()
    • FeflowModel.save()
    • FeflowModel.run()
  • remove_bulk_ids()
  • Submodules
    • ogstools.feflowlib.feflow_model module
      • FeflowModel
• 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()
  • Submodules
    • ogstools.logparser.common_ogs_analyses module
      • pre_post_check()
      • analysis_time_step()
      • analysis_simulation()
      • analysis_convergence_newton_iteration()
      • analysis_convergence_coupling_iteration()
      • time_step_vs_iterations()
      • errors_per_ts_iteration()
      • convergence_order_per_ts_iteration()
      • model_and_clock_time()
      • analysis_simulation_termination()
      • fill()
      • fill_ogs_context()
    • ogstools.logparser.log_file_handler module
      • LogFileHandler
    • ogstools.logparser.log_parser module
      • read_mpi_processes()
      • normalize_regex()
      • simple_consumer()
      • parse_line()
      • read_version()
      • parse_file()
      • select_regex()
    • ogstools.logparser.plots module
      • plot_convergence_order()
      • plot_convergence()
    • ogstools.logparser.regexes module
      • Log
      • Info
      • Termination
      • WarningType
      • ErrorType
      • CriticalType
      • MPIProcess
      • NoRankOutput
      • OGSVersionLog
      • OGSVersionLog2
      • StepStatus
      • Context
      • TimeStepContext
      • TimeStepProcessContext
      • TimeStepProcessIterationContext
      • AssemblyTime
      • TimeStepEnd
      • IterationStart
      • IterationEnd
      • CouplingIterationStart
      • CouplingIterationEnd
      • TimeStepStart
      • TimeStepOutputTime
      • SolvingProcessStart
      • SolvingProcessEnd
      • TimeStepSolutionTimeCoupledScheme
      • TimeStepFinishedTime
      • DirichletTime
      • LinearSolverTime
      • MeshReadTime
      • SimulationExecutionTime
      • SimulationExecutionTimeFailed
      • SimulationAbort
      • ComponentConvergenceCriterion
      • TimeStepConvergenceCriterion
      • CouplingIterationConvergence
      • GenericCodePoint
      • PhaseFieldEnergyVar
      • ErrorMessage
      • CriticalMessage
      • WarningMessage
      • SimulationStartTime
      • SimulationEndTime
      • SimulationEndTimeFailed
      • ogs_regexes()
      • new_regexes()
• ogstools.meshlib package
  • Boundary
    • Boundary.dim()
  • Gaussian2D()
  • Layer
    • Layer.top
    • Layer.bottom
    • Layer.material_id
    • Layer.num_subdivisions
    • Layer.create_raster()
    • Layer.dim()
    • Layer.__init__()
  • LayerSet
    • LayerSet.__init__()
    • LayerSet.bounds()
    • LayerSet.filenames()
    • LayerSet.from_pandas()
    • LayerSet.create_raster()
    • LayerSet.create_rasters()
  • LocationFrame
    • LocationFrame.xmin
    • LocationFrame.xmax
    • LocationFrame.ymin
    • LocationFrame.ymax
    • LocationFrame.as_gml()
    • LocationFrame.__init__()
  • Mesh
    • Mesh.filepath
    • Mesh.difference()
    • Mesh.depth()
    • Mesh.p_fluid()
    • Mesh.plot_contourf()
    • Mesh.plot_quiver()
    • Mesh.plot_streamlines()
    • Mesh.to_ip_mesh()
    • Mesh.to_ip_point_cloud()
    • Mesh.__init__()
    • Mesh.read()
    • Mesh.reindex_material_ids()
    • Mesh.read_feflow()
  • MeshSeries
    • MeshSeries.__init__()
    • MeshSeries.from_data()
    • MeshSeries.extend()
    • MeshSeries.resample()
    • MeshSeries.extract_probe()
    • MeshSeries.copy()
    • MeshSeries.__getitem__()
    • MeshSeries.items()
    • MeshSeries.aggregate_over_time()
    • MeshSeries.clear_cache()
    • MeshSeries.closest_timestep()
    • MeshSeries.closest_timevalue()
    • MeshSeries.ip_tesselated()
    • MeshSeries.mesh()
    • MeshSeries.rawdata_file()
    • MeshSeries.read_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_over_domain()
    • MeshSeries.plot_domain_aggregate()
    • MeshSeries.probe()
    • MeshSeries.plot_probe()
    • MeshSeries.plot_time_slice()
    • MeshSeries.mesh_func
    • MeshSeries.transform()
    • MeshSeries.scale()
    • MeshSeries.extract()
    • MeshSeries.save()
    • MeshSeries.remove_array()
  • Raster
    • Raster.frame
    • Raster.resolution
    • Raster.__init__()
    • Raster.as_vtu()
  • Surface
    • Surface.material_id
    • Surface.__init__()
    • Surface.create_raster_file()
  • cuboid()
  • difference()
  • difference_matrix()
  • difference_pairwise()
  • meshes_from_gmsh()
  • rect()
  • to_ip_mesh()
  • to_ip_point_cloud()
  • to_region_prism()
  • to_region_simplified()
  • to_region_tetraeder()
  • to_region_voxel()
  • Subpackages
    • ogstools.meshlib.region package
      • to_region_prism()
      • to_region_simplified()
      • to_region_tetraeder()
      • to_region_voxel()
      • RegionSet
      • to_boundary()
      • Submodules
  • Submodules
    • ogstools.meshlib.boundary module
      • Boundary
      • Layer
      • LocationFrame
      • Raster
    • ogstools.meshlib.boundary_set module
      • BoundarySet
      • LayerSet
    • ogstools.meshlib.boundary_subset module
      • Surface
      • Gaussian2D()
    • ogstools.meshlib.data_dict module
      • DataDict
    • ogstools.meshlib.data_processing module
      • difference()
      • difference_pairwise()
      • difference_matrix()
    • ogstools.meshlib.geo module
      • depth()
      • p_fluid()
    • ogstools.meshlib.gmsh_BHE module
      • Groundwater
      • BHE
      • gen_bhe_mesh_gmsh()
      • gen_bhe_mesh()
    • ogstools.meshlib.gmsh_converter module
      • meshes_from_gmsh()
    • ogstools.meshlib.gmsh_meshing module
      • rect()
      • cuboid()
      • remesh_with_triangles()
    • ogstools.meshlib.ip_mesh module
      • tessellate()
      • to_ip_point_cloud()
      • to_ip_mesh()
    • ogstools.meshlib.mesh module
      • Mesh
    • ogstools.meshlib.mesh_series module
      • MeshSeries
    • ogstools.meshlib.refine_mesh module
      • refine()
    • ogstools.meshlib.xdmf_reader module
      • DataItem
      • H5DataItem
      • XMLDataItem
      • BinaryDataItem
      • DataItems
      • XDMFReader
• ogstools.msh2vtu package
• ogstools.ogs6py package
  • Project
    • Project.__init__()
    • 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.restart()
    • Project.run_model()
    • Project.status
    • Project.terminate_run()
    • Project.write_input()
    • Project.property_dataframe()
    • Project.write_property_latextable()
  • Submodules
    • ogstools.ogs6py.build_tree module
      • BuildTree
    • ogstools.ogs6py.curves module
      • Curves
    • ogstools.ogs6py.display module
      • Display
    • ogstools.ogs6py.geo module
      • Geo
    • ogstools.ogs6py.linsolvers module
      • LinSolvers
    • ogstools.ogs6py.local_coordinate_system module
      • LocalCoordinateSystem
    • ogstools.ogs6py.media module
      • Media
    • ogstools.ogs6py.mesh module
      • Mesh
    • ogstools.ogs6py.nonlinsolvers module
      • NonLinSolvers
    • ogstools.ogs6py.parameters module
      • Parameters
    • ogstools.ogs6py.processes module
      • Processes
    • ogstools.ogs6py.processvars module
      • ProcessVars
    • ogstools.ogs6py.project module
      • Project
    • ogstools.ogs6py.properties module
      • Value
      • Property
      • PropertySet
    • ogstools.ogs6py.python_script module
      • PythonScript
    • ogstools.ogs6py.timeloop module
      • TimeLoop
• ogstools.physics package
  • Subpackages
    • ogstools.physics.nuclearwasteheat package
      • Submodules
• ogstools.plot package
  • animate()
  • compute_levels()
  • contourf()
  • heatmap()
  • line()
  • quiver()
  • shape_on_top()
  • streamlines()
  • subplot()
  • Submodules
    • ogstools.plot.animation module
      • animate()
    • ogstools.plot.contourplots module
      • get_ticklabels()
      • add_colorbars()
      • subplot()
      • draw_plot()
      • contourf()
    • ogstools.plot.features module
      • layer_boundaries()
      • element_edges()
      • shape_on_top()
    • ogstools.plot.heatmaps module
      • heatmap()
    • ogstools.plot.levels module
      • nice_num()
      • nice_range()
      • adaptive_rounding()
      • compute_levels()
      • median_exponent()
      • combined_levels()
      • level_boundaries()
    • ogstools.plot.lineplots module
      • line()
    • ogstools.plot.plot_setup module
      • PlotSetup
    • ogstools.plot.plot_setup_defaults module
    • ogstools.plot.shared module
    • ogstools.plot.utils module
      • get_style_cycler()
      • justified_labels()
      • label_spatial_axes()
      • label_ax()
      • update_font_sizes()
      • get_data_aspect()
      • get_rows_cols()
      • get_projection()
      • save_animation()
      • get_cmap_norm()
      • contrast_color()
      • colors_from_cmap()
      • padded()
      • color_twin_axes()
    • ogstools.plot.vectorplots module
      • streamlines()
      • quiver()
• ogstools.studies package
  • Subpackages
    • ogstools.studies.convergence package
      • add_grid_spacing()
      • convergence_metrics()
      • convergence_metrics_evolution()
      • grid_convergence()
      • log_fit()
      • plot_convergence()
      • plot_convergence_errors()
      • plot_convergence_error_evolution()
      • plot_convergence_order_evolution()
      • richardson_extrapolation()
      • run_convergence_study()
      • Submodules
• ogstools.variables package
  • Submodules
    • ogstools.variables.custom_colormaps module
    • ogstools.variables.matrix module
      • Matrix
    • ogstools.variables.mesh_dependent module
      • fluid_pressure_criterion()
      • dilatancy_critescu()
      • dilatancy_alkan()
    • ogstools.variables.tensor_math module
      • identity()
      • sym_tensor_to_mat()
      • trace()
      • matrix_trace()
      • eigenvalues()
      • eigenvectors()
      • det()
      • frobenius_norm()
      • invariant_1()
      • invariant_2()
      • invariant_3()
      • mean()
      • effective_pressure()
      • hydrostatic_component()
      • deviator()
      • deviator_invariant_1()
      • deviator_invariant_2()
      • deviator_invariant_3()
      • octahedral_shear()
      • von_mises()
      • qp_ratio()
    • ogstools.variables.unit_registry module
    • ogstools.variables.variable module
      • Variable
      • Scalar
    • ogstools.variables.vector module
      • vector_norm()
      • Vector
      • BHE_Vector
      • VectorList
• ogstools.workflow package
  • jupytext_to_jupyter()
  • jupyter_to_html()
  • Submodules
    • ogstools.workflow.jupyter_conversion module
      • jupyter_to_html()
      • jupytext_to_jupyter()

Submodules

• ogstools.definitions module