Merge pull request #1182 from SciML/myb/doc

Update docs on @nAmed

Author: YingboMa

docs/src/tutorials/acausal_components.md

@@ -95,7 +95,8 @@ rc_eqs = [
           connect(capacitor.n, source.n, ground.g)
          ]
 
-@named rc_model = compose(ODESystem(rc_eqs, t),
+@named _rc_model = ODESystem(rc_eqs, t)
+@named rc_model = compose(_rc_model,
                           [resistor, capacitor, source, ground])
 sys = structural_simplify(rc_model)
 u0 = [
@@ -288,7 +289,8 @@ rc_eqs = [
 Finally we build our four component model with these connection rules:
 
 ```julia
-@named rc_model = compose(ODESystem(rc_eqs, t)
+@named _rc_model = ODESystem(rc_eqs, t)
+@named rc_model = compose(_rc_model,
                           [resistor, capacitor, source, ground])
 ```
 

docs/src/tutorials/higher_order.md

@@ -21,7 +21,7 @@ eqs = [D(D(x)) ~ σ*(y-x),
        D(y) ~ x*(ρ-z)-y,
        D(z) ~ x*y - β*z]
 
-sys = ODESystem(eqs)
+@named sys = ODESystem(eqs)
 ```
 
 Note that we could've used an alternative syntax for 2nd order, i.e.

docs/src/tutorials/nonlinear.md

@@ -16,7 +16,7 @@ using ModelingToolkit, NonlinearSolve
 eqs = [0 ~ σ*(y-x),
        0 ~ x*(ρ-z)-y,
        0 ~ x*y - β*z]
-ns = NonlinearSystem(eqs, [x,y,z], [σ,ρ,β])
+@named ns = NonlinearSystem(eqs, [x,y,z], [σ,ρ,β])
 
 guess = [x => 1.0,
          y => 0.0,

docs/src/tutorials/nonlinear_optimal_control.md

@@ -59,7 +59,7 @@ eqs = [
     D(v) ~ p[1]*u^3 + v
 ]
 
-sys = ControlSystem(loss,eqs,t,[x,v],[u],p)
+@named sys = ControlSystem(loss,eqs,t,[x,v],[u],p)
 ```
 
 ## Solving a Control Problem via Discretize-Then-Optimize

docs/src/tutorials/optimization.md

@@ -6,7 +6,7 @@ using ModelingToolkit, GalacticOptim, Optim
 @variables x y
 @parameters a b
 loss = (a - x)^2 + b * (y - x^2)^2
-sys = OptimizationSystem(loss,[x,y],[a,b])
+@named sys = OptimizationSystem(loss,[x,y],[a,b])
 
 u0 = [
     x=>1.0

docs/src/tutorials/stochastic_diffeq.md

@@ -23,7 +23,7 @@ noiseeqs = [0.1*x,
             0.1*y,
             0.1*z]
 
-de = SDESystem(eqs,noiseeqs,t,[x,y,z],[σ,ρ,β])
+@named de = SDESystem(eqs,noiseeqs,t,[x,y,z],[σ,ρ,β])
 
 u0map = [
     x => 1.0,

docs/src/tutorials/tearing_parallelism.md

@@ -114,7 +114,7 @@ function Capacitor(;name, C = 1.0)
     ), p, n)
 end
 
-function rc_model(i; name, source, ground, R, C)
+function parallel_rc_model(i; name, source, ground, R, C)
     resistor = HeatingResistor(name=Symbol(:resistor, i), R=R)
     capacitor = Capacitor(name=Symbol(:capacitor, i), C=C)
     heat_capacitor = HeatCapacitor(name=Symbol(:heat_capacitor, i))
@@ -126,8 +126,8 @@ function rc_model(i; name, source, ground, R, C)
               connect_heat(resistor.h, heat_capacitor.h)
              ]
 
-    rc_model = compose(ODESystem(rc_eqs, t, name=Symbol(name, i)),
-                       [resistor, capacitor, source, ground, heat_capacitor])
+    compose(ODESystem(rc_eqs, t, name=Symbol(name, i)),
+            [resistor, capacitor, source, ground, heat_capacitor])
 end
 ```
 
@@ -145,13 +145,14 @@ N = 50
 Rs = 10 .^range(0, stop=-4, length=N)
 Cs = 10 .^range(-3, stop=0, length=N)
 rc_systems = map(1:N) do i
-    rc_model(i; name=:rc, source=source, ground=ground, R=Rs[i], C=Cs[i])
+    parallel_rc_model(i; name=:rc, source=source, ground=ground, R=Rs[i], C=Cs[i])
 end;
 @variables E(t)=0.0
 eqs = [
        D(E) ~ sum(((i, sys),)->getproperty(sys, Symbol(:resistor, i)).h.Q_flow, enumerate(rc_systems))
       ]
-big_rc = compose(ODESystem(eqs, t, [E], []), rc_systems)
+@named _big_rc = ODESystem(eqs, t, [E], [])
+@named big_rc = compose(_big_rc, rc_systems)
 ```
 
 Now let's say we want to expose a bit more parallelism via running tearing.