fnft_nsev.h

Go to the documentation of this file.

/*
* This file is part of FNFT.
*
* FNFT is free software; you can redistribute it and/or
* modify it under the terms of the version 2 of the GNU General
* Public License as published by the Free Software Foundation.
*
* FNFT is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* Contributors:
* Sander Wahls (TU Delft) 2017-2018.
* Shrinivas Chimmalgi (TU Delft) 2019-2020.
* Peter J Prins (TU Delft) 2020-2021.
* Sander Wahls (KIT) 2023.
*/
 
#ifndef FNFT_NSEV_H
#define FNFT_NSEV_H
 
#include "fnft__nse_fscatter.h"
#include "fnft__nse_scatter.h"
#include "fnft__misc.h" // for l2norm
#include <string.h> // for memcpy
#include <stdio.h>
#include "fnft__errwarn.h"
#include "fnft__poly_roots_fasteigen.h"
#include "fnft__poly_chirpz.h"
 
typedef enum {
    fnft_nsev_bsfilt_NONE,
    fnft_nsev_bsfilt_BASIC,
    fnft_nsev_bsfilt_FULL,
    fnft_nsev_bsfilt_MANUAL
} fnft_nsev_bsfilt_t;
 
typedef enum {
    fnft_nsev_bsloc_FAST_EIGENVALUE,
    fnft_nsev_bsloc_NEWTON,
    fnft_nsev_bsloc_SUBSAMPLE_AND_REFINE
} fnft_nsev_bsloc_t;
 
typedef enum {
    fnft_nsev_dstype_NORMING_CONSTANTS,
    fnft_nsev_dstype_RESIDUES,
    fnft_nsev_dstype_BOTH
} fnft_nsev_dstype_t;
 
typedef enum {
    fnft_nsev_cstype_REFLECTION_COEFFICIENT,
    fnft_nsev_cstype_AB,
    fnft_nsev_cstype_BOTH
} fnft_nsev_cstype_t;
 
typedef struct {
    fnft_nsev_bsfilt_t bound_state_filtering;
    fnft_nsev_bsloc_t bound_state_localization;
    FNFT_UINT niter;
    FNFT_REAL tol;
    FNFT_UINT Dsub;
    fnft_nsev_dstype_t discspec_type;
    fnft_nsev_cstype_t contspec_type;
    FNFT_INT normalization_flag;
    fnft_nse_discretization_t discretization;
    FNFT_UINT richardson_extrapolation_flag;
    FNFT_REAL bounding_box[4];
} fnft_nsev_opts_t;
 
fnft_nsev_opts_t fnft_nsev_default_opts();
 
FNFT_UINT fnft_nsev_max_K(const FNFT_UINT D,
    fnft_nsev_opts_t const * const opts);
 
FNFT_INT fnft_nsev(const FNFT_UINT D, FNFT_COMPLEX const * 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);
 
 
#ifdef FNFT_ENABLE_SHORT_NAMES
#define nsev_bsfilt_NONE fnft_nsev_bsfilt_NONE
#define nsev_bsfilt_BASIC fnft_nsev_bsfilt_BASIC
#define nsev_bsfilt_FULL fnft_nsev_bsfilt_FULL
#define nsev_bsfilt_MANUAL fnft_nsev_bsfilt_MANUAL
#define nsev_bsloc_FAST_EIGENVALUE fnft_nsev_bsloc_FAST_EIGENVALUE
#define nsev_bsloc_NEWTON fnft_nsev_bsloc_NEWTON
#define nsev_bsloc_SUBSAMPLE_AND_REFINE fnft_nsev_bsloc_SUBSAMPLE_AND_REFINE
#define nsev_dstype_NORMING_CONSTANTS fnft_nsev_dstype_NORMING_CONSTANTS
#define nsev_dstype_RESIDUES fnft_nsev_dstype_RESIDUES
#define nsev_dstype_BOTH fnft_nsev_dstype_BOTH
#define nsev_cstype_REFLECTION_COEFFICIENT fnft_nsev_cstype_REFLECTION_COEFFICIENT
#define nsev_cstype_AB fnft_nsev_cstype_AB
#define nsev_cstype_BOTH fnft_nsev_cstype_BOTH
#endif
 
#endif