Package pulse.problem.schemes

Class Grid

  • All Implemented Interfaces:
    Serializable, Descriptive
    Direct Known Subclasses:
    Grid2D
    public class Grid
extends PropertyHolder

    A Grid is used to partition the space and time domain of a Problem to allow a numeric solution with a DifferenceScheme. This specific class of grids is one-dimensional in space, meaning that it only defines rules for partitioning the axial dimension in the laser flash experiment.

    See Also:
    Serialized Form

    • Constructor Detail

      • Grid

        public Grid​(NumericProperty gridDensity,
            NumericProperty timeFactor)
        Creates a Grid object with the specified gridDensity and timeFactor.
        Parameters:
        gridDensity - a NumericProperty of the type GRID_DENSITY
        timeFactor - a NumericProperty of the type TIME_FACTOR
        See Also:
        NumericPropertyKeyword

      • Grid

        protected Grid()

    • Method Detail

      • copy

        public Grid copy()
        Creates a new Grid object with exactly the same parameters as this one.
        Returns:
        a new Grid object replicating this Grid

      • listedKeywords

        public Set<NumericPropertyKeyword> listedKeywords()
        The listed properties include GRID_DENSITY and TAU_FACTOR.
        Overrides:
        listedKeywords in class PropertyHolder
        Returns:
        a set of NumericPropertyKeyword instances, which have been explicitly marked as a listed parameter for this PropertyHolder.

      • set

        public void set​(NumericPropertyKeyword type,
                NumericProperty property)
        Description copied from class: Accessible

        An abstract method, which must be overriden to gain access over setting the values of all relevant (selected by the programmer) NumericProperties in subclasses of Accessible. Typically this involves a switch statement that goes through the different options for the type and invokes different set(...) methods to update the matching NumericProperty with property.

        Specified by:
        set in class Accessible
        Parameters:
        type - the type, which must be equal by definition to property.getType().
        property - the property, which contains new information.

      • getXStep

        public final double getXStep()
        Retrieves the value of the hx coordinate step used in finite-difference calculation.
        Returns:
        a double, representing the hx value.

      • setXStep

        public final void setXStep​(double hx)
        Sets the value of the hx coordinate step.
        Parameters:
        hx - a double, representing the new hx value.

      • getTimeStep

        public final double getTimeStep()
        Retrieves the value of the τ time step used in finite-difference calculation.
        Returns:
        a double, representing the tau value.

      • setTimeStep

        protected final void setTimeStep​(double tau)

      • getTimeFactor

        public final NumericProperty getTimeFactor()
        Retrieves the value of the τ-factor, or the time factor, used in finite-difference calculation. This factor determines the proportionally coefficient between τ and hx.
        Returns:
        a NumericProperty of the TAU_FACTOR type, representing the tauFactor value.

      • getGridDensity

        public final NumericProperty getGridDensity()
        Retrieves the value of the gridDensity used to calculate the hx and tau.
        Returns:
        a NumericProperty of the GRID_DENSITY type, representing the gridDensity value.

      • getGridDensityValue

        protected final int getGridDensityValue()

      • setGridDensityValue

        protected void setGridDensityValue​(int N)

      • setGridDensity

        public void setGridDensity​(NumericProperty gridDensity)
        Sets the value of the gridDensity. Automatically recalculates the hx value.
        Parameters:
        gridDensity - a NumericProperty of the GRID_DENSITY type

      • setTimeFactor

        public void setTimeFactor​(NumericProperty timeFactor)
        Sets the value of the tauFactor. Automatically recalculates the tau value.
        Parameters:
        timeFactor - a NumericProperty of the TAU_FACTOR type

      • gridTime

        public final double gridTime​(double time,
                             double dimensionFactor)
        The dimensionless time on this Grid, which is the time/dimensionFactor rounded up to a factor of the time step tau.
        Parameters:
        time - the time
        dimensionFactor - a conversion factor with the dimension of time
        Returns:
        a double representing the time on the finite grid

      • gridAxialDistance

        public final double gridAxialDistance​(double distance,
                                      double lengthFactor)
        The dimensionless axial distance on this Grid, which is the distance/lengthFactor rounded up to a factor of the coordinate step hx.
        Parameters:
        distance - the distance along the axial direction
        lengthFactor - a conversion factor with the dimension of length
        Returns:
        a double representing the axial distance on the finite grid