gimme-alpha_structs.h

Go to the documentation of this file.

/** @file */
/*
** gimme-alpha_structs.h
** 
** Made by Johnny Q. Hacker
** Login   <solarion@borkborkbork>
** 

    Copyright (C) 2008 Joseph Pingenot

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU Affero General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program 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 Affero General Public License for more details.

    You should have received a copy of the GNU Affero General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.

** Started on  Mon Sep 29 16:21:29 2008 Johnny Q. Hacker
** Last update Mon Sep 29 16:31:48 2008 Johnny Q. Hacker
*/

#ifndef     GIMME_ALPHA_STRUCTS_H_
# define    GIMME_ALPHA_STRUCTS_H_

#include <complex.h>

#ifdef __cplusplus
extern "C" {
#endif

/*In the following structs, EITHER x OR spacing may defined.  If
  x is non-null, it will be used and spacing will be ignored.
  Otherwise, spacing will be used.*/
struct potential {
  double *potential;
  int N;
  double *x;
  double spacing;
};

struct band {
  double *bandedge;
  int N;
  double *x;
  double spacing;
};

struct efield {
  /*Just one component; the potential is 1D.*/
  double *field;
  int N;
  double *x;
  double spacing;
};

enum kp_wavefunc_type {
  KP8X8_WAVEFUNC,
  MSTAR_WAVEFUNC
};

#ifdef __cplusplus
}
#endif

#endif      /* !GIMME-ALPHA_STRUCTS_H_ */