Exchange/Correlation Integral Plan#
- group XCIntegralPlan
Functions
- cuestStatus_t cuestXCIntPlanCreate(
- cuestHandle_t handle,
- const cuestAOBasis_t basis,
- const cuestMolecularGrid_t grid,
- cuestXCIntPlanParametersFunctional_t functional,
- const cuestXCIntPlanParameters_t parameters,
- cuestWorkspace_t *persistentWorkspace,
- cuestWorkspace_t *temporaryWorkspace,
- cuestXCIntPlan_t *outPlan
Build a plan for exchange-correlation integral evaluation.
All object handles, workspaces, and output pointers must be valid (not NULL). Workspace buffers must be preallocated with required sizes (see workspace query).
Note
The number of atoms in the
basismust match the number of atoms in thegrid.
- Parameters:
handle – [in] cuEST handle. Must not be NULL.
basis – [in] AO basis set handle. Must not be NULL.
grid – [in] Molecular grid handle. Must not be NULL.
functional – [in] Specifies the XC functional.
parameters – [in] Plan parameter structure. Must not be NULL.
Create with
cuestParametersCreate()usingCUEST_XCINTPLAN_PARAMETERS. Set attributes withcuestParametersConfigure().3 configurable attributes
CUEST_XCINTPLAN_PARAMETERS_THRESHOLD_COLLOCATIONdoubleXC collocation threshold.
Default:
1.0e-18CUEST_XCINTPLAN_PARAMETERS_DERIVATIVE_LEVELint32_tMaximum derivative level supported.
Default:
1CUEST_XCINTPLAN_PARAMETERS_NUM_THREADSint32_tHow many CPU threads to use when computing Vxc. Must be >= 1.
Default:
12
persistentWorkspace – [in] Preallocated workspace for persistent buffers. Must not be NULL.
temporaryWorkspace – [in] Preallocated workspace for temporary buffers. Must not be NULL.
outPlan – [out] Output pointer for the XC integral plan handle. Must not be NULL.
- Returns:
CUEST_STATUS_SUCCESSon success;CUEST_STATUS_INVALID_HANDLEif the cuEST handle is NULL;CUEST_STATUS_NULL_POINTERif any pointer argument is NULL;CUEST_STATUS_INVALID_TYPEif opaque handles are not the correct type;CUEST_STATUS_INVALID_ARGUMENTiffunctionaldoes not exist orCUEST_XCINTPLAN_PARAMETERS_NUM_THREADSis less than 1;CUEST_STATUS_EXCEEDS_MAX_Lifbasisincludes functions exceeding L=4;CUEST_STATUS_EXCEPTIONorCUEST_STATUS_UNKNOWN_ERRORotherwise.
- cuestStatus_t cuestXCIntPlanCreateWorkspaceQuery(
- cuestHandle_t handle,
- const cuestAOBasis_t basis,
- const cuestMolecularGrid_t grid,
- cuestXCIntPlanParametersFunctional_t functional,
- const cuestXCIntPlanParameters_t parameters,
- cuestWorkspaceDescriptor_t *persistentWorkspaceDescriptor,
- cuestWorkspaceDescriptor_t *temporaryWorkspaceDescriptor,
- cuestXCIntPlan_t *outPlan
Query workspace requirements for creating an exchange-correlation integral plan.
Determines persistent and temporary buffer sizes by simulating allocation logic. All handles and pointers must be valid (not NULL).
- Parameters:
handle – [in] cuEST handle. Must not be NULL.
basis – [in] AO basis set handle. Must not be NULL.
grid – [in] Molecular grid handle. Must not be NULL.
functional – [in] Specifies the XC functional.
parameters – [in] Plan parameters handle. Must not be NULL.
Create with
cuestParametersCreate()usingCUEST_XCINTPLAN_PARAMETERS. Set attributes withcuestParametersConfigure().3 configurable attributes
CUEST_XCINTPLAN_PARAMETERS_THRESHOLD_COLLOCATIONdoubleXC collocation threshold.
Default:
1.0e-18CUEST_XCINTPLAN_PARAMETERS_DERIVATIVE_LEVELint32_tMaximum derivative level supported.
Default:
1CUEST_XCINTPLAN_PARAMETERS_NUM_THREADSint32_tHow many CPU threads to use when computing Vxc. Must be >= 1.
Default:
12
persistentWorkspaceDescriptor – [out] Output descriptor for persistent buffer sizing. Must not be NULL.
temporaryWorkspaceDescriptor – [out] Output descriptor for temporary buffer sizing. Must not be NULL.
outPlan – Output pointer for the XC integral plan handle. May be NULL.
- Returns:
CUEST_STATUS_SUCCESSon success;CUEST_STATUS_INVALID_HANDLEif the cuEST handle is NULL;CUEST_STATUS_NULL_POINTERif any required pointer argument is NULL;CUEST_STATUS_INVALID_TYPEif opaque handles are not the correct type;CUEST_STATUS_INVALID_ARGUMENTiffunctionaldoes not exist orCUEST_XCINTPLAN_PARAMETERS_NUM_THREADSis less than 1;CUEST_STATUS_EXCEEDS_MAX_Lifbasisincludes functions exceeding L=4;CUEST_STATUS_EXCEPTIONorCUEST_STATUS_UNKNOWN_ERRORotherwise.
-
cuestStatus_t cuestXCIntPlanDestroy(cuestXCIntPlan_t plan)#
Destroy and release an exchange-correlation integral plan and its resources.
The plan handle and its memory must not be used after destruction.
- Parameters:
plan – [in] Plan handle to destroy. Must not be NULL.
- Returns:
CUEST_STATUS_SUCCESSon success;CUEST_STATUS_NULL_POINTERifplanis NULL;CUEST_STATUS_INVALID_TYPEif opaque handles are not the correct type;CUEST_STATUS_EXCEPTIONorCUEST_STATUS_UNKNOWN_ERRORotherwise.