Basis#
- cuest.bindings.cuestAOShellCreate(
- *,
- handle: cuest.bindings.cuest.cuestHandle,
- isPure: int,
- L: int,
- numPrimitive: int,
- exponents: collections.abc.Sequence[float],
- coefficients: collections.abc.Sequence[float],
- parameters: cuest.bindings.cuest.Parameters,
- outShell: cuest.bindings.cuest.cuestAOShellHandle,
Creates an AO shell object with specified parameters.
Parameters#
- handle[in]cuestHandle
cuEST handle. Must not be NULL.
- isPure[in]int
Whether the shell uses pure (spherical) functions (any nonzero value is interpreted as true).
- L[in]int
Angular momentum quantum number (s=0, p=1, d=2, etc).
- numPrimitive[in]int
Number of Gaussian primitives; must be greater than zero.
- exponents[in]List[float]
List of length
numPrimitivecontaining primitive exponents, on the CPU. Must not be empty.- coefficients[in]List[float]
List of length
numPrimitivecontaining contraction coefficients, on the CPU. Must not be empty.- parameters[in]Parameters
Parameters handle (
cuestAOShellParameters()) initialized bycuestParametersCreate()withCuestParametersType.CUEST_AOSHELL_PARAMETERS. Must not be NULL.- outShell[out]cuestAOShellHandle
Pointer to output shell object; receives opaque handle on success. Must not be NULL. Modified in place.
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 the cuEST handle or parameters are not of the correct type;CUEST_STATUS_INVALID_ARGUMENTifnumPrimitiveis zero;CUEST_STATUS_EXCEPTIONfor unexpected error;CUEST_STATUS_UNKNOWN_ERRORfor non-std exceptions.
- cuest.bindings.cuestAOShellDestroy(
- *,
- handle: cuest.bindings.cuest.cuestAOShellHandle,
Destroy/free an AO shell object created with cuestAOShellCreate.
Parameters#
- handle[in]cuestAOShellHandle
Opaque AO shell handle to destroy. Must not be NULL.
Returns#
- status[out]CuestStatus
CUEST_STATUS_SUCCESSon success;CUEST_STATUS_NULL_POINTERifhandleis NULL;CUEST_STATUS_INVALID_TYPEif the shell handle is not of thecuestAOShell_ttype;CUEST_STATUS_EXCEPTIONorCUEST_STATUS_UNKNOWN_ERRORon error;
- cuest.bindings.cuestAOBasisCreateWorkspaceQuery(
- *,
- handle: cuest.bindings.cuest.cuestHandle,
- numAtoms: int,
- numShellsPerAtom: collections.abc.Sequence[int],
- shells: collections.abc.Sequence[cuest.bindings.cuest.cuestAOShellHandle],
- parameters: cuest.bindings.cuest.Parameters,
- persistentWorkspaceDescriptor: int,
- temporaryWorkspaceDescriptor: int,
- outBasis: cuest.bindings.cuest.cuestAOBasisHandle,
Query workspace requirements for creating an AO basis object.
Parameters#
- handle[in]cuestHandle
cuEST handle. Must not be NULL.
- numAtoms[in]int
Total number of atoms/centers; must be greater than zero.
- numShellsPerAtom[in]List[int]
Array of length
numAtomsspecifying number of shells per center; each must be greater than zero. On the CPU.- shells[in]List[cuestAOShellHandle]
Flat array of shell handles (cuestAOShellHandle), length is sum of
numShellsPerAtom. On the CPU; the array and none of its entries may be NULL.- parameters[in]Parameters
Parameters handle (
cuestAOBasisParameters()) initialized bycuestParametersCreate()withCuestParametersType.CUEST_AOBASIS_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.- outBasiscuestAOBasisHandle
Pointer to output basis 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 the cuEST handle, any shell handle or parameters are not of the correct type;CUEST_STATUS_INVALID_ARGUMENTifnumAtoms== 0 or anynumShellsPerAtom[i] == 0;CUEST_STATUS_UNSUPPORTED_ARGUMENTif the AO basis mixes pure (solid-harmonic) and Cartesian shells;CUEST_STATUS_EXCEPTIONorCUEST_STATUS_UNKNOWN_ERRORfor other errors.
- cuest.bindings.cuestAOBasisCreate(
- *,
- handle: cuest.bindings.cuest.cuestHandle,
- numAtoms: int,
- numShellsPerAtom: collections.abc.Sequence[int],
- shells: collections.abc.Sequence[cuest.bindings.cuest.cuestAOShellHandle],
- parameters: cuest.bindings.cuest.Parameters,
- persistentWorkspace: int,
- temporaryWorkspace: int,
- outBasis: cuest.bindings.cuest.cuestAOBasisHandle,
Create an atomic orbital basis set object (AO basis).
Parameters#
- handle[in]cuestHandle
cuEST handle. Must not be NULL.
- numAtoms[in]int
Total number of distinct atoms/centers; must be greater than zero.
- numShellsPerAtom[in]List[int]
Array of length
numAtomsspecifying number of shells per center; each must be greater than zero. On the CPU.- shells[in]List[cuestAOShellHandle]
Flat array of shell handles (
cuestAOShellHandle), length is sum ofnumShellsPerAtom. On the CPU; none of the entries may be NULL.- parameters[in]Parameters
Parameters handle (
cuestAOBasisParameters()) initialized bycuestParametersCreate()withCuestParametersType.CUEST_AOBASIS_PARAMETERS. Must not be NULL.- persistentWorkspace[in]int
Pointer to 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
Pointer to 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.- outBasis[out]cuestAOBasisHandle
Pointer for output basis handle. Must not be NULL. Modified in place.
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 the cuEST handle, any shell handle or parameters are not of the correct type;CUEST_STATUS_INVALID_ARGUMENTifnumAtoms== 0 or anynumShellsPerAtom[i] == 0;CUEST_STATUS_UNSUPPORTED_ARGUMENTif the AO basis mixes pure (solid-harmonic) and Cartesian shells;CUEST_STATUS_EXCEPTIONorCUEST_STATUS_UNKNOWN_ERRORfor other errors.
- cuest.bindings.cuestAOBasisDestroy(
- *,
- handle: cuest.bindings.cuest.cuestAOBasisHandle,
Destroy/free an AO basis set object and all associated resources.
Parameters#
- handle[in]cuestAOBasisHandle
AO basis set handle to destroy; must not be NULL.
Returns#
- status[out]CuestStatus
CUEST_STATUS_SUCCESSon success;CUEST_STATUS_NULL_POINTERifhandleis NULL;CUEST_STATUS_INVALID_TYPEif the cuEST AO basis handle is not of typecuestAOBasisHandle;CUEST_STATUS_EXCEPTIONorCUEST_STATUS_UNKNOWN_ERRORfor other errors.
- cuest.bindings.cuestAOPairListCreateWorkspaceQuery(
- *,
- handle: cuest.bindings.cuest.cuestHandle,
- basis: cuest.bindings.cuest.cuestAOBasisHandle,
- numAtoms: int,
- xyz: collections.abc.Sequence[float],
- thresholdPQ: float,
- parameters: cuest.bindings.cuest.Parameters,
- persistentWorkspaceDescriptor: int,
- temporaryWorkspaceDescriptor: int,
- outPairList: cuest.bindings.cuest.cuestAOPairListHandle,
Query workspace requirements for AO pair list construction.
Parameters#
- handle[in]cuestHandle
cuEST handle. Must not be NULL.
- basis[in]cuestAOBasisHandle
AO basis set handle (object describing basis for the atoms). Constructed with
cuestAOBasisCreate(). Must not be NULL.- numAtoms[in]int
Number of atoms. Must be greater than zero.
- xyz[in]List[float]
Array of atomic Cartesian coordinates (size
numAtoms* 3) on the CPU. Data is expected to be row-ordered: \([x_0,y_0,z_0,...]\). Must not be empty.- thresholdPQ[in]float
Sparsity threshold for pair sieve. Must be non-negative. Pairs on the same center are never sieved.
- parameters[in]Parameters
AO pair list parameters handle (
cuestAOPairListParameters()) initialized bycuestParametersCreate()withCuestParametersType.CUEST_AOPAIRLIST_PARAMETERS. Must not be NULL.- persistentWorkspaceDescriptor[out]int
Output workspace 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 workspace 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.- outPairListcuestAOPairListHandle
Output pointer for AO pair list 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_INVALID_ARGUMENTifnumAtoms== 0 orthresholdPQis negative;CUEST_STATUS_EXCEPTIONorCUEST_STATUS_UNKNOWN_ERRORfor other errors.
- cuest.bindings.cuestAOPairListCreate(
- *,
- handle: cuest.bindings.cuest.cuestHandle,
- basis: cuest.bindings.cuest.cuestAOBasisHandle,
- numAtoms: int,
- xyz: collections.abc.Sequence[float],
- thresholdPQ: float,
- parameters: cuest.bindings.cuest.Parameters,
- persistentWorkspace: int,
- temporaryWorkspace: int,
- outPairList: cuest.bindings.cuest.cuestAOPairListHandle,
Build an AO pair list structure.
Parameters#
- handle[in]cuestHandle
cuEST handle. Must not be NULL.
- basis[in]cuestAOBasisHandle
AO basis set handle (object describing basis for the atoms). Constructed with
cuestAOBasisCreate(). Must not be NULL.- numAtoms[in]int
Number of atoms in molecule or fragment. Must be greater than zero.
- xyz[in]List[float]
Array of atomic Cartesian coordinates (size:
numAtoms* 3) on the CPU. Data is expected to be row-ordered: \([x_0,y_0,z_0,...]\). Must not be empty.- thresholdPQ[in]float
Sparsity threshold for pair sieve. Must be non-negative. Pairs on the same center are never sieved.
- parameters[in]Parameters
AO pair list parameters handle (
cuestAOPairListParameters()) initialized bycuestParametersCreate()withCuestParametersType.CUEST_AOPAIRLIST_PARAMETERS. Must not be NULL.- persistentWorkspace[in]int
Pointer to persistent workspace (preallocated). Must not be NULL. Integer address of a
cuestWorkspace_tstructure (hostBuffer,hostBufferSizeInBytes,deviceBuffer,deviceBufferSizeInBytes), as implemented byWorkspacein cuda_utils.py.- temporaryWorkspace[in]int
Pointer to temporary workspace (preallocated). Must not be NULL. Integer address of a
cuestWorkspace_tstructure (hostBuffer,hostBufferSizeInBytes,deviceBuffer,deviceBufferSizeInBytes), as implemented byWorkspacein cuda_utils.py.- outPairList[out]cuestAOPairListHandle
Output pointer for AO pair list handle. Must not be NULL. Modified in place.
Returns#
- status[out]CuestStatus
CUEST_STATUS_SUCCESSon success;CUEST_STATUS_INVALID_HANDLEif the cuEST handle is NULL;CUEST_STATUS_NULL_POINTERif any pointer is NULL;CUEST_STATUS_INVALID_TYPEif opaque handles are not the correct type.CUEST_STATUS_INVALID_ARGUMENTifnumAtoms== 0 orthresholdPQis negative;CUEST_STATUS_EXCEPTIONorCUEST_STATUS_UNKNOWN_ERRORfor other errors.
- cuest.bindings.cuestAOPairListDestroy(
- *,
- handle: cuest.bindings.cuest.cuestAOPairListHandle,
Destroy/free an AO pair list object and its resources.
The AO pair list handle and associated resources must not be used after this call.
Parameters#
- handle[in]cuestAOPairListHandle
AO pair list handle to destroy. Must not be NULL.
Returns#
- status[out]CuestStatus
CUEST_STATUS_SUCCESSon success;CUEST_STATUS_NULL_POINTERifhandleis NULL;CUEST_STATUS_INVALID_TYPEif the cuEST AOPairList handle is not of typecuestAOPairListHandle;CUEST_STATUS_EXCEPTIONorCUEST_STATUS_UNKNOWN_ERRORfor other errors.