Source code for gemseo_umdo.use_cases.beam_model.core.output_data

# Copyright 2021 IRT Saint Exupéry, https://www.irt-saintexupery.com
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License version 3 as published by the Free Software Foundation.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with this program; if not, write to the Free Software Foundation,
# Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
"""The |g|-free version of the output data for the beam use case."""
from __future__ import annotations

from dataclasses import dataclass

from numpy.typing import NDArray


@dataclass
class BeamModelOutputData:
    """Output data of the beam model."""

    Ux: NDArray[float]
    r"""The strain energy along the :math:`x`-axis."""

    Uy: NDArray[float]
    r"""The strain energy along the :math:`y`-axis."""

    Uz: NDArray[float]
    r"""The strain energy along the :math:`z`-axis."""

    sigma: NDArray[float]
    """The normal stress at the root section points."""

    tau: NDArray[float]
    """The torsional stress at the root section points."""

    displ: NDArray[float]
    """The displacements at the tip section points."""

    sigma_vm: NDArray[float]
    """The von Mises stress at the root section points."""

    w: float
    """The weight of the beam."""

    yz_grid: NDArray[float]
    r"""The :math:`yz`-grid coordinates."""