- smooth1D
smooth1D¶
Works with VSimBase, VSimEM, VSimPD, VSimPA, and VSimVE licenses.
Updater applies a multiplicative 1D digital filter of the form \(\begin{bmatrix} a & b & a \end{bmatrix}\) across a 1D grid for the specified component of a specified field. smooth1D is typically used for a single pass smoothing of the current. Only one field component can be smoothed. This updater can be applied to a 1D, 2D or 3D grid for which smoothDir will give the specific axis on which to apply smooth1D in a 1D fashion.
smooth1D Parameters¶
The smooth1D
updater takes the lowerBounds
and
upperBounds
parameters of FieldUpdater, as well as
the following parameters:
- readFields (required string vector)
A single element, the name of the field to smooth.
- writeFields (required string vector)
A single element, the name of the field to update with the smoothed values.
- aFac (optional float, default = 0.25)
The off-center stencil element value.
- bFac (optional float, default = 0.5)
The center stencil element value.
- smoothDir (optional integer, default = 0)
The direction over which to smooth.
- smoothComp (optional integer, default = 0)
The field component to smooth.
Example smooth1D Block¶
<FieldUpdater smthPhiTau>
kind = smooth1D
lowerBounds = [1 0 0]
upperBounds = [NX NY NZ]
readFields = [phiTauFld]
writeFields = [phiTauFldSmth]
aFac = 0.25
bFac = 0.5
smoothDir = 0
smoothComp = 0
</FieldUpdater>