Planar wall potential¶
This module implements the external potential for a collection of planar walls.
Position vector of the wall is given by , where is the normalized outward normal vector to the wall surface. is the distance of a particle, at position , from the wall .
is the interaction energy of a particle of species due to the wall . While computing we always make positive.
The potential is truncated at a cutoff distance and further
transformed to a continuous function using halmd.mdsim.forces.pair_trunc
.
The parameters , , and depend on both the wall and the species. For example, contains , where indices , run over the wall and species respectively.
-
class
halmd.mdsim.potentials.external.
planar_wall
(args)¶ Construct the planar wall module.
Parameters: - args (table) – keyword arguments.
- args.offset (table) – positions of the walls in MD units.
- args.surface_normal (number) – outward normal vectors to the wall surfaces in MD units.
- args.epsilon (matrix) – interaction strengths in MD units.
- args.sigma (matrix) – interaction ranges in MD units.
- args.wetting (matrix) – wetting parameters in MD units.
- args.cutoff (matrix) – cutoff lengths in MD units.
- args.smoothing (number) – smoothing parameter for the continuous truncation in MD units.
- args.memory (string) – select memory location (optional).
- args.label (string) – instance label (optional).
If all elements of a parameter sequence are equal, a single value may be passed instead. In this case,
species
must be specified.If the argument
species
is omitted, it is inferred from the length of the parameter sequences.The supported values for
memory
are “host” and “gpu”. Ifmemory
is not specified, the memory location is selected according to the compute device.-
offset
¶ Sequence with the wall position .
-
surface_normal
¶ Sequence with outward normal vector to the wall surface .
-
epsilon
¶ Sequence with interaction strength .
-
sigma
¶ Sequence with interaction range .
-
wetting
¶ Sequence with wetting parameter .
-
cutoff
¶ Sequence with cutoff length .
-
smoothing
¶ Sequence with smoothing parameter for the continuous truncation.
-
description
¶ Name of potential for profiler.
-
memory
¶ Device where the particle memory resides.