# 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 MatGeneralViscoelastic class."""
import typing
from ansys.dyna.core.lib.card import Card, Field, Flag
from ansys.dyna.core.lib.option_card import OptionCardSet, OptionSpec
from ansys.dyna.core.lib.keyword_base import KeywordBase
[docs]
class MatGeneralViscoelastic(KeywordBase):
"""DYNA MAT_GENERAL_VISCOELASTIC keyword"""
keyword = "MAT"
subkeyword = "GENERAL_VISCOELASTIC"
option_specs = [
OptionSpec("TITLE", -1, 1),
]
def __init__(self, **kwargs):
"""Initialize the MatGeneralViscoelastic class."""
super().__init__(**kwargs)
kwargs["parent"] = self
self._cards = [
Card(
[
Field(
"mid",
int,
0,
10,
**kwargs,
),
Field(
"ro",
float,
10,
10,
**kwargs,
),
Field(
"bulk",
float,
20,
10,
**kwargs,
),
Field(
"pcf",
float,
30,
10,
**kwargs,
),
Field(
"ef",
float,
40,
10,
0,
**kwargs,
),
Field(
"tref",
float,
50,
10,
**kwargs,
),
Field(
"a",
float,
60,
10,
**kwargs,
),
Field(
"b",
float,
70,
10,
**kwargs,
),
],
),
Card(
[
Field(
"lcid",
int,
0,
10,
**kwargs,
),
Field(
"nt",
int,
10,
10,
6,
**kwargs,
),
Field(
"bstart",
float,
20,
10,
0.01,
**kwargs,
),
Field(
"tramp",
float,
30,
10,
**kwargs,
),
Field(
"lcidk",
int,
40,
10,
**kwargs,
),
Field(
"ntk",
int,
50,
10,
6,
**kwargs,
),
Field(
"bstartk",
float,
60,
10,
0.01,
**kwargs,
),
Field(
"trampk",
float,
70,
10,
**kwargs,
),
],
),
Card(
[
Field(
"gi",
float,
0,
10,
**kwargs,
),
Field(
"betai",
float,
10,
10,
**kwargs,
),
Field(
"ki",
float,
20,
10,
**kwargs,
),
Field(
"betaki",
float,
30,
10,
**kwargs,
),
],
),
OptionCardSet(
option_spec = MatGeneralViscoelastic.option_specs[0],
cards = [
Card(
[
Field(
"title",
str,
0,
80,
kwargs.get("title")
),
],
),
],
**kwargs
),
]
@property
def mid(self) -> typing.Optional[int]:
"""Get or set the Material identification. A unique number has to be used.
""" # nopep8
return self._cards[0].get_value("mid")
@mid.setter
def mid(self, value: int) -> None:
"""Set the mid property."""
self._cards[0].set_value("mid", value)
@property
def ro(self) -> typing.Optional[float]:
"""Get or set the Mass density.
""" # nopep8
return self._cards[0].get_value("ro")
@ro.setter
def ro(self, value: float) -> None:
"""Set the ro property."""
self._cards[0].set_value("ro", value)
@property
def bulk(self) -> typing.Optional[float]:
"""Get or set the Elastic bulk modulus.
""" # nopep8
return self._cards[0].get_value("bulk")
@bulk.setter
def bulk(self, value: float) -> None:
"""Set the bulk property."""
self._cards[0].set_value("bulk", value)
@property
def pcf(self) -> typing.Optional[float]:
"""Get or set the Tensile pressure elimination flag for solid elements only. If set to unity tensile pressures are set to zero.
""" # nopep8
return self._cards[0].get_value("pcf")
@pcf.setter
def pcf(self, value: float) -> None:
"""Set the pcf property."""
self._cards[0].set_value("pcf", value)
@property
def ef(self) -> float:
"""Get or set the Elastic flag (if equal 1, the layer is elastic. If 0 the layer is viscoelastic).
""" # nopep8
return self._cards[0].get_value("ef")
@ef.setter
def ef(self, value: float) -> None:
"""Set the ef property."""
if value not in [0, 1, None]:
raise Exception("""ef must be `None` or one of {0,1}.""")
self._cards[0].set_value("ef", value)
@property
def tref(self) -> typing.Optional[float]:
"""Get or set the Reference temperature for shift function (must be greater than zero).
""" # nopep8
return self._cards[0].get_value("tref")
@tref.setter
def tref(self, value: float) -> None:
"""Set the tref property."""
self._cards[0].set_value("tref", value)
@property
def a(self) -> typing.Optional[float]:
"""Get or set the Coefficient for the Arrhenius and the Williams-Landau-Ferry shift function.
""" # nopep8
return self._cards[0].get_value("a")
@a.setter
def a(self, value: float) -> None:
"""Set the a property."""
self._cards[0].set_value("a", value)
@property
def b(self) -> typing.Optional[float]:
"""Get or set the Coefficient for Williams-Landau-Ferry shift function.
""" # nopep8
return self._cards[0].get_value("b")
@b.setter
def b(self, value: float) -> None:
"""Set the b property."""
self._cards[0].set_value("b", value)
@property
def lcid(self) -> typing.Optional[int]:
"""Get or set the Load curve ID for deviatoric behavior if constants, Gi , and bi are determined via a least squares fit.
""" # nopep8
return self._cards[1].get_value("lcid")
@lcid.setter
def lcid(self, value: int) -> None:
"""Set the lcid property."""
self._cards[1].set_value("lcid", value)
@property
def nt(self) -> int:
"""Get or set the Number of terms in shear fit (default = 6). Currently, the maximum number is set to 6.
""" # nopep8
return self._cards[1].get_value("nt")
@nt.setter
def nt(self, value: int) -> None:
"""Set the nt property."""
self._cards[1].set_value("nt", value)
@property
def bstart(self) -> float:
"""Get or set the In the fit, beta-1 is set to zero, beta-2 is set to BSTART, beta-3 is 10 times beta-2, beta-4 is 100 times greater than beta-3 , and so on (default = 0.01).
""" # nopep8
return self._cards[1].get_value("bstart")
@bstart.setter
def bstart(self, value: float) -> None:
"""Set the bstart property."""
self._cards[1].set_value("bstart", value)
@property
def tramp(self) -> typing.Optional[float]:
"""Get or set the Optional ramp time for loading.
""" # nopep8
return self._cards[1].get_value("tramp")
@tramp.setter
def tramp(self, value: float) -> None:
"""Set the tramp property."""
self._cards[1].set_value("tramp", value)
@property
def lcidk(self) -> typing.Optional[int]:
"""Get or set the Load curve ID for bulk behavior if constants, Ki , and beta-ki are determined via a least squares fit.
""" # nopep8
return self._cards[1].get_value("lcidk")
@lcidk.setter
def lcidk(self, value: int) -> None:
"""Set the lcidk property."""
self._cards[1].set_value("lcidk", value)
@property
def ntk(self) -> int:
"""Get or set the Number of terms desired in bulk fit (default = 6). Currently, the maximum number is set to 18.
""" # nopep8
return self._cards[1].get_value("ntk")
@ntk.setter
def ntk(self, value: int) -> None:
"""Set the ntk property."""
self._cards[1].set_value("ntk", value)
@property
def bstartk(self) -> float:
"""Get or set the In the fit, beta-k1 is set to zero, beta-k2 is set to BSTARTK, beta-k3 is 10 times beta-k2, beta-k4 is 100 times greater than beta-k3 , and so on (default =0.01)
""" # nopep8
return self._cards[1].get_value("bstartk")
@bstartk.setter
def bstartk(self, value: float) -> None:
"""Set the bstartk property."""
self._cards[1].set_value("bstartk", value)
@property
def trampk(self) -> typing.Optional[float]:
"""Get or set the Optional ramp time for bulk loading.
""" # nopep8
return self._cards[1].get_value("trampk")
@trampk.setter
def trampk(self, value: float) -> None:
"""Set the trampk property."""
self._cards[1].set_value("trampk", value)
@property
def gi(self) -> typing.Optional[float]:
"""Get or set the Optional shear relaxation modulus for the ith term. Define up to six cards. Define only, if card 2 is blank.
""" # nopep8
return self._cards[2].get_value("gi")
@gi.setter
def gi(self, value: float) -> None:
"""Set the gi property."""
self._cards[2].set_value("gi", value)
@property
def betai(self) -> typing.Optional[float]:
"""Get or set the Optional shear decay constant for the ith term.
""" # nopep8
return self._cards[2].get_value("betai")
@betai.setter
def betai(self, value: float) -> None:
"""Set the betai property."""
self._cards[2].set_value("betai", value)
@property
def ki(self) -> typing.Optional[float]:
"""Get or set the Optional bulk relaxation modulus for the ith term.
""" # nopep8
return self._cards[2].get_value("ki")
@ki.setter
def ki(self, value: float) -> None:
"""Set the ki property."""
self._cards[2].set_value("ki", value)
@property
def betaki(self) -> typing.Optional[float]:
"""Get or set the Optional bulk decay constant for the ith term.
""" # nopep8
return self._cards[2].get_value("betaki")
@betaki.setter
def betaki(self, value: float) -> None:
"""Set the betaki property."""
self._cards[2].set_value("betaki", value)
@property
def title(self) -> typing.Optional[str]:
"""Get or set the Additional title line
""" # nopep8
return self._cards[3].cards[0].get_value("title")
@title.setter
def title(self, value: str) -> None:
"""Set the title property."""
self._cards[3].cards[0].set_value("title", value)
if value:
self.activate_option("TITLE")
