vhal.h

Go to the documentation of this file.

#ifndef _VAPBSHAL_H_
#define _VAPBSHAL_H_

enum eVrc_Codes {
        
        VRC_WARNING=-1, 
        VRC_FAILURE=0,  
        VRC_SUCCESS=1   
};
typedef enum eVrc_Codes Vrc_Codes;

enum eVsol_Meth {
        
        VSOL_CGMG,              /* 0: conjugate gradient multigrid */
        VSOL_Newton,    /* 1: newton */
        VSOL_MG,                /* 2: multigrid */
        VSOL_CG,                /* 3: conjugate gradient */
        VSOL_SOR,               /* 4: sucessive overrelaxation */
        VSOL_RBGS,              /* 5: red-black gauss-seidel */
        VSOL_WJ,                /* 6: weighted jacobi */
        VSOL_Richardson,/* 7: richardson  */
        VSOL_CGMGAqua,  /* 8: conjugate gradient multigrid aqua */ 
        VSOL_NewtonAqua /* 9: newton aqua */
        
};
typedef enum eVsol_Meth Vsol_Meth;

enum eVsurf_Meth {
        VSM_MOL=0, 
    VSM_MOLSMOOTH=1, 
        VSM_SPLINE=2,    
        VSM_SPLINE3=3,  
        VSM_SPLINE4=4   
};

typedef enum eVsurf_Meth Vsurf_Meth;

enum eVhal_PBEType {
    PBE_LPBE,  
    PBE_NPBE,  
    PBE_LRPBE,  
    PBE_NRPBE,  
        PBE_SMPBE       
};

typedef enum eVhal_PBEType Vhal_PBEType;

enum eVhal_IPKEYType {
    IPKEY_SMPBE = -2, 
        IPKEY_LPBE,  
    IPKEY_NPBE 
};

typedef enum eVhal_IPKEYType Vhal_IPKEYType;

enum eVhal_NONLINType {
    NONLIN_LPBE = 0,
        NONLIN_NPBE,  
    NONLIN_SMPBE,
        NONLIN_LPBEAQUA,
        NONLIN_NPBEAQUA
};

typedef enum eVhal_NONLINType Vhal_NONLINType;

enum eVoutput_Format {
    OUTPUT_NULL,   
    OUTPUT_FLAT, 
};

typedef enum eVoutput_Format Voutput_Format;

enum eVbcfl {
    BCFL_ZERO=0,  
    BCFL_SDH=1,  
    BCFL_MDH=2,  
    BCFL_UNUSED=3,  
    BCFL_FOCUS=4,  
    BCFL_MEM=5  
};

typedef enum eVbcfl Vbcfl;

enum eVchrg_Meth {
        VCM_TRIL=0,  
    VCM_BSPL2=1,  
    VCM_BSPL4=2  
};

typedef enum eVchrg_Meth Vchrg_Meth;

enum eVchrg_Src {
        VCM_CHARGE=0,     
        VCM_PERMANENT=1,  
    VCM_INDUCED=2,    
    VCM_NLINDUCED=3   
};

typedef enum eVchrg_Src Vchrg_Src;

enum eVdata_Type {
    VDT_CHARGE, 
    VDT_POT,    
    VDT_SMOL,   
    VDT_SSPL,   
    VDT_VDW,    
    VDT_IVDW,   
    VDT_LAP,    
    VDT_EDENS,  
    VDT_NDENS,  
    VDT_QDENS,  
    VDT_DIELX,  
    VDT_DIELY,  
    VDT_DIELZ,  
    VDT_KAPPA   
};

typedef enum eVdata_Type Vdata_Type;

enum eVdata_Format {
    VDF_DX=0,  
    VDF_UHBD=1, 
    VDF_AVS=2,  
        VDF_MCSF=3  
};

typedef enum eVdata_Format Vdata_Format;

#define APBS_TIMER_WALL_CLOCK 26

#define APBS_TIMER_SETUP 27

#define APBS_TIMER_SOLVER 28

#define APBS_TIMER_ENERGY 29

#define APBS_TIMER_FORCE 30

#define APBS_TIMER_TEMP1 31

#define APBS_TIMER_TEMP2 32

#define MAXMOL 5

#define MAXION 10

#define MAXFOCUS 5

#define VMGNLEV 4

#define VREDFRAC 0.25

#define VAPBS_NVS 4

#define VAPBS_DIM 3

#define VAPBS_RIGHT 0

#define VAPBS_FRONT 1

#define VAPBS_UP    2

#define VAPBS_LEFT  3

#define VAPBS_BACK  4

#define VAPBS_DOWN  5

#define VPMGSMALL 1e-12

#define SINH_MIN -85.0
#define SINH_MAX 85.0


#if defined(VDEBUG)
#   if !defined(APBS_NOINLINE)
#       define APBS_NOINLINE 1
#   endif
#endif

#if !defined(APBS_NOINLINE)

#   define VINLINE_VACC

#   define VINLINE_VATOM

#   define VINLINE_VCSM

#   define VINLINE_VPBE

#   define VINLINE_VPEE

#   define VINLINE_VGREEN

#   define VINLINE_VFETK

#   define VINLINE_VPMG 

#   define MAX_HASH_DIM 75

#endif

/* Fortran name mangling */
#if defined(VF77_UPPERCASE)
#   if defined(VF77_NOUNDERSCORE)
#       define VF77_MANGLE(name,NAME) NAME
#   elif defined(VF77_ONEUNDERSCORE)
#       define VF77_MANGLE(name,NAME) NAME ## _
#   else
#       define VF77_MANGLE(name,NAME) name
#   endif
#else
#   if defined(VF77_NOUNDERSCORE)
#       define VF77_MANGLE(name,NAME) name
#   elif defined(VF77_ONEUNDERSCORE)
#       define VF77_MANGLE(name,NAME) name ## _
#   else

#       define VF77_MANGLE(name,NAME) name
#   endif
#endif

/* Floating Point Error */
#if defined(MACHINE_EPS)
#     define VFLOOR(value) \
              ((floor(value) != floor(value + MACHINE_EPS)) ? \
              floor(value + MACHINE_EPS) : floor(value))
#else

#     define VFLOOR(value) floor(value)
#endif

/* String embedding for ident */
#if defined(HAVE_EMBED)

#    define VEMBED(rctag) \
         VPRIVATE const char* rctag; \
         static void* use_rcsid=(0 ? &use_rcsid : (void**)&rcsid);
#else

#    define VEMBED(rctag)
#endif /* if defined(HAVE_EMBED) */

#endif /* #ifndef _VAPBSHAL_H_ */

---