Detailed Description

Namespace for vectorized second-order tensor types and operations on those. The tensors are for example, deformation gradients.

Typedefs
template<int DisplacementDim>
using	Type = Eigen::Matrix<double, size(DisplacementDim), 1, Eigen::ColMajor>

Functions
bool	isTensorConvertibleTo1d (Eigen::Matrix3d const &tensor)
	Only a diagonal tensor can be converted to a 1d vectorized tensor.
bool	isTensorConvertibleTo2d (Eigen::Matrix3d const &tensor)
constexpr int	size (int const displacement_dim)
	Vectorized tensor size for given displacement dimension.
template<typename VectorizedTensor>
constexpr int	dimension ()
	Displacement dimension of a vectorized tensor.
template<int DisplacementDim>
constexpr auto	identity ()
template<typename Derived>
double	determinant (Eigen::MatrixBase< Derived > const &tensor)
	Computes determinant of a vectorized tensor.
template<int DisplacementDim, typename Derived>
Type< DisplacementDim >	toVector (Eigen::MatrixBase< Derived > const &tensor)
template<int DisplacementDim>
Eigen::Matrix3d	toTensor (Type< DisplacementDim > const &tensor)
	Converts a vectorized tensor to a 3x3 matrix.

Typedef Documentation

◆ Type

template<int DisplacementDim>

using MathLib::VectorizedTensor::Type = Eigen::Matrix<double, size(DisplacementDim), 1, Eigen::ColMajor>

Vectorized tensor type for given displacement dimension.

Note: The Eigen vector is always a fixed size vector in contrast to a shape matrix policy types like GMatrixPolicyType::GradientVectorType.

Definition at line 66 of file VectorizedTensor.h.

Function Documentation

◆ determinant()

template<typename Derived>

double MathLib::VectorizedTensor::determinant ( Eigen::MatrixBase< Derived > const & tensor )

Computes determinant of a vectorized tensor.

Definition at line 105 of file VectorizedTensor.h.

{
    constexpr int displacement_dim = dimension<Derived>();
    static_assert(0 < displacement_dim && displacement_dim <= 3,
                  "Vectorized tensor determinant is implemented only for "
                  "displacement dimension 1, 2, or 3.");
 
    if constexpr (displacement_dim == 1)
    {
        return tensor[0] * tensor[1] * tensor[2];
    }
    if constexpr (displacement_dim == 2)
    {
        Eigen::Map<Eigen::Matrix2d const> const top_left{
            tensor.derived().data()};
 
        return top_left.determinant() * tensor[4];
    }
    if constexpr (displacement_dim == 3)
    {
        return Eigen::Map<Eigen::Matrix3d const>(tensor.derived().data())
            .determinant();
    }
}

References dimension().

Referenced by ProcessLib::NonLinearFbar::computeFBarInitialVariablesAverage(), ProcessLib::NonLinearFbar::computeFBarInitialVariablesElementCenter(), and ProcessLib::LargeDeformation::LargeDeformationLocalAssembler< ShapeFunction, DisplacementDim >::computeOutputStrainData().

◆ dimension()

template<typename VectorizedTensor>

int MathLib::VectorizedTensor::dimension ( )

constexpr

Displacement dimension of a vectorized tensor.

Definition at line 40 of file VectorizedTensor.h.

{
    static_assert(VectorizedTensor::ColsAtCompileTime == 1);
    constexpr int rows = VectorizedTensor::RowsAtCompileTime;
    if (rows == 3)
    {
        return 1;
    }
    if (rows == 5)
    {
        return 2;
    }
    if (rows == 9)
    {
        return 3;
    }
    OGS_FATAL(
        "Cannot convert vectorized tensor of size {} to displacement "
        "dimension.",
        rows);
}

References OGS_FATAL.

Referenced by determinant().

◆ identity()

template<int DisplacementDim>

auto MathLib::VectorizedTensor::identity ( )

constexpr

Vectorized identity tensor expression. Corresponds to 3x3 identity matrix in all dimensions.

Definition at line 71 of file VectorizedTensor.h.

{
    static_assert(
        0 < DisplacementDim && DisplacementDim <= 3,
        "Identity is implemented only for displacement dimension 1, 2, or 3.");
    return Type<DisplacementDim>::NullaryExpr(
        size(DisplacementDim), 1,
        [](Eigen::Index const row, [[maybe_unused]] Eigen::Index const col)
        {
            assert(col == 0);
            if constexpr (DisplacementDim == 1)
            {  // All entries are diagonal entries.
                return 1;
            }
            if constexpr (DisplacementDim == 2)
            {
                if (row == 0 || row == 3 || row == 4)
                {
                    return 1;
                }
            }
            if constexpr (DisplacementDim == 3)
            {
                if (row == 0 || row == 4 || row == 8)
                {
                    return 1;
                }
            }
            return 0;
        });
}

References size().

Referenced by ProcessLib::NonLinearFbar::computeFBarInitialVariablesAverage(), ProcessLib::NonLinearFbar::computeFBarInitialVariablesElementCenter(), ProcessLib::LargeDeformation::LargeDeformationLocalAssembler< ShapeFunction, DisplacementDim >::computeOutputStrainData(), and ProcessLib::LargeDeformation::LargeDeformationLocalAssembler< ShapeFunction, DisplacementDim >::updateConstitutiveRelations().

◆ isTensorConvertibleTo1d()

bool MathLib::VectorizedTensor::isTensorConvertibleTo1d ( Eigen::Matrix3d const & tensor )

Only a diagonal tensor can be converted to a 1d vectorized tensor.

Definition at line 9 of file VectorizedTensor.cpp.

{
    return (tensor(0, 1) == 0. && tensor(1, 0) == 0. &&  //
            tensor(0, 2) == 0. && tensor(2, 0) == 0. &&  //
            tensor(1, 2) == 0. && tensor(2, 1) == 0.);
}

Referenced by toVector().

◆ isTensorConvertibleTo2d()

bool MathLib::VectorizedTensor::isTensorConvertibleTo2d ( Eigen::Matrix3d const & tensor )

Only a tensor of form \( \left( \begin{array}{ccc} a & b & 0 \\% c & d & 0 \\% 0 & 0 & e \\% \end{array} \right)\) can be converted to a 2d vectorized tensor.

Definition at line 16 of file VectorizedTensor.cpp.

{
    return (tensor(0, 2) == 0. && tensor(1, 2) == 0. &&  //
            tensor(2, 0) == 0. && tensor(2, 1) == 0.);
}

Referenced by toVector().

◆ size()

int MathLib::VectorizedTensor::size ( int const displacement_dim )

constexpr

Vectorized tensor size for given displacement dimension.

Definition at line 19 of file VectorizedTensor.h.

{
    if (displacement_dim == 1)
    {
        return 3;
    }
    if (displacement_dim == 2)
    {
        return 5;
    }
    if (displacement_dim == 3)
    {
        return 9;
    }
    OGS_FATAL(
        "Cannot convert displacement dimension {} to vectorized tensor size.",
        displacement_dim);
}

References OGS_FATAL.

Referenced by MaterialPropertyLib::Function::Implementation< D >::createSymbolTable(), and identity().

◆ toTensor()

template<int DisplacementDim>

Eigen::Matrix3d MathLib::VectorizedTensor::toTensor ( Type< DisplacementDim > const & tensor )

Converts a vectorized tensor to a 3x3 matrix.

Definition at line 198 of file VectorizedTensor.h.

{
    static_assert(
        DisplacementDim == 1 || DisplacementDim == 2 || DisplacementDim == 3,
        "Conversion from displacement dimension other than 1, 2, or 3 "
        "is not valid.");
 
    using Matrix = Eigen::Matrix3d;
    if constexpr (DisplacementDim == 1)
    {
        return tensor.asDiagonal();
    }
    if constexpr (DisplacementDim == 2)
    {
        Matrix m = Matrix::Zero();
        m.template block<2, 2>(0, 0) =
            Eigen::Map<Eigen::Matrix<double, 2, 2> const>(tensor.data());
        m(2, 2) = tensor(4);
        return m;
    }
    if constexpr (DisplacementDim == 3)
    {
        return Eigen::Map<Matrix const>(tensor.data());
    }
}

Referenced by ProcessLib::NonLinearFbar::computeFBarInitialVariablesAverage(), and ProcessLib::NonLinearFbar::computeQVector().

◆ toVector()

template<int DisplacementDim, typename Derived>

Type< DisplacementDim > MathLib::VectorizedTensor::toVector ( Eigen::MatrixBase< Derived > const & tensor )

Converts a 3x3 matrix expression to a vectorized tensor if the conversion for that dimension is possible; see isTensorConvertibleTo1d() and isTensorConvertibleTo2d() functions.

Definition at line 146 of file VectorizedTensor.h.

{
    static_assert(0 < DisplacementDim && DisplacementDim <= 3,
                  "Conversion to displacement dimension other than 1, 2, or 3 "
                  "is not valid.");
 
    constexpr int rows = Derived::RowsAtCompileTime;
    constexpr int cols = Derived::ColsAtCompileTime;
    static_assert(rows == 3 || rows == Eigen::Dynamic);
    static_assert(cols == 3 || cols == Eigen::Dynamic);
    if (tensor.rows() != 3 || tensor.cols() != 3)
    {
        OGS_FATAL(
            "Incorrect tensor size, must be 3x3, but tensor is {:d}x{:d}.",
            tensor.rows(), tensor.cols());
    }
 
    if constexpr (DisplacementDim == 1)
    {
        if (!isTensorConvertibleTo1d(tensor))
        {
            OGS_FATAL(
                "Cannot convert a tensor with non-zero off-diagonal elements "
                "to a 1d vectorized tensor representation.");
        }
        return tensor.diagonal();
    }
    if constexpr (DisplacementDim == 2)
    {
        if (!isTensorConvertibleTo2d(tensor))
        {
            OGS_FATAL(
                "Cannot convert a tensor with non-zero elements at (0, 2), (1, "
                "2), (2, 0), and (2, 1) positions to a 2d vectorized tensor "
                "representation.");
        }
        Type<2> result;
        result.template head<4>() =
            tensor.template block<2, 2>(0, 0).reshaped();
        result(4) = tensor(2, 2);
        return result;
    }
    if constexpr (DisplacementDim == 3)
    {
        return tensor.reshaped();
    }
    OGS_FATAL(
        "Not all cases handled in the VectorizedTensor::toVector() function.");
}

References isTensorConvertibleTo1d(), isTensorConvertibleTo2d(), and OGS_FATAL.

Detailed Description

Typedefs

Functions

Typedef Documentation

◆ Type

Function Documentation

◆ determinant()

◆ dimension()

◆ identity()

◆ isTensorConvertibleTo1d()

◆ isTensorConvertibleTo2d()

◆ size()

◆ toTensor()

◆ toVector()