| extraction_option |
String |
default |
extraction_option |
- Sets the extraction technique, must be one of:
- 'default' (use SLEPC default)
- 'slepc_default' (use SLEPC default)
- 'ritz'
- 'harmonic'
- 'harmonic_relative'
- 'harmonic_right'
- 'harmonic_largest'
- 'refined'
- 'refined_harmonic'
|
| max_iter |
Integer |
PETSC_DECIDE |
max_iter |
- Sets the maximum number of SLEPC iterations used.
- If not set (recommended) then let SLEPC decide what to use (varies with different options).
|
| n_eig |
Integer |
1 |
n_eig |
- The number of eigenmodes to search for. number of modes found may be larger than this.
|
| nadv |
Integer |
|
nadv |
- How many GS2 timesteps to take each time SLEPc wants to advance the distribution function. Useful to separate closely spaced eigenvalues without changing delt.
|
| save_restarts |
Fortran_Bool |
|
save_restarts |
- If true then we save a set of restart files for each eigenmode found. These are named as standard restart file (i.e. influenced by the restart_file input), but have eig_<id> appended near end, where <id> is an integer representing the eigenmode id.
- If save_distfn of gs2_diagnostics_knobs is true then will also save the distribution function files.
|
| solver_option |
String |
default |
solver_option |
- Sets the type of solver to use, must be one of:
- 'default' (Krylov-Schur)
- 'slepc_default' (Krylov-Schur)
- 'power'
- 'subspace'
- 'arnoldi'
- 'lanczos'
- 'krylov'
- 'GD'
- 'JD'
- 'RQCG'
- 'CISS'
- 'lapack'
- 'arpack'
- 'blzpack'
- 'trlan'
- 'blopex'
- 'primme'
- 'feast'
- Not all solver types are compatible with other eigenvalue options, some options may not be supported in older SLEPC versions and some may require certain flags to be set when SLEPC is compiled.
|
| targ_im |
Float |
0.5 |
targ_im |
- Imaginary part of the eigenvalue target
- Often beneficial to set this fairly large (e.g. 10)
|
| targ_re |
Float |
0.5 |
targ_re |
- Real part of the eigenvalue target
- Often beneficial to set this fairly small (e.g. ~0)
|
| tolerance |
Float |
1.0e-06 |
tolerance |
- Sets tolerance on SLEPC eigenmode search.
|
| transform_option |
String |
default |
transform_option |
- Sets the type of spectral transform to be used. Must be one of
- 'default' (let SLEPC decide)
- 'slepc_default' (let SLEPC decide)
- 'shell'
- 'shift'
- 'invert'
- 'cayley'
- 'fold'
- 'precond' (not implemented)
- Not all options are available in all versions of the library.
|
| use_ginit |
Fortran_Bool |
.false. |
use_ginit |
- If true then provide an initial guess for the eigenmode based on using init_g routines to initialise g.
- Probably most useful with ginit_option='many' (etc.) to start an eigenvalue search from a previously obtained solution.
|
| which_option |
String |
default |
which_option |
- Sets SLEPC mode of operation (i.e. what sort of eigenvalues it looks for). Must be one of
- 'default' (equivalent to 'target_magnitude')
- 'slepc_default' (let SLEPC decide)
- 'largest_magnitude'
- 'smallest_magnitude'
- 'largest_real'
- 'smallest_real'
- 'largest_imaginary'
- 'smallest_imaginary'
- 'target_magnitude' (complex eigenvalue magnitude closest to magnitude of target)
- 'target_real'
- 'target_imaginary'
- 'all' (only some solver types, e.g. lapack)
- 'user' (will use a user specified function to pick between eigenmodes, note not currently implemented)
|
