One-Electron Integral Plan#
- cuest.bindings.cuestOEIntPlanCreate(
- *,
- handle: cuest.bindings.cuest.cuestHandle,
- basis: cuest.bindings.cuest.cuestAOBasisHandle,
- pairList: cuest.bindings.cuest.cuestAOPairListHandle,
- parameters: cuest.bindings.cuest.Parameters,
- persistentWorkspace: int,
- temporaryWorkspace: int,
- outPlan: cuest.bindings.cuest.cuestOEIntPlanHandle,
Build a plan for one-electron integrals over atomic orbitals.
All object handles, workspaces, and output pointers must be valid (not NULL). Workspace buffers must be preallocated with required sizes (see workspace query).
Parameters#
- handle[in]cuestHandle
cuEST handle. Must not be NULL.
- basis[in]cuestAOBasisHandle
AO basis set handle. Constructed with
cuestAOBasisCreate(). Must not be NULL.- pairList[in]cuestAOPairListHandle
AO pair list handle. Constructed with
cuestAOPairListCreate(). Must not be NULL.- parameters[in]Parameters
Integral plan parameters handle (
cuestOEIntPlanParameters()) initialized bycuestParametersCreate()withCuestParametersType.CUEST_OEINTPLAN_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]cuestOEIntPlanHandle
Output pointer for integral plan handle. 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_EXCEEDS_MAX_Lifbasisincludes functions exceeding L=4;CUEST_STATUS_EXCEPTIONorCUEST_STATUS_UNKNOWN_ERRORotherwise.
- cuest.bindings.cuestOEIntPlanDestroy(
- *,
- handle: cuest.bindings.cuest.cuestOEIntPlanHandle,
Destroy and release a one-electron integral plan and its resources.
The plan handle and its memory must not be used after destruction.
Parameters#
- handle[in]cuestOEIntPlanHandle
Plan handle to destroy. Must not be NULL.
Returns#
- status[out]CuestStatus
CUEST_STATUS_SUCCESSon success;CUEST_STATUS_NULL_POINTERif the plan handle is NULL;CUEST_STATUS_INVALID_TYPEif the plan handle is not the correct type.CUEST_STATUS_EXCEPTIONorCUEST_STATUS_UNKNOWN_ERRORotherwise.
- cuest.bindings.cuestOEIntPlanCreateWorkspaceQuery(
- *,
- handle: cuest.bindings.cuest.cuestHandle,
- basis: cuest.bindings.cuest.cuestAOBasisHandle,
- pairList: cuest.bindings.cuest.cuestAOPairListHandle,
- parameters: cuest.bindings.cuest.Parameters,
- persistentWorkspaceDescriptor: int,
- temporaryWorkspaceDescriptor: int,
- outPlan: cuest.bindings.cuest.cuestOEIntPlanHandle,
Query workspace requirements for creating a one-electron integral plan.
Determines persistent and temporary buffer sizes by simulating allocation logic.
Parameters#
- handle[in]cuestHandle
cuEST handle. Must not be NULL.
- basis[in]cuestAOBasisHandle
AO basis set handle. Constructed with
cuestAOBasisCreate(). Must not be NULL.- pairList[in]cuestAOPairListHandle
AO pair list handle. Constructed with
cuestAOPairListCreate(). Must not be NULL.- parameters[in]Parameters
Integral plan parameters handle (
cuestOEIntPlanParameters()) initialized bycuestParametersCreate()withCuestParametersType.CUEST_OEINTPLAN_PARAMETERS. Must not be NULL.- persistentWorkspaceDescriptor[out]int
Output descriptor for persistent buffer sizing. Must not be NULL. 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. Integer address of a
cuestWorkspaceDescriptor_tstructure (hostBufferSizeInBytes,deviceBufferSizeInBytes; bothsize_t), as implemented byWorkspaceDescriptorin cuda_utils.py.- outPlancuestOEIntPlanHandle
Output pointer for integral plan handle. 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_EXCEEDS_MAX_Lifbasisincludes functions exceeding L=4;CUEST_STATUS_EXCEPTIONorCUEST_STATUS_UNKNOWN_ERRORotherwise.