torchgpe.utils.potentials.NonLinearPotential.potential_function#

abstract NonLinearPotential.potential_function(X, Y, psi, time=None)[source]#

Return the non-linear potential evaluated on the grid. If time dependent parameters are present, the parameter time is also specified, otherwise it is set to None.

Parameters:

X (torch.tensor) – The X coordinates on the adimentionalized grid where to compute the potential.
Y (torch.tensor) – The Y coordinates on the adimentionalized grid where to compute the potential.
psi (torch.tensor) – The wave function of the gas.
time (float, optional) – If time dependent parameters are specified, the time at which to evaluate the potential. Defaults to None.

Returns:

The potential evaluated on the grid.

Return type:

torch.tensor