Axes

noxaxis
Noxaxis
Syntax
noxaxis(pre_step=none, post_step=none, name='noxaxis')
xaxis
Xaxis
Syntax
xaxis(
    parameter,
    mode,
    start,
    stop,
    steps,
    relative=false,
    pre_step=none,
    post_step=none,
    name='xaxis'
)
See Also

x2axis, x3axis, sweep

x2axis
X2axis
Syntax
x2axis(
    parameter1,
    mode1,
    start1,
    stop1,
    steps1,
    parameter2,
    mode2,
    start2,
    stop2,
    steps2,
    relative=false,
    pre_step=none,
    post_step=none,
    name='x2axis'
)
See Also

xaxis, x3axis, sweep

x3axis
X3axis
Syntax
x3axis(
    parameter1,
    mode1,
    start1,
    stop1,
    steps1,
    parameter2,
    mode2,
    start2,
    stop2,
    steps2,
    parameter3,
    mode3,
    start3,
    stop3,
    steps3,
    relative=false,
    pre_step=none,
    post_step=none,
    name='x3axis'
)
See Also

xaxis, x2axis, sweep

sweep
Sweep

An action that sweeps N number of parameters through the values in N arrays.

Syntax
sweep(
    *args,
    pre_step=none,
    post_step=none,
    reset_parameter=true,
    name='sweep'
)
Required

args: Expects 3 arguments per axis. The first is a full name of a Parameter or a Parameter object. The second is an array of values to step this parameter over, and lastly a boolean value to say whether this is a relative step from the parameters initial value.

name: Name of the action, used to find the solution in the final output.

Optional

pre_step: An action to perform before the step is computed

post_step: An action to perform after the step is computed

reset_parameter: When true this action will reset the all the parameters it changed to the values before it ran.

See Also

xaxis, x2axis, x3axis

frequency_response
freqresp
FrequencyResponse

Computes the frequency response of a signal injected at various nodes to compute transfer functions to multiple output nodes. Inputs and outputs should be electrical or mechanical nodes. It does this in an efficient way by using the same model and solving for multiple RHS input vectors.

This action does not alter the model state. This action will ignore any currently definied signal generator elements in the model. Produces an output transfer matrix from each input node to some readout output. The shape of the output matrix is: [frequencies, inputs, outputs] To inject into optical nodes please see FrequencyResponse2 and FrequencyResponse3. To readout optical nodes please see FrequencyResponse3 and FrequencyResponse4.

Syntax
freqresp(f, inputs, outputs, open_loop=false, name='frequency_response')
Required

f: Frequencies to compute the transfer functions over

inputs: Mechanical or electrical node to inject signal at

outputs: Mechanical or electrical nodes to measure output at

Optional

open_loop: Computes open loop transfer functions if the system has closed

name: Solution name