Difference between revisions of "Grid polar.m"

From Spinach Documentation Wiki
Jump to: navigation, search
(Add See also section to function-description page)
(sync with Spinach main f053e432: align Syntax/Parameters/Outputs blocks with source header formatting)
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{DISPLAYTITLE:grid_polar.m}} __NOTOC__
 
{{DISPLAYTITLE:grid_polar.m}} __NOTOC__
−
 
+
Generates a balanced polar grid in which the density of points does not increase towards the centre.
−
Generates a balanced polar grid in which the density of
 
−
points does not increase towards the centre.
 
  
 
==Syntax==
 
==Syntax==
  
−
[phi,r,L]=grid_polar(ncircles,rmax)
+
    [phi,r,L]=grid_polar(ncircles,rmax)
  
−
==Arguments==
+
==Parameters==
  
−
ncircles - number of radial circles
+
    ncircles - number of radial circles  
 
                 in the grid, an integer
 
                 in the grid, an integer
−
 
+
 
     rmax    - maximum radius that the
 
     rmax    - maximum radius that the
 
                 grid must reach
 
                 grid must reach
Line 18: Line 16:
 
==Outputs==
 
==Outputs==
  
−
phi      - a column vector of polar
+
    phi      - a column vector of polar
 
                 phi angles, radians
 
                 phi angles, radians
−
 
+
 
     rmax    - a coluim vector of radii
 
     rmax    - a coluim vector of radii
−
 
+
 
     L        - sparse Laplacian operator
 
     L        - sparse Laplacian operator
 
                 acting on functions defined
 
                 acting on functions defined
Line 28: Line 26:
 
                 same order as the grid
 
                 same order as the grid
  
−
c.brett@soton.ac.uk
+
==See also==
−
ilya.kuprov@weizmann.ac.il
+
[[grid_igloo.m]], [[grid_fibon.m]], [[grid_plot.m]], [[arclength.m]], [[gaussleg.m]], [[get_hull.m]], [[grid_kron.m]], [[grid_test.m]], [[grid_trian.m]], [[one_vcell_solidangle.m]], [[repulsion.m]], [[shrewd.m]], [[sphtarea.m]], [[sphtrsubd.m]], [[vcell_solidangle.m]], [[voitlander.m]], [[voronoisphere.m]], [[zfs_sampling.m]], [[Kernel_utilities]]
  
−
==See also==
+
''Version 2.11, authors: [[Chadwick Brett]], [[Ilya Kuprov]]''
−
[[grid_igloo.m]], [[grid_fibon.m]], [[grid_plot.m]], [[Kernel_utilities#Integration_grids|Integration grids]]
 

Latest revision as of 06:48, 30 August 2026

Generates a balanced polar grid in which the density of points does not increase towards the centre.

Syntax

    [phi,r,L]=grid_polar(ncircles,rmax)

Parameters

    ncircles - number of radial circles 
               in the grid, an integer

    rmax     - maximum radius that the
               grid must reach

Outputs

    phi      - a column vector of polar
               phi angles, radians

    rmax     - a coluim vector of radii

    L        - sparse Laplacian operator
               acting on functions defined
               as vector of values in the
               same order as the grid

See also

grid_igloo.m, grid_fibon.m, grid_plot.m, arclength.m, gaussleg.m, get_hull.m, grid_kron.m, grid_test.m, grid_trian.m, one_vcell_solidangle.m, repulsion.m, shrewd.m, sphtarea.m, sphtrsubd.m, vcell_solidangle.m, voitlander.m, voronoisphere.m, zfs_sampling.m, Kernel_utilities

Version 2.11, authors: Chadwick Brett, Ilya Kuprov