(git:a660c7f)
Loading...
Searching...
No Matches
skala_gpw_functional Module Reference

Experimental CP2K-native GPW real-space-grid path for SKALA TorchScript models. More...

Functions/Subroutines

logical function, public xc_section_uses_native_skala_grid (xc_section)
 Return true if the GAUXC subsection requests the CP2K-native GPW grid path.
 
logical function, public xc_section_uses_gauxc_model (xc_section)
 Return true if the GAUXC subsection requests a model evaluation.
 
integer function, public native_skala_gapw_density_partition (xc_section)
 Return the hard/soft GAPW one-center density partition for native SKALA.
 
subroutine, public ensure_native_skala_grid_scope (xc_section)
 Enforce the currently implemented native SKALA GPW input scope.
 
subroutine, public skala_gpw_eval (vxc_rho, vxc_tau, exc, rho_r, rho_g, tau, xc_section, weights, pw_pool, particle_set, cell, compute_virial, virial_xc, just_energy, atom_force)
 Evaluate SKALA energy and first derivatives on a CP2K GPW grid.
 
subroutine, public skala_gpw_exc_density (exc_r, rho_r, rho_g, tau, xc_section, weights, pw_pool, particle_set, cell)
 Evaluate the native SKALA XC energy density on the CP2K PW grid.
 
subroutine, public skala_gapw_atom_vxc_of_r (xc_section, grid_atom, group, atom_coord, rho, drho, tau, weights, lsd, nspins, na, nr, exc, vxc, vxg, vtau, energy_only, atom_force, atom_virial)
 Evaluate SKALA on a GAPW one-center atomic grid.
 
type(section_vals_type) function, pointer, public get_gauxc_section (xc_section)
 Return the first GAUXC functional subsection, if present.
 

Variables

integer, parameter, public skala_gapw_density_partition_hard_minus_soft = 1
 
integer, parameter, public skala_gapw_density_partition_hard_only = 2
 
integer, parameter, public skala_gapw_density_partition_soft_only = 3
 
integer, parameter, public skala_gapw_density_partition_none = 4
 

Detailed Description

Experimental CP2K-native GPW real-space-grid path for SKALA TorchScript models.

Function/Subroutine Documentation

◆ xc_section_uses_native_skala_grid()

logical function, public skala_gpw_functional::xc_section_uses_native_skala_grid ( type(section_vals_type), intent(in), pointer  xc_section)

Return true if the GAUXC subsection requests the CP2K-native GPW grid path.

Parameters
xc_section...
Returns
...

Definition at line 97 of file skala_gpw_functional.F.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ xc_section_uses_gauxc_model()

logical function, public skala_gpw_functional::xc_section_uses_gauxc_model ( type(section_vals_type), intent(in), pointer  xc_section)

Return true if the GAUXC subsection requests a model evaluation.

Parameters
xc_section...
Returns
...

Definition at line 116 of file skala_gpw_functional.F.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ native_skala_gapw_density_partition()

integer function, public skala_gpw_functional::native_skala_gapw_density_partition ( type(section_vals_type), intent(in), pointer  xc_section)

Return the hard/soft GAPW one-center density partition for native SKALA.

Parameters
xc_section...
Returns
...

Definition at line 143 of file skala_gpw_functional.F.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ensure_native_skala_grid_scope()

subroutine, public skala_gpw_functional::ensure_native_skala_grid_scope ( type(section_vals_type), intent(in), pointer  xc_section)

Enforce the currently implemented native SKALA GPW input scope.

Parameters
xc_section...

Definition at line 173 of file skala_gpw_functional.F.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ skala_gpw_eval()

subroutine, public skala_gpw_functional::skala_gpw_eval ( type(pw_r3d_rs_type), dimension(:), pointer  vxc_rho,
type(pw_r3d_rs_type), dimension(:), pointer  vxc_tau,
real(kind=dp), intent(out)  exc,
type(pw_r3d_rs_type), dimension(:), pointer  rho_r,
type(pw_c1d_gs_type), dimension(:), pointer  rho_g,
type(pw_r3d_rs_type), dimension(:), pointer  tau,
type(section_vals_type), pointer  xc_section,
type(pw_r3d_rs_type), pointer  weights,
type(pw_pool_type), pointer  pw_pool,
type(particle_type), dimension(:), pointer  particle_set,
type(cell_type), pointer  cell,
logical, intent(in)  compute_virial,
real(kind=dp), dimension(3, 3), intent(out)  virial_xc,
logical, intent(in), optional  just_energy,
real(kind=dp), dimension(:, :), intent(out), optional  atom_force 
)

Evaluate SKALA energy and first derivatives on a CP2K GPW grid.

Parameters
vxc_rho...
vxc_tau...
exc...
rho_r...
rho_g...
tau...
xc_section...
weights...
pw_pool...
particle_set...
cell...
compute_virial...
virial_xc...
just_energy...
atom_force...

Definition at line 238 of file skala_gpw_functional.F.

Here is the call graph for this function:

◆ skala_gpw_exc_density()

subroutine, public skala_gpw_functional::skala_gpw_exc_density ( type(pw_r3d_rs_type), intent(inout)  exc_r,
type(pw_r3d_rs_type), dimension(:), pointer  rho_r,
type(pw_c1d_gs_type), dimension(:), pointer  rho_g,
type(pw_r3d_rs_type), dimension(:), pointer  tau,
type(section_vals_type), pointer  xc_section,
type(pw_r3d_rs_type), pointer  weights,
type(pw_pool_type), pointer  pw_pool,
type(particle_type), dimension(:), pointer  particle_set,
type(cell_type), pointer  cell 
)

Evaluate the native SKALA XC energy density on the CP2K PW grid.

Parameters
exc_r...
rho_r...
rho_g...
tau...
xc_section...
weights...
pw_pool...
particle_set...
cell...

Definition at line 511 of file skala_gpw_functional.F.

Here is the call graph for this function:

◆ skala_gapw_atom_vxc_of_r()

subroutine, public skala_gpw_functional::skala_gapw_atom_vxc_of_r ( type(section_vals_type), pointer  xc_section,
type(grid_atom_type), pointer  grid_atom,
class(mp_comm_type), intent(in)  group,
real(kind=dp), dimension(3), intent(in)  atom_coord,
real(kind=dp), dimension(:, :, :), pointer  rho,
real(kind=dp), dimension(:, :, :, :), pointer  drho,
real(kind=dp), dimension(:, :, :), pointer  tau,
real(kind=dp), dimension(:, :), intent(in)  weights,
logical, intent(in)  lsd,
integer, intent(in)  nspins,
integer, intent(in)  na,
integer, intent(in)  nr,
real(kind=dp), intent(out)  exc,
real(kind=dp), dimension(:, :, :), pointer  vxc,
real(kind=dp), dimension(:, :, :, :), pointer  vxg,
real(kind=dp), dimension(:, :, :), pointer  vtau,
logical, intent(in), optional  energy_only,
real(kind=dp), dimension(3), intent(out), optional  atom_force,
real(kind=dp), dimension(3, 3), intent(out), optional  atom_virial 
)

Evaluate SKALA on a GAPW one-center atomic grid.

Parameters
xc_section...
grid_atom...
group...
atom_coord...
rho...
drho...
tau...
weights...
lsd...
nspins...
na...
nr...
exc...
vxc...
vxg...
vtau...
energy_only...
atom_force...
atom_virial...

Definition at line 650 of file skala_gpw_functional.F.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ get_gauxc_section()

type(section_vals_type) function, pointer, public skala_gpw_functional::get_gauxc_section ( type(section_vals_type), intent(in), pointer  xc_section)

Return the first GAUXC functional subsection, if present.

Parameters
xc_section...
Returns
...

Definition at line 2175 of file skala_gpw_functional.F.

Here is the call graph for this function:
Here is the caller graph for this function:

Variable Documentation

◆ skala_gapw_density_partition_hard_minus_soft

integer, parameter, public skala_gpw_functional::skala_gapw_density_partition_hard_minus_soft = 1

Definition at line 72 of file skala_gpw_functional.F.

◆ skala_gapw_density_partition_hard_only

integer, parameter, public skala_gpw_functional::skala_gapw_density_partition_hard_only = 2

Definition at line 72 of file skala_gpw_functional.F.

◆ skala_gapw_density_partition_soft_only

integer, parameter, public skala_gpw_functional::skala_gapw_density_partition_soft_only = 3

Definition at line 72 of file skala_gpw_functional.F.

◆ skala_gapw_density_partition_none

integer, parameter, public skala_gpw_functional::skala_gapw_density_partition_none = 4

Definition at line 72 of file skala_gpw_functional.F.