density_1d.h

Go to the documentation of this file.

/*
 *1D density routines

 Copyright (C) 2010 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 ____DENSITY_1D_H__
#define ____DENSITY_1D_H__

#ifdef __cplusplus
extern "C" {
#define restrict
#endif

#include <glib-2.0/glib.h>
#include <gio/gio.h>
#include <libpostproc/density_common.h>

  struct density_1d {
    unsigned int N;
    double dx;
    double* storage;
  };

  /**Density distribution hints.  These help ensure numerical accuracy.
   *constant: there is roughly an even distribution across the structure
   *centered: there is very very little at the edges and much more at the center.
   *anticentered: there is very little at the center and much more at the edges.
   */
  enum density_1d_distribution_hint {
    CONSTANT,
    CENTERED,
    ANTICENTERED
  };

  void init_density_1d(struct density_1d* d, double initial_value);
  void density_1d_mul_by_const(struct density_1d* d, double c);
  void density_1d_add_const(struct density_1d* d, double c);
  struct density_1d* new_density_1d(int N, double dx, double initial_value);
  struct density_1d* new_density_1d_copy(const struct density_1d* orig);
  void free_density_1d(struct density_1d* d);
  int op_density_1d_to_density_1d(struct density_1d* to, enum density_op op, const struct density_1d* from);
  /**Allows the caller to specify a callback to perform a more advanced manipulation.
   *\param to density to which values are saved and from which values are drawn
   *\param from density from which values are drawn
   *\param callback function to call at each point
   *\param privdat private data to send to the callback
   *\note CALLBACK MUST NOT SAVE STATE; callback may be called in numerous threads!
   *\note that to and from CANNOT be the same or overlap! (restrict keyword)
   */
  int op_density_1d_to_density_1d_cb(struct density_1d *restrict to, const struct density_1d *restrict from, void(*callback)(int X, unsigned N, double dx, double *restrict to, double from, void *restrict privdat), void *restrict privdat);
  /**Gets the sum of the density, using distribution hint.*/
  double density_1d_sum(const struct density_1d* d, enum density_1d_distribution_hint hint);
  double density_1d_integrate_density(const struct density_1d* d, double abserr, double relerr, double* ierr, GError **e, int filename_index);

    /*These ops are not yet supported; we don't need them anytime soon.*/
    /*
      void put_density_1d_into_metadensity_1d(struct density_1d* md, struct density_1d* d, int *Nn, int x, int y, int z, gboolean invert_x, gboolean invert_y, gboolean invert_z);

      void write_density_1d_slice(enum coord c, int* index, struct density_1d* d, char** filename, GError **err, GFile *location, char sepchar, const char* coord_units, const char* density_1d_units);
      void write_density_1d_sweep(enum coord c, struct density_1d* d, char** filename, GError **err, GFile* location, gboolean sweep_log);

      void get_density_1d_from_metadensity_1d(struct density_1d* md, struct density_1d* d, int* buffzone, int *Nn, int x, int y, int z);

      struct density_1d* expand_density_1d_box_with_value(const struct density_1d* od, const int* I, double value, GError **err);

      struct density_1d* expand_density_1d_box(const struct density_1d* od, const int* I, GError **err);
    */

#ifdef __cplusplus
  }
#endif

#endif