forked from materialsproject/pymatgen
-
Notifications
You must be signed in to change notification settings - Fork 0
/
pymatgen.electronic_structure.core.html
486 lines (437 loc) · 26.5 KB
/
pymatgen.electronic_structure.core.html
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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title>pymatgen.electronic_structure.core module — pymatgen 2019.5.1 documentation</title>
<link rel="stylesheet" href="_static/proBlue.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="shortcut icon" href="_static/favicon.ico"/>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-33990148-1']);
_gaq.push(['_trackPageview']);
</script>
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">pymatgen 2019.5.1 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="module-pymatgen.electronic_structure.core">
<span id="pymatgen-electronic-structure-core-module"></span><h1>pymatgen.electronic_structure.core module<a class="headerlink" href="#module-pymatgen.electronic_structure.core" title="Permalink to this headline">¶</a></h1>
<dl class="class">
<dt id="pymatgen.electronic_structure.core.Magmom">
<em class="property">class </em><code class="descname">Magmom</code><span class="sig-paren">(</span><em>moment</em>, <em>saxis=(0</em>, <em>0</em>, <em>1)</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pymatgen/electronic_structure/core.html#Magmom"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.electronic_structure.core.Magmom" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">monty.json.MSONable</span></code></p>
<p>New class in active development. Use with caution, feedback is
appreciated.</p>
<p>Class to handle magnetic moments. Defines the magnetic moment of a
site or species relative to a spin quantization axis. Designed for
use in electronic structure calculations.</p>
<ul class="simple">
<li><p>For the general case, Magmom can be specified by a vector,
e.g. m = Magmom([1.0, 1.0, 2.0]), and subscripts will work as
expected, e.g. m[0] gives 1.0</p></li>
<li><p>For collinear calculations, Magmom can assumed to be scalar-like,
e.g. m = Magmom(5.0) will work as expected, e.g. float(m) gives 5.0</p></li>
</ul>
<p>Both of these cases should be safe and shouldn’t give any surprises,
but more advanced functionality is available if required.</p>
<p>There also exist useful static methods for lists of magmoms:</p>
<ul class="simple">
<li><p>Magmom.are_collinear(magmoms) - if true, a collinear electronic
structure calculation can be safely initialized, with float(Magmom)
giving the expected scalar magnetic moment value</p></li>
<li><p>Magmom.get_consistent_set_and_saxis(magmoms) - for non-collinear
electronic structure calculations, a global, consistent spin axis
has to be used. This method returns a list of Magmoms which all
share a common spin axis, along with the global spin axis.</p></li>
</ul>
<p>All methods that take lists of magmoms will accept magmoms either as
Magmom objects or as scalars/lists and will automatically convert to
a Magmom representation internally.</p>
<p>The following methods are also particularly useful in the context of
VASP calculations:</p>
<ul class="simple">
<li><p>Magmom.get_xyz_magmom_with_001_saxis()</p></li>
<li><p>Magmom.get_00t_magmom_with_xyz_saxis()</p></li>
</ul>
<p>See VASP documentation for more information:</p>
<p><a class="reference external" href="https://cms.mpi.univie.ac.at/wiki/index.php/SAXIS">https://cms.mpi.univie.ac.at/wiki/index.php/SAXIS</a></p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>moment</strong> – magnetic moment, supplied as float or list/np.ndarray</p></li>
<li><p><strong>saxis</strong> – spin axis, supplied as list/np.ndarray, parameter will</p></li>
</ul>
</dd>
</dl>
<p>be converted to unit vector (default is [0, 0, 1])
:return: Magmom object</p>
<dl class="staticmethod">
<dt id="pymatgen.electronic_structure.core.Magmom.are_collinear">
<em class="property">static </em><code class="descname">are_collinear</code><span class="sig-paren">(</span><em>magmoms</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pymatgen/electronic_structure/core.html#Magmom.are_collinear"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.electronic_structure.core.Magmom.are_collinear" title="Permalink to this definition">¶</a></dt>
<dd><p>Method checks to see if a set of magnetic moments are collinear
with each other.
:param magmoms: list of magmoms (Magmoms, scalars or vectors)
:return: bool</p>
</dd></dl>
<dl class="classmethod">
<dt id="pymatgen.electronic_structure.core.Magmom.from_global_moment_and_saxis">
<em class="property">classmethod </em><code class="descname">from_global_moment_and_saxis</code><span class="sig-paren">(</span><em>global_moment</em>, <em>saxis</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pymatgen/electronic_structure/core.html#Magmom.from_global_moment_and_saxis"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.electronic_structure.core.Magmom.from_global_moment_and_saxis" title="Permalink to this definition">¶</a></dt>
<dd><p>Convenience method to initialize Magmom from a given global
magnetic moment, i.e. magnetic moment with saxis=(0,0,1), and
provided saxis.</p>
<p>Method is useful if you do not know the components of your
magnetic moment in frame of your desired saxis.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>global_moment</strong> – </p></li>
<li><p><strong>saxis</strong> – desired saxis</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p></p>
</dd>
</dl>
</dd></dl>
<dl class="classmethod">
<dt id="pymatgen.electronic_structure.core.Magmom.from_moment_relative_to_crystal_axes">
<em class="property">classmethod </em><code class="descname">from_moment_relative_to_crystal_axes</code><span class="sig-paren">(</span><em>moment</em>, <em>lattice</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pymatgen/electronic_structure/core.html#Magmom.from_moment_relative_to_crystal_axes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.electronic_structure.core.Magmom.from_moment_relative_to_crystal_axes" title="Permalink to this definition">¶</a></dt>
<dd><p>Obtaining a Magmom object from a magnetic moment provided
relative to crystal axes.</p>
<p>Used for obtaining moments from magCIF file.
:param magmom: list of floats specifying vector magmom
:param lattice: Lattice
:return: Magmom</p>
</dd></dl>
<dl class="method">
<dt id="pymatgen.electronic_structure.core.Magmom.get_00t_magmom_with_xyz_saxis">
<code class="descname">get_00t_magmom_with_xyz_saxis</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pymatgen/electronic_structure/core.html#Magmom.get_00t_magmom_with_xyz_saxis"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.electronic_structure.core.Magmom.get_00t_magmom_with_xyz_saxis" title="Permalink to this definition">¶</a></dt>
<dd><p>For internal implementation reasons, in non-collinear calculations
VASP prefers:</p>
<p>MAGMOM = 0 0 total_magnetic_moment
SAXIS = x y z</p>
<p>to an equivalent:</p>
<p>MAGMOM = x y z
SAXIS = 0 0 1</p>
<p>This method returns a Magmom object with magnetic moment [0, 0, t],
where t is the total magnetic moment, and saxis rotated as required.</p>
<p>A consistent direction of saxis is applied such that t might be positive
or negative depending on the direction of the initial moment. This is useful
in the case of collinear structures, rather than constraining assuming
t is always positive.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Magmom</p>
</dd>
</dl>
</dd></dl>
<dl class="staticmethod">
<dt id="pymatgen.electronic_structure.core.Magmom.get_consistent_set_and_saxis">
<em class="property">static </em><code class="descname">get_consistent_set_and_saxis</code><span class="sig-paren">(</span><em>magmoms</em>, <em>saxis=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pymatgen/electronic_structure/core.html#Magmom.get_consistent_set_and_saxis"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.electronic_structure.core.Magmom.get_consistent_set_and_saxis" title="Permalink to this definition">¶</a></dt>
<dd><p>Method to ensure a list of magmoms use the same spin axis.
Returns a tuple of a list of Magmoms and their global spin axis.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>magmoms</strong> – list of magmoms (Magmoms, scalars or vectors)</p></li>
<li><p><strong>saxis</strong> – can provide a specific global spin axis</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>(list of Magmoms, global spin axis) tuple</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="pymatgen.electronic_structure.core.Magmom.get_moment">
<code class="descname">get_moment</code><span class="sig-paren">(</span><em>saxis=(0</em>, <em>0</em>, <em>1)</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pymatgen/electronic_structure/core.html#Magmom.get_moment"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.electronic_structure.core.Magmom.get_moment" title="Permalink to this definition">¶</a></dt>
<dd><p>Get magnetic moment relative to a given spin quantization axis.
If no axis is provided, moment will be given relative to the
Magmom’s internal spin quantization axis, i.e. equivalent to
Magmom.moment</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>axis</strong> – (list/numpy array) spin quantization axis</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>np.ndarray of length 3</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="pymatgen.electronic_structure.core.Magmom.get_moment_relative_to_crystal_axes">
<code class="descname">get_moment_relative_to_crystal_axes</code><span class="sig-paren">(</span><em>lattice</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pymatgen/electronic_structure/core.html#Magmom.get_moment_relative_to_crystal_axes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.electronic_structure.core.Magmom.get_moment_relative_to_crystal_axes" title="Permalink to this definition">¶</a></dt>
<dd><p>If scalar magmoms, moments will be given arbitrarily along z.
Used for writing moments to magCIF file.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>magmom</strong> – Magmom</p></li>
<li><p><strong>lattice</strong> – Lattice</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>vector as list of floats</p>
</dd>
</dl>
</dd></dl>
<dl class="staticmethod">
<dt id="pymatgen.electronic_structure.core.Magmom.get_suggested_saxis">
<em class="property">static </em><code class="descname">get_suggested_saxis</code><span class="sig-paren">(</span><em>magmoms</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pymatgen/electronic_structure/core.html#Magmom.get_suggested_saxis"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.electronic_structure.core.Magmom.get_suggested_saxis" title="Permalink to this definition">¶</a></dt>
<dd><p>This method returns a suggested spin axis for a set of magmoms,
taking the largest magnetic moment as the reference. For calculations
with collinear spins, this would give a sensible saxis for a ncl
calculation.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>magmoms</strong> – list of magmoms (Magmoms, scalars or vectors)</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>np.ndarray of length 3</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="pymatgen.electronic_structure.core.Magmom.get_xyz_magmom_with_001_saxis">
<code class="descname">get_xyz_magmom_with_001_saxis</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pymatgen/electronic_structure/core.html#Magmom.get_xyz_magmom_with_001_saxis"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.electronic_structure.core.Magmom.get_xyz_magmom_with_001_saxis" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a Magmom in the default setting of saxis = [0, 0, 1] and
the magnetic moment rotated as required.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Magmom</p>
</dd>
</dl>
</dd></dl>
<dl class="attribute">
<dt id="pymatgen.electronic_structure.core.Magmom.global_moment">
<code class="descname">global_moment</code><a class="headerlink" href="#pymatgen.electronic_structure.core.Magmom.global_moment" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the magnetic moment defined in an arbitrary global reference frame.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>np.ndarray of length 3</p>
</dd>
</dl>
</dd></dl>
<dl class="staticmethod">
<dt id="pymatgen.electronic_structure.core.Magmom.have_consistent_saxis">
<em class="property">static </em><code class="descname">have_consistent_saxis</code><span class="sig-paren">(</span><em>magmoms</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pymatgen/electronic_structure/core.html#Magmom.have_consistent_saxis"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.electronic_structure.core.Magmom.have_consistent_saxis" title="Permalink to this definition">¶</a></dt>
<dd><p>This method checks that all Magmom objects in a list have a
consistent spin quantization axis. To write MAGMOM tags to a
VASP INCAR, a global SAXIS value for all magmoms has to be used.
If saxis are inconsistent, can create consistent set with:
Magmom.get_consistent_set(magmoms)</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>magmoms</strong> – list of magmoms (Magmoms, scalars or vectors)</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>bool</p>
</dd>
</dl>
</dd></dl>
<dl class="attribute">
<dt id="pymatgen.electronic_structure.core.Magmom.projection">
<code class="descname">projection</code><a class="headerlink" href="#pymatgen.electronic_structure.core.Magmom.projection" title="Permalink to this definition">¶</a></dt>
<dd><p>Projects moment along spin quantisation axis. Useful for obtaining
collinear approximation for slightly non-collinear magmoms.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="pymatgen.electronic_structure.core.Orbital">
<em class="property">class </em><code class="descname">Orbital</code><a class="reference internal" href="_modules/pymatgen/electronic_structure/core.html#Orbital"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.electronic_structure.core.Orbital" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">enum.Enum</span></code></p>
<p>Enum type for specific orbitals. The indices are basically the order in
which the orbitals are reported in VASP and has no special meaning.</p>
<dl class="attribute">
<dt id="pymatgen.electronic_structure.core.Orbital.dx2">
<code class="descname">dx2</code><em class="property"> = 8</em><a class="headerlink" href="#pymatgen.electronic_structure.core.Orbital.dx2" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pymatgen.electronic_structure.core.Orbital.dxy">
<code class="descname">dxy</code><em class="property"> = 4</em><a class="headerlink" href="#pymatgen.electronic_structure.core.Orbital.dxy" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pymatgen.electronic_structure.core.Orbital.dxz">
<code class="descname">dxz</code><em class="property"> = 7</em><a class="headerlink" href="#pymatgen.electronic_structure.core.Orbital.dxz" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pymatgen.electronic_structure.core.Orbital.dyz">
<code class="descname">dyz</code><em class="property"> = 5</em><a class="headerlink" href="#pymatgen.electronic_structure.core.Orbital.dyz" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pymatgen.electronic_structure.core.Orbital.dz2">
<code class="descname">dz2</code><em class="property"> = 6</em><a class="headerlink" href="#pymatgen.electronic_structure.core.Orbital.dz2" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pymatgen.electronic_structure.core.Orbital.f0">
<code class="descname">f0</code><em class="property"> = 12</em><a class="headerlink" href="#pymatgen.electronic_structure.core.Orbital.f0" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pymatgen.electronic_structure.core.Orbital.f1">
<code class="descname">f1</code><em class="property"> = 13</em><a class="headerlink" href="#pymatgen.electronic_structure.core.Orbital.f1" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pymatgen.electronic_structure.core.Orbital.f2">
<code class="descname">f2</code><em class="property"> = 14</em><a class="headerlink" href="#pymatgen.electronic_structure.core.Orbital.f2" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pymatgen.electronic_structure.core.Orbital.f3">
<code class="descname">f3</code><em class="property"> = 15</em><a class="headerlink" href="#pymatgen.electronic_structure.core.Orbital.f3" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pymatgen.electronic_structure.core.Orbital.f_1">
<code class="descname">f_1</code><em class="property"> = 11</em><a class="headerlink" href="#pymatgen.electronic_structure.core.Orbital.f_1" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pymatgen.electronic_structure.core.Orbital.f_2">
<code class="descname">f_2</code><em class="property"> = 10</em><a class="headerlink" href="#pymatgen.electronic_structure.core.Orbital.f_2" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pymatgen.electronic_structure.core.Orbital.f_3">
<code class="descname">f_3</code><em class="property"> = 9</em><a class="headerlink" href="#pymatgen.electronic_structure.core.Orbital.f_3" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pymatgen.electronic_structure.core.Orbital.orbital_type">
<code class="descname">orbital_type</code><a class="headerlink" href="#pymatgen.electronic_structure.core.Orbital.orbital_type" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns OrbitalType of an orbital.</p>
</dd></dl>
<dl class="attribute">
<dt id="pymatgen.electronic_structure.core.Orbital.px">
<code class="descname">px</code><em class="property"> = 3</em><a class="headerlink" href="#pymatgen.electronic_structure.core.Orbital.px" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pymatgen.electronic_structure.core.Orbital.py">
<code class="descname">py</code><em class="property"> = 1</em><a class="headerlink" href="#pymatgen.electronic_structure.core.Orbital.py" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pymatgen.electronic_structure.core.Orbital.pz">
<code class="descname">pz</code><em class="property"> = 2</em><a class="headerlink" href="#pymatgen.electronic_structure.core.Orbital.pz" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pymatgen.electronic_structure.core.Orbital.s">
<code class="descname">s</code><em class="property"> = 0</em><a class="headerlink" href="#pymatgen.electronic_structure.core.Orbital.s" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="pymatgen.electronic_structure.core.OrbitalType">
<em class="property">class </em><code class="descname">OrbitalType</code><a class="reference internal" href="_modules/pymatgen/electronic_structure/core.html#OrbitalType"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.electronic_structure.core.OrbitalType" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">enum.Enum</span></code></p>
<p>Enum type for orbital type. Indices are basically the azimuthal quantum
number, l.</p>
<dl class="attribute">
<dt id="pymatgen.electronic_structure.core.OrbitalType.d">
<code class="descname">d</code><em class="property"> = 2</em><a class="headerlink" href="#pymatgen.electronic_structure.core.OrbitalType.d" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pymatgen.electronic_structure.core.OrbitalType.f">
<code class="descname">f</code><em class="property"> = 3</em><a class="headerlink" href="#pymatgen.electronic_structure.core.OrbitalType.f" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pymatgen.electronic_structure.core.OrbitalType.p">
<code class="descname">p</code><em class="property"> = 1</em><a class="headerlink" href="#pymatgen.electronic_structure.core.OrbitalType.p" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pymatgen.electronic_structure.core.OrbitalType.s">
<code class="descname">s</code><em class="property"> = 0</em><a class="headerlink" href="#pymatgen.electronic_structure.core.OrbitalType.s" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="pymatgen.electronic_structure.core.Spin">
<em class="property">class </em><code class="descname">Spin</code><a class="reference internal" href="_modules/pymatgen/electronic_structure/core.html#Spin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.electronic_structure.core.Spin" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">enum.Enum</span></code></p>
<p>Enum type for Spin. Only up and down.
Usage: Spin.up, Spin.down.</p>
<dl class="attribute">
<dt id="pymatgen.electronic_structure.core.Spin.down">
<code class="descname">down</code><em class="property"> = -1</em><a class="headerlink" href="#pymatgen.electronic_structure.core.Spin.down" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pymatgen.electronic_structure.core.Spin.up">
<code class="descname">up</code><em class="property"> = 1</em><a class="headerlink" href="#pymatgen.electronic_structure.core.Spin.up" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/pymatgen.electronic_structure.core.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">pymatgen 2019.5.1 documentation</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2011, Pymatgen Development Team.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.0.1.
</div>
<div class="footer">This page uses <a href="http://analytics.google.com/">
Google Analytics</a> to collect statistics. You can disable it by blocking
the JavaScript coming from www.google-analytics.com.
<script type="text/javascript">
(function() {
var ga = document.createElement('script');
ga.src = ('https:' == document.location.protocol ?
'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
ga.setAttribute('async', 'true');
document.documentElement.firstChild.appendChild(ga);
})();
</script>
</div>
</body>
</html>