APIs:

  • Modules API
    • AO Restricted Fock Op
    • AO Restricted Kohn-Sham Op
    • AO Restricted One-Electron Fock Op
    • AO Restricted One-Electron Kohn-Sham Op
    • Core guess
    • Coulomb’s Law
    • Density matrix builder
    • Determinant driver
    • Diagonalization Fock update
    • Electronic energy
    • Fock matrix builder
    • GauXC Basis Converter
    • GauXC Driver
    • GauXC Molecule Converter
    • GauXC Quadrature Batches
    • GauXC XC Energy
    • GauXC XC Potential
    • Generalized eigensolve via Eigen
    • Loop
    • Restricted Fock Op
    • Restricted Kohn-Sham Op
    • Restricted One-Electron Fock Op
    • Restricted One-Electron Kohn-Sham Op
    • SAD guess
    • SCF Driver
    • SCF integral driver
    • snLinK
      • Please Cite
      • Property Types
      • Module Inputs
        • Quick Reference
        • Detailed Descriptions
      • Module Results
      • Submodules
  • C++ API
SCF
  • Modules API
  • snLinK
  • View page source

snLinK

No description provided

Please Cite

No citations

Property Types

The following is a list of property types that this module satisfies.

  • simde::EvaluateBraKet<chemist::braket::BraKet<chemist::wavefunction::AOs, chemist::qm_operator::Exchange<chemist::Electron, chemist::DecomposableDensity<chemist::Electron>>, chemist::wavefunction::AOs>>

Module Inputs

This section details the full list of inputs that the module accepts. Inputs that are not listed as optional must have their value set before the module can be run. Inputs can be set manually by calling the module’s change_input function or by passing arguments to a property type.

Quick Reference

The following table provides a quick summary of the inputs available to this module. The columns are:

  • Key: The key used to retrieve the option,

  • Default : The initial value, if one exists, and

  • Description : A human readable description of what the option is used for.

Key

Default

Description

BraKet

N/A

N/A

On GPU

0

N/A

Detailed Descriptions

The following subsections provide detailed descriptions of each input recognized by this module. The subsection headings are the name of the input. Within each subsection we list:

  • Description : A human readable description of what the option is used for.

  • Default Value : The initial value, if one exists.

  • Optional? : Whether the value must be set inorder for the module to run.

  • Opaque? : Does the value of the input influence memoization?.

  • Domain Restrictions : Criteria a value must obey to be deemed valid.

BraKet

  • Description : N/A

  • Default Value : N/A

  • Optional? : False

  • Opaque? : True

  • Domain Restrictions :

    • Type == chemist::braket::BraKet<chemist::wavefunction::AOs, chemist::qm_operator::Exchange<chemist::Electron, chemist::DecomposableDensity<chemist::Electron>>, chemist::wavefunction::AOs>

On GPU

  • Description : N/A

  • Default Value : 0

  • Optional? : False

  • Opaque? : True

  • Domain Restrictions :

    • Type == bool

Module Results

This section tabulates the full list of results that the module returns. The columns respectively are:

  • Key: What the result is called

  • Type: The C++ type of the result

  • Description: What the result is/how it was computed.

Note

A given property type will only return a subset of the available results. Additional results can be accessed by using other property types or by using the Module class’s advanced API.

Key

Type

Description

tensor representation

tensorwrapper::Tensor

N/A

Submodules

This section details the full list of submodules that the module uses. For each submodule we have listed:

  • Key : The key used to refer to this particular callback.

  • Property Type : The property type that the submodule must satisfy.

  • Description : How the module will use the submodule.

Key

Property Type

Description

Quadrature Batches

scf::xc::gauxc::XCQuadratureBatches

Generate XC Quadrature Batches

Previous

© Copyright 2024, NWChemEx Team.

Built with Sphinx using a theme provided by Read the Docs.