ECP Integral Plan#
- cuest.bindings.cuestECPIntPlanCreate(
- *,
- handle: cuest.bindings.cuest.cuestHandle,
- basis: cuest.bindings.cuest.cuestAOBasisHandle,
- xyz: collections.abc.Sequence[float],
- numECPAtoms: int,
- activeIndices: collections.abc.Sequence[int],
- activeAtoms: collections.abc.Sequence[cuest.bindings.cuest.cuestECPAtomHandle],
- parameters: cuest.bindings.cuest.Parameters,
- persistentWorkspace: int,
- temporaryWorkspace: int,
- outPlan: cuest.bindings.cuest.cuestECPIntPlanHandle,
Create an ECP integral plan with specified parameters.
Parameters#
- handle[in]cuestHandle
cuEST handle. Must not be NULL.
- basis[in]cuestAOBasisHandle
Handle to cuestAOBasis. Constructed with
cuestAOBasisCreate(). Must not be NULL.- xyz[in]List[float]
List of Cartesian coordinates for the atoms in the system (size: 3 * natom) on the CPU. Must not be empty.
- numECPAtoms[in]int
Number of atoms with ECPs. Must be greater than zero and less than or equal to the total number of system atoms (natom).
- activeIndices[in]List[int]
List of indices of the atoms with ECPs (size:
numECPAtoms) on the CPU. Must not be empty. The indices cannot be greater than or equal to natom and cannot contain duplicate entries.- activeAtoms[in]List[cuestECPAtomHandle]
List of ECP atom handles. Must not be empty and none of the entries may be NULL.
- parameters[in]Parameters
Integral plan parameters handle (
cuestECPIntPlanParameters()) initialized bycuestParametersCreate()withCuestParametersType.CUEST_ECPINTPLAN_PARAMETERS. Must not be NULL.- persistentWorkspace[in]int
Preallocated workspace for persistent buffers. Must not be NULL. Integer address of a
cuestWorkspace_tstructure (hostBuffer,hostBufferSizeInBytes,deviceBuffer,deviceBufferSizeInBytes), as implemented byWorkspacein cuda_utils.py.- temporaryWorkspace[in]int
Preallocated workspace for temporary buffers. Must not be NULL. Integer address of a
cuestWorkspace_tstructure (hostBuffer,hostBufferSizeInBytes,deviceBuffer,deviceBufferSizeInBytes), as implemented byWorkspacein cuda_utils.py.- outPlan[out]cuestECPIntPlanHandle
Pointer to output ECP integral plan object; receives opaque handle on success. Must not be NULL.
Returns#
- status[out]CuestStatus
CUEST_STATUS_SUCCESSon success;CUEST_STATUS_INVALID_HANDLEif the cuEST handle is NULL;CUEST_STATUS_NULL_POINTERif any required pointer is NULL;CUEST_STATUS_INVALID_TYPEif opaque handles are not the correct type;CUEST_STATUS_INVALID_ARGUMENTifnumECPAtomsis zero or theactiveIndicesare invalid;CUEST_STATUS_EXCEEDS_MAX_Lifbasisincludes functions exceeding L=4;CUEST_STATUS_EXCEPTIONorCUEST_STATUS_UNKNOWN_ERRORon error.
- cuest.bindings.cuestECPIntPlanCreateWorkspaceQuery(
- *,
- handle: cuest.bindings.cuest.cuestHandle,
- basis: cuest.bindings.cuest.cuestAOBasisHandle,
- xyz: collections.abc.Sequence[float],
- numECPAtoms: int,
- activeIndices: collections.abc.Sequence[int],
- activeAtoms: collections.abc.Sequence[cuest.bindings.cuest.cuestECPAtomHandle],
- parameters: cuest.bindings.cuest.Parameters,
- persistentWorkspaceDescriptor: int,
- temporaryWorkspaceDescriptor: int,
- outPlan: cuest.bindings.cuest.cuestECPIntPlanHandle,
Query the persistent and temporary workspace sizes (in bytes) required to create an ECP integral plan.
Parameters#
- handle[in]cuestHandle
cuEST handle. Must not be NULL.
- basis[in]cuestAOBasisHandle
Handle to cuestAOBasis. Constructed with
cuestAOBasisCreate(). Must not be NULL.- xyz[in]List[float]
List of Cartesian coordinates for the atoms in the system (size: 3 * natom) on the CPU. Must not be empty.
- numECPAtoms[in]int
Number of atoms with ECPs. Must be greater than zero and less than or equal to the total number of system atoms (natom).
- activeIndices[in]List[int]
List of indices of the atoms with ECPs (size:
numECPAtoms) on the CPU. Must not be empty. The indices cannot be greater than or equal to natom and cannot contain duplicate entries.- activeAtoms[in]List[cuestECPAtomHandle]
List of ECP atom handles. Must not be empty and none of the entries may be NULL.
- parameters[in]Parameters
Integral plan parameters handle (
cuestECPIntPlanParameters()) initialized bycuestParametersCreate()withCuestParametersType.CUEST_ECPINTPLAN_PARAMETERS. Must not be NULL.- persistentWorkspaceDescriptor[out]int
Output descriptor for persistent buffer sizing. Must not be NULL. Modified in place. Integer address of a
cuestWorkspaceDescriptor_tstructure (hostBufferSizeInBytes,deviceBufferSizeInBytes; bothsize_t), as implemented byWorkspaceDescriptorin cuda_utils.py.- temporaryWorkspaceDescriptor[out]int
Output descriptor for temporary buffer sizing. Must not be NULL. Modified in place. Integer address of a
cuestWorkspaceDescriptor_tstructure (hostBufferSizeInBytes,deviceBufferSizeInBytes; bothsize_t), as implemented byWorkspaceDescriptorin cuda_utils.py.- outPlancuestECPIntPlanHandle
Pointer to output ECP integral plan object. May be NULL.
Returns#
- status[out]CuestStatus
CUEST_STATUS_SUCCESSon success;CUEST_STATUS_INVALID_HANDLEif the cuEST handle is NULL;CUEST_STATUS_NULL_POINTERif any required pointer is NULL;CUEST_STATUS_INVALID_TYPEif opaque handles are not the correct type;CUEST_STATUS_INVALID_ARGUMENTifnumECPAtomsis zero or theactiveIndicesare invalid;CUEST_STATUS_EXCEEDS_MAX_Lifbasisincludes functions exceeding L=4;CUEST_STATUS_EXCEPTIONorCUEST_STATUS_UNKNOWN_ERRORon error.
- cuest.bindings.cuestECPIntPlanDestroy(
- *,
- handle: cuest.bindings.cuest.cuestECPIntPlanHandle,
Destroy an ECP integral plan object.
Parameters#
- handle[in]cuestECPIntPlanHandle
Pointer to ECP integral plan object to destroy. Must not be NULL.
Returns#
- status[out]CuestStatus
CUEST_STATUS_SUCCESSon success;CUEST_STATUS_NULL_POINTERif the ECP integral plan handle is NULL;CUEST_STATUS_INVALID_TYPEif the ECP integral plan handle is not of the correct type;CUEST_STATUS_EXCEPTIONorCUEST_STATUS_UNKNOWN_ERRORon error.