matdb.h

Go to the documentation of this file.

/*
 * matdb: generic materials database information.

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

*/

#ifndef MATDB_H_
#define MATDB_H_

#include <glib-2.0/glib.h>
#include <libcommon/gcc_hints.h>

enum material_type {
  SIMPLE,
  ALLOY
};

/*Generic material; has a type and storage.
 *If type is SIMPLE, storage is a pointer to the properties hash.
 *If type is ALLOY, storage is alloy_storage
 */
struct material {
  enum material_type type;
  GString* name;
  void* storage;
};

/*This contains the percentage of mat1, mat1 and mat2, and a *copy* of the
 *properties for this percentage.
 */
struct alloy_storage {
  GString *mat1;
  GString *mat2;
  double x;
  GHashTable *ppts;
};

/*
 *materials is a hash of matdb_materials, indexed by material name.
 *bowings is indexed by material 1, which contains
 *  hashes which are indexed by material2, which contains
 *    hashes of matdb_bowing structures.
 */
struct matdb {
  GHashTable *materials;
  GHashTable *bowings;
};

struct matdb* matdb_new();

void matdb_destroy(struct matdb* mdb);

void print_matdb(const struct matdb *mdb);

double get_param(const struct matdb *mdb, const char* mat1, const char* mat2, double x, const char* param, int *err);

double get_material_param(const struct matdb *mdb, const char* mat, const char* param, int *err);

double get_alloy_param(const struct matdb *mdb, const char* mat1, const char* mat2, double x, const char* param, int *err);

void set_material_param(struct matdb *mdb, const char* mat, const char* param, double value, int* err);

/*NOTE: To ensure db consistency, paramerty *MUST* be set in both mat1
  and mat2 *BEFORE* the bowing param can be set.*/
void set_bowing_param(struct matdb *mdb, const char* mat1, const char* mat2, const char* param, double value, int *err);

/*Canonicalizes the alloy, i.e. arranges mat1, mat2 in alphabetical
 *order.  In order to ensure coherence between the resulting string
 *and mat1, mat2, and x, pointers to where mat1 and mat2 and x are
 *stored are given, so that mat1 and mat2 can be safely assumed to be
 *canonicalized and thereafter safely used.
 */
GString* canonicalize_alloy(char **mat1, char **mat2, double *x);
void canonicalize_alloy_args(char **mat1, char **mat2, double *x);

double ___always_inline alloy_linear(double m1, double m2, double x) {
  return m1 + (m2-m1)*x;
}

double ___always_inline alloy_bowed(double m1, double m2, double bow, double x) {
  return m1 + (m2-m1)*x + bow*x*(1-x);
}

#endif