Nabla#

cuest.bindings.cuestNablaComputeWorkspaceQuery(
*,
handle: cuest.bindings.cuest.cuestHandle,
plan: cuest.bindings.cuest.cuestOEIntPlanHandle,
parameters: cuest.bindings.cuest.Parameters,
temporaryWorkspaceDescriptor: int,
component: int,
outMatrix: cuest.bindings.cuest.Pointer,
) → cuest.bindings.cuest.CuestStatus#

Query the temporary workspace required (in bytes) for nabla matrix calculation.

This function computes the workspace requirements for a requested nabla calculation. Fill the provided workspace descriptor with host and device buffer sizes required. The outMatrix pointer may be NULL.

The nabla operator is specified by the cuestNablaComputeParametersComponent_t enum.

Parameters#

handle[in]cuestHandle

cuEST handle. Must not be NULL.

plan[in]cuestOEIntPlanHandle

One-electron integral computation plan (opaque handle). Must not be NULL.

parameters[in]cuestNablaComputeParameters_t

Parameters object. Must not be NULL.

temporaryWorkspaceDescriptor[out]cuestWorkspaceDescriptor

Output descriptor for temporary workspace sizes. Must not be NULL.

component[in]cuestNablaComputeParametersComponent

Specifies the operator: \(\nabla_x\), \(\nabla_y\), or \(\nabla_z\).

outMatrixPointer

Optional buffer for computed nabla matrix

Returns#

status[out]cuestStatus_t
cuest.bindings.cuestNablaCompute(
*,
handle: cuest.bindings.cuest.cuestHandle,
plan: cuest.bindings.cuest.cuestOEIntPlanHandle,
parameters: cuest.bindings.cuest.Parameters,
temporaryWorkspace: int,
component: int,
outMatrix: cuest.bindings.cuest.Pointer,
) → cuest.bindings.cuest.CuestStatus#

Compute the atomic orbital nabla matrix using the provided OEIntPlan.

The output buffer must be preallocated and sized for (nao × nao) elements, where nao is the number of atomic orbitals in the basis. Temporary workspace must be allocated using size returned by cuestNablaComputeWorkspaceQuery().

The nabla operator is specified by the cuestNablaComputeParametersComponent_t enum.

Parameters#

handle[in]cuestHandle

cuEST handle. Must not be NULL.

plan[in]cuestOEIntPlanHandle

One-electron integral computation plan (opaque handle). Must not be NULL.

parameters[in]cuestNablaComputeParameters_t

Parameters object. Must not be NULL.

temporaryWorkspace[in]Workspace

Temporary workspace buffers for computation (preallocated). Must not be NULL.

component[in]cuestNablaComputeParametersComponent

Specifies the operator: \(\nabla_x\), \(\nabla_y\), or \(\nabla_z\).

outMatrix[out]Pointer

Output buffer for computed nabla matrix elements (size: nao × nao) on the GPU. Must not be NULL. Elements of this array are overwritten by the calculation results.

Returns#

status[out]cuestStatus_t
cuest.bindings.cuestNablaDerivativeComputeWorkspaceQuery(
*,
handle: cuest.bindings.cuest.cuestHandle,
plan: cuest.bindings.cuest.cuestOEIntPlanHandle,
parameters: cuest.bindings.cuest.Parameters,
temporaryWorkspaceDescriptor: int,
component: int,
densityMatrix: cuest.bindings.cuest.Pointer,
outGradient: cuest.bindings.cuest.Pointer,
) → cuest.bindings.cuest.CuestStatus#

Query the temporary workspace required (in bytes) for nabla gradient calculation.

This function computes the workspace requirements of a single gradient evaluation, based on the supplied plan and dimensions. The workspace descriptor is filled with host and device memory requirements. Output buffers may be NULL for the purposes of the query.

The nabla operator is specified by the cuestNablaComputeParametersComponent_t enum.

Parameters#

handle[in]cuestHandle

cuEST handle. Must not be NULL.

plan[in]cuestOEIntPlanHandle

One-electron integral computation plan (opaque handle). Must not be NULL.

parameters[in]cuestNablaDerivativeComputeParameters_t

Parameters object. Must not be NULL.

temporaryWorkspaceDescriptor[out]cuestWorkspaceDescriptor

Output descriptor for temporary workspace sizes. Must not be NULL.

component[in]cuestNablaComputeParametersComponent

Specifies the operator: \(\nabla_x\), \(\nabla_y\), or \(\nabla_z\).

densityMatrixPointer

Optional density matrix

outGradientPointer

Optional output gradient

Returns#

status[out]cuestStatus_t
cuest.bindings.cuestNablaDerivativeCompute(
*,
handle: cuest.bindings.cuest.cuestHandle,
plan: cuest.bindings.cuest.cuestOEIntPlanHandle,
parameters: cuest.bindings.cuest.Parameters,
temporaryWorkspace: int,
component: int,
densityMatrix: cuest.bindings.cuest.Pointer,
outGradient: cuest.bindings.cuest.Pointer,
) → cuest.bindings.cuest.CuestStatus#

Compute the electronic gradient (derivative) of the atomic orbital nabla matrix using the supplied integral plan and density matrix.

Both the input density matrix and the output gradient must be preallocated. The density matrix must be a nao x nao array and the output gradient must have space for (natom x 3) elements, where nao is the number of atomic orbitals and natom the number of atoms in the system. All required temporary workspace must be allocated by the user prior to calling this function.

The nabla operator is specified by the cuestNablaComputeParametersComponent_t enum.

Parameters#

handle[in]cuestHandle

cuEST handle. Must not be NULL.

plan[in]cuestOEIntPlanHandle

One-electron integral computation plan (opaque handle). Must not be NULL.

parameters[in]cuestNablaDerivativeComputeParameters_t

Parameters object. Must not be NULL.

temporaryWorkspace[in]Workspace

Temporary workspace buffers (preallocated for this operation). Must not be NULL.

component[in]cuestNablaComputeParametersComponent

Specifies the operator: \(\nabla_x\), \(\nabla_y\), or \(\nabla_z\).

densityMatrix[in]Pointer

Input density matrix (size: nao × nao) on the GPU. Must not be NULL.

outGradient[out]Pointer

Output gradient (size: natom × 3) on the GPU. Must not be NULL. Elements of this array are overwritten by the calculation results.

Returns#

statuscuestStatus_t