SFNResultFile

class ase2sprkkr.result_files.definitions.sfn.SFNResultFile(definition=None, container=None, potential=None)[source]

Grammar-backed representation of an SPR-KKR shape-function file.

Class hierarchy

Inheritance diagram of ase2sprkkr.result_files.definitions.sfn.SFNResultFile


Constructor

__init__(definition=None, container=None, potential=None)
additional_actions = ('plot_cell', 'plot_periodic', 'plot_shape', 'plot_slice', 'plot_radial')
plot_parameters = {'cmap', 'conventional', 'level', 'levels', 'mesh', 'n', 'offset', 'plane', 'separate_plots', 'what'}
property alat

Length scale in Angstrom, taken from the associated potential.

property nm

Return the number of shape-function meshes.

property meshes

Provide indexed access to shape-function mesh views.

mesh_for_idx(index)[source]

Return the mesh with the given SPR-KKR index, if present.

_selected_meshes(mesh)[source]

Resolve a mesh selector to a non-empty tuple of mesh views.

_cell_context(selected, conventional)[source]

Return atomic, mesh-index and cell data used by cell plots.

static _clip_polygon_to_cell(vertices, cell, inverse_cell)[source]

Clip a Cartesian polygon to the unit-cell parallelepiped.

static _cell_corners(cell)[source]

Return the eight Cartesian corners of a unit cell.

static _draw_cell(axis, cell, color)[source]

Draw unit-cell edges and return their Cartesian corners.

static _draw_polygon_edges(axis, polygons, color, linewidth)[source]

Draw polygons of unequal sizes without confusing Matplotlib autoscaling.

static _periodic_centers(position, vertices, cell, inverse_cell)[source]

Yield translations whose geometry intersects the displayed cell.

static _periodic_mesh_colors(meshes, facecolor, colormap='hsv')[source]

Assign a distinct plotting color to every selected mesh.

_plot_cell_on_axis(axis, selected, *, show_atoms=True, conventional=True, facecolor=None, alpha=0.35, edgecolor=None, cellcolor='black', legend=True, colormap='hsv')[source]

Plot periodically tiled and cell-clipped SFN geometry.

_plot_representative_on_axis(axis, mesh, cell, *, shape, show_atom=True, show_mesh=True, n=64, levels=1, level=None, facecolor='tab:blue', cmap='viridis', alpha=0.22, edgecolor='tab:blue', cellcolor='black', conventional=True)[source]

Draw one unique SFN mesh without overlapping periodic copies.

plot(what='mesh', **kwargs)[source]

Dispatch to one of the explicit SFN visualization methods.

plot_mesh(*, mesh=None, layout=None, separate_plots=False, figsize=None, filename=None, show=None, dpi=600, latex=None, show_rmt=True, show_panels=False, facecolor='tab:blue', alpha=0.22, edgecolor='black')[source]

Plot one or more Voronoi meshes.

plot_cell(*, mesh=None, layout=None, separate_plots=False, figsize=None, filename=None, show=None, dpi=600, latex=None, show_atoms=True, facecolor='tab:blue', alpha=0.16, edgecolor='tab:blue', conventional=True, cellcolor='black')[source]

Plot each unique mesh in a centered crystallographic cell.

plot_periodic(*, mesh=None, layout=None, separate_plots=False, figsize=None, filename=None, show=None, dpi=600, latex=None, show_atoms=True, facecolor=None, alpha=0.16, edgecolor=None, conventional=True, cellcolor='black', legend=True, colormap='hsv')[source]

Plot the periodically tiled meshes clipped to one cell.

plot_shape(*, mesh=None, layout=None, separate_plots=False, figsize=None, filename=None, show=None, dpi=600, latex=None, n=None, levels=1, level=None, facecolor=None, cmap='viridis', alpha=0.25, edgecolor='none', show_atoms=True, show_mesh=True, conventional=True, cellcolor='black')[source]

Plot 3D shape-function isosurfaces for each unique mesh.

plot_slice(*, mesh=None, layout=None, separate_plots=False, figsize=None, filename=None, show=None, dpi=600, latex=None, plane='xy', n=200, offset=0.0, level=0.5, levels=31, cmap='viridis', colorbar=True, show_boundary=True)[source]

Plot planar sections through one or more shape functions.

plot_radial(*, mesh=None, layout=None, separate_plots=False, figsize=None, filename=None, show=None, dpi=600, latex=None, show_panels=True, legend=True)[source]

Plot radial coefficients of one or more shape functions.

_abc_impl = <_abc._abc_data object>