Skip to content

Commit

Permalink
ModeSolver no longer outputs epsilon by default (#88)
Browse files Browse the repository at this point in the history
  • Loading branch information
ChristopherHogan authored and stevengj committed Jan 22, 2019
1 parent 9d93131 commit d0b78ff
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions doc/docs/Python_User_Interface.md
Original file line number Diff line number Diff line change
Expand Up @@ -321,7 +321,7 @@ These are functions to help you run and control the simulation. They are all met

**`ModeSolver.run(*band_func)`**
          
This runs the simulation described by the input parameters (see above), with no constraints on the polarization of the solution. That is, it reads the input parameters, initializes the simulation, and solves for the requested eigenstates of each k-point. The dielectric function is outputted to `epsilon.h5` before any eigenstates are computed. `run` takes as arguments zero or more "band functions" `band_func`. A band function should be a function of one integer argument, the band index, so that `band_func(which_band)` performs some operation on the band `which_band` (e.g. outputting fields). After every k-point, each band function is called for the indices of all the bands that were computed. Alternatively, a band function may be a "thunk" (function of zero arguments), in which case `band_func()` is called exactly once per k-point.
This runs the simulation described by the input parameters (see above), with no constraints on the polarization of the solution. That is, it reads the input parameters, initializes the simulation, and solves for the requested eigenstates of each k-point. `run` takes as arguments zero or more "band functions" `band_func`. A band function should be a function of one integer argument, the band index, so that `band_func(which_band)` performs some operation on the band `which_band` (e.g. outputting fields). After every k-point, each band function is called for the indices of all the bands that were computed. Alternatively, a band function may be a "thunk" (function of zero arguments), in which case `band_func()` is called exactly once per k-point.

**`ModeSolver.run_zeven(*band_func)`, ``Modesolver.run_zodd(*band_func)`**
          
Expand Down Expand Up @@ -567,7 +567,7 @@ Loads the bound charge density \(\nabla \cdot \mathbf{E}\) for the band `which_b

**`ModeSolver.get_epsilon()`**
          
Loads the dielectric function and returns a numpy array.
Loads the dielectric function and returns a numpy array. Must call `ModeSolver.init_params` or any `run` function before calling `get_epsilon`.

Once loaded, the field can be transformed into another field or a scalar field:

Expand Down

0 comments on commit d0b78ff

Please sign in to comment.