Dimensionality

class ansys.dpf.core.dimensionality.Dimensionality(dim_vec, nature: ansys.dpf.core.common.natures)

Bases: object

Represents the dimensionality of a field.

This class reads a list of dimension vectors and creates a dimensionality message.

Parameters
  • dim_vec (list) –

    List of integers for the dimension vectors. There is a 1D vector for a scalar or 3D vector. There is a 2D vector for a matrix. For example:

    • [1]: scalar

    • [3]: 3d vector

    • [3, 3]: 3 x 3 matrix

  • nature (ansys.dpf.core.common.natures) –

static scalar_dim()

Retrieve the dimensionality of a scalar field.

Returns

Dimensionality of the scalar field.

Return type

ansys.dpf.core.dimensionnality.Dimensionality

static vector_dim(size)

Retrieve the dimensionality of a vector field of a given size.

Parameters

size (int) – Number of components by entity.

Returns

Dimensionality of the vector field.

Return type

ansys.dpf.core.dimensionnality.Dimensionality

static vector_3d_dim()

Retrieve the dimensionality of a three-dimension vector field.

Returns

Dimensionality of the three-dimension vector field.

Return type

ansys.dpf.core.dimensionnality.Dimensionality

static tensor_dim()

Retrieve the dimensionality of a symmetrical 3 x 3 tensor field.

Returns

Dimensionality of the symmetrical 3 x 3 tensor field.

Return type

ansys.dpf.core.dimensionnality.Dimensionality