abipy.tools.elate namespace

Submodules

abipy.tools.elate.elastic module

abipy.tools.elate.elastic.dirVec(theta, phi)[source]

Return a unit vector associated with angles theta and phi

abipy.tools.elate.elastic.dirVec1(theta, phi, chi)[source]

Return the first unit vector associated with angles (theta, phi, chi)

abipy.tools.elate.elastic.dirVec2(theta, phi, chi)[source]

Return the second unit vector associated with angles (theta, phi, chi)

abipy.tools.elate.elastic.minimize(func, dim)[source]

Find the global minimum of a function with 2 (theta, phi) or 3 (theta, phi, chi) parameters

abipy.tools.elate.elastic.maximize(func, dim)[source]

Find the global maximum of a function with 2 (theta, phi) or 3 (theta, phi, chi) parameters

class abipy.tools.elate.elastic.Elastic(s)[source]

Bases: object

An elastic tensor, along with methods to access it.

It will raise a ValueError when the input is invalid, and a TypeError if the input is valid but corresponds to a 2D material.

is2D()[source]

Return True if the material is 2D.

isOrthorhombic()[source]

Return True if the elastic tensor is orthorhombic.

isCubic()[source]

Return True if the elastic tensor is cubic.

Young(x)[source]

Return the Young’s modulus in the direction x=(theta, phi).

Young_2(x, y)[source]

Return the Young’s modulus in the direction x, y.

LC(x)[source]

Return the linear compressibility in the direction x=(theta, phi).

LC_2(x, y)[source]

Return the linear compressibility in the direction x, y.

shear(x)[source]

Return the shear modulus in the direction x=(theta, phi, chi).

Poisson(x)[source]

Return the Poisson’s ratio in the direction x=(theta, phi, chi).

averages()[source]

Return the Voigt, Reuss, and Hill averages for the elastic tensor.

eigenvalues()[source]

Return the eigenvalues of the stiffness matrix.

shear2D(x)[source]

Find the minimum and maximum shear modulus for a given direction x=(theta, phi).

shear3D(x, y, guess1=1.5707963267948966, guess2=1.5707963267948966)[source]

Find the minimum and maximum shear modulus for a given direction (x, y).

Poisson2D(x)[source]

Find the minimum and maximum Poisson’s ratio for a given direction x=(theta, phi).

Poisson3D(x, y, guess1=1.5707963267948966, guess2=1.5707963267948966)[source]

Find the minimum and maximum Poisson’s ratio for a given direction (x, y).

class abipy.tools.elate.elastic.ElasticOrtho(arg)[source]

Bases: Elastic

An elastic tensor, for the specific case of an orthorhombic system

Young(x)[source]

Return the Young’s modulus in the direction x=(theta, phi).

LC(x)[source]

Return the linear compressibility in the direction x=(theta, phi).

shear(x)[source]

Return the shear modulus in the direction x=(theta, phi, chi).

Poisson(x)[source]

Return the Poisson’s ratio in the direction x=(theta, phi, chi).

class abipy.tools.elate.elastic.Elastic2D(s)[source]

Bases: object

Elastic tensor for 2D material, along with methods to access it

is2D()[source]

Return True if the material is 2D.

Young(theta)[source]

Return the Young’s modulus in the direction theta.

shear(theta)[source]

Return the shear modulus in the direction theta.

Poisson(theta)[source]

Return the Poisson’s ratio in the direction theta.

eigenvalues()[source]

Return the eigenvalues of the stiffness matrix.