BlockDiscreteSystem.java

/**
 * $Id$
 *
 * Copyright (C) 2004-2005 Koga Laboratory. All rights reserved.
 */

package org.mklab.tool.control.system.discrete;

import java.util.List;

import org.mklab.nfc.matrix.ComplexNumericalMatrix;
import org.mklab.nfc.matrix.RealNumericalMatrix;
import org.mklab.nfc.ode.SolverStopException;
import org.mklab.nfc.scalar.ComplexNumericalScalar;
import org.mklab.nfc.scalar.RealNumericalScalar;
import org.mklab.tool.control.LinearSystem;
import org.mklab.tool.control.system.DynamicSystem;
import org.mklab.tool.control.system.LinearSystemOperator;
import org.mklab.tool.control.system.StaticSystem;
import org.mklab.tool.control.system.SystemOperator;
import org.mklab.tool.control.system.sampled.BlockSamplingSystem;
import org.mklab.tool.control.system.sampled.Sampler;


/**
 * 差分方程式で表現されるブロック離散時間システムを表わすクラスです。
 * 
 * @author koga
 * @version $Revision$
 * @param <RS> type of real scalar
 * @param <RM> type of real matrix
 * @param <CS> type of complex scalar
 * @param <CM> type of complex matrix
 */
public abstract class BlockDiscreteSystem<RS extends RealNumericalScalar<RS,RM,CS,CM>, RM extends RealNumericalMatrix<RS,RM,CS,CM>, CS extends ComplexNumericalScalar<RS,RM,CS,CM>, CM extends ComplexNumericalMatrix<RS,RM,CS,CM>> extends BlockSamplingSystem<RS,RM,CS,CM> implements Sampler<RS,RM,CS,CM> {

  /**
   * 新しく生成された<code>BlockDiscreteSystem</code>オブジェクトを初期化します。
   * 
   * @param elements 隣接行列
   * @param inputNodes 入力ノードの番号のリスト(番号は1から始まる)
   * @param outputNodes 出力ノードの番号のリスト(番号は1から始まる)
   * @param sunit unit of scalar
   */
  public BlockDiscreteSystem(final SystemOperator<RS,RM,CS,CM>[][] elements, final List<Integer> inputNodes, final List<Integer> outputNodes, RS sunit) {
    super(elements, inputNodes, outputNodes, sunit);
    separateDirectFeedthroughAndNonDirectFeedthrough();
  }

  /**
   * ノードの値を計算します。
   * 
   * @param k ステップ
   * @exception SolverStopException ソルバーが停止された場合
   */
  protected void calcNodeValue(final int k) throws SolverStopException {
    this.time = getSamplingInterval().multiply(k);
    calcNodeValue();
  }

  /**
   * ノードの値を計算します。
   * 
   * @param t 時刻
   * @exception SolverStopException ソルバーが停止された場合
   */
  protected void calcNodeValue(final RS t) throws SolverStopException {
    this.time = t;
    calcNodeValue();
  }

  /**
   * {@inheritDoc}
   */
  @Override
  protected RM calcOutputOfDirectFeedthroughSystem(final SystemOperator<RS,RM,CS,CM> system, final RM u) throws SolverStopException {
    if (system instanceof DynamicSystem) {
      final DynamicSystem<RS,RM,CS,CM> dSystem = (DynamicSystem<RS,RM,CS,CM>)system;
      return dSystem.outputEquation(this.time, dSystem.getState(), u);
    }

    return ((StaticSystem<RS,RM,CS,CM>)system).outputEquation(this.time, u);
  }

  /**
   * @see org.mklab.tool.control.system.BlockSystem#calcOutputOfNonDirectFeedthroughSystem(org.mklab.tool.control.system.SystemOperator)
   */
  @Override
  protected RM calcOutputOfNonDirectFeedthroughSystem(final SystemOperator<RS,RM,CS,CM> system) throws SolverStopException {
    if (system instanceof DynamicSystem) {
      final DynamicSystem<RS,RM,CS,CM> dSystem = (DynamicSystem<RS,RM,CS,CM>)system;
      return dSystem.outputEquation(this.time, dSystem.getState());
    }

    return ((StaticSystem<RS,RM,CS,CM>)system).outputEquation(this.time);
  }

  /**
   * @see org.mklab.tool.control.system.BlockSystem#createStrictlyProperLinearDynamicSystem(org.mklab.tool.control.system.SystemOperator)
   */
  @Override
  protected SystemOperator<RS,RM,CS,CM> createStrictlyProperLinearDynamicSystem(final SystemOperator<RS,RM,CS,CM> system) {
    final LinearSystem<RS,RM,CS,CM> linearSystem = ((LinearSystemOperator<RS,RM,CS,CM>)system).getLinearSystem();
    final RM a = linearSystem.getA();
    final RM b = linearSystem.getB();
    final RM c = linearSystem.getC();
    final DiscreteLinearDynamicSystem<RS,RM,CS,CM> newSystem = new DiscreteLinearDynamicSystem<>(a, b, c, this.sunit);
    newSystem.setInitialState(((DiscreteLinearDynamicSystem<RS,RM,CS,CM>)system).getInitialState());
    return newSystem;
  }

  /**
   * {@inheritDoc}
   */
  public void setSamplingInterval(final RS interval) {
    throw new RuntimeException(Messages.getString("BlockDiscreteSystem.2")); //$NON-NLS-1$

  }

  /**
   * @see org.mklab.tool.control.system.sampled.Sampler#getSamplingInterval()
   */
  public RS getSamplingInterval() {
    throw new RuntimeException(Messages.getString("BlockDiscreteSystem.3")); //$NON-NLS-1$
  }

}