Module simpa.core
Package simpa.core.api

Interface SurfacePoint

All Superinterfaces:
OcTreeEntry
public interface SurfacePoint extends OcTreeEntry
Accessible interface for SurfacePoint. A SurfacePoint is a point on a surface surrounding the region of interest where we want to represent the field.

  • Method Summary

    Modifier and Type
    Method
    Description
    static SurfacePoint
    createSurfacePoint(org.apache.commons.math3.geometry.euclidean.threed.Vector3D location, org.apache.commons.math3.geometry.euclidean.threed.Vector3D toSource)
    Creates an instance of the SurfacePoint class.
    org.apache.commons.math3.geometry.euclidean.threed.Vector3D
    getField()
     
    org.apache.commons.math3.geometry.euclidean.threed.Vector3D
    getLocation()
    Gets the location of the SurfacePoint.
    void
    setField(org.apache.commons.math3.geometry.euclidean.threed.Vector3D field)
    Sets the B or E field of the SurfacePoint.
    String
    sourceToString()
    Prints the source to a string.

  • Method Details

    • createSurfacePoint

      static SurfacePoint createSurfacePoint(org.apache.commons.math3.geometry.euclidean.threed.Vector3D location, org.apache.commons.math3.geometry.euclidean.threed.Vector3D toSource)
      Creates an instance of the SurfacePoint class.
      Parameters:
      location - location of the point.
      toSource - direction of the source.
      Returns:
      implementation of the SurfacePoint class.

    • getLocation

      org.apache.commons.math3.geometry.euclidean.threed.Vector3D getLocation()
      Gets the location of the SurfacePoint.
      Specified by:
      getLocation in interface OcTreeEntry
      Returns:
      Coordinates of the SurfacePoint

    • setField

      void setField(org.apache.commons.math3.geometry.euclidean.threed.Vector3D field)
      Sets the B or E field of the SurfacePoint.
      Parameters:
      field - input field.

    • getField

      org.apache.commons.math3.geometry.euclidean.threed.Vector3D getField()
      Returns:
      The given field at this surface point location.

    • sourceToString

      String sourceToString()
      Prints the source to a string.
      Returns:
      a string of the source.