ansys.dyna.core.lib.option_card

Classes

OptionSpec
OptionCardSet	Abstract base class for all the implementations of keyword cards.
OptionsInterface	Abstract base class for option card api interface.
OptionAPI	API for an individual option associated with a keyword.
Options	Option collection associated with an options API.

Module Contents

class ansys.dyna.core.lib.option_card.OptionSpec(name: str, card_order: int, title_order: int)

property name: str

property card_order: int

property title_order: int

__repr__() → str

class ansys.dyna.core.lib.option_card.OptionCardSet(option_spec: OptionSpec, cards: List[ansys.dyna.core.lib.card_interface.CardInterface], **kwargs)

Bases: ansys.dyna.core.lib.card_interface.CardInterface

Abstract base class for all the implementations of keyword cards.

property cards: List[ansys.dyna.core.lib.card_interface.CardInterface]

property option_spec: OptionSpec

property name: str

property title_order: int

property card_order: int

property active: bool

Return whether the card is active.

property format: ansys.dyna.core.lib.format_type.format_type

Get the card format type.

__hash__()

__lt__(other: OptionCardSet)

read(buf: TextIO, parameter_set: ansys.dyna.core.lib.parameters.ParameterSet = None) → bool

Read from buf.

write(format: ansys.dyna.core.lib.format_type.format_type | None = None, buf: TextIO | None = None, comment: bool | None = True) → str | None

Renders the card in the dyna keyword format. :param buf: Buffer to write to. If None, the output is returned as a string :param format: format_type to use. Default to standard.

class ansys.dyna.core.lib.option_card.OptionsInterface

Abstract base class for option card api interface.

abstractmethod get_option_spec(name: str) → OptionSpec

abstractmethod deactivate_option(name: str) → None

abstractmethod activate_option(name: str) → None

abstractmethod is_option_active(name: str) → bool

property option_specs: Iterable[OptionSpec]

Abstractmethod:

Get the card format type.

class ansys.dyna.core.lib.option_card.OptionAPI(options_api: OptionsInterface, name: str)

API for an individual option associated with a keyword.

property active: bool

class ansys.dyna.core.lib.option_card.Options(api: OptionsInterface)

Option collection associated with an options API.

__getitem__(name: str) → OptionAPI

Gets the option with the given name.

__repr__() → str

property api: OptionsInterface