GetSubstitutions - MapleSim Help
For the best experience, we recommend viewing online help using Google Chrome or Microsoft Edge.

Online Help

All Products    Maple    MapleSim


GetSubstitutions

get variable and parameter substitutions

 

Calling Sequence

Parameters

Returns

Options

Description

Notes

Examples

Calling Sequence

A := MapleSim:-LinkModel();

A:-GetSubstitutions(options)

Parameters

options

-

(optional) equation(s) of the form name = value

Returns

• 

set : set of the system's variable and parameter substitutions

Options

• 

reverse : true or false

  

Specifies whether to return the reverse of the substitutions that are used in other API calls. Default is false.

• 

shortexplicit : true or false

  

True (the default) means use short names, if possible, for explicit parameters, which are those defined in parameter blocks or, if the selected subsystem is a component, the parameters of the component.

Description

• 

A:-GetSubstitutions returns the substitutions that are applied to variable and parameter names in other API function calls.

• 

The A := MapleSim:-LinkModel() statement needs to be run prior to successfully using any of the ModelObject A's export functions.

Notes

• 

If no substitutions have been defined for the system, a set of default substitutions will be returned.

Examples

Linking to a MapleSim model (located in .msim file):

AMapleSim:-LinkModelfilename=catkerneloptstoolboxdir=MapleSim,/data/examples/RLCcircuit.msim:

Getting the substitutions that are applied to variable and parameter names in other API function calls:

A:-GetSubstitutions

Main.RLC.C=C,Main.RLC.C1.i=C1_i,Main.RLC.C1.n.i=C1_n_i,Main.RLC.C1.n.v=C1_n_v,Main.RLC.C1.p.i=C1_p_i,Main.RLC.C1.p.v=C1_p_v,Main.RLC.C1.v=C1_v,Main.RLC.G2.p.i=G2_p_i,Main.RLC.G2.p.v=G2_p_v,Main.RLC.I1.i=I1_i,Main.RLC.I1.n.i=I1_n_i,Main.RLC.I1.n.v=I1_n_v,Main.RLC.I1.p.i=I1_p_i,Main.RLC.I1.p.v=I1_p_v,Main.RLC.I1.v=I1_v,Main.RLC.L=L,Main.RLC.NP1.i=NP1_i,Main.RLC.NP1.v=NP1_v,Main.RLC.NP2.i=NP2_i,Main.RLC.NP2.v=NP2_v,Main.RLC.PP1.i=PP1_i,Main.RLC.PP1.v=PP1_v,Main.RLC.PP2.i=PP2_i,Main.RLC.PP2.v=PP2_v,Main.RLC.PP3.i=PP3_i,Main.RLC.PP3.v=PP3_v,Main.RLC.PS1.y=PS1_y,Main.RLC.R=R,Main.RLC.R1.T=T,Main.RLC.R1.i=R1_i,Main.RLC.R1.n.i=R1_n_i,Main.RLC.R1.n.v=R1_n_v,Main.RLC.R1.p.i=R1_p_i,Main.RLC.R1.p.v=R1_p_v,Main.RLC.R1.v=R1_v,Main.RLC.SC1.i=SC1_i,Main.RLC.SC1.v=SC1_v,Main.S1.f=S1_f,Main.S1.offset=S1_offset,Main.S1.phase=S1_phase,Main.S1.y=S1_y,Main.Probe1.Vout=Vout,Main.RLC.InputSignal=InputSignal,Main.RLC.OutputSignal=OutputSignal,Main.RLC.PS1.p.i=PS1_p_i,Main.RLC.PS1.p.v=PS1_p_v,Main.RLC.R1.LossPower=R1_LossPower,Main.RLC.R1.R_actual=R1_R_actual,Main.RLC.R1.T_heatPort=R1_T_heatPort,Main.RLC.R1.T_ref=T,Main.RLC.R1.alpha=R1_alpha,Main.RLC.SC1.n.i=SC1_n_i,Main.RLC.SC1.n.v=SC1_n_v,Main.RLC.SC1.p.i=SC1_p_i,Main.RLC.SC1.p.v=SC1_p_v,Main.S1.amplitude=S1_amplitude,Main.S1.startTime=S1_startTime

(1)

Getting reverse substitutions:

A:-GetSubstitutionsreverse

C=Main.RLC.C,C1_i=Main.RLC.C1.i,C1_n_i=Main.RLC.C1.n.i,C1_n_v=Main.RLC.C1.n.v,C1_p_i=Main.RLC.C1.p.i,C1_p_v=Main.RLC.C1.p.v,C1_v=Main.RLC.C1.v,G2_p_i=Main.RLC.G2.p.i,G2_p_v=Main.RLC.G2.p.v,I1_i=Main.RLC.I1.i,I1_n_i=Main.RLC.I1.n.i,I1_n_v=Main.RLC.I1.n.v,I1_p_i=Main.RLC.I1.p.i,I1_p_v=Main.RLC.I1.p.v,I1_v=Main.RLC.I1.v,L=Main.RLC.L,NP1_i=Main.RLC.NP1.i,NP1_v=Main.RLC.NP1.v,NP2_i=Main.RLC.NP2.i,NP2_v=Main.RLC.NP2.v,PP1_i=Main.RLC.PP1.i,PP1_v=Main.RLC.PP1.v,PP2_i=Main.RLC.PP2.i,PP2_v=Main.RLC.PP2.v,PP3_i=Main.RLC.PP3.i,PP3_v=Main.RLC.PP3.v,PS1_p_i=Main.RLC.PS1.p.i,PS1_p_v=Main.RLC.PS1.p.v,PS1_y=Main.RLC.PS1.y,R=Main.RLC.R,R1_i=Main.RLC.R1.i,R1_n_i=Main.RLC.R1.n.i,R1_n_v=Main.RLC.R1.n.v,R1_p_i=Main.RLC.R1.p.i,R1_p_v=Main.RLC.R1.p.v,R1_v=Main.RLC.R1.v,S1_f=Main.S1.f,S1_y=Main.S1.y,SC1_i=Main.RLC.SC1.i,SC1_n_i=Main.RLC.SC1.n.i,SC1_n_v=Main.RLC.SC1.n.v,SC1_p_i=Main.RLC.SC1.p.i,SC1_p_v=Main.RLC.SC1.p.v,SC1_v=Main.RLC.SC1.v,T=Main.RLC.R1.T_ref,Vout=Main.Probe1.Vout,InputSignal=Main.RLC.InputSignal,OutputSignal=Main.RLC.OutputSignal,R1_LossPower=Main.RLC.R1.LossPower,R1_R_actual=Main.RLC.R1.R_actual,R1_T_heatPort=Main.RLC.R1.T_heatPort,R1_alpha=Main.RLC.R1.alpha,S1_amplitude=Main.S1.amplitude,S1_offset=Main.S1.offset,S1_phase=Main.S1.phase,S1_startTime=Main.S1.startTime

(2)

See Also

MapleSim

MapleSim[LinkModel]

MapleSim[LinkModel][SetSubstitutions]