warpy.post_processing.band_diagrams.analytical_1d.Bands1D Class Reference

Base class for 1D photonic band objects. More...

Inheritance diagram for warpy.post_processing.band_diagrams.analytical_1d.Bands1D:

Detailed Description

Base class for 1D photonic band objects.

Public Member Functions
def	__init__ (self, fcoeff, omega_p0, Kx, Ky=None, gx=1, omega_a=1, Nx=None)
def	plot (self, **kwargs)
	Plots self.bands given pyplot **kwargs.
def	gradient (self, omega_min, omega_max, num_bins)
	Calculate gradient of bands.
def	calculated_band_gaps (self, gap_num=1)
	Calculate approximate band gap mid, max and min frequency.

Public Attributes
	fcoeff
	omega_p0
	Kx
	Ky
	gx
	omega_a
	Nx
	bands

Protected Member Functions
def	_calc_bands (self)
	Calculates bands given **band_kwargs.

Constructor & Destructor Documentation

__init__()

def warpy.post_processing.band_diagrams.analytical_1d.Bands1D.__init__	(		self,
			fcoeff,
			omega_p0,
			Kx,
			Ky = None,
			gx = 1,
			omega_a = 1,
			Nx = None
	)

Parameters

fcoeff	Fourier coefficients of density profile
omega_p0	Electron plasma frequency of average density.
Kx	List of Kx values
Ky	List of Ky values. Must be same size as Kx.
gx	Lattice vector = 2*pi/a, where a is the lattice constant.
omega_a	Lattice frequency = 2*pi*c_0/a

Reimplemented in warpy.post_processing.band_diagrams.analytical_2d.Bands2D.

Member Function Documentation

_calc_bands()

def warpy.post_processing.band_diagrams.analytical_1d.Bands1D._calc_bands (   self )

protected

Calculates bands given **band_kwargs.

calculated_band_gaps()

def warpy.post_processing.band_diagrams.analytical_1d.Bands1D.calculated_band_gaps	(		self,
			gap_num = 1
	)

Calculate approximate band gap mid, max and min frequency.

Parameters

gap_num

Band gap number to calculate

Returns

gap_min, gap_mid, gap_max

gradient()

def warpy.post_processing.band_diagrams.analytical_1d.Bands1D.gradient	(		self,
			omega_min,
			omega_max,
			num_bins
	)

Calculate gradient of bands.

Calculates gradient of a band and assigns gradient to an ascociated frequency bin. To avoid duplicates, only calculates from kx=0-pi/a.

Returns

omega_bins, gradients

Reimplemented in warpy.post_processing.band_diagrams.analytical_2d.Bands2D.

plot()

def warpy.post_processing.band_diagrams.analytical_1d.Bands1D.plot	(		self,
		**	kwargs
	)

Plots self.bands given pyplot **kwargs.

Reimplemented in warpy.post_processing.band_diagrams.analytical_2d.Bands2D.

Member Data Documentation

bands

warpy.post_processing.band_diagrams.analytical_1d.Bands1D.bands

fcoeff

warpy.post_processing.band_diagrams.analytical_1d.Bands1D.fcoeff

gx

warpy.post_processing.band_diagrams.analytical_1d.Bands1D.gx

Kx

warpy.post_processing.band_diagrams.analytical_1d.Bands1D.Kx

Ky

warpy.post_processing.band_diagrams.analytical_1d.Bands1D.Ky

Nx

warpy.post_processing.band_diagrams.analytical_1d.Bands1D.Nx

omega_a

warpy.post_processing.band_diagrams.analytical_1d.Bands1D.omega_a

omega_p0

warpy.post_processing.band_diagrams.analytical_1d.Bands1D.omega_p0

---

The documentation for this class was generated from the following file:

• tools/warpy/post_processing/band_diagrams/analytical_1d.py