nanostructures.h

Go to the documentation of this file.

/*
** nanostructures.h
** 
** Made by Johnny Q. Hacker
** Login   <solarion@borkborkbork>
** 

    Copyright (C) 2009 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  Tue Mar 17 14:37:28 2009 Johnny Q. Hacker
** Last update Tue Mar 17 14:37:28 2009 Johnny Q. Hacker
*/

#ifndef     NANOSTRUCTURES_H_
# define    NANOSTRUCTURES_H_

#include <glib.h>
#include "matdb.h"

enum doping_type {
  NONE,
  CONST,
  LAST_TYPE
};

enum nanostructure_type {
  NS_D1
};

struct doping_region_1d {
  enum doping_type dt;
  double start;
  double end;
  void *datum;
};

struct region_1d {
  double start;
  double end;
};

struct nanostructure {
  enum nanostructure_type type;
  void* storage;
};

struct nanostructure_1d {
  /*Holds a list of the regions*/
  GList *regions;
  /*Holds a list of the doping regions.*/
  GList *doping_regions;
};

/*\param dim number of dimensions of the structure
 */
struct nanostructure* nanostructure_new(enum nanostructure_type type);
void structure_free(struct nanostructure* s);

struct doping_region_1d* doping_region_1d_new(enum doping_type dt);
struct region_1d* region_1d_new();

#endif      /* !NANOSTRUCTURES_H_ */