StructuredPML

class pysit.core.StructuredPML(mesh, domain_bc, dim, side, delta, *args, **kwargs)

Bases: pysit.core.mesh.StructuredBCBase

Specification of the PML-absorbing boundary condition on structured meshes.

Parameters:

mesh : subclass of pysit.core.mesh.MeshBase

domain_bc : subclass of pysit.core.domain.DomainBC

dim : int

Dimension number of the boundary condition. See Note 1.

side : {‘left’, ‘right’}

Side of the domain that the boundary condition applies to.

delta : float

Mesh spacing

Notes

1. dim is the dimension number corresponding to x, y, or z, not the spatial dimension that the problem lives in.

Attributes Summary

boundary_type	The physical type of boundary condition.
type	The type of discrete implementation of the boundary condition.

Methods Summary

eval_on_mesh(self)

Evaluates the PML profile function sigma on the mesh.

Attributes Documentation

boundary_type

The physical type of boundary condition.

type

The type of discrete implementation of the boundary condition.

Methods Documentation

eval_on_mesh(self)

Evaluates the PML profile function sigma on the mesh. Returns an array the size of the mesh with the PML function evalauted at each node.