Apply PML

Package: kwave.toolbox Class: kwave.toolbox.SplitFieldPML

Apply PML to a vector field.

Syntax

f = applyPML(obj, f, options)

Description

Applies the PML variables stored in a SplitFieldPML object to a vector field f, where the Cartesian components of the field are stored in the fourth dimension. The x-direction PML is applied to the x-component of the field, and so on. If Staggered=false (the default), the PML defined by obj.pmlX (etc) is applied. If Staggered=true, the PML defined by obj.pmlXStaggered (etc) is applied.

Input Arguments

• f - (numeric) Vector field to apply the PML to.

Name-Value Arguments

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

• Staggered - (logical) If true, the staggered grid PML profiles are used. Default = false.

Output Arguments

• f - (numeric) Vector field with the PML applied.