ogstools.variables.matrix module#

class ogstools.variables.matrix.Matrix[source]#

Bases: Variable

Represent a matrix variable.

Matrix variables should contain either 4 (2D) or 6 (3D) components. Matrix components can be accesses with brackets e.g. stress[0]

__getitem__(index)[source]#

A scalar variable as a matrix component.

The following index values correspond to a polar coordinate system:

rr: radial component tt: angular component in theta (azimuthal) direction pp: angular component in phi (polar) direction rt: shear component in the radial-azimuthal plane tp: shear component in the azimuthal-polar plane rp: shear component in the radial-polar plane

Return type:: Scalar

to_polar(center=(0, 0, 0), normal=(0, 0, 1))[source]#

Return the Matrix converted to a polar coordinate system.

For 3D only spherical coordinate system is implemented for now.

Return type:: Matrix

property magnitude: Scalar#: A scalar variable as the frobenius norm of the matrix.

property trace: Scalar#: A scalar variable as the trace of the matrix.

property eigenvalues: Vector#: A vector variable as the eigenvalues of the matrix.

property eigenvectors: VectorList#: A vector variable as the eigenvectors of the matrix.

property det: Scalar#: A scalar variable as the determinant of the matrix.

property invariant_1: Scalar#: A scalar variable as the first invariant of the matrix.

property invariant_2: Scalar#: A scalar variable as the second invariant of the matrix.

property invariant_3: Scalar#: A scalar variable as the third invariant of the matrix.

property mean: Scalar#: A scalar variable as the mean value of the matrix.

property hydrostatic_component: Matrix#: A vector variable as the effective pressure of the matrix.

property deviator: Matrix#: A vector variable as the deviator of the matrix.

property deviator_invariant_1: Scalar#: A scalar variable as the first invariant of the matrix deviator.

property deviator_invariant_2: Scalar#: A scalar variable as the second invariant of the matrix deviator.

property deviator_invariant_3: Scalar#: A scalar variable as the third invariant of the matrix deviator.

property octahedral_shear: Scalar#: A scalar variable as the octahedral shear component of the matrix.

property von_Mises: Scalar#: A scalar variable as the von Mises stress.

property qp_ratio: Scalar#: A scalar variable as the qp stress ratio.