Library References

API References

• gustaf
  • gustaf.create
    • gustaf.create.edges
      • gustaf.create.edges.from_data
        • from_data()
      • gustaf.create.edges.from_vertices
        • from_vertices()
    • gustaf.create.faces
      • gustaf.create.faces.box
        • box()
      • gustaf.create.faces.edges_as_quad
        • edges_as_quad()
      • gustaf.create.faces.to_quad
        • to_quad()
      • gustaf.create.faces.to_simplex
        • to_simplex()
      • gustaf.create.faces.vertex_normals
        • vertex_normals()
    • gustaf.create.vertices
      • gustaf.create.vertices.raster
        • raster()
    • gustaf.create.volumes
      • gustaf.create.volumes.box
        • box()
  • gustaf.edges
    • gustaf.edges.Edges
      • Edges
      • gustaf.edges.Edges.centers
        • Edges.centers()
      • gustaf.edges.Edges.dashed
        • Edges.dashed()
      • gustaf.edges.Edges.referenced_vertices
        • Edges.referenced_vertices()
      • gustaf.edges.Edges.remove_unreferenced_vertices
        • Edges.remove_unreferenced_vertices()
      • gustaf.edges.Edges.shrink
        • Edges.shrink()
      • gustaf.edges.Edges.single_edges
        • Edges.single_edges()
      • gustaf.edges.Edges.sorted_edges
        • Edges.sorted_edges()
      • gustaf.edges.Edges.to_vertices
        • Edges.to_vertices()
      • gustaf.edges.Edges.unique_edges
        • Edges.unique_edges()
      • gustaf.edges.Edges.update_edges
        • Edges.update_edges()
      • gustaf.edges.Edges.update_elements
        • Edges.update_elements()
      • gustaf.edges.Edges.const_edges
        • Edges.const_edges
      • gustaf.edges.Edges.const_elements
        • Edges.const_elements
      • gustaf.edges.Edges.edges
        • Edges.edges
      • gustaf.edges.Edges.elements
        • Edges.elements
      • gustaf.edges.Edges.kind
        • Edges.kind
      • gustaf.edges.Edges.whatami
        • Edges.whatami
    • gustaf.edges.EdgesShowOption
      • EdgesShowOption
  • gustaf.faces
    • gustaf.faces.Faces
      • Faces
      • gustaf.faces.Faces.dashed
        • Faces.dashed()
      • gustaf.faces.Faces.edges
        • Faces.edges()
      • gustaf.faces.Faces.single_faces
        • Faces.single_faces()
      • gustaf.faces.Faces.sorted_faces
        • Faces.sorted_faces()
      • gustaf.faces.Faces.to_edges
        • Faces.to_edges()
      • gustaf.faces.Faces.to_subelements
        • Faces.to_subelements()
      • gustaf.faces.Faces.unique_faces
        • Faces.unique_faces()
      • gustaf.faces.Faces.update_edges
        • Faces.update_edges()
      • gustaf.faces.Faces.update_faces
        • Faces.update_faces()
      • gustaf.faces.Faces.whatareyou
        • Faces.whatareyou()
      • gustaf.faces.Faces.BC
        • Faces.BC
      • gustaf.faces.Faces.const_edges
        • Faces.const_edges
      • gustaf.faces.Faces.const_faces
        • Faces.const_faces
      • gustaf.faces.Faces.faces
        • Faces.faces
      • gustaf.faces.Faces.kind
        • Faces.kind
      • gustaf.faces.Faces.whatami
        • Faces.whatami
    • gustaf.faces.FacesShowOption
      • FacesShowOption
  • gustaf.helpers
    • gustaf.helpers.data
      • gustaf.helpers.data.make_tracked_array
        • make_tracked_array()
      • gustaf.helpers.data.ComputedData
        • ComputedData
        • gustaf.helpers.data.ComputedData.depends_on
          • ComputedData.depends_on()
      • gustaf.helpers.data.ComputedMeshData
        • ComputedMeshData
      • gustaf.helpers.data.DataHolder
        • DataHolder
        • gustaf.helpers.data.DataHolder.clear
          • DataHolder.clear()
        • gustaf.helpers.data.DataHolder.get
          • DataHolder.get()
        • gustaf.helpers.data.DataHolder.items
          • DataHolder.items()
        • gustaf.helpers.data.DataHolder.keys
          • DataHolder.keys()
        • gustaf.helpers.data.DataHolder.pop
          • DataHolder.pop()
        • gustaf.helpers.data.DataHolder.update
          • DataHolder.update()
        • gustaf.helpers.data.DataHolder.values
          • DataHolder.values()
      • gustaf.helpers.data.TrackedArray
        • TrackedArray
        • gustaf.helpers.data.TrackedArray.copy
          • TrackedArray.copy()
        • gustaf.helpers.data.TrackedArray.view
          • TrackedArray.view()
        • gustaf.helpers.data.TrackedArray.modified
          • TrackedArray.modified
      • gustaf.helpers.data.Unique2DFloats
        • Unique2DFloats
        • gustaf.helpers.data.Unique2DFloats.ids
          • Unique2DFloats.ids
        • gustaf.helpers.data.Unique2DFloats.intersection
          • Unique2DFloats.intersection
        • gustaf.helpers.data.Unique2DFloats.inverse
          • Unique2DFloats.inverse
        • gustaf.helpers.data.Unique2DFloats.values
          • Unique2DFloats.values
      • gustaf.helpers.data.Unique2DIntegers
        • Unique2DIntegers
        • gustaf.helpers.data.Unique2DIntegers.counts
          • Unique2DIntegers.counts
        • gustaf.helpers.data.Unique2DIntegers.ids
          • Unique2DIntegers.ids
        • gustaf.helpers.data.Unique2DIntegers.inverse
          • Unique2DIntegers.inverse
        • gustaf.helpers.data.Unique2DIntegers.values
          • Unique2DIntegers.values
      • gustaf.helpers.data.VertexData
        • VertexData
        • gustaf.helpers.data.VertexData.as_arrow
          • VertexData.as_arrow()
        • gustaf.helpers.data.VertexData.as_scalar
          • VertexData.as_scalar()
    • gustaf.helpers.notebook
      • gustaf.helpers.notebook.get_shape
        • get_shape()
      • gustaf.helpers.notebook.K3DPlotterN
        • K3DPlotterN
        • gustaf.helpers.notebook.K3DPlotterN.clear
          • K3DPlotterN.clear()
        • gustaf.helpers.notebook.K3DPlotterN.close
          • K3DPlotterN.close()
        • gustaf.helpers.notebook.K3DPlotterN.display
          • K3DPlotterN.display()
        • gustaf.helpers.notebook.K3DPlotterN.show
          • K3DPlotterN.show()
    • gustaf.helpers.options
      • gustaf.helpers.options.make_valid_options
        • make_valid_options()
      • gustaf.helpers.options.Option
        • Option
        • gustaf.helpers.options.Option.backends
          • Option.backends
        • gustaf.helpers.options.Option.key
          • Option.key
        • gustaf.helpers.options.Option.description
          • Option.description
        • gustaf.helpers.options.Option.allowed_types
          • Option.allowed_types
        • gustaf.helpers.options.Option.default
          • Option.default
      • gustaf.helpers.options.SetDefault
        • SetDefault
        • gustaf.helpers.options.SetDefault.key
          • SetDefault.key
        • gustaf.helpers.options.SetDefault.default
          • SetDefault.default
      • gustaf.helpers.options.ShowOption
        • ShowOption
        • gustaf.helpers.options.ShowOption.clear
          • ShowOption.clear()
        • gustaf.helpers.options.ShowOption.copy_valid_options
          • ShowOption.copy_valid_options()
        • gustaf.helpers.options.ShowOption.get
          • ShowOption.get()
        • gustaf.helpers.options.ShowOption.items
          • ShowOption.items()
        • gustaf.helpers.options.ShowOption.keys
          • ShowOption.keys()
        • gustaf.helpers.options.ShowOption.pop
          • ShowOption.pop()
        • gustaf.helpers.options.ShowOption.update
          • ShowOption.update()
        • gustaf.helpers.options.ShowOption.valid_keys
          • ShowOption.valid_keys()
        • gustaf.helpers.options.ShowOption.values
          • ShowOption.values()
    • gustaf.helpers.raise_if
      • gustaf.helpers.raise_if.invalid_inherited_attr
        • invalid_inherited_attr()
      • gustaf.helpers.raise_if.ModuleImportRaiser
        • ModuleImportRaiser
  • gustaf.io
    • gustaf.io.default
      • gustaf.io.default.load
        • load()
    • gustaf.io.ioutils
      • gustaf.io.ioutils.abs_fname
        • abs_fname()
      • gustaf.io.ioutils.check_and_makedirs
        • check_and_makedirs()
    • gustaf.io.meshio
      • gustaf.io.meshio.export
        • export()
      • gustaf.io.meshio.load
        • load()
    • gustaf.io.mfem
      • gustaf.io.mfem.export
        • export()
      • gustaf.io.mfem.load
        • load()
    • gustaf.io.mixd
      • gustaf.io.mixd.export
        • export()
      • gustaf.io.mixd.load
        • load()
      • gustaf.io.mixd.make_mrng
        • make_mrng()
    • gustaf.io.nutils
      • gustaf.io.nutils.export
        • export()
      • gustaf.io.nutils.load
        • load()
      • gustaf.io.nutils.to_nutils_simplex
        • to_nutils_simplex()
  • gustaf.settings
  • gustaf.show
    • gustaf.show.interpolate_vedo_dictcam
      • interpolate_vedo_dictcam()
    • gustaf.show.make_showable
      • make_showable()
    • gustaf.show.show
      • show()
  • gustaf.utils
    • gustaf.utils.arr
      • gustaf.utils.arr.bounds
        • bounds()
      • gustaf.utils.arr.bounds_diagonal
        • bounds_diagonal()
      • gustaf.utils.arr.bounds_mean
        • bounds_mean()
      • gustaf.utils.arr.bounds_norm
        • bounds_norm()
      • gustaf.utils.arr.close_rows
        • close_rows()
      • gustaf.utils.arr.cross3d
        • cross3d()
      • gustaf.utils.arr.derivatives_to_normals
        • derivatives_to_normals()
      • gustaf.utils.arr.enforce_len
        • enforce_len()
      • gustaf.utils.arr.is_one_of_shapes
        • is_one_of_shapes()
      • gustaf.utils.arr.is_shape
        • is_shape()
      • gustaf.utils.arr.make_c_contiguous
        • make_c_contiguous()
      • gustaf.utils.arr.rotate
        • rotate()
      • gustaf.utils.arr.rotation_matrix
        • rotation_matrix()
      • gustaf.utils.arr.rotation_matrix_around_axis
        • rotation_matrix_around_axis()
      • gustaf.utils.arr.select_with_ranges
        • select_with_ranges()
      • gustaf.utils.arr.unique_rows
        • unique_rows()
    • gustaf.utils.connec
      • gustaf.utils.connec.faces_to_edges
        • faces_to_edges()
      • gustaf.utils.connec.hexa_to_quad
        • hexa_to_quad()
      • gustaf.utils.connec.make_hexa_volumes
        • make_hexa_volumes()
      • gustaf.utils.connec.make_quad_faces
        • make_quad_faces()
      • gustaf.utils.connec.range_to_edges
        • range_to_edges()
      • gustaf.utils.connec.sequence_to_edges
        • sequence_to_edges()
      • gustaf.utils.connec.sequentialize_edges
        • sequentialize_edges()
      • gustaf.utils.connec.sorted_unique
        • sorted_unique()
      • gustaf.utils.connec.subdivide_edges
        • subdivide_edges()
      • gustaf.utils.connec.subdivide_quad
        • subdivide_quad()
      • gustaf.utils.connec.subdivide_tri
        • subdivide_tri()
      • gustaf.utils.connec.tet_to_tri
        • tet_to_tri()
      • gustaf.utils.connec.volumes_to_faces
        • volumes_to_faces()
    • gustaf.utils.log
      • gustaf.utils.log.configure
        • configure()
      • gustaf.utils.log.debug
        • debug()
      • gustaf.utils.log.info
        • info()
      • gustaf.utils.log.prepended_log
        • prepended_log()
      • gustaf.utils.log.warning
        • warning()
    • gustaf.utils.tictoc
      • gustaf.utils.tictoc.Tic
        • Tic
        • gustaf.utils.tictoc.Tic.now
          • Tic.now()
        • gustaf.utils.tictoc.Tic.summary
          • Tic.summary()
        • gustaf.utils.tictoc.Tic.toc
          • Tic.toc()
  • gustaf.vertices
    • gustaf.vertices.Vertices
      • Vertices
      • gustaf.vertices.Vertices.bounds
        • Vertices.bounds()
      • gustaf.vertices.Vertices.bounds_diagonal
        • Vertices.bounds_diagonal()
      • gustaf.vertices.Vertices.bounds_diagonal_norm
        • Vertices.bounds_diagonal_norm()
      • gustaf.vertices.Vertices.concat
        • Vertices.concat()
      • gustaf.vertices.Vertices.copy
        • Vertices.copy()
      • gustaf.vertices.Vertices.merge_vertices
        • Vertices.merge_vertices()
      • gustaf.vertices.Vertices.remove_vertices
        • Vertices.remove_vertices()
      • gustaf.vertices.Vertices.select_vertices
        • Vertices.select_vertices()
      • gustaf.vertices.Vertices.show
        • Vertices.show()
      • gustaf.vertices.Vertices.showable
        • Vertices.showable()
      • gustaf.vertices.Vertices.unique_vertices
        • Vertices.unique_vertices()
      • gustaf.vertices.Vertices.update_vertices
        • Vertices.update_vertices()
      • gustaf.vertices.Vertices.const_vertices
        • Vertices.const_vertices
      • gustaf.vertices.Vertices.kind
        • Vertices.kind
      • gustaf.vertices.Vertices.show_options
        • Vertices.show_options
      • gustaf.vertices.Vertices.vertex_data
        • Vertices.vertex_data
      • gustaf.vertices.Vertices.vertices
        • Vertices.vertices
      • gustaf.vertices.Vertices.whatami
        • Vertices.whatami
    • gustaf.vertices.VerticesShowOption
      • VerticesShowOption
  • gustaf.volumes
    • gustaf.volumes.Volumes
      • Volumes
      • gustaf.volumes.Volumes.faces
        • Volumes.faces()
      • gustaf.volumes.Volumes.sorted_volumes
        • Volumes.sorted_volumes()
      • gustaf.volumes.Volumes.to_faces
        • Volumes.to_faces()
      • gustaf.volumes.Volumes.unique_volumes
        • Volumes.unique_volumes()
      • gustaf.volumes.Volumes.update_faces
        • Volumes.update_faces()
      • gustaf.volumes.Volumes.update_volumes
        • Volumes.update_volumes()
      • gustaf.volumes.Volumes.whatareyou
        • Volumes.whatareyou()
      • gustaf.volumes.Volumes.const_faces
        • Volumes.const_faces
      • gustaf.volumes.Volumes.const_volumes
        • Volumes.const_volumes
      • gustaf.volumes.Volumes.kind
        • Volumes.kind
      • gustaf.volumes.Volumes.volumes
        • Volumes.volumes
    • gustaf.volumes.VolumesShowOption
      • VolumesShowOption