FNFT
fnft_nsev.h
Go to the documentation of this file.
1 /*
2 * This file is part of FNFT.
3 *
4 * FNFT is free software; you can redistribute it and/or
5 * modify it under the terms of the version 2 of the GNU General
6 * Public License as published by the Free Software Foundation.
7 *
8 * FNFT is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15 *
16 * Contributors:
17 * Sander Wahls (TU Delft) 2017-2018.
18 */
19 
27 #ifndef FNFT_NSEV_H
28 #define FNFT_NSEV_H
29 
31 
42 typedef enum {
43  fnft_nsev_bsfilt_NONE,
44  fnft_nsev_bsfilt_BASIC,
45  fnft_nsev_bsfilt_FULL
47 
82 typedef enum {
83  fnft_nsev_bsloc_FAST_EIGENVALUE,
84  fnft_nsev_bsloc_NEWTON,
85  fnft_nsev_bsloc_SUBSAMPLE_AND_REFINE
87 
99 typedef enum {
100  fnft_nsev_dstype_NORMING_CONSTANTS,
101  fnft_nsev_dstype_RESIDUES,
102  fnft_nsev_dstype_BOTH
104 
121 typedef enum {
122  fnft_nsev_cstype_REFLECTION_COEFFICIENT,
123  fnft_nsev_cstype_AB,
124  fnft_nsev_cstype_BOTH
126 
175 typedef struct {
185 
202 
217  fnft_nsev_opts_t const * const opts);
218 
292 FNFT_INT fnft_nsev(const FNFT_UINT D, FNFT_COMPLEX * const q,
293  FNFT_REAL const * const T, const FNFT_UINT M,
294  FNFT_COMPLEX * const contspec, FNFT_REAL const * const XI,
295  FNFT_UINT * const K_ptr, FNFT_COMPLEX * const bound_states,
296  FNFT_COMPLEX * const normconsts_or_residues, const FNFT_INT kappa,
297  fnft_nsev_opts_t *opts);
298 
299 #ifdef FNFT_ENABLE_SHORT_NAMES
300 #define nsev_bsfilt_NONE fnft_nsev_bsfilt_NONE
301 #define nsev_bsfilt_BASIC fnft_nsev_bsfilt_BASIC
302 #define nsev_bsfilt_FULL fnft_nsev_bsfilt_FULL
303 #define nsev_bsloc_FAST_EIGENVALUE fnft_nsev_bsloc_FAST_EIGENVALUE
304 #define nsev_bsloc_NEWTON fnft_nsev_bsloc_NEWTON
305 #define nsev_bsloc_SUBSAMPLE_AND_REFINE fnft_nsev_bsloc_SUBSAMPLE_AND_REFINE
306 #define nsev_dstype_NORMING_CONSTANTS fnft_nsev_dstype_NORMING_CONSTANTS
307 #define nsev_dstype_RESIDUES fnft_nsev_dstype_RESIDUES
308 #define nsev_dstype_BOTH fnft_nsev_dstype_BOTH
309 #define nsev_cstype_REFLECTION_COEFFICIENT fnft_nsev_cstype_REFLECTION_COEFFICIENT
310 #define nsev_cstype_AB fnft_nsev_cstype_AB
311 #define nsev_cstype_BOTH fnft_nsev_cstype_BOTH
312 #endif
313 
314 #endif
FNFT_INT
int32_t FNFT_INT
Definition: fnft_numtypes.h:56
FNFT_UINT
size_t FNFT_UINT
Definition: fnft_numtypes.h:62
fnft_nsev_opts_t::bound_state_localization
fnft_nsev_bsloc_t bound_state_localization
Definition: fnft_nsev.h:177
fnft_nsev_opts_t::discretization
fnft_nse_discretization_t discretization
Definition: fnft_nsev.h:183
fnft_nsev_opts_t::Dsub
FNFT_UINT Dsub
Definition: fnft_nsev.h:179
fnft_nsev_cstype_t
fnft_nsev_cstype_t
Definition: fnft_nsev.h:121
fnft_nse_discretization_t
fnft_nse_discretization_t
Enum that specifies discretizations used to compute nonlinear Fourier transforms for the Nonlinear Sc...
Definition: fnft_nse_discretization_t.h:98
fnft_nsev_dstype_t
fnft_nsev_dstype_t
Definition: fnft_nsev.h:99
fnft_nsev_opts_t::bound_state_filtering
fnft_nsev_bsfilt_t bound_state_filtering
Definition: fnft_nsev.h:176
fnft_nsev_bsfilt_t
fnft_nsev_bsfilt_t
Definition: fnft_nsev.h:42
fnft_nse_discretization_t.h
Lists discretizations for the nonlinear Schroedinger equation.
fnft_nsev_opts_t::niter
FNFT_UINT niter
Definition: fnft_nsev.h:178
fnft_nsev_opts_t::discspec_type
fnft_nsev_dstype_t discspec_type
Definition: fnft_nsev.h:180
fnft_nsev_default_opts
fnft_nsev_opts_t fnft_nsev_default_opts()
Creates a new options variable for fnft_nsev with default settings.
fnft_nsev_bsloc_t
fnft_nsev_bsloc_t
Definition: fnft_nsev.h:82
fnft_nsev
FNFT_INT fnft_nsev(const FNFT_UINT D, FNFT_COMPLEX *const q, FNFT_REAL const *const T, const FNFT_UINT M, FNFT_COMPLEX *const contspec, FNFT_REAL const *const XI, FNFT_UINT *const K_ptr, FNFT_COMPLEX *const bound_states, FNFT_COMPLEX *const normconsts_or_residues, const FNFT_INT kappa, fnft_nsev_opts_t *opts)
Fast nonlinear Fourier transform for the nonlinear Schroedinger equation with vanishing boundary cond...
FNFT_COMPLEX
double complex FNFT_COMPLEX
Definition: fnft_numtypes.h:47
fnft_nsev_opts_t::contspec_type
fnft_nsev_cstype_t contspec_type
Definition: fnft_nsev.h:181
fnft_nsev_opts_t::normalization_flag
FNFT_INT normalization_flag
Definition: fnft_nsev.h:182
fnft_nsev_opts_t
Stores additional options for the routine fnft_nsev.
Definition: fnft_nsev.h:175
FNFT_REAL
double FNFT_REAL
Definition: fnft_numtypes.h:40
fnft_nsev_max_K
FNFT_UINT fnft_nsev_max_K(const FNFT_UINT D, fnft_nsev_opts_t const *const opts)
Returns the maximum number of bound states that can be detected by fnft_nsev.