sisl.Grid
=========















.. currentmodule:: sisl

.. autoclass:: Grid







   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         


   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
            
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
            
      
         

   
      
      
         
      
      
         

   
      
      
         
      
      
         

   
      
      
         
      
      
         

   
      
      
         
      
      
         







   .. rubric:: Conversion

   .. autosummary::
      :removeprefix: Grid.

      
      





   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   


   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   
      
      Grid.to
      
      





   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   


   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   
      
      Grid.to.Path

   
      
      Grid.to.pyamg

   
      
      Grid.to.str

   

   




   .. rubric:: Plotting

   .. autosummary::
      :removeprefix: Grid.

      Grid.plot
      





   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   


   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   
      
      Grid.plot.grid

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   








   .. rubric:: Methods

   .. autosummary::
      





   

   

   
   
      
      

   
      
      
      
      

   

   

   

   
   

   
      
      
      
      

   
      
   
      ~Grid.append

   

   

   
   
      
      

   
      
      
      
      

   

   

   

   
   

   
      
      
      
      

   
      
   
      ~Grid.area

   

   

   
   

   
      
      
      
      

   
      
   
      ~Grid.average

   

   

   
   

   
      
      
      
      

   
      
   
      ~Grid.copy

   

   

   
   

   
      
      
      
      

   
      
   
      ~Grid.cross_section

   

   

   
   

   
      
      
      
      

   
      
   
      ~Grid.fill

   

   

   
   

   
      
      
      
      

   
      
   
      ~Grid.index

   

   

   
   

   
      
      
      
      

   
      
   
      ~Grid.index2xyz

   

   

   
   

   
      
      
      
      

   
      
   
      ~Grid.index_fold

   

   

   
   

   
      
      
      
      

   
      
   
      ~Grid.index_truncate

   

   

   
   

   
      
      
      
      

   
      
   
      ~Grid.interp

   

   

   
   

   
      
      
      
      

   
      
   
      ~Grid.isosurface

   

   

   
   

   
      
      
      
      

   
      
   
      ~Grid.mean

   

   

   
   

   
      
      
      
      

   
      
   
      ~Grid.mgrid

   

   

   
   

   
      
         
      
      
      

   

   

   

   
   

   
      
      
      
      

   
      
   
      ~Grid.pyamg_boundary_condition

   

   

   
   

   
      
      
      
      

   
      
   
      ~Grid.pyamg_fix

   

   

   
   

   
      
      
      
      

   
      
   
      ~Grid.pyamg_index

   

   

   
   

   
      
      
      
      

   
      
   
      ~Grid.pyamg_source

   

   

   
   

   
      
      
      
      

   
      
   
      ~Grid.read

   

   

   
   

   
      
      
      
      

   
      
   
      ~Grid.remove

   

   

   
   

   
      
      
      
      

   
      
   
      ~Grid.remove_part

   

   

   
   

   
      
      
      
      

   
      
   
      ~Grid.sc_index

   

   

   
   

   
      
      
      
      

   
      
   
      ~Grid.set_bc

   

   

   
   

   
      
      
      
      

   
      
   
      ~Grid.set_boundary

   

   

   
   

   
      
      
      
      

   
      
   
      ~Grid.set_boundary_condition

   

   

   
   

   
      
      
      
      

   
      
   
      ~Grid.set_geometry

   

   

   
   

   
      
      
      
      

   
      
   
      ~Grid.set_grid

   

   

   
   

   
      
      
      
      

   
      
   
      ~Grid.set_lattice

   

   

   
   

   
      
      
      
      

   
      
   
      ~Grid.set_nsc

   

   

   
   

   
      
      
      
      

   
      
   
      ~Grid.set_supercell

   

   

   
   

   
      
      
      
      

   
      
   
      ~Grid.smooth

   

   

   
   

   
      
      
      
      

   
      
   
      ~Grid.sub

   

   

   
   

   
      
      
      
      

   
      
   
      ~Grid.sub_part

   

   

   
   

   
      
      
      
      

   
      
   
      ~Grid.sum

   

   

   
   

   
      
      
      
      

   
      
   
      ~Grid.swapaxes

   

   

   
   

   
      
      
      
      

   
      
   
      ~Grid.tile

   

   

   
   

   
      
      
      
         
      

   

   

   

   
   

   
      
      
      
         
      

   

   

   

   
   

   
      
      
      
         
      

   

   

   

   
   

   
      
      
      
      

   
      
   
      ~Grid.topyamg

   

   

   
   

   
      
      
      
      

   
      
   
      ~Grid.write




   .. rubric:: Attributes

   .. autosummary::
      





   

   

   
   

   
      
      
      
      

   
      
   
      ~Grid.DIRICHLET

   

   

   
   

   
      
      
      
      

   
      
   
      ~Grid.NEUMANN

   

   

   
   

   
      
      
      
      

   
      
   
      ~Grid.OPEN

   

   

   
   

   
      
      
      
      

   
      
   
      ~Grid.PERIODIC

   

   

   
   

   
      
      
      
      

   
      
   
      ~Grid.boundary_condition

   

   

   
   

   
      
      
      
      

   
      
   
      ~Grid.cell

   

   

   
   

   
      
      
      
      

   
      
   
      ~Grid.dcell

   

   

   
   

   
      
      
      
      

   
      
   
      ~Grid.dkind

   

   

   
   

   
      
      
      
      

   
      
   
      ~Grid.dtype

   

   

   
   

   
      
      
      
      

   
      
   
      ~Grid.dvolume

   

   

   
   

   
      
      
      
      

   
      
   
      ~Grid.icell

   

   

   
   

   
      
      
      
      

   
      
   
      ~Grid.isc_off

   

   

   
   

   
      
      
      
      

   
      
   
      ~Grid.length

   

   

   
   

   
      
      
      
      

   
      
   
      ~Grid.n_s

   

   

   
   
      
      

   
      
      
      
      

   

   

   

   
   

   
      
      
      
      

   
      
   
      ~Grid.nsc

   

   

   
   

   
      
      
      
      

   
      
   
      ~Grid.origin

   

   

   
   

   
      
      
      
      

   
      
   
      ~Grid.pbc

   

   

   
   
      
      

   
      
      
      
      

   

   

   

   
   

   
      
      
      
      

   
      
   
      ~Grid.rcell

   

   

   
   

   
      
      
      
      

   
      
   
      ~Grid.sc

   

   

   
   

   
      
      
      
      

   
      
   
      ~Grid.sc_off

   

   

   
   

   
      
      
      
      

   
      
   
      ~Grid.shape

   

   

   
   

   
      
      
      
      

   
      
   
      ~Grid.size

   

   

   
   
      
      

   
      
      
      
      

   

   

   

   
   

   
      
      
      
      

   
      
   
      ~Grid.volume