IMPLICIT

References: BaniHashemian2016

Parameters for the implicit (generalized) Poisson solver. [Edit on GitHub]

Subsections

Keywords

Keyword descriptions

BOUNDARY_CONDITIONS

Type: enum
Default: PERIODIC
Usage: BOUNDARY_CONDITIONS <bc_type>

Description: Specifies the type of boundary conditions. Dirichlet=fixed value, Neumann=zero normal deriv. Mixed and Neumann boundaries essentially requires FFTW3 so that all grid sizes are FFT-able.

Valid values:

  • PERIODIC periodic boundary conditions

  • MIXED Dirichlet + homogeneous Neumann boundary conditions

  • MIXED_PERIODIC Dirichlet + periodic boundary conditions

  • NEUMANN homogeneous Neumann BC (zero-average solution)

[Edit on GitHub]

MAX_ITER

Type: integer
Default: 30
Usage: max_iter

Description: Maximum number of iterations.

[Edit on GitHub]

NEUMANN_DIRECTIONS

Type: enum
Default: XYZ
Usage: NEUMANN_DIRECTIONS

Description: Directions in which homogeneous Neumann conditions are imposed. In the remaining directions periodic conditions will be enforced. Having specified MIXED or NEUMANN as BOUNDARY_CONDITIONS, the keyword is meant to be used to combine periodic and homogeneous Neumann conditions at the boundaries of the simulation cell.

Valid values:

  • XYZ

  • XY

  • XZ

  • YZ

  • X

  • Y

  • Z

[Edit on GitHub]

OR_PARAMETER

Type: real
Default: 1.00000000E+000
Aliases: OMEGA
Usage: OR_PARAMETER

Description: Over-relaxation parameter (large epsilon requires smaller omega ~0.1).

[Edit on GitHub]

TOL

Type: real
Default: 1.00000000E-008
Usage: tol

Description: Stopping tolerance.

[Edit on GitHub]

ZERO_INITIAL_GUESS

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

Description: Whether or not to use zero potential as initial guess.

[Edit on GitHub]