API reference

ogstools package

Subpackages

• ogstools.fe2vtu package
  • get_geo_mesh()
  • get_specific_surface()
  • get_property_mesh()
  • helpFormat
  • update_geo_mesh()
  • write_xml()
  • Submodules
    • ogstools.fe2vtu.fe2vtu module
      • get_pts_cells()
      • get_matids_from_selections()
      • get_pt_cell_data()
      • get_geo_mesh()
      • update_geo_mesh()
      • get_property_mesh()
    • ogstools.fe2vtu.tools module
      • helpFormat
      • get_specific_surface()
      • write_xml()
• ogstools.meshplotlib package
  • PlotSetup
    • PlotSetup.cmap_dict_if_component
    • PlotSetup.cmap_dict
    • PlotSetup.cmap_if_mask
    • PlotSetup.default_cmap
    • PlotSetup.dpi
    • PlotSetup.fig_scale
    • PlotSetup.figsize
    • PlotSetup.length
    • PlotSetup.material_names
    • PlotSetup.num_levels
    • PlotSetup.num_streamline_interp_pts
    • PlotSetup.p_max
    • PlotSetup.p_min
    • PlotSetup.rcParams
    • PlotSetup.scale_type
    • PlotSetup.show_aspect_ratio
    • PlotSetup.show_element_edges
    • PlotSetup.show_layer_bounds
    • PlotSetup.cmap_str()
    • PlotSetup.rcParams_scaled
    • PlotSetup.from_dict()
    • PlotSetup.reset()
    • PlotSetup.__init__()
  • plot()
  • plot_isometric()
  • subplot()
  • Mesh
    • Mesh.__init__()
    • Mesh.from_file()
  • MeshSeries
    • MeshSeries.__init__()
    • MeshSeries.read()
    • MeshSeries.timesteps
    • MeshSeries.timevalues
    • MeshSeries.timestep_from_value()
    • MeshSeries.read_closest_timestep()
  • Submodules
    • ogstools.meshplotlib.core module
      • xin_cell_data()
      • get_data()
      • get_cmap_norm()
      • plot_isometric()
      • add_colorbar()
      • subplot()
      • plot()
    • ogstools.meshplotlib.default_setup module
    • ogstools.meshplotlib.image_tools module
      • trim()
      • save_plot()
    • ogstools.meshplotlib.levels module
      • nice_num()
      • nice_range()
      • get_levels()
    • ogstools.meshplotlib.mesh module
      • Mesh
    • ogstools.meshplotlib.mesh_series module
      • MeshSeries
    • ogstools.meshplotlib.plot_features module
      • plot_layer_boundaries()
      • plot_element_edges()
      • plot_streamlines()
      • get_aspect()
• ogstools.msh2vtu package
  • my_remove_orphaned_nodes()
  • print_info()
  • find_cells_at_nodes()
  • find_connected_domain_cells()
  • run()
  • 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.tag
    • Property.replace()
    • Property.values()
    • Property.get_output_unit()
    • Property.is_component()
    • Property.is_mask()
    • Property.get_mask()
    • Property.__init__()
  • ScalarProperty
    • ScalarProperty.__init__()
  • VectorProperty
    • VectorProperty.__init__()
    • VectorProperty.magnitude
    • VectorProperty.log_magnitude
  • MatrixProperty
    • MatrixProperty.__init__()
    • MatrixProperty.magnitude
    • MatrixProperty.trace
  • Submodules
    • ogstools.propertylib.defaults module
    • ogstools.propertylib.property module
      • TagType
      • Property
      • ScalarProperty
      • VectorProperty
      • MatrixProperty
    • ogstools.propertylib.property_collection module
      • PropertyCollection
    • ogstools.propertylib.utils module
      • dim_from_len()
      • sym_tensor_to_mat()
      • identity()
    • ogstools.propertylib.vector2scalar module
      • trace()
      • effective_pressure()
      • von_mises()
      • qp_ratio()