API reference

ogstools package

Subpackages

• ogstools.feflowlib package
  • combine_material_properties()
  • convert_geometry_mesh()
  • convert_properties_mesh()
  • deactivate_cells()
  • extract_cell_boundary_conditions()
  • extract_point_boundary_conditions()
  • get_specific_surface()
  • helpFormat
  • liquid_flow()
  • points_and_cells()
  • setup_prj_file()
  • steady_state_diffusion()
  • update_geometry()
  • write_mesh_of_combined_properties()
  • write_point_boundary_conditions()
  • Submodules
    • ogstools.feflowlib.templates module
      • steady_state_diffusion()
      • liquid_flow()
    • ogstools.feflowlib.tools module
      • helpFormat
      • get_specific_surface()
      • assign_bulk_ids()
      • extract_point_boundary_conditions()
      • write_point_boundary_conditions()
      • extract_cell_boundary_conditions()
      • get_material_properties()
      • combine_material_properties()
      • write_mesh_of_combined_properties()
      • materials_in_steady_state_diffusion()
      • materials_in_liquid_flow()
      • setup_prj_file()
      • deactivate_cells()
• ogstools.meshlib package
  • Surface
    • Surface.material_id
    • Surface.__init__()
    • Surface.create_raster_file()
  • Layer
    • Layer.top
    • Layer.bottom
    • Layer.material_id
    • Layer.num_subdivisions
    • Layer.create_raster()
    • Layer.dim()
    • Layer.__init__()
  • Raster
    • Raster.frame
    • Raster.resolution
    • Raster.__init__()
    • Raster.as_vtu()
  • LocationFrame
    • LocationFrame.xmin
    • LocationFrame.xmax
    • LocationFrame.ymin
    • LocationFrame.ymax
    • LocationFrame.as_gml()
    • LocationFrame.__init__()
  • Boundary
    • Boundary.dim()
  • MeshSeries
    • MeshSeries.__init__()
    • MeshSeries.read()
    • MeshSeries.clear()
    • MeshSeries.timesteps
    • MeshSeries.timevalues
    • MeshSeries.closest_timestep()
    • MeshSeries.closest_timevalue()
    • MeshSeries.read_closest()
    • MeshSeries.read_interp()
  • LayerSet
    • LayerSet.__init__()
    • LayerSet.bounds()
    • LayerSet.filenames()
    • LayerSet.from_pandas()
    • LayerSet.create_raster()
    • LayerSet.create_rasters()
  • rect()
  • cuboid()
  • 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.gmsh_meshing module
      • rect()
      • cuboid()
    • ogstools.meshlib.mesh_series module
      • TimeSeriesReader
      • MeshSeries
    • ogstools.meshlib.refine_mesh module
      • refine()
• ogstools.meshplotlib package
  • plot()
  • plot_on_top()
  • plot_contour()
  • subplot()
  • Submodules
    • ogstools.meshplotlib.animation module
      • timeline()
      • animate()
      • save_animation()
    • ogstools.meshplotlib.core module
      • get_data()
      • get_level_boundaries()
      • get_cmap_norm()
      • fix_scientific_offset_position()
      • y_update_offset_text_position()
      • add_colorbars()
      • subplot()
      • get_combined_levels()
      • get_data_aspect()
      • plot()
    • ogstools.meshplotlib.levels module
      • nice_num()
      • nice_range()
      • adaptive_rounding()
      • get_levels()
    • ogstools.meshplotlib.plot_features module
      • plot_layer_boundaries()
      • plot_element_edges()
      • plot_streamlines()
      • plot_on_top()
      • plot_contour()
    • ogstools.meshplotlib.plot_setup module
      • PlotSetup
    • ogstools.meshplotlib.plot_setup_defaults module
• ogstools.msh2vtu package
  • my_remove_orphaned_nodes()
  • print_info()
  • find_cells_at_nodes()
  • find_connected_domain_cells()
  • msh2vtu()
  • Subpackages
    • ogstools.msh2vtu.tools package
      • Subpackages
• ogstools.physics package
  • Subpackages
    • ogstools.physics.nuclearwasteheat package
      • Submodules
• ogstools.propertylib package
  • Property
    • Property.data_name
    • Property.data_unit
    • Property.output_unit
    • Property.output_name
    • Property.mask
    • Property.func()
    • Property.bilinear_cmap
    • Property.categoric
    • Property.type_name
    • Property.replace()
    • Property.strip_units()
    • Property.get_output_unit()
    • Property.is_mask()
    • Property.get_mask()
    • Property.magnitude
    • Property.__init__()
  • Scalar
    • Scalar.__init__()
    • Scalar.data_name
  • Vector
    • Vector.__init__()
    • Vector.data_name
    • Vector.magnitude
    • Vector.log_magnitude
  • Matrix
    • Matrix.__init__()
    • Matrix.data_name
    • Matrix.magnitude
    • Matrix.trace
  • Submodules
    • ogstools.propertylib.presets module
      • find_property_preset()
    • ogstools.propertylib.property module
      • Property
      • Scalar
      • Vector
      • Matrix
    • ogstools.propertylib.utils module
      • dim_from_len()
      • sym_tensor_to_mat()
      • identity()
    • ogstools.propertylib.vector2scalar module
      • trace()
      • effective_pressure()
      • von_mises()
      • qp_ratio()
• 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.workflow package
  • jupytext_to_jupyter()
  • jupyter_to_html()
  • Submodules
    • ogstools.workflow.jupyter_conversion module
      • jupyter_to_html()
      • jupytext_to_jupyter()

Submodules

• ogstools.definitions module