ogstools.variables package

Predefined variables for data and unit transformation.

class ogstools.variables.Matrix

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)

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))

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 tensor_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.

class ogstools.variables.Scalar

Bases: Variable

Represent a scalar variable.

class ogstools.variables.Variable

Bases: object

Represent a generic mesh variable.

__init__(data_name, data_unit='', output_unit=None, output_name=None, symbol='', mask='', func=identity, mesh_dependent=False, process_with_units=False, cmap='coolwarm', bilinear_cmap=False, categoric=False, color=None)

data_name: str

The name of the variable data in the mesh.

data_unit: str = ''

The unit of the variable data in the mesh.

output_unit: str = ''

The output unit of the variable.

output_name: str = ''

The output name of the variable.

symbol: str = ''

The symbol representing this variable.

mask: str = ''

The name of the mask data in the mesh.

func()

The function to be applied on the data. .. seealso:: transform()

Return type:

TypeVar(T)

mesh_dependent: bool = False

If the function to be applied is dependent on the mesh itself

process_with_units: bool = False

If true, apply the function on values with units.

cmap: Colormap | str = 'coolwarm'

Colormap to use for plotting.

bilinear_cmap: bool = False

Should this variable be displayed with a bilinear cmap?

categoric: bool = False

Does this variable only have categoric values?

color: str | None = None

Default color for plotting

property type_name: str

replace(**changes)

Create a new Variable object with modified attributes.

Be aware that there is no type check safety here. So make sure, the new attributes and values are correct.

Parameters:

changes (Any) – Attributes to be changed.

Return type:

Self

Returns:

A copy of the Variable with changed attributes.

classmethod from_variable(new_variable, **changes)

Create a new Variable object with modified attributes.

Return type:

Self

classmethod find(variable, mesh)

Returns a Variable preset or creates one with correct type.

Searches for presets by data_name and output_name and returns if found. If ‘variable’ is given as type Variable this will also look for derived variables (difference, aggregate). Otherwise create Scalar, Vector, or Matrix Variable depending on the shape of data in mesh.

Parameters:

• variable (Variable | str) – The variable to retrieve or its name if a string.

• mesh (DataSet) – The mesh containing the variable data.

Return type:

Variable

Returns:

A corresponding Variable preset or a new Variable of correct type.

transform(data, strip_unit=True)

Return the transformed data values.

Converts the data from data_unit to output_unit and applies the transformation function of this variable. The result is returned by default without units. if strip_unit is False, a quantity is returned.

Note: If self.mesh_dependent is True, self.func is applied directly to the mesh. Otherwise, it is determined by self.process_with_units if the data is passed to the function with units (i.e. as a pint quantity) or without.

Return type:

ndarray

property get_output_unit: str

Return the output unit

property min: Self

A variable relating to minimum of this quantity.

property max: Self

A variable relating to maximum of this quantity.

property mean: Self

A variable relating to mean of this quantity.

property median: Self

A variable relating to median of this quantity.

property sum: Self

A variable relating to sum of this quantity.

property std: Self

A variable relating to standard deviation of this quantity.

property var: Self

A variable relating to variance of this quantity.

property difference: Variable

A variable relating to differences in this quantity.

property abs_error: Variable

A variable relating to an absolute error of this quantity.

property rel_error: Variable

A variable relating to a relative error of this quantity.

property anasol: Variable

A variable relating to an analytical solution of this quantity.

is_mask()

Check if the variable is a mask.

Return type:

bool

Returns:

True if the variable is a mask, False otherwise.

get_mask()

A variable representing this variables mask.

Return type:

Variable

property magnitude: Variable

mask_used(mesh)

Check whether the mesh contains the mask of this variable.

Return type:

bool

get_label(split_at=None)

Creates variable label in format ‘variable_name / variable_unit’

Return type:

str

class ogstools.variables.Vector

Bases: Variable

Represent a vector variable.

Vector variables should contain either 2 (2D) or 3 (3D) components. Vector components can be accesses with brackets e.g. displacement[0]

__getitem__(index)

Get a scalar variable as a specific component of the vector variable.

Parameters:

index (Union[int, Literal['x', 'y', 'z']]) – The index of the component.

Return type:

Scalar

Returns:

A scalar variable as a vector component.

property magnitude: Scalar

Returns:

A scalar variable as the magnitude of the vector.

Submodules

• ogstools.variables.custom_colormaps module
• ogstools.variables.matrix module
  • Matrix
    • Matrix.__getitem__()
    • Matrix.to_polar()
    • Matrix.magnitude
    • Matrix.trace
    • Matrix.eigenvalues
    • Matrix.eigenvectors
    • Matrix.det
    • Matrix.invariant_1
    • Matrix.invariant_2
    • Matrix.invariant_3
    • Matrix.tensor_mean
    • Matrix.hydrostatic_component
    • Matrix.deviator
    • Matrix.deviator_invariant_1
    • Matrix.deviator_invariant_2
    • Matrix.deviator_invariant_3
    • Matrix.octahedral_shear
    • Matrix.von_Mises
    • Matrix.qp_ratio
• ogstools.variables.mesh_dependent module
  • fluid_pressure_criterion()
  • dilatancy_critescu()
  • dilatancy_alkan()
  • angles()
• ogstools.variables.tensor_math module
  • identity()
  • sym_tensor_to_mat()
  • mat_to_sym_tensor()
  • trace()
  • matrix_trace()
  • eigenvalues()
  • eigenvectors()
  • det()
  • frobenius_norm()
  • invariant_1()
  • invariant_2()
  • invariant_3()
  • mean()
  • effective_pressure()
  • hydrostatic_component()
  • deviator()
  • deviator_invariant_1()
  • deviator_invariant_2()
  • deviator_invariant_3()
  • octahedral_shear()
  • von_mises()
  • qp_ratio()
  • to_polar()
• ogstools.variables.unit_registry module
• ogstools.variables.variable module
  • Variable
    • Variable.__init__()
    • Variable.data_name
    • Variable.data_unit
    • Variable.output_unit
    • Variable.output_name
    • Variable.symbol
    • Variable.mask
    • Variable.func()
    • Variable.mesh_dependent
    • Variable.process_with_units
    • Variable.cmap
    • Variable.bilinear_cmap
    • Variable.categoric
    • Variable.color
    • Variable.type_name
    • Variable.replace()
    • Variable.from_variable()
    • Variable.find()
    • Variable.transform()
    • Variable.get_output_unit
    • Variable.min
    • Variable.max
    • Variable.mean
    • Variable.median
    • Variable.sum
    • Variable.std
    • Variable.var
    • Variable.difference
    • Variable.abs_error
    • Variable.rel_error
    • Variable.anasol
    • Variable.is_mask()
    • Variable.get_mask()
    • Variable.magnitude
    • Variable.mask_used()
    • Variable.get_label()
  • Scalar
• ogstools.variables.vector module
  • vector_norm()
  • Vector
    • Vector.__getitem__()
    • Vector.magnitude
  • BHE_Vector
    • BHE_Vector.BHE_COMPONENTS
    • BHE_Vector.__getitem__()
    • BHE_Vector.magnitude
    • BHE_Vector.__init__()
  • VectorList
    • VectorList.__getitem__()
    • VectorList.__init__()