# Copyright (C) 2021 - 2024 ANSYS, Inc. and/or its affiliates.
# SPDX-License-Identifier: MIT
#
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.

"""Module providing the DampingPartStiffness class."""
import typing
from ansys.dyna.core.lib.card import Card, Field, Flag
from ansys.dyna.core.lib.field_schema import FieldSchema
from ansys.dyna.core.lib.keyword_base import KeywordBase
from ansys.dyna.core.lib.keyword_base import LinkType

_DAMPINGPARTSTIFFNESS_CARD0 = (
    FieldSchema("pid", int, 0, 10, None),
    FieldSchema("coef", float, 10, 10, None),
)

class DampingPartStiffness(KeywordBase):
    """DYNA DAMPING_PART_STIFFNESS keyword"""

    keyword = "DAMPING"
    subkeyword = "PART_STIFFNESS"
    _link_fields = {
        "pid": LinkType.PART,
    }

    def __init__(self, **kwargs):
        """Initialize the DampingPartStiffness class."""
        super().__init__(**kwargs)
        self._cards = [
            Card.from_field_schemas_with_defaults(
                _DAMPINGPARTSTIFFNESS_CARD0,
                **kwargs,
            ),        ]
    @property
    def pid(self) -> typing.Optional[int]:
        """Get or set the Part ID, see *PART.
        """ # nopep8
        return self._cards[0].get_value("pid")

    @pid.setter
    def pid(self, value: int) -> None:
        """Set the pid property."""
        self._cards[0].set_value("pid", value)

    @property
    def coef(self) -> typing.Optional[float]:
        """Get or set the Rayleigh damping coefficient.  Two methods are now available:
        LT.0.0:	Rayleigh damping coefficient in units of time, set based on a given frequencyand applied uniformly to each element in the specified part or part set.This method is typically used for implicit dynamic analysis.See remarks below.
        EQ.0.0 : Inactive.
        GT.0.0 : Unitless damping coefficient for stiffness weighted damping.This non - classical method is typically used for explicit analyses as it does not require assembly of a stiffness matrix.Values between 0.01 and 0.25 are recommended.Higher values are strongly discouraged,and values less than 0.01 may have little effect.The damping coefficient is uniquely calculated internally for each element of the part ID.
        """ # nopep8
        return self._cards[0].get_value("coef")

    @coef.setter
    def coef(self, value: float) -> None:
        """Set the coef property."""
        self._cards[0].set_value("coef", value)

    @property
    def pid_link(self) -> typing.Optional[KeywordBase]:
        """Get the PART keyword containing the given pid."""
        return self._get_link_by_attr("PART", "pid", self.pid, "parts")

