Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add general integer exponents #128

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 30 additions & 6 deletions src/torchpme/potentials/inversepowerlaw.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
from typing import Optional

import torch
from torch.special import gammainc, gammaincc, gammaln
from torch.special import gammaln

from .potential import Potential

Expand All @@ -17,6 +17,30 @@ def gamma(x: torch.Tensor) -> torch.Tensor:
return torch.exp(gammaln(x))


# Auxilary function for stable Fourier transform implementation
def gammainc_upper_over_powerlaw(exponent, zz):
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Give the equation in the docstring here.

if exponent not in [1, 2, 3, 4, 5, 6]:
raise ValueError(f"Unsupported exponent: {exponent}")

if exponent == 1:
return torch.exp(-zz) / zz
if exponent == 2:
return torch.sqrt(torch.pi / zz) * torch.erfc(torch.sqrt(zz))
if exponent == 3:
return -torch.expi(-zz)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As far as I know torch.expi doesn't exist in torch module ...

if exponent == 4:
return 2 * (
torch.exp(-zz) - torch.sqrt(torch.pi * zz) * torch.erfc(torch.sqrt(zz))
)
if exponent == 5:
return torch.exp(-zz) + zz * torch.expi(-zz)
if exponent == 6:
return (
(2 - 4 * zz) * torch.exp(-zz)
+ 4 * torch.sqrt(torch.pi) * zz**1.5 * torch.erfc(torch.sqrt(zz))
) / 3
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need an error message if the exponent is not supported.

I think there is a check already at the init of InversePowerLawPotential.

I would maybe call this function in the init of InversePowerLawPotential for the given exponent and maybe zz=0 to not have a duplicated test. But up to you.



Comment on lines +21 to +43
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we double-check that everything here is correct? With the new implementation, test_values_ewald.py fails for inverse potentials with an exponent of 1, as it does not coincide with the Madelung constant.

class InversePowerLawPotential(Potential):
"""
Inverse power-law potentials of the form :math:`1/r^p`.
Expand Down Expand Up @@ -46,7 +70,7 @@ class InversePowerLawPotential(Potential):

def __init__(
self,
exponent: float,
exponent: int,
smearing: Optional[float] = None,
exclusion_radius: Optional[float] = None,
dtype: Optional[torch.dtype] = None,
Expand All @@ -58,8 +82,8 @@ def __init__(
if device is None:
device = torch.device("cpu")

if exponent <= 0 or exponent > 3:
raise ValueError(f"`exponent` p={exponent} has to satisfy 0 < p <= 3")
# function call to check the validity of the exponent
gammainc_upper_over_powerlaw(exponent, torch.tensor(1.0, dtype=dtype, device=device))
self.register_buffer(
"exponent", torch.tensor(exponent, dtype=dtype, device=device)
)
Expand Down Expand Up @@ -103,7 +127,7 @@ def lr_from_dist(self, dist: torch.Tensor) -> torch.Tensor:
x = 0.5 * dist**2 / smearing**2
peff = exponent / 2
prefac = 1.0 / (2 * smearing**2) ** peff
return prefac * gammainc(peff, x) / x**peff
return self.from_dist(dist) - prefac * gammainc_upper_over_powerlaw(exponent, x)

@torch.jit.export
def lr_from_k_sq(self, k_sq: torch.Tensor) -> torch.Tensor:
Expand Down Expand Up @@ -136,7 +160,7 @@ def lr_from_k_sq(self, k_sq: torch.Tensor) -> torch.Tensor:
return torch.where(
k_sq == 0,
0.0,
prefac * gammaincc(peff, masked) / masked**peff * gamma(peff),
prefac * gammainc_upper_over_powerlaw(exponent, masked),
)

def self_contribution(self) -> torch.Tensor:
Expand Down
6 changes: 3 additions & 3 deletions tests/calculators/test_values_ewald.py
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ def test_madelung(crystal_name, scaling_factor, calc_name):
lr_wavelength = 0.5 * smearing
calc = EwaldCalculator(
InversePowerLawPotential(
exponent=1.0,
exponent=1,
smearing=smearing,
),
lr_wavelength=lr_wavelength,
Expand All @@ -111,7 +111,7 @@ def test_madelung(crystal_name, scaling_factor, calc_name):
smearing = sr_cutoff / 5.0
calc = PMECalculator(
InversePowerLawPotential(
exponent=1.0,
exponent=1,
smearing=smearing,
),
mesh_spacing=smearing / 8,
Expand Down Expand Up @@ -198,7 +198,7 @@ def test_wigner(crystal_name, scaling_factor):
# Compute potential and compare against reference
calc = EwaldCalculator(
InversePowerLawPotential(
exponent=1.0,
exponent=1,
smearing=smeareff,
),
lr_wavelength=smeareff / 2,
Expand Down
2 changes: 1 addition & 1 deletion tests/helpers.py
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,7 @@ def neighbor_list(

nl = NeighborList(cutoff=cutoff, full_list=full_neighbor_list)
neighbor_indices, d, S = nl.compute(
points=positions, box=box, periodic=periodic, quantities="PdS"
points=positions, box=box, periodic=periodic, quantities="pdS"
)

neighbor_indices = torch.from_numpy(neighbor_indices.astype(int)).to(
Expand Down
Loading