ScalarInterpolation

Performs interpolation on input values using a specified dataset and interpolation method.

Takes an input value and produces an output by interpolating within a dataset according to the specified interpolation type. The component creates an interpolator object from the dataset and interpolation parameters, then applies this interpolator to map input values to output values through lookup and interpolation.

Usage

ScalarInterpolation(interpolator=dataset_interpolation(interpolation_type, filepath, independent_var, dependent_vars))

Parameters:

Name	Description	Units	Default value
filepath	Dataset containing the data points to be interpolated	–
independent_var		–
dependent_vars		–
interpolation_type		–

Connectors

• u - This connector represents a real signal as an input to a component (RealInput)

• y - This connector represents a real signal as an output from a component (RealOutput)

Behavior

using BlockComponents #hide
using ModelingToolkit #hide
@named sys = ScalarInterpolation() #hide
full_equations(sys) #hide

Source

# Performs interpolation on input values using a specified dataset and interpolation method.
#
# Takes an input value and produces an output by interpolating within a dataset according to the
# specified interpolation type. The component creates an interpolator object from the dataset and
# interpolation parameters, then applies this interpolator to map input values to output values
# through lookup and interpolation.
component ScalarInterpolation
  # Input value to be used for interpolation lookup
  u = RealInput()
  # Interpolated output value
  y = RealOutput()
  # Dataset containing the data points to be interpolated
  structural parameter filepath::String
  structural parameter independent_var::String
  structural parameter dependent_vars::String[:]
  structural parameter interpolation_type::String
  final parameter interpolator::Real2RealInterpolator = dataset_interpolation(interpolation_type, filepath, independent_var, dependent_vars)
relations
  y = interpolator(u)
end

Flattened Source

# Performs interpolation on input values using a specified dataset and interpolation method.
#
# Takes an input value and produces an output by interpolating within a dataset according to the
# specified interpolation type. The component creates an interpolator object from the dataset and
# interpolation parameters, then applies this interpolator to map input values to output values
# through lookup and interpolation.
component ScalarInterpolation
  # Input value to be used for interpolation lookup
  u = RealInput()
  # Interpolated output value
  y = RealOutput()
  # Dataset containing the data points to be interpolated
  structural parameter filepath::String
  structural parameter independent_var::String
  structural parameter dependent_vars::String[:]
  structural parameter interpolation_type::String
  final parameter interpolator::Real2RealInterpolator = dataset_interpolation(interpolation_type, filepath, independent_var, dependent_vars)
relations
  y = interpolator(u)
metadata {}
end

Test Cases

No test cases defined.

Related

• Examples

• Experiments

• Analyses

• Tests

  • ScalarInterpolationFileTest