py_utils.core.cluster_identifier.Polarity Class Reference

Inheritance diagram for py_utils.core.cluster_identifier.Polarity:

Collaboration diagram for py_utils.core.cluster_identifier.Polarity:

Public Member Functions
str	label (self)
int	signed_defect (self)
"Polarity"	opposite (self)

Public Attributes
	value

Static Public Attributes
int	VACANCY = -1
int	SIA = +1

Detailed Description

Sign of a cluster's net Frenkel-pair content w.r.t. the host lattice.

The polarity index splits the state space into two sub-spaces without
a host-specific taxonomy.  It also serves as the *species-class*
discriminator of the paper (C_V for vacancy-type, C_I for SIA-type).

Definition at line 35 of file cluster_identifier.py.

Member Function Documentation

label()

str py_utils.core.cluster_identifier.Polarity.label

(

self

)

Definition at line 47 of file cluster_identifier.py.

opposite()

"Polarity" py_utils.core.cluster_identifier.Polarity.opposite

(

self

)

Definition at line 56 of file cluster_identifier.py.

signed_defect()

int py_utils.core.cluster_identifier.Polarity.signed_defect

(

self

)

Signed lattice-defect content per unit size (-1 vacancy, +1 SIA).

Definition at line 51 of file cluster_identifier.py.

Member Data Documentation

SIA

int py_utils.core.cluster_identifier.Polarity.SIA = +1

static

Definition at line 44 of file cluster_identifier.py.

VACANCY

int py_utils.core.cluster_identifier.Polarity.VACANCY = -1

static

Definition at line 43 of file cluster_identifier.py.

value

py_utils.core.cluster_identifier.Polarity.value

Definition at line 53 of file cluster_identifier.py.

---

The documentation for this class was generated from the following file:

• radcluster_code/py_utils/core/cluster_identifier.py