UseTheForce/DarkSide/electrostatic_interface.h

/*
 * Copyright (c) 2005 The University of Notre Dame. All Rights Reserved.
 *
 * The University of Notre Dame grants you ("Licensee") a
 * non-exclusive, royalty free, license to use, modify and
 * redistribute this software in source and binary code form, provided
 * that the following conditions are met:
 *
 * 1. Acknowledgement of the program authors must be made in any
 *    publication of scientific results based in part on use of the
 *    program.  An acceptable form of acknowledgement is citation of
 *    the article in which the program was described (Matthew
 *    A. Meineke, Charles F. Vardeman II, Teng Lin, Christopher
 *    J. Fennell and J. Daniel Gezelter, "OOPSE: An Object-Oriented
 *    Parallel Simulation Engine for Molecular Dynamics,"
 *    J. Comput. Chem. 26, pp. 252-271 (2005))
 *
 * 2. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 3. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the
 *    distribution.
 *
 * This software is provided "AS IS," without a warranty of any
 * kind. All express or implied conditions, representations and
 * warranties, including any implied warranty of merchantability,
 * fitness for a particular purpose or non-infringement, are hereby
 * excluded.  The University of Notre Dame and its licensors shall not
 * be liable for any damages suffered by licensee as a result of
 * using, modifying or distributing the software or its
 * derivatives. In no event will the University of Notre Dame or its
 * licensors be liable for any lost revenue, profit or data, or for
 * direct, indirect, special, consequential, incidental or punitive
 * damages, however caused and regardless of the theory of liability,
 * arising out of the use of or inability to use software, even if the
 * University of Notre Dame has been advised of the possibility of
 * such damages.
 */
 
#ifndef USETHEFORCE_DARKSIDE_ELECTROSTATIC_INTERFACE_H
#define USETHEFORCE_DARKSIDE_ELECTROSTATIC_INTERFACE_H

#define __C

#include "config.h"
#include "types/AtomTypeProperties.h"
 
#define setElectrostaticSummationMethod FC_FUNC(setelectrostaticsummationmethod, SETELECTROSTATICSUMMATIONMETHOD)
#define setScreeningMethod FC_FUNC(setscreeningmethod, SETSCREENINGMETHOD)
#define setElectrostaticCutoffRadius FC_FUNC(setelectrostaticcutoffradius, SETELECTROSTATICCUTOFFRADIUS)
#define setDampingAlpha FC_FUNC(setdampingalpha, SETDAMPINGALPHA)
#define setReactionFieldDielectric FC_FUNC(setreactionfielddielectric, SETREACTIONFIELDDIELECTRIC)

#define newElectrostaticType FC_FUNC(newelectrostatictype, NEWELECTROSTATICTYPE)
#define setCharge FC_FUNC(setcharge, SETCHARGE)
#define setDipoleMoment FC_FUNC(setdipolemoment, SETDIPOLEMOMENT)
#define setSplitDipoleDistance FC_FUNC(setsplitdipoledistance, SETSPLITDIPOLEDISTANCE)

#define setQuadrupoleMoments FC_FUNC(setquadrupolemoments, SETQUADRUPOLEMOMENTS)

#define destroyElectrostaticTypes FC_FUNC(destroyelectrostatictypes,DESTROYELECTROSTATICTYPES)
extern "C"{

  void setElectrostaticSummationMethod( int* theESM );
  void setScreeningMethod( int* theSM );
  void setElectrostaticCutoffRadius( double* theECR, double* theRSW );
  void setDampingAlpha( double* theDA );
  void setReactionFieldDielectric( double* theDielectric );

  void newElectrostaticType( AtomTypeProperties* atp,
                             int* status);
  
  void setCharge( int* c_ident, 
                  double* charge,
                  int* status);
  
  void setDipoleMoment( int* c_ident,
                        double* dipole_moment,
                        int* status);
  
  void setSplitDipoleDistance( int* c_ident,
                               double* split_dipole_distance,
                               int* status);
  
  void setQuadrupoleMoments( int* c_ident,
                             double* quadrupole_moments,
                             int* status);
        
  void destroyElectrostaticTypes(void);
}  
#endif

Revision:	2552
Committed:	Thu Jan 12 16:47:25 2006 UTC (18 years, 5 months ago) by chrisfen
Content type:	text/plain
File size:	4142 byte(s)
Log Message:	unifying function name in electrostatics
#	Content
1	/*
2	* Copyright (c) 2005 The University of Notre Dame. All Rights Reserved.
3	*
4	* The University of Notre Dame grants you ("Licensee") a
5	* non-exclusive, royalty free, license to use, modify and
6	* redistribute this software in source and binary code form, provided
7	* that the following conditions are met:
8	*
9	* 1. Acknowledgement of the program authors must be made in any
10	* publication of scientific results based in part on use of the
11	* program. An acceptable form of acknowledgement is citation of
12	* the article in which the program was described (Matthew
13	* A. Meineke, Charles F. Vardeman II, Teng Lin, Christopher
14	* J. Fennell and J. Daniel Gezelter, "OOPSE: An Object-Oriented
15	* Parallel Simulation Engine for Molecular Dynamics,"
16	* J. Comput. Chem. 26, pp. 252-271 (2005))
17	*
18	* 2. Redistributions of source code must retain the above copyright
19	* notice, this list of conditions and the following disclaimer.
20	*
21	* 3. Redistributions in binary form must reproduce the above copyright
22	* notice, this list of conditions and the following disclaimer in the
23	* documentation and/or other materials provided with the
24	* distribution.
25	*
26	* This software is provided "AS IS," without a warranty of any
27	* kind. All express or implied conditions, representations and
28	* warranties, including any implied warranty of merchantability,
29	* fitness for a particular purpose or non-infringement, are hereby
30	* excluded. The University of Notre Dame and its licensors shall not
31	* be liable for any damages suffered by licensee as a result of
32	* using, modifying or distributing the software or its
33	* derivatives. In no event will the University of Notre Dame or its
34	* licensors be liable for any lost revenue, profit or data, or for
35	* direct, indirect, special, consequential, incidental or punitive
36	* damages, however caused and regardless of the theory of liability,
37	* arising out of the use of or inability to use software, even if the
38	* University of Notre Dame has been advised of the possibility of
39	* such damages.
40	*/
41
42	#ifndef USETHEFORCE_DARKSIDE_ELECTROSTATIC_INTERFACE_H
43	#define USETHEFORCE_DARKSIDE_ELECTROSTATIC_INTERFACE_H
44
45	#define __C
46
47	#include "config.h"
48	#include "types/AtomTypeProperties.h"
49
50	#define setElectrostaticSummationMethod FC_FUNC(setelectrostaticsummationmethod, SETELECTROSTATICSUMMATIONMETHOD)
51	#define setScreeningMethod FC_FUNC(setscreeningmethod, SETSCREENINGMETHOD)
52	#define setElectrostaticCutoffRadius FC_FUNC(setelectrostaticcutoffradius, SETELECTROSTATICCUTOFFRADIUS)
53	#define setDampingAlpha FC_FUNC(setdampingalpha, SETDAMPINGALPHA)
54	#define setReactionFieldDielectric FC_FUNC(setreactionfielddielectric, SETREACTIONFIELDDIELECTRIC)
55
56	#define newElectrostaticType FC_FUNC(newelectrostatictype, NEWELECTROSTATICTYPE)
57	#define setCharge FC_FUNC(setcharge, SETCHARGE)
58	#define setDipoleMoment FC_FUNC(setdipolemoment, SETDIPOLEMOMENT)
59	#define setSplitDipoleDistance FC_FUNC(setsplitdipoledistance, SETSPLITDIPOLEDISTANCE)
60
61	#define setQuadrupoleMoments FC_FUNC(setquadrupolemoments, SETQUADRUPOLEMOMENTS)
62
63	#define destroyElectrostaticTypes FC_FUNC(destroyelectrostatictypes,DESTROYELECTROSTATICTYPES)
64	extern "C"{
65
66	void setElectrostaticSummationMethod( int* theESM );
67	void setScreeningMethod( int* theSM );
68	void setElectrostaticCutoffRadius( double* theECR, double* theRSW );
69	void setDampingAlpha( double* theDA );
70	void setReactionFieldDielectric( double* theDielectric );
71
72	void newElectrostaticType( AtomTypeProperties* atp,
73	int* status);
74
75	void setCharge( int* c_ident,
76	double* charge,
77	int* status);
78
79	void setDipoleMoment( int* c_ident,
80	double* dipole_moment,
81	int* status);
82
83	void setSplitDipoleDistance( int* c_ident,
84	double* split_dipole_distance,
85	int* status);
86
87	void setQuadrupoleMoments( int* c_ident,
88	double* quadrupole_moments,
89	int* status);
90
91	void destroyElectrostaticTypes(void);
92	}
93	#endif
94