documentation.HELP! Control Design VI and Function Documentation

CD Linear Simulation VI

Control Design VI and Function

previous page next page

CD Linear Simulation VI

Owning Palette: Time Response VIs

Installed With: Control Design and Simulation Module

Calculates the output when the Inputs excite the given system using discrete simulation. The data type you wire to the State-Space Model input determines the polymorphic instance to use.

Note  The CD Linear Simulation VI ignores the transport delay in a system. You can reduce the nonzero delay entries in the transport delay matrix with the CD Distribute Delay VI. However, the system inputs and outputs cannot accommodate all delay elements. Therefore, the CD Linear Simulation VI ignores the residue, or transport delay.

Details  

Use the pull-down menu to select an instance of this VI.

Select an instance Linear Simulation (State-Space)Linear Simulation (Transfer Function)Linear Simulation (Zero-Pole-Gain)Linear Simulation (State-Space with Waveforms)Linear Simulation (Transfer Function with Waveforms)Linear Simulation (Zero-Pole-Gain with Waveforms)

Place on the block diagram

Find on the Functions palette

Linear Simulation (State-Space)

	Delta t is the integration time step.
	Initial Time represents the time at the beginning of the simulation.
	State-Space Model contains a mathematical representation of and information about the system of which this VI calculates a response.
	Inputs is the stimulus signal this VI applies to the system model. When you use this VI with a discrete model, you must ensure that the time step of the model matches the time step of this input signal. If you have only one input signal, specify Inputs as a 2D array with only one row or column. If you have two or more input signals, this VI considers the smaller dimension of the 2D array to be the number of channels and the larger dimension to be the number of points in each channel.
	Initial Conditions is the initial state vector. The ith element of the array corresponds to the ith initial state. If Initial Conditions is empty, then this VI uses zero initial conditions to determine the time response.
	error in describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use exception control to treat what is normally an error as no error or to treat a warning as an error. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node. status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE. code is the error or warning code. The default is 0. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source specifies the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.
	Method specifies the method this VI uses to convert a continuous system to a discrete system before simulating the output. This VI uses the sampling interval (dt) from the Inputs signal. 0 ZOH (default)—Zero-Order-Hold 1 FOH—First-Order-Hold
	Simulation Graph displays all the outputs resulting from inputs to the system.
	State Trajectory Graph displays the individual trajectories of each state of the system.
	Simulation Data returns the outputs and state data from the linear simulation. To access the Simulation Data, use the CD Get Time Response Data VI. Time returns the uniformly-spaced time vector against which this VI plots the impulse, initial, or step response and the state trajectories. Outputs Data returns data about the time response of the outputs to the inputs. States Data returns data about the time response of the states to the inputs. For transfer function and zero-pole-gain models, this array is empty.
	error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error. status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred. code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning.

Linear Simulation (Transfer Function)

	Delta t is the integration time step.
	Initial Time represents the time at the beginning of the simulation.
	Transfer Function Model contains a mathematical representation of and information about the system of which this VI calculates a response.
	Inputs is the stimulus signal this VI applies to the system model. When you use this VI with a discrete model, you must ensure that the time step of the model matches the time step of this input signal. If you have only one input signal, specify Inputs as a 2D array with only one row or column. If you have two or more input signals, this VI considers the smaller dimension of the 2D array to be the number of channels and the larger dimension to be the number of points in each channel.
	Initial Conditions is the initial state vector. The ith element of the array corresponds to the ith initial state. If Initial Conditions is empty, then this VI uses zero initial conditions to determine the time response.
	error in describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use exception control to treat what is normally an error as no error or to treat a warning as an error. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node. status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE. code is the error or warning code. The default is 0. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source specifies the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.
	Method specifies the method this VI uses to convert a continuous system to a discrete system before simulating the output. This VI uses the sampling interval (dt) from the Inputs signal. 0 ZOH (default)—Zero-Order-Hold 1 FOH—First-Order-Hold
	Simulation Graph displays all the outputs resulting from inputs to the system.
	Simulation Data returns the outputs and state data from the linear simulation. To access the Simulation Data, use the CD Get Time Response Data VI. Time returns the uniformly-spaced time vector against which this VI plots the impulse, initial, or step response and the state trajectories. Outputs Data returns data about the time response of the outputs to the inputs.
	error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error. status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred. code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning.

Linear Simulation (Zero-Pole-Gain)

	Delta t is the integration time step.
	Initial Time represents the time at the beginning of the simulation.
	Zero-Pole-Gain Model contains a mathematical representation of and information about the system of which this VI calculates a response.
	Inputs is the stimulus signal this VI applies to the system model. When you use this VI with a discrete model, you must ensure that the time step of the model matches the time step of this input signal. If you have only one input signal, specify Inputs as a 2D array with only one row or column. If you have two or more input signals, this VI considers the smaller dimension of the 2D array to be the number of channels and the larger dimension to be the number of points in each channel.
	Initial Conditions is the initial state vector. The ith element of the array corresponds to the ith initial state. If Initial Conditions is empty, then this VI uses zero initial conditions to determine the time response.
	error in describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use exception control to treat what is normally an error as no error or to treat a warning as an error. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node. status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE. code is the error or warning code. The default is 0. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source specifies the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.
	Method specifies the method this VI uses to convert a continuous system to a discrete system before simulating the output. This VI uses the sampling interval (dt) from the Inputs signal. 0 ZOH (default)—Zero-Order-Hold 1 FOH—First-Order-Hold
	Simulation Graph displays all the outputs resulting from inputs to the system.
	Simulation Data returns the outputs and state data from the linear simulation. To access the Simulation Data, use the CD Get Time Response Data VI. Time returns the uniformly-spaced time vector against which this VI plots the impulse, initial, or step response and the state trajectories. Outputs Data returns data about the time response of the outputs to the inputs.
	error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error. status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred. code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning.

Linear Simulation (State-Space with Waveforms)

	State-Space Model contains a mathematical representation of and information about the system of which this VI calculates a response.
	Inputs is an array of waveforms. There must be as many waveforms in the array as the number of inputs to the system. The size of Inputs must equal the number of columns of matrices B and D of the State-Space Model. When you use this VI with a discrete model, you must ensure that the time step of the model matches the time step of this input signal.
	Initial Conditions is the initial state vector. The ith element of the array corresponds to the ith initial state. If Initial Conditions is empty, then this VI uses zero initial conditions to determine the time response.
	error in describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use exception control to treat what is normally an error as no error or to treat a warning as an error. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node. status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE. code is the error or warning code. The default is 0. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source specifies the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.
	Method specifies the method this VI uses to convert a continuous system to a discrete system before simulating the output. This VI uses the sampling interval (dt) from the Inputs signal. 0 ZOH (default)—Zero-Order-Hold 1 FOH—First-Order-Hold
	Outputs is a waveform graph that plots all the outputs resulting from Inputs to the system as the model represents.
	State Trajectories is a waveform graph that shows the individual trajectories of each state of the system.
	Simulation Data returns the outputs and state data from the linear simulation. To access the Simulation Data, use the CD Get Time Response Data VI. Time returns the uniformly-spaced time vector against which this VI plots the impulse, initial, or step response and the state trajectories. Outputs Data returns data about the time response of the outputs to the inputs. States Data returns data about the time response of the states to the inputs. For transfer function and zero-pole-gain models, this array is empty.
	error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error. status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred. code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning.

Linear Simulation (Transfer Function with Waveforms)

	Transfer Function Model contains a mathematical representation of and information about the system of which this VI calculates a response.
	Inputs is an array of waveforms. There must be as many waveforms in the array as the number of inputs to the system. The size of Inputs must equal the number of columns of matrices B and D of the State-Space Model. When you use this VI with a discrete model, you must ensure that the time step of the model matches the time step of this input signal.
	Initial Conditions is the initial state vector. The ith element of the array corresponds to the ith initial state. If Initial Conditions is empty, then this VI uses zero initial conditions to determine the time response.
	error in describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use exception control to treat what is normally an error as no error or to treat a warning as an error. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node. status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE. code is the error or warning code. The default is 0. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source specifies the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.
	Method specifies the method this VI uses to convert a continuous system to a discrete system before simulating the output. This VI uses the sampling interval (dt) from the Inputs signal. 0 ZOH (default)—Zero-Order-Hold 1 FOH—First-Order-Hold
	Outputs is a waveform graph that plots all the outputs resulting from Inputs to the system as the model represents.
	Simulation Data returns the outputs and state data from the linear simulation. To access the Simulation Data, use the CD Get Time Response Data VI. Time returns the uniformly-spaced time vector against which this VI plots the impulse, initial, or step response and the state trajectories. Outputs Data returns data about the time response of the outputs to the inputs.
	error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error. status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred. code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning.

Linear Simulation (Zero-Pole-Gain with Waveforms)

	Zero-Pole-Gain Model contains a mathematical representation of and information about the system of which this VI calculates a response.
	Inputs is the stimulus signal this VI applies to the system model. When you use this VI with a discrete model, you must ensure that the time step of the model matches the time step of this input signal. If you have only one input signal, specify Inputs as a 2D array with only one row or column. If you have two or more input signals, this VI considers the smaller dimension of the 2D array to be the number of channels and the larger dimension to be the number of points in each channel.
	Initial Conditions is the initial state vector. The ith element of the array corresponds to the ith initial state. If Initial Conditions is empty, then this VI uses zero initial conditions to determine the time response.
	error in describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use exception control to treat what is normally an error as no error or to treat a warning as an error. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node. status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE. code is the error or warning code. The default is 0. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source specifies the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.
	Method specifies the method this VI uses to convert a continuous system to a discrete system before simulating the output. This VI uses the sampling interval (dt) from the Inputs signal. 0 ZOH (default)—Zero-Order-Hold 1 FOH—First-Order-Hold
	Outputs is a waveform graph that plots all the outputs resulting from Inputs to the system as the model represents.
	Simulation Data returns the outputs and state data from the linear simulation. To access the Simulation Data, use the CD Get Time Response Data VI. Time returns the uniformly-spaced time vector against which this VI plots the impulse, initial, or step response and the state trajectories. Outputs Data returns data about the time response of the outputs to the inputs.
	error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error. status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred. code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning.

CD Linear Simulation Details

This VI supports input and output delays. This VI ignores the transport delay information. Refer to the LabVIEW Control Design User Manual for more information about delays.

previous page start next page

Get in touch

Submit feedback about this site to:

• [email protected]