DoubleCoulombViscousFriction.java

/*
 * $Id: CoulombViscousFriction.java,v 1.14 2008/07/15 15:27:15 koga Exp $
 *
 * Copyright (C) 2004 Masanobu Koga. All rights reserved.
 */
package org.mklab.tool.control.system.discontinuous;

import java.util.ArrayList;
import java.util.List;

import org.mklab.nfc.matrix.DoubleMatrix;
import org.mklab.nfc.ode.DoublePiecewiseContinuousAlgebraicSystem;
import org.mklab.nfc.ode.PiecewiseUtil;
import org.mklab.tool.control.system.continuous.DoubleBaseContinuousStaticSystem;
import org.mklab.tool.control.system.parameter.Parameter;
import org.mklab.tool.control.system.parameter.StringExternalizable;


/**
 * クーロン(静的)摩擦と粘性(動的)摩擦システムを表すクラスです。
 * 
 * @author koga
 * @version $Revision: 1.14 $
 */
public class DoubleCoulombViscousFriction extends DoubleBaseContinuousStaticSystem implements DoublePiecewiseContinuousAlgebraicSystem, StringExternalizable {

  /** ゲイン */
  @Parameter(name = "gain", description = "CoulombViscousFriction.1", internationalization = true)
  private double gain;

  /** オフセット */
  @Parameter(name = "offset", description = "CoulombViscousFriction.3", internationalization = true)
  private double offset;

  /**
   * コンストラクター
   */
  public DoubleCoulombViscousFriction() {
    this(1, 1);
  }

  /**
   * 新しく生成された<code>Saturation</code>オブジェクトを初期化します。
   * 
   * @param gain ゲイン
   * @param offset オフセット
   */
  public DoubleCoulombViscousFriction(final double gain, final double offset) {
    super(-1, -1);
    setAutoSize(true);
    setHasDirectFeedthrough(true);
    setGain(gain);
    setOffset(offset);
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public DoubleMatrix outputEquation( final double t, final DoubleMatrix u) {
    return u.signumElementWise().multiply(u.absElementWise().multiply(this.gain).addElementWise(this.offset));
  }

  /**
   * ゲインを設定します。
   * 
   * @param gain ゲイン
   */
  public void setGain(final double gain) {
    this.gain = gain;
  }

  /**
   * オフセットを設定します。
   * 
   * @param offset オフセット
   */
  public void setOffset(final double offset) {
    this.offset = offset;
  }

  /**
   * ゲインを返します。
   * 
   * @return ゲイン
   */
  public double getGain() {
    return this.gain;
  }

  /**
   * オフセットを返します。
   * 
   * @return オフセット
   */
  public double getOffset() {
    return this.offset;
  }

  /**
   * {@inheritDoc}
   */
  @SuppressWarnings("boxing")
  public List<Integer> getPiece( final double t, final DoubleMatrix u) {
    final int size = u.getRowSize();
    final List<Integer> pieces = new ArrayList<>(size);

    for (int i = 1; i <= size; i++) {
      if (u.getDoubleElement(i) < 0) {
        pieces.add(0);
      } else {
        pieces.add(1);
      }
    }

    return pieces;
  }

  /**
   * {@inheritDoc}
   */
  @SuppressWarnings("boxing")
  public double getDiscontinuousPoint(final double t1, final DoubleMatrix u1, final double t2, final DoubleMatrix u2) {
    final List<Integer> pieces1 = getPiece(t1, u1);
    final List<Integer> pieces2 = getPiece(t2, u2);

    if (pieces1.equals(pieces2)) {
      return Double.NaN;
    }

    final int number = PiecewiseUtil.getDistinctPiece(pieces1, pieces2);
    final int piece1 = pieces1.get(number - 1);
    final int piece2 = pieces2.get(number - 1);

    final boolean fromZeroToOne = piece1 == 0 && piece2 == 1;
    final boolean fromOneToZero = piece1 == 1 && piece2 == 0;

    final double uu1 = u1.getDoubleElement(number);
    final double uu2 = u2.getDoubleElement(number);

    if (fromZeroToOne || fromOneToZero) {
      return t1 + (-uu1) / (uu2 - uu1) * (t2 - t1);
    }

    assert false : "never reached"; //$NON-NLS-1$

    return Double.NaN;
  }

  /**
   * @see org.mklab.tool.control.system.SystemOperator#setInputSize(int)
   */
  @Override
  public void setInputSize(final int size) {
    super.setInputSize(size);
    super.setOutputSize(size);
  }

  /**
   * @see org.mklab.tool.control.system.SystemOperator#setOutputSize(int)
   */
  @Override
  public void setOutputSize(final int size) {
    super.setInputSize(size);
    super.setOutputSize(size);
  }

  /**
   * @see org.mklab.tool.control.system.parameter.StringExternalizable#getString(java.lang.String)
   */
  public String getString(String key) {
    return Messages.getString(key);
  }

  /**
   * @see org.mklab.tool.control.system.SystemOperator#equals(java.lang.Object)
   */
  @Override
  public boolean equals(Object o) {
    if (this == o) {
      return true;
    }
    if (!super.equals(o)) {
      return false;
    }
    if (o == null) {
      return false;
    }
    if (o.getClass() != getClass()) {
      return false;
    }
    DoubleCoulombViscousFriction castedObj = (DoubleCoulombViscousFriction)o;
    return ((this.gain == castedObj.gain) && (this.offset == castedObj.offset));
  }

  /**
   * @see org.mklab.tool.control.system.SystemOperator#hashCode()
   */
  @Override
  public int hashCode() {
    int hashCode = super.hashCode();
    hashCode = 31 * hashCode + (int)(Double.doubleToLongBits(this.gain) ^ (Double.doubleToLongBits(this.gain) >>> 32));
    hashCode = 31 * hashCode + (int)(Double.doubleToLongBits(this.offset) ^ (Double.doubleToLongBits(this.offset) >>> 32));
    return hashCode;
  }
}