Module simpa.core
Package simpa.core.api

Class ElectricMonopole

java.lang.Object
simpa.core.api.ElectricMonopole
All Implemented Interfaces:
PointSource
public class ElectricMonopole extends Object implements PointSource
Point source that is outside the volume that is used to reproduce the electric field inside the volume of interest.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ElectricMonopole(org.apache.commons.math3.geometry.euclidean.threed.Vector3D locaton, double charge)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    PointSource
    copy()
     
    double
    getCharge()
     
    org.apache.commons.math3.geometry.euclidean.threed.Vector3D
    getField(org.apache.commons.math3.geometry.euclidean.threed.Vector3D evp)
    Calculates the E field at a given evaluation point.
    org.apache.commons.math3.geometry.euclidean.threed.Vector3D
    getLocation()
    For debugging purposes
    void
    scale(double scalingFactor)
    Multiplies the strength of this source with the given scaling factor
    void
    setCharge(double charge)
     
    void
    setLocation(org.apache.commons.math3.geometry.euclidean.threed.Vector3D locaton)
     
    String
    toString()
     

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • ElectricMonopole

      public ElectricMonopole(org.apache.commons.math3.geometry.euclidean.threed.Vector3D locaton, double charge)

  • Method Details

    • copy

      public PointSource copy()
      Specified by:
      copy in interface PointSource
      Returns:
      Shallow copy, except the currents which is native, so deep.

    • getLocation

      public org.apache.commons.math3.geometry.euclidean.threed.Vector3D getLocation()
      Description copied from interface: PointSource
      For debugging purposes
      Specified by:
      getLocation in interface PointSource
      Returns:
      the location of the source

    • setLocation

      public void setLocation(org.apache.commons.math3.geometry.euclidean.threed.Vector3D locaton)

    • getCharge

      public double getCharge()

    • setCharge

      public void setCharge(double charge)

    • scale

      public void scale(double scalingFactor)
      Description copied from interface: PointSource
      Multiplies the strength of this source with the given scaling factor
      Specified by:
      scale in interface PointSource
      Parameters:
      scalingFactor - -A scaling factor

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • getField

      public org.apache.commons.math3.geometry.euclidean.threed.Vector3D getField(org.apache.commons.math3.geometry.euclidean.threed.Vector3D evp)
      Calculates the E field at a given evaluation point.
      Specified by:
      getField in interface PointSource
      Parameters:
      evp - Evaluation point
      Returns:
      E field