CPMDParams schema fields¶
The schema is schema/Potentials.capnp, a vendored copy of the shared
potentials-schema release pinned in subprojects/potentials-schema.wrap.
This page lists the fields that decide what CPMD computes.
The option mapping lists every typed field with its feature ID
and deck spelling.
CPMDParams¶
Field |
Type, default |
Role |
|---|---|---|
|
|
functional when no |
|
|
plane-wave cutoff in Rydberg when no |
|
|
system charge when the |
|
|
2S+1; above 1 selects spin-polarized defaults |
|
|
host hint: |
|
|
comment header of the rendered deck |
|
|
host memory hint |
|
|
|
|
|
OpenCPMD tree hint for hosts |
|
|
library path hint for hosts such as |
|
|
literal |
|
|
structured sections, rendered in list order |
A section missing from inputSections gets a default: &CPMD with
OPTIMIZE WAVEFUNCTION and CONVERGENCE ORBITALS 1e-6, &SYSTEM with
ANGSTROM and the top-level cutoff, charge, and multiplicity, and &DFT
with the top-level functional.
That deck has no SYMMETRY line.
A force call with a positive volume writes symmetry 1 for a cube, symmetry 8
for unequal orthogonal edges, or CELL VECTORS with no symmetry line when
the box is tilted.
A zero box stays SYMMETRY 0 and adds POISSON SOLVER HOCKNEY.
CPMDInputSection¶
A union; each list entry sets exactly one arm.
Arm |
Payload |
Renders |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
typed long-tail sections |
the matching section |
|
|
the matching section, one line per directive |
|
|
one keyword merged into a named section |
|
|
a section by name |
|
|
a full |
CPMDDirective¶
Field |
Meaning |
|---|---|
|
the line, for example |
|
|
Every typed section has a directives list for keywords without a typed
field.
CPMDCpmdSection, the fields a force call uses¶
Field |
Default |
Deck |
|---|---|---|
|
|
|
|
1e-6 |
|
|
0, omitted |
|
|
0, omitted |
|
|
off |
|
|
off |
|
|
off |
|
|
off |
|
|
off |
|
|
off |
|
The OpenCPMD path ignores restarted coordinates, velocities, and geometry: the host owns them.
CPMDSystemSection, the fields that set the cell¶
Field |
Default |
Deck |
|---|---|---|
|
0 |
|
|
|
|
|
empty |
|
|
off |
|
|
70.0 |
|
|
empty |
|
|
0, 1 |
|
|
empty |
|
CPMDDftSection¶
Field |
Default |
Deck |
|---|---|---|
|
|
|
|
|
|
|
0, omitted |
|
|
off |
|
|
off |
hybrid exchange controls |
CPMDAtomsSection and CPMDAtomsPseudopotential¶
Field |
Default |
Deck |
|---|---|---|
|
element symbol, such as |
|
|
the |
|
|
-1, omitted |
|
|
|
|
|
0, omitted |
|
|
|
|
The atoms section also carries constraints, isotopes, velocities,
dummyAtoms, changeBonds, generate, and directives.
Coordinates never go here.
On the OpenCPMD path, the &ATOMS block CPMD reads is rebuilt from each
step’s geometry.
Entries in pseudopotentials supply the file, LMAX, LOC, and
KLEINMAN-BYLANDER for the elements they name.
Elements left out of that list use a built-in table for H, C, N, O, Si, and
Ge; see writing a CPMDParams message.
ForceInput¶
Field |
Default |
Meaning |
|---|---|---|
|
|
|
|
atomic numbers |
|
|
empty |
nine values, row-major cell vectors in |
|
|
unit of |
|
|
unit of the |
PotentialConfig¶
A union of backend arms plus a common overlay (CommonMethodSpec).
cpmdc accepts the cpmd arm, which holds a CPMDParams, or the overlay
alone; see the C ABI reference for the lowering rules.