Module simpa.core
Package simpa.core.api

Interface PotentialProvider

public interface PotentialProvider
Accessible interface for PotentialProviders.

  • Method Details

    • getPotentialsWithDerivatives

      double[][] getPotentialsWithDerivatives(org.apache.commons.math3.geometry.euclidean.threed.Vector3D r) throws OutOfApertureException, KnownFatalException
      Gets the vector potentials and gradients at a given point.
      Parameters:
      r - point to be evaluated
      Returns:
      the potentials and gradients for the given point.
      Throws:
      OutOfApertureException - thrown when the point is outside the volume.
      KnownFatalException - when an internal error happens.

    • setAperture

      void setAperture(Aperture ap)
      Sets the aperture for the PotentialProvider.
      Parameters:
      ap - Aperture object.

    • getAperture

      Aperture getAperture()
      Gets the aperture.
      Returns:
      Aperture object.

    • copy

      PotentialProvider copy()