1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
|
---
The Run Function Is Not A Loop
---
In Meep, there are functions `run` (Python) or `run-until` (Scheme) and similar that time step the fields, and take arguments allowing custom actions to be performed on every time step, or on some subset of the time steps. Many users misunderstand this, however, and make the same mistake: they think the `run` function is a "looping" construct of some kind, and that you can just put any code you want into it and it will get executed for every time step. This mistake and how to correct it are described in this article.
[TOC]
Hello World
-----------
Let's consider a "Hello World" example. Suppose we start with a control file that runs for 200 time units and outputs $E_z$ on each time step:
**Python**
```py
sim = meep.Simulation(...)
sim.run(meep.output_efield_z, until=200)
```
**Scheme**
```scm
(run-until 200 output-efield-z)
```
and now we want to modify it to also print "Hello World!" for every time step, as it is running.
The Wrong Way
-------------
Many users will naively write:
**Python**
```py
sim.run(meep.output_efield_z, print("Hello World!"), until=200)
```
**Scheme**
```scm
(run-until 200 output-efield-z (print "Hello World!\n"))
```
**This is wrong.** It will output "Hello World!" *once*, then give an error. What is going on? The problem is that you are thinking of `run` (Python) or `run-until` (Scheme) in the wrong way, as if it were a loop:
**Python**
```py
for time < 200:
meep.output_efield_z
print("Hello World!")
```
**Scheme**
```scm
for time < 200 do
output-efield-z
(print "Hello World!\n")
```
This is **not** what is happening. Instead, `run` (Python) or `run-until` (Scheme) is just a *function* that runs the simulation, and its arguments should be *functions* that are called for each time step. That is, it is really doing something like:
```html
evaluate the arguments: 200: a number
output-efield-z: a function
(print "Hello World!\n"): prints output and returns #<unspecified>;
call run-until:
time-step until t=200
at each time step, call the arguments:
call (output-efield-z)
call (#<unspecified>)
```
Two things went wrong. First, the arguments are evaluated **before** calling the function, which means that the `print` statement is executed before `run-until` even starts. Second, `run-until` then tries to call the **result** of `(print ...)` as if it were a function, which causes an error because `(print ...)` does not return a function. The `print` returns a special Scheme code `#<unspecified>` that means it doesn't really return anything at all.
The Right Way
-------------
What we should have passed to `run` (Python) or `run-until` (Scheme), instead of the *result* of calling `print(...)` (Python) or `(print ...)` (Scheme), is a *function* that calls `print(...)` (Python) or `(print ...)` (Scheme). There are two ways to do it.
First, we could explicitly define a function, call it `my_hello` (Python) or `my-hello` (Scheme), that does what we want:
**Python**
```py
def my_hello(sim):
print("Hello World!")
sim.run(meep.output_efield_z, my_hello, until=200)
```
**Scheme**
```scm
(define (my-hello) (print "Hello World!\n"))
(run-until 200 output-efield-z my-hello)
```
Notice two things. First, `my_hello` (Python) or `my-hello` (Scheme) is a function of one argument (Python) or no arguments (Scheme), which means that it is just called at every time step. Another, more complicated, possibility is described in the [Python Interface/Writing Your Own Step Functions](Python_User_Interface.md#writing-your-own-step-functions) or [Scheme Interface/Writing Your Own Step Functions](Scheme_User_Interface.md#writing-your-own-step-functions). Second, when we call `run` (Python) or `run-until` (Scheme), we just pass the *name* of the function `my_hello` (Python) or `my-hello` (Scheme), and not the *result* of calling the function `my_hello(...)` (Python) or `(my-hello)` (Scheme).
A second possibility in Scheme is that we could use Python or Scheme's `lambda` construct to define our function in-line. The `lambda` syntax in Python or Scheme allows you to define [anonymous functions](https://en.wikipedia.org/wiki/Anonymous_function) without assigning them a name via `def` (Python) or `define` (Scheme), and to stick the function definition right into another expression. It works like this:
**Python**
```py
sim.run(meep.output_efield_z, lambda sim: print("Hello World!"), until=200)
```
**Scheme**
```scm
(run-until 200 output-efield-z (lambda () (print "Hello World!\n")))
```
In Python, `lambda sim: ...` defines a function of one argument `sim`. In Scheme, `(lambda () ...)` defines a function of no arguments `()`. Both functions, when called, execute the `...` statements.
|
