ScaFaCoS  1.0.1
Scalable Fast Coulomb Solvers
fcs_mmm2d_p.h
Go to the documentation of this file.
1 /*
2  Copyright (C) 2011-2012 Pedro Sanchez
3 
4  This file is part of ScaFaCoS.
5 
6  ScaFaCoS is free software: you can redistribute it and/or modify
7  it under the terms of the GNU Lesser Public License as published by
8  the Free Software Foundation, either version 3 of the License, or
9  (at your option) any later version.
10 
11  ScaFaCoS is distributed in the hope that it will be useful,
12  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  GNU Lesser Public License for more details.
15 
16  You should have received a copy of the GNU Lesser Public License
17  along with this program. If not, see <http://www.gnu.org/licenses/>.
18 */
19 
20 
21 
22 #ifndef _FCS_MMM2D_P_H
23 #define _FCS_MMM2D_P_H
24 
25 #include "fcs_definitions.h"
26 #include "fcs_result_p.h"
27 #include "fcs_interface_p.h"
28 
30 
31 FCSResult fcs_mmm2d_set_maxPWerror(FCS handle, fcs_float maxPWerror);
32 FCSResult fcs_mmm2d_get_maxPWerror(FCS handle, fcs_float *maxPWerror);
33 
34 FCSResult fcs_mmm2d_set_far_cutoff(FCS handle, fcs_float cutoff);
35 FCSResult fcs_mmm2d_get_far_cutoff(FCS handle, fcs_float *cutoff);
36 
37 FCSResult fcs_mmm2d_set_dielectric_contrasts(FCS handle, fcs_float delta_top, fcs_float delta_bot);
38 FCSResult fcs_mmm2d_get_dielectric_contrasts(FCS handle, fcs_float *delta_top, fcs_float *delta_bot);
39 
40 FCSResult fcs_mmm2d_set_layers_per_node(FCS handle, fcs_int n_layers);
41 FCSResult fcs_mmm2d_get_layers_per_node(FCS handle, fcs_int *n_layers);
42 
43 FCSResult fcs_mmm2d_set_skin(FCS handle, fcs_float skin);
44 FCSResult fcs_mmm2d_get_skin(FCS handle, fcs_float *skin);
45 
46 FCSResult fcs_mmm2d_require_total_energy(FCS handle, fcs_int flag);
47 FCSResult fcs_mmm2d_get_total_energy(FCS handle, fcs_float *total_energy);
48 
49 #endif
FCSResult fcs_mmm2d_set_maxPWerror(FCS handle, fcs_float maxPWerror)
file containing all mmm2d specific functions
FCSResult fcs_mmm2d_get_total_energy(FCS handle, fcs_float *total_energy)
FCSResult fcs_mmm2d_set_far_cutoff(FCS handle, fcs_float cutoff)
FCSResult fcs_mmm2d_get_layers_per_node(FCS handle, fcs_int *n_layers)
FCSResult fcs_mmm2d_get_skin(FCS handle, fcs_float *skin)
FCSResult fcs_mmm2d_get_dielectric_contrasts(FCS handle, fcs_float *delta_top, fcs_float *delta_bot)
FCSResult fcs_mmm2d_set_skin(FCS handle, fcs_float skin)
FCSResult fcs_mmm2d_get_far_cutoff(FCS handle, fcs_float *cutoff)
FCSResult fcs_mmm2d_set_layers_per_node(FCS handle, fcs_int n_layers)
public interface definitions for the FCSResult-object that is used for handling the return state of t...
struct FCSResult_t * FCSResult
FCSResult-object that is used for handling the return state of the ScaFaCoS library functions...
Definition: fcs_result_p.h:42
FCSResult fcs_mmm2d_require_total_energy(FCS handle, fcs_int flag)
FCSResult fcs_mmm2d_get_maxPWerror(FCS handle, fcs_float *maxPWerror)
public interface definitions for the main solver-independent functionality of the ScaFaCoS library ...
struct _FCS_t * FCS
FCS-object representing an FCS solver.
FCSResult fcs_mmm2d_set_dielectric_contrasts(FCS handle, fcs_float delta_top, fcs_float delta_bot)