grid1.h

Go to the documentation of this file.

/*
** grid1.h
** 

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

** Made by Johnny Q. Hacker
** Login   <solarion@borkborkbork>
** 
** Started on  Mon Nov 23 16:18:43 2009 Johnny Q. Hacker
** Last update Mon Nov 23 16:18:43 2009 Johnny Q. Hacker
*/

#include <glib-2.0/glib.h>
#include <gio/gio.h>
#include <libdotcode/dotcode_generic.h>
#include <libdotcode/matdb.h>
#include <libdotcode/matdb-dotcode.h>

#ifndef     DOTCODE_GRID1_H_
# define    DOTCODE_GRID1_H_

struct dotcode_grid1 {
  /*Number of X, Y, Z components of the grid, respectively*/
  int N[3];
  /*Spacing of of X, Y, Z components of the grid, respectively*/
  double dx[3];
  /*Array of strings containing material names*/
  char **materials;
  /*N[0] x N[1] x N[2] array of material assignments (indices into
    the materials array*/
  unsigned char *assignments;
};

enum dotcode_grid1_errors {
  DOTCODE_GRID1_ERROR_NOSUCHPROPERTY=DOTCODE_ERROR_LAST,
  DOTCODE_GRID1_ERROR_LAST
};

struct dotcode_grid1* dotcode_grid1_get_from_gfile(GFile* f, GError **error);
GError* dotcode_grid1_write_to_gfile(GFile* f, const struct dotcode_grid1* grid);
void dotcode_grid1_free(struct dotcode_grid1* grid);

/**
 *Sets up an array containing the property, by material index
 *\param grid the grid to use
 *\param mdb the material database
 *\param property_name the name of the property to be cached
 */
double* dotcode_grid1_get_property_cache(const struct dotcode_grid1* grid, const struct matdb* mdb, const char* property_name, GError **err);

/**
 *Gets a grid with the respective property.
 */
double* dotcode_grid1_get_property_grid(const struct dotcode_grid1* grid, const struct matdb *mdb, const char* property, GError **err);

/**
 *Gets a specified property at a grid site
 *\param grid the grid to pull the information from
 *\param property string containing the property to pull
 *\param index ponter to an array containing 3 ints indicating the site 
 */
double dotcode_grid1_get_property_at_site(const struct dotcode_grid1* grid, const struct matdb *mdb, const char* property, const int* index, GError **err);
/**same as dotcode_grdi1_get_property_at_site, but uses property cache instead of matdb and property string.
 *\param
 */
double dotcode_grid1_get_property_at_site_cached(const struct dotcode_grid1* grid, const double* propcache, const int* index);

/**
 *Writes the a slice of the grid material assignments out to a file in human-readalbe
 *format
 *\param grid the grid to write out
 *\param base the directory into which to write the file
 *\param coord which coordinate to write a slice out
 *\param x the value of the coordinate to write out
 *\param err pointer to a pointer in which to store the GError, if any.
 */
void dotcode_grid1_write_assignments_slice_text(const struct dotcode_grid1* grid, GFile* base, enum dotcode_coord coord, int index, GError **err);

/*Same as for writing assignment slices, but this writes properties
 *\param grid the grid to write out
 *\param property_array output of get_property_grid
 *\param property_name string containing the property's name
 *\param base the directory into which to write the file
 *\param coord which coordinate to write a slice out
 *\param x the value of the coordinate to write out
 *\param err pointer to a pointer in which to store the GError, if any.
 */
void dotcode_grid1_write_property_slice_text(const struct dotcode_grid1* grid, const double* property_array, const char* property_name, GFile* base, enum dotcode_coord coord, int index, GError **err);

long unsigned int dotcode_grid1_get_assignment_index(int x, int y, int z, int Nx, int Ny);

#endif      /* !GRID1_H_ */