Record Class AbstractEquationSolver.KappaNu

java.lang.Object
java.lang.Record
by.andd3dfx.math.pde.solver.AbstractEquationSolver.KappaNu
Record Components:
kappa - coefficient for the boundary condition
nu - right-hand side term for the boundary condition
Enclosing class:
AbstractEquationSolver<E extends Equation>

public static record AbstractEquationSolver.KappaNu(double kappa, double nu) extends Record
Record class to store boundary condition parameters for the tridiagonal algorithm.
  • Constructor Summary

    Constructors
    Constructor
    Description
    KappaNu(double kappa, double nu)
    Creates an instance of a KappaNu record class.
  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    Indicates whether some other object is "equal to" this one.
    final int
    Returns a hash code value for this object.
    double
    Returns the value of the kappa record component.
    double
    nu()
    Returns the value of the nu record component.
    final String
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  • Constructor Details

    • KappaNu

      public KappaNu(double kappa, double nu)
      Creates an instance of a KappaNu record class.
      Parameters:
      kappa - the value for the kappa record component
      nu - the value for the nu record component
  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object
    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object
    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.
    • kappa

      public double kappa()
      Returns the value of the kappa record component.
      Returns:
      the value of the kappa record component
    • nu

      public double nu()
      Returns the value of the nu record component.
      Returns:
      the value of the nu record component