PML

class pysit.core.domain.PML(length, amplitude, ftype='quadratic', boundary='dirichlet', compact=False)[source]

Bases: pysit.core.domain.DomainBC

Perfectly Matched Layer (PML) domain boundary condition.

Parameters:
length : float

Size of the PML in physical units.

amplitude : float

Scaling factor for the PML coefficient.

ftype : {‘quadratic’, ‘b-spline’}, optional

PML function profile. Defaults to 'quadratic'

Examples

>>> pmlx = PML(0.1, 100)

Attributes Summary

type

Methods Summary

evaluate(self, n[, orientation]) Evaluates the PML profile function on n points over the range [0,1].

Attributes Documentation

type = 'pml'

Methods Documentation

evaluate(self, n, orientation='right')[source]

Evaluates the PML profile function on n points over the range [0,1].

Parameters:
n : int
orientation : {‘left’, ‘right’}

Orients the direction of increase. Defaults to 'right’.