ScaFaCoS  1.0.1
Scalable Fast Coulomb Solvers
fcs_wolf_p.h
Go to the documentation of this file.
1 /*
2  Copyright (C) 2011, 2012, 2013 Michael Hofmann
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_WOLF_P_INCLUDED
23 #define FCS_WOLF_P_INCLUDED
24 
25 
26 #include "fcs_definitions.h"
27 #include "fcs_result_p.h"
28 #include "fcs_interface_p.h"
29 
30 
42 typedef struct fcs_wolf_parameters_t *fcs_wolf_parameters;
43 
44 
51 FCSResult fcs_wolf_set_cutoff(FCS handle, fcs_float cutoff);
52 
53 
60 FCSResult fcs_wolf_get_cutoff(FCS handle, fcs_float *cutoff);
61 
62 
69 FCSResult fcs_wolf_set_alpha(FCS handle, fcs_float alpha);
70 
71 
78 FCSResult fcs_wolf_get_alpha(FCS handle, fcs_float *alpha);
79 
80 
88 FCSResult fcs_wolf_setup(FCS handle, fcs_float cutoff, fcs_float alpha);
89 
90 
98 void fcs_wolf_setup_f(void *handle, fcs_float cutoff, fcs_float alpha, fcs_int *return_value);
99 
100 
101 #endif
FCSResult fcs_wolf_get_alpha(FCS handle, fcs_float *alpha)
function to get the current ewald splitting parameter alpha
void fcs_wolf_setup_f(void *handle, fcs_float cutoff, fcs_float alpha, fcs_int *return_value)
function to set all solver parameters (Fortran wrapper)
FCSResult fcs_wolf_get_cutoff(FCS handle, fcs_float *cutoff)
function to get the current cutoff radius
struct fcs_wolf_parameters_t * fcs_wolf_parameters
data structure with parameters of the wolf solver
Definition: fcs_wolf_p.h:42
FCSResult fcs_wolf_set_cutoff(FCS handle, fcs_float cutoff)
function to set the cutoff radius
FCSResult fcs_wolf_setup(FCS handle, fcs_float cutoff, fcs_float alpha)
function to set all solver parameters
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
public interface definitions for the main solver-independent functionality of the ScaFaCoS library ...
FCSResult fcs_wolf_set_alpha(FCS handle, fcs_float alpha)
function to set the ewald splitting parameter alpha
struct _FCS_t * FCS
FCS-object representing an FCS solver.