Skip to content

Commit 315e82c

Browse files
Update README.md
1 parent 881c67d commit 315e82c

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ pip install glimy
3131
|
3232
|
3333
|
34-
|---Render(field,n_time_steps,pre=False)
34+
|---Render(field,n_time_steps,obs="ALL",pre=False)
3535
|
3636
|
3737
|
@@ -175,6 +175,7 @@ pip install glimy
175175
Executes FDTD calculations on a Continuum object.
176176
- **field** : It must take Continuum object. It s the field that evolved through time.
177177
- **n_time_steps** : It is number of time steps that field will evolve. It may take an integer. Lenght of time steps is given by ds/c/(<span>&#8730;</span>dim) ; where ds is grid spacing, c is speed of light and dim is number of dimensions of the grid. All units are SI.
178+
- **obs** : Determines whether time dependent logging will be the case. If it is set to <code>"ALL"</code>, time dependent observation is not the case. However, it is a set of points e.g <code>{ (0,0), (2,2) }</code> then it returns field amplitude of each given point. Returned array's order is the same as implicit order of the fed set.
178179
- **pre** : It is a boolean. <code>False</code> : Rendering will refresh E-field and H-Field. <code>True</code> : Rendering will continue from last rendered state.
179180

180181
## DotSource(location,presence,amplitude,frequency,phase=0)

0 commit comments

Comments
 (0)