ScaFaCoS  1.0.1
Scalable Fast Coulomb Solvers
fcs_memd_p.h
Go to the documentation of this file.
1 /*
2  Copyright (C) 2011-2012 Rene Halver
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_MEMD_P_INCLUDED
23 #define FCS_MEMD_P_INCLUDED
24 
25 #include "fcs_definitions.h"
26 #include "fcs_result_p.h"
27 #include "fcs_interface_p.h"
28 
35 typedef struct fcs_memd_parameters_t *fcs_memd_parameters;
36 
52  fcs_float box_size,
53  fcs_float timestep,
54  fcs_int local_number_of_particles,
55  fcs_int mesh_size,
56  fcs_float lightspeed,
57  fcs_float temperature,
58  fcs_float permittivity
59  );
60 
61 FCSResult fcs_fcs_memd_set_box_size(FCS handle, fcs_float length_x, fcs_float length_y, fcs_float length_z);
62 FCSResult fcs_fcs_memd_set_time_step(FCS handle, fcs_float timestep);
63 FCSResult fcs_fcs_memd_set_total_number_of_particles(FCS handle, fcs_int number_of_particles);
64 FCSResult fcs_fcs_memd_set_local_number_of_particles(FCS handle, fcs_int number_of_particles);
65 
66 FCSResult fcs_fcs_memd_set_init_flag(FCS handle, fcs_int flagvalue);
67 
68 FCSResult fcs_fcs_memd_set_mesh_size_1D(FCS handle, fcs_int mesh_size);
69 FCSResult fcs_fcs_memd_set_speed_of_light(FCS handle, fcs_float lightspeed);
70 
71 FCSResult fcs_fcs_memd_set_permittivity(FCS handle, fcs_float epsilon);
72 FCSResult fcs_fcs_memd_set_temperature(FCS handle, fcs_float temperature);
73 FCSResult fcs_fcs_memd_set_bjerrum_length(FCS handle, fcs_float bjerrum);
74 
75 
76 #endif
FCSResult fcs_fcs_memd_set_local_number_of_particles(FCS handle, fcs_int number_of_particles)
FCSResult fcs_fcs_memd_set_permittivity(FCS handle, fcs_float epsilon)
FCSResult fcs_fcs_memd_set_temperature(FCS handle, fcs_float temperature)
FCSResult fcs_fcs_memd_set_speed_of_light(FCS handle, fcs_float lightspeed)
FCSResult fcs_fcs_memd_set_mesh_size_1D(FCS handle, fcs_int mesh_size)
FCSResult fcs_fcs_memd_set_time_step(FCS handle, fcs_float timestep)
FCSResult fcs_fcs_memd_set_init_flag(FCS handle, fcs_int flagvalue)
public interface definitions for the FCSResult-object that is used for handling the return state of t...
FCSResult fcs_fcs_memd_set_bjerrum_length(FCS handle, fcs_float bjerrum)
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_fcs_memd_set_box_size(FCS handle, fcs_float length_x, fcs_float length_y, fcs_float length_z)
FCSResult fcs_fcs_memd_set_total_number_of_particles(FCS handle, fcs_int number_of_particles)
public interface definitions for the main solver-independent functionality of the ScaFaCoS library ...
struct fcs_memd_parameters_t * fcs_memd_parameters
Definition: fcs_memd_p.h:35
struct _FCS_t * FCS
FCS-object representing an FCS solver.
FCSResult fcs_memd_setup(FCS handle, fcs_float box_size, fcs_float timestep, fcs_int local_number_of_particles, fcs_int mesh_size, fcs_float lightspeed, fcs_float temperature, fcs_float permittivity)
Function to set all memd parameters with a single call.