File: python-fix-external.py

package info (click to toggle)
lammps 20250204%2Bdfsg.1-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 474,368 kB
  • sloc: cpp: 1,060,070; python: 27,785; ansic: 8,956; f90: 7,254; sh: 6,044; perl: 4,171; fortran: 2,442; xml: 1,714; makefile: 1,352; objc: 238; lisp: 188; yacc: 58; csh: 16; awk: 14; tcl: 6; javascript: 2
file content (218 lines) | stat: -rw-r--r-- 9,772 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
import sys,os,unittest
from ctypes import *
from lammps import lammps, LMP_STYLE_GLOBAL, LMP_STYLE_ATOM, LMP_TYPE_VECTOR, LMP_TYPE_ARRAY

try:
    import numpy
    NUMPY_INSTALLED = True
except ImportError:
    NUMPY_INSTALLED = False

# add timestep dependent force
def callback_one(lmp, ntimestep, nlocal, tag, x, f):
    lmp.fix_external_set_virial_global("ext",[1.0, 1.0, 1.0, 0.0, 0.0, 0.0])
    for i in range(nlocal):
        f[i][0] = float(ntimestep)
        f[i][1] = float(ntimestep)
        f[i][2] = float(ntimestep)
    if ntimestep < 10:
        lmp.fix_external_set_energy_global("ext", 0.5)
        lmp.fix_external_set_vector("ext", 1, ntimestep)
        lmp.fix_external_set_vector("ext", 3, 1.0)
        lmp.fix_external_set_vector("ext", 4, -0.25)
    else:
        lmp.fix_external_set_energy_global("ext", 1.0)
        lmp.fix_external_set_vector("ext", 2, ntimestep)
        lmp.fix_external_set_vector("ext", 5, -1.0)
        lmp.fix_external_set_vector("ext", 6, 0.25)

    eatom = [0.0,0.1,0.2,0.3,0.4,0.5,0.6,0.7]
    vatom = [ [0.1,0.0,0.0,0.0,0.0,0.0],
              [0.0,0.2,0.0,0.0,0.0,0.0],
              [0.0,0.0,0.3,0.0,0.0,0.0],
              [0.0,0.0,0.0,0.4,0.0,0.0],
              [0.0,0.0,0.0,0.0,0.5,0.0],
              [0.0,0.0,0.0,0.0,0.0,0.6],
              [0.0,0.0,0.0,0.0,-7.0,0.0],
              [0.0,-8.0,0.0,0.0,0.0,0.0] ]
    if ntimestep < 5:
        lmp.fix_external_set_energy_peratom("ext",eatom)
        lmp.fix_external_set_virial_peratom("ext",vatom)
    else:
        import numpy as np
        eng = np.array(eatom)
        vir = np.array(vatom)

        lmp.numpy.fix_external_set_energy_peratom("ext",eng)
        lmp.numpy.fix_external_set_virial_peratom("ext",vir)

    # ------------------------------------------------------------------------

class PythonExternal(unittest.TestCase):
    @unittest.skipIf(not NUMPY_INSTALLED, "NumPy is not available")
    def testExternalCallback(self):
        """Test fix external from Python with pf/callback"""

        machine=None
        if 'LAMMPS_MACHINE_NAME' in os.environ:
            machine=os.environ['LAMMPS_MACHINE_NAME']
        lmp=lammps(name=machine, cmdargs=['-nocite', '-log','none', '-echo', 'screen'])

        # a few commands to set up simple system
        basic_system="""lattice sc 1.0
                        region box block -1 1 -1 1 -1 1
                        create_box 1 box
                        create_atoms 1 box
                        mass 1 1.0
                        pair_style zero 0.1
                        pair_coeff 1 1
                        velocity all set 0.1 0.0 -0.1
                        thermo_style custom step temp pe ke etotal press
                        thermo 5
                        fix 1 all nve
                        fix ext all external pf/callback 5 1
                        compute eatm all pe/atom fix
                        compute vatm all stress/atom NULL fix
                        compute sum all reduce sum c_eatm c_vatm[*]
                        thermo_style custom step temp pe ke etotal press c_sum[*]
                        fix_modify ext energy yes virial yes
"""
        lmp.commands_string(basic_system)
        lmp.fix_external_set_vector_length("ext",6);
        lmp.set_fix_external_callback("ext",callback_one,lmp)

        # check setting per-atom data with python lists
        lmp.command("run 0 post no")
        reduce = lmp.extract_compute("sum", LMP_STYLE_GLOBAL, LMP_TYPE_VECTOR)
        self.assertAlmostEqual(reduce[0],2.8,14)
        self.assertAlmostEqual(reduce[1],-0.1,14)
        self.assertAlmostEqual(reduce[2],7.8,14)
        self.assertAlmostEqual(reduce[3],-0.3,14)
        self.assertAlmostEqual(reduce[4],-0.4,14)
        self.assertAlmostEqual(reduce[5],6.5,14)
        self.assertAlmostEqual(reduce[6],-0.6,14)

        fext = lmp.extract_fix("ext", LMP_STYLE_ATOM, LMP_TYPE_ARRAY)
        self.assertAlmostEqual(float(fext[0][0]), 0.0)
        self.assertAlmostEqual(float(fext[0][1]), 0.0)
        self.assertAlmostEqual(float(fext[0][2]), 0.0)
        self.assertAlmostEqual(float(fext[1][0]), 0.0)
        self.assertAlmostEqual(float(fext[1][1]), 0.0)
        self.assertAlmostEqual(float(fext[1][2]), 0.0)
        self.assertAlmostEqual(float(fext[2][0]), 0.0)
        self.assertAlmostEqual(float(fext[2][1]), 0.0)
        self.assertAlmostEqual(float(fext[2][2]), 0.0)

        lmp.command("run 10 post no")
        self.assertAlmostEqual(lmp.get_thermo("temp"),1.0/30.0,14)
        self.assertAlmostEqual(lmp.get_thermo("pe"),1.0/8.0,14)
        self.assertAlmostEqual(lmp.get_thermo("press"),0.15416666666666667,14)
        # check setting per-atom data numpy arrays
        reduce = lmp.extract_compute("sum", LMP_STYLE_GLOBAL, LMP_TYPE_VECTOR)
        self.assertAlmostEqual(reduce[0],2.8,14)
        self.assertAlmostEqual(reduce[1],-0.1,14)
        self.assertAlmostEqual(reduce[2],7.8,14)
        self.assertAlmostEqual(reduce[3],-0.3,14)
        self.assertAlmostEqual(reduce[4],-0.4,14)
        self.assertAlmostEqual(reduce[5],6.5,14)
        self.assertAlmostEqual(reduce[6],-0.6,14)
        val = 0.0
        for i in range(0,6):
            val += lmp.extract_fix("ext",LMP_STYLE_GLOBAL,LMP_TYPE_VECTOR,nrow=i)
        self.assertAlmostEqual(val,15.0,14)

        fext = lmp.extract_fix("ext", LMP_STYLE_ATOM, LMP_TYPE_ARRAY)
        self.assertAlmostEqual(float(fext[0][0]), 10.0)
        self.assertAlmostEqual(float(fext[0][1]), 10.0)
        self.assertAlmostEqual(float(fext[0][2]), 10.0)
        self.assertAlmostEqual(float(fext[1][0]), 10.0)
        self.assertAlmostEqual(float(fext[1][1]), 10.0)
        self.assertAlmostEqual(float(fext[1][2]), 10.0)
        self.assertAlmostEqual(float(fext[2][0]), 10.0)
        self.assertAlmostEqual(float(fext[2][1]), 10.0)
        self.assertAlmostEqual(float(fext[2][2]), 10.0)

    def testExternalArray(self):
        """Test fix external from Python with pf/array"""

        machine=None
        if 'LAMMPS_MACHINE_NAME' in os.environ:
            machine=os.environ['LAMMPS_MACHINE_NAME']
        lmp=lammps(name=machine, cmdargs=['-nocite', '-log','none', '-echo', 'screen'])

        # a few commands to set up simple system
        basic_system="""lattice sc 1.0
                        region box block -1 1 -1 1 -1 1
                        create_box 1 box
                        create_atoms 1 box
                        mass 1 1.0
                        pair_style zero 0.1
                        pair_coeff 1 1
                        velocity all set 0.1 0.0 -0.1
                        fix 1 all nve
                        fix ext all external pf/array 1
                        fix_modify ext energy yes virial yes
                        thermo_style custom step temp pe ke press
                        thermo 5
"""
        lmp.commands_string(basic_system)
        force = lmp.fix_external_get_force("ext");
        nlocal = lmp.extract_setting("nlocal");
        for i in range(nlocal):
            force[i][0] = 0.0
            force[i][1] = 0.0
            force[i][2] = 0.0
        lmp.fix_external_set_energy_global("ext", 0.5)
        lmp.fix_external_set_virial_global("ext",[0.5, 0.5, 0.5, 0.0, 0.0, 0.0])
        fext = lmp.extract_fix("ext", LMP_STYLE_ATOM, LMP_TYPE_ARRAY)
        self.assertAlmostEqual(float(fext[0][0]), 0.0)
        self.assertAlmostEqual(float(fext[0][1]), 0.0)
        self.assertAlmostEqual(float(fext[0][2]), 0.0)
        self.assertAlmostEqual(float(fext[1][0]), 0.0)
        self.assertAlmostEqual(float(fext[1][1]), 0.0)
        self.assertAlmostEqual(float(fext[1][2]), 0.0)
        self.assertAlmostEqual(float(fext[2][0]), 0.0)
        self.assertAlmostEqual(float(fext[2][1]), 0.0)
        self.assertAlmostEqual(float(fext[2][2]), 0.0)

        lmp.command("run 5 post no")
        self.assertAlmostEqual(lmp.get_thermo("temp"),4.0/525.0,14)
        self.assertAlmostEqual(lmp.get_thermo("pe"),1.0/16.0,14)
        self.assertAlmostEqual(lmp.get_thermo("press"),0.06916666666666667,14)
        if NUMPY_INSTALLED:
            npforce = lmp.numpy.fix_external_get_force("ext")
            self.assertEqual(len(npforce),8)
            self.assertEqual(len(npforce[0]),3)
            self.assertEqual(npforce[1][1],0.0)

        force = lmp.fix_external_get_force("ext");
        nlocal = lmp.extract_setting("nlocal");
        for i in range(nlocal):
            force[i][0] = 6.0
            force[i][1] = 6.0
            force[i][2] = 6.0
        lmp.fix_external_set_energy_global("ext", 1.0)
        lmp.fix_external_set_virial_global("ext",[1.0, 1.0, 1.0, 0.0, 0.0, 0.0])
        lmp.command("run 5 post no")
        self.assertAlmostEqual(lmp.get_thermo("temp"),1.0/30.0,14)
        self.assertAlmostEqual(lmp.get_thermo("pe"),1.0/8.0,14)
        self.assertAlmostEqual(lmp.get_thermo("press"),0.15416666666666667,14)
        if NUMPY_INSTALLED:
            npforce = lmp.numpy.fix_external_get_force("ext")
            self.assertEqual(npforce[0][0],6.0)
            self.assertEqual(npforce[3][1],6.0)
            self.assertEqual(npforce[7][2],6.0)
        fext = lmp.extract_fix("ext", LMP_STYLE_ATOM, LMP_TYPE_ARRAY)
        self.assertAlmostEqual(float(fext[0][0]), 6.0)
        self.assertAlmostEqual(float(fext[0][1]), 6.0)
        self.assertAlmostEqual(float(fext[0][2]), 6.0)
        self.assertAlmostEqual(float(fext[1][0]), 6.0)
        self.assertAlmostEqual(float(fext[1][1]), 6.0)
        self.assertAlmostEqual(float(fext[1][2]), 6.0)
        self.assertAlmostEqual(float(fext[2][0]), 6.0)
        self.assertAlmostEqual(float(fext[2][1]), 6.0)
        self.assertAlmostEqual(float(fext[2][2]), 6.0)

##############################
if __name__ == "__main__":
    unittest.main()