AA_PLANAR

Section can be repeated.

Parameters for creating axis-aligned planar (rectangular) Dirichlet boundary regions. [Edit on GitHub]

Keywords

• FREQUENCY

• INTERCEPT

• N_PRTN

• OSCILLATING_FRACTION

• PARALLEL_PLANE

• PERIODIC_REGION

• PHASE

• SMOOTHING_WIDTH

• THICKNESS

• V_D

• X_XTNT

• Y_XTNT

• Z_XTNT

Keyword descriptions

FREQUENCY

Type: real
Default: 0.00000000E+000 [s^-1]
Usage: FREQUENCY

Description: The frequency with which the oscillating fraction oscillates. [Edit on GitHub]

INTERCEPT

Type: real
Default: [angstrom]
Usage: INTERCEPT

Description: The intercept of the rectangle’s plane. [Edit on GitHub]

N_PRTN

Type: integer[2]
Default: 1 1
Usage: N_PRTN

Description: The number of partitions in the directions of the unit vectors generating the corresponding PARALLEL_PLANE (e1, e2 or e3) for tiling the rectangluar region. [Edit on GitHub]

OSCILLATING_FRACTION

Type: real
Default: 0.00000000E+000
Usage: OSCILLATING_FRACTION

Description: A fraction of the field can be set to oscilate over time. [Edit on GitHub]

PARALLEL_PLANE

Type: enum
Usage: PARALLEL_PLANE

Description: The coordinate plane that the region is parallel to. [Edit on GitHub]

Valid values:

• XY

• YZ

• XZ

PERIODIC_REGION

Type: logical
Default: F
Lone keyword: T
Usage: PERIODIC_REGION

Description: Whether or not to take into consideration the effects of the periodicity of the simulation cell (MIXED_PERIODIC bc) for regions defined sufficiently close to the boundaries. [Edit on GitHub]

PHASE

Type: real
Default: 0.00000000E+000
Usage: PHASE

Description: The phase of the oscillattion. A phase of zero corresponds to a cosine function. [Edit on GitHub]

SMOOTHING_WIDTH

Type: real
Default: 2.00000000E-001 [angstrom]
Aliases: SIGMA
Usage: SMOOTHING_WIDTH

Description: The width of the transition region between the Dirichlet subdomain and its surrounding. [Edit on GitHub]

THICKNESS

Type: real
Default: 7.50000000E-001 [angstrom]
Usage: THICKNESS

Description: The thickness of the planar Dirichlet region. [Edit on GitHub]

V_D

Type: real
Default: [volt]
Usage: v_D

Description: The value of the fixed potential to be imposed at the axis-aligned Dirichlet boundary. [Edit on GitHub]

X_XTNT

Type: real[2]
Default: [angstrom]
Usage: X_xtnt <xmin(real)> <xmax(real)>

Description: The X extents of the rectangle. [Edit on GitHub]

Y_XTNT

Type: real[2]
Default: [angstrom]
Usage: Y_xtnt <ymin(real)> <ymax(real)>

Description: The Y extents of the rectangle. [Edit on GitHub]

Z_XTNT

Type: real[2]
Default: [angstrom]
Usage: Z_xtnt <zmin(real)> <zmax(real)>

Description: The Z extents of the rectangle. [Edit on GitHub]