# 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 DualceseD3PlotFluidSsid 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

_DUALCESED3PLOTFLUIDSSID_CARD0 = (
    FieldSchema("ssid", int, 0, 10, None),
)

_DUALCESED3PLOTFLUIDSSID_CARD1 = (
    FieldSchema("flow_var", str, 0, 80, None),
)

class DualceseD3PlotFluidSsid(KeywordBase):
    """DYNA DUALCESE_D3PLOT_FLUID_SSID keyword"""

    keyword = "DUALCESE"
    subkeyword = "D3PLOT_FLUID_SSID"

    def __init__(self, **kwargs):
        """Initialize the DualceseD3PlotFluidSsid class."""
        super().__init__(**kwargs)
        self._cards = [
            Card.from_field_schemas_with_defaults(
                _DUALCESED3PLOTFLUIDSSID_CARD0,
                **kwargs,
            ),            Card.from_field_schemas_with_defaults(
                _DUALCESED3PLOTFLUIDSSID_CARD1,
                **kwargs,
            ),        ]
    @property
    def ssid(self) -> typing.Optional[int]:
        """Get or set the Segment set ID created with *DUALCESE_SEGMENTSET
        """ # nopep8
        return self._cards[0].get_value("ssid")

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

    @property
    def flow_var(self) -> typing.Optional[str]:
        """Get or set the Name of a flow variable to output to the d3plot file. The currently supported variables are:
        DENSITY
        VELOCITY
        MOMENTUM
        VORTICITY
        TOTAL_ENERGY
        INTERNAL_ENERGY
        PRESSURE
        TEMPERATURE
        ENTROPY
        ENTHALPY
        SCHLIEREN_NUMBER
        VOID_FRACTION
        VOLUME_FRACTION
        REACTANT_MASS_FRACTION
        """ # nopep8
        return self._cards[1].get_value("flow_var")

    @flow_var.setter
    def flow_var(self, value: str) -> None:
        """Set the flow_var property."""
        self._cards[1].set_value("flow_var", value)

