Keyword

class ansys.chemkin.core.reactormodel.Keyword(phrase: str, value: float | bool | str, data_type: str)

A Chemkin style keyword.

Overview

Methods

show	Display the Chemkin keyword and its parameter value.
resetvalue	Reset the parameter value of an existing keyword.
parametertype	Get parameter type of the keyword.
getvalue_as_string	Create the keyword input line for Chemkin applications.

Properties

value	Get parameter value of the keyword.
keyphrase	Get the phrase of the keyword.
keyprefix	Get the status of the keyword.

Attributes

gasspecieskeywords
flowratekeywords
profilekeywords
fourspaces
no_fullkeyword

Static methods

setfullkeywords

Require all keywords and their parameters must be specified.

Import detail

from ansys.chemkin.core.reactormodel import Keyword

Property detail

property Keyword.value: int | float | bool | str

Get parameter value of the keyword.

property Keyword.keyphrase: str

Get the phrase of the keyword.

property Keyword.keyprefix: bool

Get the status of the keyword.

Attribute detail

Keyword.gasspecieskeywords = ['REAC', 'XEST', 'FUEL', 'OXID']

Keyword.flowratekeywords = ['FLRT', 'VDOT', 'VEL', 'SCCM']

Keyword.profilekeywords = ['TPRO', 'PPRO', 'VPRO', 'QPRO', 'AINT', 'AEXT', 'DPRO', 'FPRO', 'SCCMPRO', 'VDOTPRO', 'VELPRO',...

Keyword.fourspaces = '    '

Keyword.no_fullkeyword = True

Method detail

static Keyword.setfullkeywords(mode: bool)

Require all keywords and their parameters must be specified.

Keyword.show()

Display the Chemkin keyword and its parameter value.

Keyword.resetvalue(value: float | bool | str)

Reset the parameter value of an existing keyword.

Keyword.parametertype() → type

Get parameter type of the keyword.

Keyword.getvalue_as_string() → tuple[int, str]

Create the keyword input line for Chemkin applications.