generic_structure.h++

Go to the documentation of this file.

/*
  

    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/>.

*/

#ifndef GENERIC_STRUCTURE_HXX__
#define GENERIC_STRUCTURE_HXX__

#include <glib.h>
#include <libmodelxx/material.h++>
#include <libmodelxx/grid.h++>
#include <libmodelxx/fast_complex.h++>

namespace kdotp {
  namespace libmodelxx {
    namespace structure {

      /*This is access to a generic structure, without vtables.*/
      struct generic_structure {
  struct grid::grid* g;
  /*This is where the actual pointer to the classes are stored.*/
  /*Type material**/
  void* material_grid;
  /*Type double: the density (inverse-centimeters per length^dimension)*/
  void* doping_grid;
  /*Type double: the electrostatic potential*/
  void* potential_grid;
  /*6-component grid to hold the strain field*/
  void* strain_grid;
      };

      struct generic_structure* generic_structure_new(struct grid::grid *g);

      /**
       *Destroys a generic structure.
       *\param *s pointer to the structure to be freed.
       */
      GError* generic_structure_free(struct generic_structure* s);
      void generic_structure_free_potential(struct generic_structure* s);

      /*
       *Save the structure.
       *\param s the structure to save
       *\param file a string containing the filename
       *\return pointer to a GError giving the error.
       */
      GError* generic_structure_save(struct generic_structure *s, const char* filename);
      /*
       *restore the structure.
       *\param s pointer to a pointer to a generic_structure (generic structure is allocated and restored here)
       *\param file a string containing the filename
       *\return pointer to a GError giving the error.
       */
      GError* generic_structure_restore(struct generic_structure **s, const char* filename);

      /*
       *dump the structure to an ASCII file.
       *\param s pointer to a pointer to a generic_structure (generic structure is allocated and restored here)
       *\param file a string containing the filename
       *\return pointer to a GError giving the error.
       */
      GError* generic_structure_dump(struct generic_structure *s, GFile* file);







    }
  }
}

#endif