Package pulse.problem.laser

Class DiscretePulse

  • All Implemented Interfaces:
    Serializable
    Direct Known Subclasses:
    DiscretePulse2D
    public class DiscretePulse
extends Object
implements Serializable
    A DiscretePulse is an object that acts as a medium between the physical Pulse and the respective DifferenceScheme used to process the solution of a Problem.
    See Also:
    Pulse, Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      DiscretePulse​(Problem problem, Grid grid)
      This creates a one-dimensional discrete pulse on a grid.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      double getCharacteristicTime()
      Gets the dimensional factor required to convert real time variable into a dimensional variable, defined in the Problem class
      double getDiscreteWidth()
      Gets the discrete dimensionless pulse width, which is a multiplier of the current grid timestep.
      Grid getGrid()
      Gets the Grid object used to construct this DiscretePulse
      Pulse getPhysicalPulse()
      Gets the physical Pulse
      int getWidthToleranceFactor()
      Assuming a characteristic time is divided by the return value of this method and is set to the minimal resolved pulse width, shows how small a pulse width can be to enable finite pulse correction.
      void init()
      Recalculates the discretePulseWidth by calling gridTime on the physical pulse width and timeFactor.
      double laserPowerAt​(double time)
      Uses the PulseTemporalShape of the Pulse object to calculate the laser power at the specified moment of time.
      double pulseWidthGrid()
      Optimises the Grid parameters so that the timestep is sufficiently small to enable accurate pulse correction.
      double resolvedPulseWidthSeconds()
      Gets the minimal resolved pulse width defined by the WIDTH_TOLERANCE_FACTOR and the characteristic time given by the getConversionFactor.
      double totalEnergy()
      Calculates the total pulse energy using a numerical integrator.The normalisation factor is then equal to the inverse total energy.

    • Constructor Detail

      • DiscretePulse

        public DiscretePulse​(Problem problem,
                     Grid grid)
        This creates a one-dimensional discrete pulse on a grid.

        The dimensional factor is taken from the problem, while the discrete pulse width (a multiplier of the grid parameter tau is calculated using the gridTime method.

        Parameters:
        problem - the problem, used to extract the dimensional time factor
        grid - a grid used to discretise the pulse

    • Method Detail

      • laserPowerAt

        public double laserPowerAt​(double time)
        Uses the PulseTemporalShape of the Pulse object to calculate the laser power at the specified moment of time.
        Parameters:
        time - the time argument
        Returns:
        the laser power at the specified moment of time

      • init

        public final void init()
        Recalculates the discretePulseWidth by calling gridTime on the physical pulse width and timeFactor.

      • pulseWidthGrid

        public double pulseWidthGrid()
        Optimises the Grid parameters so that the timestep is sufficiently small to enable accurate pulse correction.

        This can change the tauFactor and tau variables in the Grid object if discretePulseWidth/(M - 1) < grid.tau, where M is the required number of pulse calculations.

      • totalEnergy

        public final double totalEnergy()
        Calculates the total pulse energy using a numerical integrator.The normalisation factor is then equal to the inverse total energy.
        Returns:
        the total pulse energy, assuming sample area fully covered by the beam

      • getDiscreteWidth

        public double getDiscreteWidth()
        Gets the discrete dimensionless pulse width, which is a multiplier of the current grid timestep. The pulse width is converted to the dimensionless pulse width by dividing the real value by l2/a.
        Returns:
        the dimensionless pulse width mapped to the grid.

      • getPhysicalPulse

        public Pulse getPhysicalPulse()
        Gets the physical Pulse
        Returns:
        the Pulse object

      • getGrid

        public Grid getGrid()
        Gets the Grid object used to construct this DiscretePulse
        Returns:
        the Grid object.

      • getCharacteristicTime

        public double getCharacteristicTime()
        Gets the dimensional factor required to convert real time variable into a dimensional variable, defined in the Problem class
        Returns:
        the conversion factor

      • resolvedPulseWidthSeconds

        public double resolvedPulseWidthSeconds()
        Gets the minimal resolved pulse width defined by the WIDTH_TOLERANCE_FACTOR and the characteristic time given by the getConversionFactor.
        Returns:

      • getWidthToleranceFactor

        public int getWidthToleranceFactor()
        Assuming a characteristic time is divided by the return value of this method and is set to the minimal resolved pulse width, shows how small a pulse width can be to enable finite pulse correction.
        Returns:
        the smallest fraction of a characteristic time resolved as a finite pulse.