Section AA_PLANAR

• Parameters for creating axis-aligned planar (rectangular) Dirichlet boundary regions.

• Section path: CP2K_INPUT / FORCE_EVAL / MM / POISSON / IMPLICIT / DIRICHLET_BC / AA_PLANAR

• This section can be repeated.

• Subsections

  • none

• 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
  	FREQUENCY {Real}
  	The frequency with which the oscillating fraction oscillates.
  	This keyword cannot be repeated and it expects precisely one real.
  	Default value: 0.00000000E+000
  	Default unit: [s^-1]

  INTERCEPT
  	INTERCEPT {Real}
  	The intercept of the rectangle's plane.
  	This keyword cannot be repeated and it expects precisely one real.
  	Default unit: [angstrom]

  N_PRTN
  	N_PRTN {Integer} {Integer}
  	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.
  	This keyword cannot be repeated and it expects precisely 2 integers.
  	Default values: 1 1

  OSCILLATING_FRACTION
  	OSCILLATING_FRACTION {Real}
  	A fraction of the field can be set to oscilate over time.
  	This keyword cannot be repeated and it expects precisely one real.
  	Default value: 0.00000000E+000

  PARALLEL_PLANE
  	PARALLEL_PLANE {Keyword}
  	The coordinate plane that the region is parallel to.
  	This keyword cannot be repeated and it expects precisely one keyword.
  	List of valid keywords: XY Without description, yet. XZ Without description, yet. YZ Without description, yet.

  PERIODIC_REGION
  	PERIODIC_REGION {Logical}
  	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.
  	This keyword cannot be repeated and it expects precisely one logical.
  	The lone keyword behaves as a switch to .TRUE.
  	Default value: .FALSE.

  PHASE
  	PHASE {Real}
  	The phase of the oscillattion. A phase of zero corresponds to a cosine function.
  	This keyword cannot be repeated and it expects precisely one real.
  	Default value: 0.00000000E+000

  SMOOTHING_WIDTH
  	SMOOTHING_WIDTH {Real}
  	The width of the transition region between the Dirichlet subdomain and its surrounding.
  	This keyword cannot be repeated and it expects precisely one real.
  	Default value: 2.00000000E-001
  	Default unit: [angstrom]
  	Alias names for this keyword: SIGMA

  THICKNESS
  	THICKNESS {Real}
  	The thickness of the planar Dirichlet region.
  	This keyword cannot be repeated and it expects precisely one real.
  	Default value: 7.50000000E-001
  	Default unit: [angstrom]

  V_D
  	V_D {Real}
  	The value of the fixed potential to be imposed at the axis-aligned Dirichlet boundary.
  	This keyword cannot be repeated and it expects precisely one real.
  	Default unit: [volt]

  X_XTNT
  	X_XTNT {Real} {Real}
  	The X extents of the rectangle.
  	This keyword cannot be repeated and it expects precisely 2 reals.
  	Default unit: [angstrom]

  Y_XTNT
  	Y_XTNT {Real} {Real}
  	The Y extents of the rectangle.
  	This keyword cannot be repeated and it expects precisely 2 reals.
  	Default unit: [angstrom]

  Z_XTNT
  	Z_XTNT {Real} {Real}
  	The Z extents of the rectangle.
  	This keyword cannot be repeated and it expects precisely 2 reals.
  	Default unit: [angstrom]