majordome.fluent

majordome.fluent#

Generation of TSV files#

class majordome.fluent.FluentInputRow(name: str, value: str, unit: str = '', kind: str = '', inpar: bool = False, outpar: bool = False, descr: str = '')#

Fluent TSV file data entry for automated parameter generation.

Parameters:
name: str

Name of parameter, no spaces allowed.

value: str

String representation of the value, if required with units.

unit: str = “”

Units of parameter.

kind: str = “”

Unit family of parameter.

inpar: bool = False

Whether to use parameter as a design input parameter.

outpar: bool = False

Whether to use parameter as a design output parameter.

descr: str = “”

A short description of the parameter.

property name#

Provides access to entry name.

class majordome.fluent.FluentInputFile(rows: list[FluentInputRow], sort_list: bool = False)#

Representation of an Ansys Fluent expressions input file.

Attributes:
HEADtuple[str]

Tuple containing TSV file headers.

append(row: FluentInputRow)#

Append a single row to the inputs file.

to_file(saveas: str, overwrite: bool = False)#

Generate Fluent input file.

Parsing Scheme data#

class majordome.fluent.FluentSchemePatch(row: str)#

Parse patch name from a Scheme file.

property index: int#

Provides access to patch index.

property name: str#

Provides access to patch name.

class majordome.fluent.FluentSchemeHeader(row: str)#

Parse header row from a Scheme table file.

property names: list[str]#

Provides access to column names.

class majordome.fluent.FluentSchemeTableRow(row: str)#

Parse data row from a Scheme table file.

property values: list[float]#

Provides access to row data.

class majordome.fluent.FluentDpmFile(fname: str)#

Parse a sampled Scheme DPM file generated by Fluent.

to_dataframe()#

Convert parsed data to a data frame for analysis.

Others#

majordome.fluent.convert_xy_to_dict(fname: str | Path) → dict[int, dict[str, list[float]]]#

Convert Ansys XY format to a dictionary structure.

Parameters:
fname: str | Path

Path to “.xy” file to be converted by function.

Returns:
dict[int, dict[str, list[float]]]

A dictionary with each particle from pathlines transformed into a dictionary of coordinates X and Y.

majordome.fluent.load_dpm_table(fname: str) → DataFrame#

Wrapper for simple loading of data table.

Contents