PCM Integral Plan#

cuest.bindings.cuestPCMIntPlanCreate(
*,
handle: cuest.bindings.cuest.cuestHandle,
intPlan: cuest.bindings.cuest.cuestOEIntPlanHandle,
parameters: cuest.bindings.cuest.Parameters,
persistentWorkspace: int,
temporaryWorkspace: int,
numAngularPointsPerAtom: collections.abc.Sequence[int],
epsilon: float,
zetas: collections.abc.Sequence[float],
atomicRadii: collections.abc.Sequence[float],
effectiveNuclearCharges: collections.abc.Sequence[float],
outPlan: cuest.bindings.cuest.cuestPCMIntPlanHandle,
) → cuest.bindings.cuest.CuestStatus#

Build a PCM plan for potential and gradient computations.

Parameters#

handle[in]cuestHandle

cuEST handle. Must not be NULL.

intPlan[in]cuestOEIntPlanHandle

One-electron integral plan (opaque handle) constructed with cuestOEIntPlanCreate(). Must not be NULL.

parameters[in]Parameters

PCM integral plan parameters handle (cuestPCMIntPlanParameters()) initialized by cuestParametersCreate() with CuestParametersType.CUEST_PCMINTPLAN_PARAMETERS. Must not be NULL.

persistentWorkspace[in]int

Preallocated workspace for persistent buffers. Must not be NULL. Integer address of a cuestWorkspace_t structure (hostBuffer, hostBufferSizeInBytes, deviceBuffer, deviceBufferSizeInBytes), as implemented by Workspace in cuda_utils.py.

temporaryWorkspace[in]int

Preallocated workspace for temporary buffers. Must not be NULL. Integer address of a cuestWorkspace_t structure (hostBuffer, hostBufferSizeInBytes, deviceBuffer, deviceBufferSizeInBytes), as implemented by Workspace in cuda_utils.py.

numAngularPointsPerAtom[in]List[int]

List of number of angular points per atom (size: number of atoms). Must not be empty.

epsilon[in]float

Dielectric constant. Must be greater than 1.0.

zetas[in]List[float]

List (size: number of atoms) with each element containing the optimized zeta coefficient for the number of angular points placed on that atom.

atomicRadii[in]List[float]

List (size: number of atoms) of atomic radii in bohr. Must not be empty.

effectiveNuclearCharges[in]List[float]

List (size: number of atoms) of nuclear charges, adjusted for the presence of effective core potentials. Must not be empty.

outPlan[out]cuestPCMIntPlanHandle

Output pointer for PCM plan handle. Must not be NULL.

Returns#

statusCuestStatus
cuest.bindings.cuestPCMIntPlanCreateWorkspaceQuery(
*,
handle: cuest.bindings.cuest.cuestHandle,
intPlan: cuest.bindings.cuest.cuestOEIntPlanHandle,
parameters: cuest.bindings.cuest.Parameters,
persistentWorkspaceDescriptor: int,
temporaryWorkspaceDescriptor: int,
numAngularPointsPerAtom: collections.abc.Sequence[int],
epsilon: float,
zetas: collections.abc.Sequence[float],
atomicRadii: collections.abc.Sequence[float],
effectiveNuclearCharges: collections.abc.Sequence[float],
outPlan: cuest.bindings.cuest.cuestPCMIntPlanHandle,
) → cuest.bindings.cuest.CuestStatus#

Query workspace requirements for creating a PCM integral plan.

Parameters#

handle[in]cuestHandle

cuEST handle. Must not be NULL.

intPlan[in]cuestOEIntPlanHandle

One-electron integral plan (opaque handle) constructed with cuestOEIntPlanCreate(). Must not be NULL.

parameters[in]Parameters

PCM integral plan parameters handle (cuestPCMIntPlanParameters()) initialized by cuestParametersCreate() with CuestParametersType.CUEST_PCMINTPLAN_PARAMETERS. Must not be NULL.

persistentWorkspaceDescriptor[out]int

Output descriptor for persistent workspace requirements. Must not be NULL. Integer address of a cuestWorkspaceDescriptor_t structure (hostBufferSizeInBytes, deviceBufferSizeInBytes; both size_t), as implemented by WorkspaceDescriptor in cuda_utils.py.

temporaryWorkspaceDescriptor[out]int

Output descriptor for temporary workspace requirements. Must not be NULL. Integer address of a cuestWorkspaceDescriptor_t structure (hostBufferSizeInBytes, deviceBufferSizeInBytes; both size_t), as implemented by WorkspaceDescriptor in cuda_utils.py.

numAngularPointsPerAtom[in]List[int]

List (size: number of atoms) of number of angular points per atom. Must not be empty.

epsilon[in]float

Dielectric constant. Must be greater than 1.0.

zetasList[float]

List (size: number of atoms) with each element containing the optimized zeta coefficient for the number of angular points placed on that atom (see cuestPCMIntPlanCreate() for details). May be NULL.

atomicRadiiList[float]

List (size: number of atoms) of atomic radii in bohr. May be empty.

effectiveNuclearChargesList[float]

List (size: number of atoms) of nuclear charges, adjusted for the presence of effective core potentials. May be empty.

outPlancuestPCMIntPlanHandle

Output pointer for PCM plan handle. May be NULL.

Returns#

statusCuestStatus
cuest.bindings.cuestPCMIntPlanDestroy(
*,
handle: cuest.bindings.cuest.cuestPCMIntPlanHandle,
) → cuest.bindings.cuest.CuestStatus#

Destroy a PCM integral plan and release its resources.

The plan handle and its memory must not be used after destruction.

Parameters#

handle[in]cuestPCMIntPlanHandle

PCM integral plan (opaque handle) constructed with cuestPCMIntPlanCreate(). Must not be NULL.

Returns#

status[out]CuestStatus