File: test_phonopy_yaml.py

package info (click to toggle)
phonopy 2.47.1-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 29,380 kB
  • sloc: python: 43,690; xml: 12,080; ansic: 3,227; cpp: 525; sh: 213; makefile: 20
file content (211 lines) | stat: -rw-r--r-- 7,596 bytes parent folder | download | duplicates (4)
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
"""Tests of PhonopyYaml."""

import io
from pathlib import Path

import numpy as np
import yaml

import phonopy
from phonopy import Phonopy
from phonopy.interface.phonopy_yaml import (
    PhonopyYaml,
    PhonopyYamlLoader,
    load_phonopy_yaml,
    read_cell_yaml,
    read_phonopy_yaml,
)
from phonopy.interface.vasp import read_vasp
from phonopy.structure.atoms import PhonopyAtoms
from phonopy.structure.cells import get_primitive
from phonopy.structure.dataset import get_displacements_and_forces

cwd = Path(__file__).parent


def test_read_poscar_yaml(helper_methods):
    """Test to parse PhonopyAtoms.__str__ output."""
    filename = cwd / "NaCl-vasp.yaml"
    cell = _get_unitcell(filename)

    _compare_NaCl_convcell(cell, helper_methods.compare_cells_with_order)


def test_read_phonopy_yaml(helper_methods):
    """Test to parse phonopy.yaml like file."""
    filename = cwd / "phonopy.yaml"
    cell = read_phonopy_yaml(filename).unitcell
    _compare_NaCl_convcell(cell, helper_methods.compare_cells_with_order)


def test_read_phonopy_yaml_with_stream(helper_methods):
    """Test to parse phonopy.yaml like file stream."""
    filename = cwd / "phonopy.yaml"
    with open(filename) as fp:
        cell = read_phonopy_yaml(fp).unitcell
        _compare_NaCl_convcell(cell, helper_methods.compare_cells_with_order)


def test_PhonopyYaml_read(helper_methods):
    """Test to parse phonopy.yaml like file using PhonopyYaml.read()."""
    filename = cwd / "phonopy.yaml"
    cell = _get_unitcell(filename)
    _compare_NaCl_convcell(cell, helper_methods.compare_cells_with_order)


def test_PhonopyYaml_read_with_stream(helper_methods):
    """Test to parse phonopy.yaml like file stream using PhonopyYaml.read()."""
    filename = cwd / "phonopy.yaml"
    with open(filename) as fp:
        cell = _get_unitcell(fp)
        _compare_NaCl_convcell(cell, helper_methods.compare_cells_with_order)


def test_read_cell_yaml(helper_methods):
    """Test to parse phonopy_symcells.yaml like file."""
    filename = cwd / "phonopy_symcells_NaCl.yaml"
    cell = read_cell_yaml(filename)
    _compare_NaCl_convcell(cell, helper_methods.compare_cells)

    pcell = read_cell_yaml(filename, cell_type="primitive")
    helper_methods.compare_cells(pcell, get_primitive(cell, "F"))


def test_read_cell_yaml_with_stream(helper_methods):
    """Test to parse phonopy_symcells.yaml like file."""
    filename = cwd / "phonopy_symcells_NaCl.yaml"
    with open(filename) as fp:
        cell = _get_unitcell(fp)
        _compare_NaCl_convcell(cell, helper_methods.compare_cells)
        fp.seek(0)
        pcell = read_cell_yaml(fp, cell_type="primitive")
        helper_methods.compare_cells(pcell, get_primitive(cell, "F"))


def test_write_phonopy_yaml(ph_nacl_nofcsym: Phonopy, helper_methods):
    """Test PhonopyYaml.set_phonon_info, __str__, yaml_data, parse."""
    phonon = ph_nacl_nofcsym
    phpy_yaml = PhonopyYaml(calculator="vasp")
    phpy_yaml.set_phonon_info(phonon)
    phpy_yaml_test = PhonopyYaml()
    phpy_yaml_test._data = load_phonopy_yaml(
        yaml.safe_load(io.StringIO(str(phpy_yaml))), calculator=phpy_yaml.calculator
    )
    helper_methods.compare_cells_with_order(
        phpy_yaml.primitive, phpy_yaml_test.primitive
    )
    helper_methods.compare_cells_with_order(phpy_yaml.unitcell, phpy_yaml_test.unitcell)
    helper_methods.compare_cells_with_order(
        phpy_yaml.supercell, phpy_yaml_test.supercell
    )
    assert phpy_yaml.version == phpy_yaml_test.version
    np.testing.assert_allclose(
        phpy_yaml.supercell_matrix, phpy_yaml_test.supercell_matrix, atol=1e-8
    )
    np.testing.assert_allclose(
        phpy_yaml.primitive_matrix, phpy_yaml_test.primitive_matrix, atol=1e-8
    )


def test_write_phonopy_yaml_extra(ph_nacl_nofcsym: Phonopy):
    """Test PhonopyYaml.set_phonon_info, __str__, yaml_data, parse.

    settings parameter controls amount of yaml output. In this test,
    more data than the default are dumped and those are tested.

    """
    phonon = ph_nacl_nofcsym
    settings = {
        "force_sets": True,
        "displacements": True,
        "force_constants": True,
        "born_effective_charge": True,
        "dielectric_constant": True,
    }
    phpy_yaml = PhonopyYaml(calculator="vasp", settings=settings)
    phpy_yaml.set_phonon_info(phonon)
    phpy_yaml_test = PhonopyYaml()
    phpy_yaml_test._data = load_phonopy_yaml(
        yaml.safe_load(io.StringIO(str(phpy_yaml))), calculator=phpy_yaml.calculator
    )
    np.testing.assert_allclose(
        phpy_yaml.force_constants, phpy_yaml_test.force_constants, atol=1e-8
    )
    np.testing.assert_allclose(
        phpy_yaml.nac_params["born"], phpy_yaml_test.nac_params["born"], atol=1e-8
    )
    np.testing.assert_allclose(
        phpy_yaml.nac_params["dielectric"],
        phpy_yaml_test.nac_params["dielectric"],
        atol=1e-8,
    )
    np.testing.assert_allclose(
        phpy_yaml.nac_params["factor"],
        phpy_yaml_test.nac_params["factor"],
        atol=1e-8,
    )
    disps, forces = get_displacements_and_forces(phpy_yaml.dataset)
    disps_test, forces_test = get_displacements_and_forces(phpy_yaml_test.dataset)
    np.testing.assert_allclose(forces, forces_test, atol=1e-8)
    np.testing.assert_allclose(disps, disps_test, atol=1e-8)


def test_load_nac_yaml():
    """Test to read NAC params using PhonopyYamlLoader."""
    pyl = PhonopyYamlLoader(yaml.safe_load(open(cwd / "nac.yaml"))).parse()
    assert pyl.data.nac_params
    for key in (
        "dielectric",
        "born",
        "factor",
        "method",
    ):
        assert key in pyl.data.nac_params
    assert pyl.data.nac_params["dielectric"].shape == (3, 3)
    assert pyl.data.nac_params["born"].shape == (2, 3, 3)
    assert isinstance(pyl.data.nac_params["factor"], float)
    assert isinstance(pyl.data.nac_params["method"], str)


def test_phonopy_yaml_extended_symbol(nacl_unitcell_order1: PhonopyAtoms):
    """Test of PhonopyYaml with extended symbol."""
    unitcell = nacl_unitcell_order1
    symbols = unitcell.symbols
    symbols[-1] = "Cl1"
    cell = PhonopyAtoms(
        cell=unitcell.cell,
        symbols=symbols,
        scaled_positions=unitcell.scaled_positions,
        masses=unitcell.masses,
    )
    ph = Phonopy(cell, supercell_matrix=[2, 2, 2])
    assert ph.primitive.symbols[:4] == ["Na"] * 4
    assert ph.primitive.symbols[4:7] == ["Cl"] * 3
    assert ph.primitive.symbols[-1] == "Cl1"
    assert ph.unitcell.symbols[:4] == ["Na"] * 4
    assert ph.unitcell.symbols[4:7] == ["Cl"] * 3
    assert ph.unitcell.symbols[-1] == "Cl1"
    assert ph.supercell.symbols[:32] == ["Na"] * 32
    assert ph.supercell.symbols[-32:-8] == ["Cl"] * 24
    assert ph.supercell.symbols[-8:] == ["Cl1"] * 8

    ph_load = phonopy.load(io.StringIO(str(PhonopyYaml().set_phonon_info(ph))))
    assert ph_load.primitive.symbols[:4] == ["Na"] * 4
    assert ph_load.primitive.symbols[4:7] == ["Cl"] * 3
    assert ph_load.primitive.symbols[-1] == "Cl1"
    assert ph_load.unitcell.symbols[:4] == ["Na"] * 4
    assert ph_load.unitcell.symbols[4:7] == ["Cl"] * 3
    assert ph_load.unitcell.symbols[-1] == "Cl1"
    assert ph_load.supercell.symbols[:32] == ["Na"] * 32
    assert ph_load.supercell.symbols[-32:-8] == ["Cl"] * 24
    assert ph_load.supercell.symbols[-8:] == ["Cl1"] * 8


def _compare_NaCl_convcell(cell, compare_cells):
    cell_ref = read_vasp(cwd / ".." / "POSCAR_NaCl")
    compare_cells(cell, cell_ref)


def _get_unitcell(filename):
    phpy_yaml = PhonopyYaml().read(filename)
    return phpy_yaml.unitcell