# 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 RigidwallPlanarFiniteMovingForcesId class."""
import typing
from ansys.dyna.core.lib.card import Card, Field, Flag
from ansys.dyna.core.lib.keyword_base import KeywordBase
[docs]
class RigidwallPlanarFiniteMovingForcesId(KeywordBase):
"""DYNA RIGIDWALL_PLANAR_FINITE_MOVING_FORCES_ID keyword"""
keyword = "RIGIDWALL"
subkeyword = "PLANAR_FINITE_MOVING_FORCES_ID"
def __init__(self, **kwargs):
"""Initialize the RigidwallPlanarFiniteMovingForcesId class."""
super().__init__(**kwargs)
self._cards = [
Card(
[
Field(
"id",
int,
0,
10,
**kwargs,
),
Field(
"title",
str,
10,
70,
**kwargs,
),
],
),
Card(
[
Field(
"nsid",
int,
0,
10,
**kwargs,
),
Field(
"nsidex",
int,
10,
10,
0,
**kwargs,
),
Field(
"boxid",
int,
20,
10,
0,
**kwargs,
),
Field(
"offset",
float,
30,
10,
0.0,
**kwargs,
),
Field(
"birth",
float,
40,
10,
0.0,
**kwargs,
),
Field(
"death",
float,
50,
10,
1.0E+20,
**kwargs,
),
Field(
"rwksf",
float,
60,
10,
1.0,
**kwargs,
),
],
),
Card(
[
Field(
"xt",
float,
0,
10,
0.0,
**kwargs,
),
Field(
"yt",
float,
10,
10,
0.0,
**kwargs,
),
Field(
"zt",
float,
20,
10,
0.0,
**kwargs,
),
Field(
"xh",
float,
30,
10,
0.0,
**kwargs,
),
Field(
"yh",
float,
40,
10,
0.0,
**kwargs,
),
Field(
"zh",
float,
50,
10,
0.0,
**kwargs,
),
Field(
"fric",
float,
60,
10,
0.0,
**kwargs,
),
Field(
"wvel",
float,
70,
10,
0.0,
**kwargs,
),
],
),
Card(
[
Field(
"xhev",
float,
0,
10,
0.0,
**kwargs,
),
Field(
"yhev",
float,
10,
10,
0.0,
**kwargs,
),
Field(
"zhev",
float,
20,
10,
0.0,
**kwargs,
),
Field(
"lenl",
float,
30,
10,
0.0,
**kwargs,
),
Field(
"lenm",
float,
40,
10,
0.0,
**kwargs,
),
],
),
Card(
[
Field(
"mass",
float,
0,
10,
**kwargs,
),
Field(
"v0",
float,
10,
10,
0.0,
**kwargs,
),
],
),
Card(
[
Field(
"soft",
int,
0,
10,
0,
**kwargs,
),
Field(
"ssid",
int,
10,
10,
0,
**kwargs,
),
Field(
"n1",
int,
20,
10,
0,
**kwargs,
),
Field(
"n2",
int,
30,
10,
0,
**kwargs,
),
Field(
"n3",
int,
40,
10,
0,
**kwargs,
),
Field(
"n4",
int,
50,
10,
0,
**kwargs,
),
],
),
]
@property
def id(self) -> typing.Optional[int]:
"""Get or set the Optional Rigidwall ID.
""" # nopep8
return self._cards[0].get_value("id")
@id.setter
def id(self, value: int) -> None:
"""Set the id property."""
self._cards[0].set_value("id", value)
@property
def title(self) -> typing.Optional[str]:
"""Get or set the Ridigwall id descriptor. It is suggested that unique descriptions be used.
""" # nopep8
return self._cards[0].get_value("title")
@title.setter
def title(self, value: str) -> None:
"""Set the title property."""
self._cards[0].set_value("title", value)
@property
def nsid(self) -> typing.Optional[int]:
"""Get or set the Node set ID containing tracked nodes, see *SET_NODE_OPTION.
EQ.0: All nodes are tracked for interacting with the rigid wall.
""" # nopep8
return self._cards[1].get_value("nsid")
@nsid.setter
def nsid(self, value: int) -> None:
"""Set the nsid property."""
self._cards[1].set_value("nsid", value)
@property
def nsidex(self) -> int:
"""Get or set the Node set ID containing nodes that exempted as tracked nodes, see *SET_NODE_OPTION.
""" # nopep8
return self._cards[1].get_value("nsidex")
@nsidex.setter
def nsidex(self, value: int) -> None:
"""Set the nsidex property."""
self._cards[1].set_value("nsidex", value)
@property
def boxid(self) -> int:
"""Get or set the All nodes in box are included as tracked nodes for the interacting with ther rigid wall, see *DEFINE_BOX. If options NSID or NSIDEX are active then only the subset of nodes activated by these options are checked to see if they are within the box.
""" # nopep8
return self._cards[1].get_value("boxid")
@boxid.setter
def boxid(self, value: int) -> None:
"""Set the boxid property."""
self._cards[1].set_value("boxid", value)
@property
def offset(self) -> float:
"""Get or set the All nodes within a normal offset distance, OFFSET, to the rigid wall are included as tracked nodes for the rigid wall. If options NSID, NSIDEX, or BOXID are active then only the subset of nodes activated by these options are checked to see if they are within the offset distance.
""" # nopep8
return self._cards[1].get_value("offset")
@offset.setter
def offset(self, value: float) -> None:
"""Set the offset property."""
self._cards[1].set_value("offset", value)
@property
def birth(self) -> float:
"""Get or set the Birth time of rigid wall. The time values of the load curves that control the motion of the wall are offset by the birth time.
""" # nopep8
return self._cards[1].get_value("birth")
@birth.setter
def birth(self, value: float) -> None:
"""Set the birth property."""
self._cards[1].set_value("birth", value)
@property
def death(self) -> float:
"""Get or set the Death time of rigid wall. At this time the wall is deleted from the calculation
""" # nopep8
return self._cards[1].get_value("death")
@death.setter
def death(self, value: float) -> None:
"""Set the death property."""
self._cards[1].set_value("death", value)
@property
def rwksf(self) -> float:
"""Get or set the Stiffness scaling factor. If RWKSF is also specified in *CONTROL_ CONTACT, the stiffness is scaled by the product of the two values.
""" # nopep8
return self._cards[1].get_value("rwksf")
@rwksf.setter
def rwksf(self, value: float) -> None:
"""Set the rwksf property."""
self._cards[1].set_value("rwksf", value)
@property
def xt(self) -> float:
"""Get or set the x-coordinate of tail of any outward drawn normal vector, n, originating on wall (tail) and terminating in space (head).
""" # nopep8
return self._cards[2].get_value("xt")
@xt.setter
def xt(self, value: float) -> None:
"""Set the xt property."""
self._cards[2].set_value("xt", value)
@property
def yt(self) -> float:
"""Get or set the y-coordinate of tail of normal vector n.
""" # nopep8
return self._cards[2].get_value("yt")
@yt.setter
def yt(self, value: float) -> None:
"""Set the yt property."""
self._cards[2].set_value("yt", value)
@property
def zt(self) -> float:
"""Get or set the z-coordinate of tail of normal vector n
""" # nopep8
return self._cards[2].get_value("zt")
@zt.setter
def zt(self, value: float) -> None:
"""Set the zt property."""
self._cards[2].set_value("zt", value)
@property
def xh(self) -> float:
"""Get or set the x-coordinate of head of normal vector n
""" # nopep8
return self._cards[2].get_value("xh")
@xh.setter
def xh(self, value: float) -> None:
"""Set the xh property."""
self._cards[2].set_value("xh", value)
@property
def yh(self) -> float:
"""Get or set the y-coordinate of head of normal vector n.
""" # nopep8
return self._cards[2].get_value("yh")
@yh.setter
def yh(self, value: float) -> None:
"""Set the yh property."""
self._cards[2].set_value("yh", value)
@property
def zh(self) -> float:
"""Get or set the z-coordinate of head of normal vector n.
""" # nopep8
return self._cards[2].get_value("zh")
@zh.setter
def zh(self, value: float) -> None:
"""Set the zh property."""
self._cards[2].set_value("zh", value)
@property
def fric(self) -> float:
"""Get or set the Interface friction:
EQ.0.0: frictionless sliding after contact,
EQ.1.0: no sliding after contact, 0.0 < FRIC < 1.0: Coulomb friction coefficient,
EQ.2.0: node is welded after contact with frictionless sliding. Welding occurs if and only if the normal value of the impact velocity exceeds the critical value specified by WVEL,
EQ.3.0: node is welded after contact with no sliding. Welding occurs if and only if the normal value of the impact velocity exceeds the critical value specified by WVEL.
""" # nopep8
return self._cards[2].get_value("fric")
@fric.setter
def fric(self, value: float) -> None:
"""Set the fric property."""
self._cards[2].set_value("fric", value)
@property
def wvel(self) -> float:
"""Get or set the Critical normal velocity at which nodes weld to wall (FRIC = 2.0 or 3.0).
""" # nopep8
return self._cards[2].get_value("wvel")
@wvel.setter
def wvel(self, value: float) -> None:
"""Set the wvel property."""
self._cards[2].set_value("wvel", value)
@property
def xhev(self) -> float:
"""Get or set the x-coordinate of head of edge vector l.
""" # nopep8
return self._cards[3].get_value("xhev")
@xhev.setter
def xhev(self, value: float) -> None:
"""Set the xhev property."""
self._cards[3].set_value("xhev", value)
@property
def yhev(self) -> float:
"""Get or set the y-coordinate of head of edge vector l.
""" # nopep8
return self._cards[3].get_value("yhev")
@yhev.setter
def yhev(self, value: float) -> None:
"""Set the yhev property."""
self._cards[3].set_value("yhev", value)
@property
def zhev(self) -> float:
"""Get or set the z-coordinate of head of edge vector l.
""" # nopep8
return self._cards[3].get_value("zhev")
@zhev.setter
def zhev(self, value: float) -> None:
"""Set the zhev property."""
self._cards[3].set_value("zhev", value)
@property
def lenl(self) -> float:
"""Get or set the Length of l edge.
EQ.0.0: defines an infinite size plane.
""" # nopep8
return self._cards[3].get_value("lenl")
@lenl.setter
def lenl(self, value: float) -> None:
"""Set the lenl property."""
self._cards[3].set_value("lenl", value)
@property
def lenm(self) -> float:
"""Get or set the Length of m edge.
EQ.0.0: defines an infinite size plane.
""" # nopep8
return self._cards[3].get_value("lenm")
@lenm.setter
def lenm(self, value: float) -> None:
"""Set the lenm property."""
self._cards[3].set_value("lenm", value)
@property
def mass(self) -> typing.Optional[float]:
"""Get or set the Total mass of stonewall.
""" # nopep8
return self._cards[4].get_value("mass")
@mass.setter
def mass(self, value: float) -> None:
"""Set the mass property."""
self._cards[4].set_value("mass", value)
@property
def v0(self) -> float:
"""Get or set the Initial velocity of stonewall in direction of defining vector, n.
""" # nopep8
return self._cards[4].get_value("v0")
@v0.setter
def v0(self, value: float) -> None:
"""Set the v0 property."""
self._cards[4].set_value("v0", value)
@property
def soft(self) -> int:
"""Get or set the Number of cycles to zero relative velocity to reduce force spike
""" # nopep8
return self._cards[5].get_value("soft")
@soft.setter
def soft(self, value: int) -> None:
"""Set the soft property."""
self._cards[5].set_value("soft", value)
@property
def ssid(self) -> int:
"""Get or set the Segment set ID for defining areas for force output, see *SET_SEGMENT.
""" # nopep8
return self._cards[5].get_value("ssid")
@ssid.setter
def ssid(self, value: int) -> None:
"""Set the ssid property."""
self._cards[5].set_value("ssid", value)
@property
def n1(self) -> int:
"""Get or set the Optional nodal point for visualization in LS-DYNA database.
""" # nopep8
return self._cards[5].get_value("n1")
@n1.setter
def n1(self, value: int) -> None:
"""Set the n1 property."""
self._cards[5].set_value("n1", value)
@property
def n2(self) -> int:
"""Get or set the Optional nodal point for visualization in LS-DYNA database.
""" # nopep8
return self._cards[5].get_value("n2")
@n2.setter
def n2(self, value: int) -> None:
"""Set the n2 property."""
self._cards[5].set_value("n2", value)
@property
def n3(self) -> int:
"""Get or set the Optional nodal point for visualization in LS-DYNA database.
""" # nopep8
return self._cards[5].get_value("n3")
@n3.setter
def n3(self, value: int) -> None:
"""Set the n3 property."""
self._cards[5].set_value("n3", value)
@property
def n4(self) -> int:
"""Get or set the Optional nodal point for visualization in LS-DYNA database.
""" # nopep8
return self._cards[5].get_value("n4")
@n4.setter
def n4(self, value: int) -> None:
"""Set the n4 property."""
self._cards[5].set_value("n4", value)
