potential_1d.h

Go to the documentation of this file.

/*
 *Gets the potential from a 1D charge density through a number of methods

    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 ___POTENTIAL_1D_H___
#define ___POTENTIAL_1D_H___

#ifdef __cplusplus
extern "C" {
#endif

#include <glib-2.0/glib.h>
#include <libpostproc/density_1d.h>

  enum density_1d_potential_calculation_method {
    INTEGRATION_METHOD_NP,
    INTEGRATION_METHOD_PN
  };
  
  /**Gets the 1D potential from a 1D charge density.
   *\param charge_density the charge density (C/m^-3)
   *\param epsilon dielectric constant across the structure
   *\param method method to use to calculate the potential
   *\param err pointer to a pointer to a GError to store the routine's error information, if any
   *\return density_1d* the potential, or NULL if an error occurred
   */
  struct density_1d* potential_1d_get_potential(double const_efield, double const_background, struct density_1d* charge_density, struct density_1d* epsilon, enum density_1d_potential_calculation_method method, double* max_pot_int_err, double* max_efield_int_err, double relerr, double abserr, GError **err);

  /**Gets the 1D displacement field from a 1D charge density.
   *\param charge_density the charge density (C/m^-3)
   *\param direction 0 to go negative-positive; 1 to go positive-negative
   *\param err pointer to a pointer to a GError to store the routine's error information, if any
   *\return density_1d* the potential, or NULL if an error occurred
   */


  struct density_1d* potential_1d_get_dfield_integrate(double const_background,const struct density_1d* charge_density, short int direction_pn, double* max_int_err, double relerr, double abserr, GError **err);

  struct density_1d* potential_1d_get_potential_integrate(double dfield_background, double pot_background, const struct density_1d* charge_density, const struct density_1d* epsilon, short int direction_pn, double* max_pot_int_err, double* max_dfield_int_error, double relerr, double abserr, GError **err);

  struct density_1d* potential_1d_get_potential_from_dfield(double background, const struct density_1d* Dfield,  const struct density_1d* epsilon, short int direction_pn, double* max_int_err, double relerr, double abserr, GError **err);



#ifdef __cplusplus
}
#endif

#endif