pyturbogrid_core#

Module in the ansys-turbogrid-api package that is internally used by modules in the pyturbogrid package for interactions with a running Ansys TurboGrid application.

Classes:

PyTurboGrid(socket_port, ...[, log_level, ...])

This class enables you to launch, interact with, and quit, a session of TurboGrid.

class ansys.turbogrid.api.pyturbogrid_core.PyTurboGrid(socket_port: int | None, turbogrid_location_type: TurboGridLocationType, cfxtg_location, additional_args_str: str | None, additional_kw_args: dict | None, log_level=TurboGridLogLevel.INFO, host_ip: str = '127.0.0.1', pim_app_name: str = 'turbogrid', pim_app_ver: str = '241', log_filename_suffix: str = '')#

This class enables you to launch, interact with, and quit, a session of TurboGrid. Refer to the launcher module to see how to create an instance of this class.

Attributes:

Classes:

`TurboGridLocationType`(value)	Specifies whether the PyTurboGrid class should launch TurboGrid from the given location, or connect to a running session of TurboGrid.
`TurboGridLogLevel`(value)	Controls which logging messages are reported.

Methods:

`__init__`(socket_port, ...[, log_level, ...])
`end_session`()	Stop recording a session file.
`getBoundaryGeometry`([prefix_string])
`getTGInitTopology`(tginit_path[, ...])
`get_object_param`(object, param)	Returns the parameter value.
`get_version`()	Get the version of the application which is being run in the current session.
`query_average_background_face_area`()	Returns the average background face area, averaged again from the hub, midspan and shroud.
`query_average_base_face_area`()	Returns the average base face area, averaged again from each layer.
`query_mesh_statistics`([domain])	Returns mesh quality measures from TurboGrid for the current session and specified domain.
`query_mesh_statistics_histogram_data`(variable)	Returns data that can be used to plot mesh statistics histograms.
`query_number_of_spanwise_elements`()	Returns the total number of elements in the spanwise direction.
`query_valid_topology_choices`()	Returns the permitted topology methods for the blade geometry in the current session.
`quit`()	Quit the application instance.
`read_inf`(filename)	Read a blade model from a BladeGen *.inf file.
`read_ndf`(ndffilename[, cadfilename, ...])	Read a blade model from an NDF (*.ndf) file.
`read_session`(filename)	Read a session file to repeat a previous session.
`read_state`(filename)	Restore a previous state from a saved state file.
`read_tginit`(path[, bladerow])	Read a blade row from a *.tginit file.
`save_image`(filename[, format])	Save the current contents of the viewer window to a file.
`save_mesh`(filename[, onefile, onedomain])	Save generated mesh to a file.
`save_state`(filename)	Save the current state into a file.
`send_ccl`(ccl)	Send the provided CCL to the application.
`set_global_size_factor`(global_size_factor)	Set the global size factor.
`set_inlet_hub_position`(parametric_hub_location)	Set the parametric position of the inlet line on the hub.
`set_inlet_shroud_position`(...)	Set the parametric position of the inlet line on the shroud.
`set_obj_param`(object, param_val_pairs)	Update the value for a CCL object parameter.
`set_outlet_hub_position`(parametric_hub_location)	Set the parametric position of the outlet line on the hub.
`set_outlet_shroud_position`(...)	Set the parametric position of the outlet line on the shroud.
`set_topology_choice`(atm_topology_choice)	Set the topology method to be used for the topology set generation process.
`set_topology_list`(atm_topology_list)	Set the list of topology pieces to be used for topology generation.
`start_session`(filename)	Start recording a new session.
`suspend`(object)	Suspend a TurboGrid object.
`unsuspend`(object)	Unsuspend a TurboGrid object.

QUERY_ERROR_PREFIX = 'ERROR:'#

class TurboGridLocationType(value)#

Specifies whether the PyTurboGrid class should launch TurboGrid from the given location, or connect to a running session of TurboGrid. :member-order: bysource

Attributes:

`TURBOGRID_ANSYS_LABS`
`TURBOGRID_INSTALL`
`TURBOGRID_RUNNING_CONTAINER`
`denominator`	the denominator of a rational number in lowest terms
`imag`	the imaginary part of a complex number
`numerator`	the numerator of a rational number in lowest terms
`real`	the real part of a complex number

Methods:

`as_integer_ratio`()	Return integer ratio.
`bit_count`()	Number of ones in the binary representation of the absolute value of self.
`bit_length`()	Number of bits necessary to represent self in binary.
`conjugate`	Returns self, the complex conjugate of any int.
`from_bytes`(byteorder, *[, signed])	Return the integer represented by the given array of bytes.
`to_bytes`(length, byteorder, *[, signed])	Return an array of bytes representing an integer.

TURBOGRID_ANSYS_LABS = 2#

TURBOGRID_INSTALL = 0#

TURBOGRID_RUNNING_CONTAINER = 1#

as_integer_ratio()#

Return integer ratio.

Return a pair of integers, whose ratio is exactly equal to the original int and with a positive denominator.

>>> (10).as_integer_ratio()
(10, 1)
>>> (-10).as_integer_ratio()
(-10, 1)
>>> (0).as_integer_ratio()
(0, 1)

bit_count()#

Number of ones in the binary representation of the absolute value of self.

Also known as the population count.

>>> bin(13)
'0b1101'
>>> (13).bit_count()
3

bit_length()#

Number of bits necessary to represent self in binary.

>>> bin(37)
'0b100101'
>>> (37).bit_length()
6

conjugate()#: Returns self, the complex conjugate of any int.

denominator#: the denominator of a rational number in lowest terms

from_bytes(byteorder, *, signed=False)#

Return the integer represented by the given array of bytes.

bytes: Holds the array of bytes to convert. The argument must either support the buffer protocol or be an iterable object producing bytes. Bytes and bytearray are examples of built-in objects that support the buffer protocol.
byteorder: The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.
signed: Indicates whether two’s complement is used to represent the integer.

imag#: the imaginary part of a complex number

numerator#: the numerator of a rational number in lowest terms

real#: the real part of a complex number

to_bytes(length, byteorder, *, signed=False)#

Return an array of bytes representing an integer.

length: Length of bytes object to use. An OverflowError is raised if the integer is not representable with the given number of bytes.
byteorder: The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.
signed: Determines whether two’s complement is used to represent the integer. If signed is False and a negative integer is given, an OverflowError is raised.

class TurboGridLogLevel(value)#

Controls which logging messages are reported. The higher values report the fewest messages. :member-order: bysource

Attributes:

`CRITICAL`
`DEBUG`
`ERROR`
`INFO`
`NETWORK_DEBUG`
`NOTSET`
`WARNING`
`denominator`	the denominator of a rational number in lowest terms
`imag`	the imaginary part of a complex number
`numerator`	the numerator of a rational number in lowest terms
`real`	the real part of a complex number

Methods:

`as_integer_ratio`()	Return integer ratio.
`bit_count`()	Number of ones in the binary representation of the absolute value of self.
`bit_length`()	Number of bits necessary to represent self in binary.
`conjugate`	Returns self, the complex conjugate of any int.
`from_bytes`(byteorder, *[, signed])	Return the integer represented by the given array of bytes.
`to_bytes`(length, byteorder, *[, signed])	Return an array of bytes representing an integer.

CRITICAL = 50#

DEBUG = 10#

ERROR = 40#

INFO = 20#

NETWORK_DEBUG = 15#

NOTSET = 0#

WARNING = 30#

as_integer_ratio()#

Return integer ratio.

Return a pair of integers, whose ratio is exactly equal to the original int and with a positive denominator.

>>> (10).as_integer_ratio()
(10, 1)
>>> (-10).as_integer_ratio()
(-10, 1)
>>> (0).as_integer_ratio()
(0, 1)

bit_count()#

Number of ones in the binary representation of the absolute value of self.

Also known as the population count.

>>> bin(13)
'0b1101'
>>> (13).bit_count()
3

bit_length()#

Number of bits necessary to represent self in binary.

>>> bin(37)
'0b100101'
>>> (37).bit_length()
6

conjugate()#: Returns self, the complex conjugate of any int.

denominator#: the denominator of a rational number in lowest terms

from_bytes(byteorder, *, signed=False)#

Return the integer represented by the given array of bytes.

bytes: Holds the array of bytes to convert. The argument must either support the buffer protocol or be an iterable object producing bytes. Bytes and bytearray are examples of built-in objects that support the buffer protocol.
byteorder: The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.
signed: Indicates whether two’s complement is used to represent the integer.

imag#: the imaginary part of a complex number

numerator#: the numerator of a rational number in lowest terms

real#: the real part of a complex number

to_bytes(length, byteorder, *, signed=False)#

Return an array of bytes representing an integer.

length: Length of bytes object to use. An OverflowError is raised if the integer is not representable with the given number of bytes.
byteorder: The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.
signed: Determines whether two’s complement is used to represent the integer. If signed is False and a negative integer is given, an OverflowError is raised.

__init__(socket_port: int | None, turbogrid_location_type: TurboGridLocationType, cfxtg_location, additional_args_str: str | None, additional_kw_args: dict | None, log_level=TurboGridLogLevel.INFO, host_ip: str = '127.0.0.1', pim_app_name: str = 'turbogrid', pim_app_ver: str = '241', log_filename_suffix: str = '')#

already_exited = False#

app_name = 'App'#

block_each_message: bool = False#

client_socket: socket = 0#

console_log_file: TextIOWrapper = 0#

end_session()#: Stop recording a session file.

engine_ccl_observers: Set[ICCLChangeObserver] = {}#

engine_incoming_error_queue: <module 'queue' from '/opt/hostedtoolcache/Python/3.10.16/x64/lib/python3.10/queue.py'> = 0#

engine_incoming_message_queue: <module 'queue' from '/opt/hostedtoolcache/Python/3.10.16/x64/lib/python3.10/queue.py'> = 0#

engine_proc: Popen = 0#

engine_ready: bool = False#

getBoundaryGeometry(prefix_string: str = '') → list[any]#

getTGInitTopology(tginit_path: str, transformIOToLines: bool = False) → dict[str, any]#

get_object_param(object: str, param: str) → str#

Returns the parameter value.

Parameters#

objectstr: Name with full path for the CCL object.
paramstr: Name of the parameter to get.

Returns#

str: The parameter value.

get_version() → str#: Get the version of the application which is being run in the current session.

Returns#

The application version e.g. ‘24.1’.

host_ip: str = '127.0.0.1'#

log_filename_suffix: str = ''#

outgoing_log_file: TextIOWrapper = 0#

print_messages_in_console: bool = False#

proc_port: int | None = None#

process_log_file: TextIOWrapper = 0#

pyengine_log_level: ServerLogLevel = 20#

query_average_background_face_area() → float#

Returns the average background face area, averaged again from the hub, midspan and shroud.

Returns#

float: Average Area in base units ^ 2.

query_average_base_face_area() → float#

Returns the average base face area, averaged again from each layer.

Returns#

float: Average Area in base units ^ 2.

query_mesh_statistics(domain: str = 'ALL') → dict#

Returns mesh quality measures from TurboGrid for the current session and specified domain. Note: It is suggested to use the mesh_statistics module instead of directly calling this.

Parameters#

domainstr, default: "ALL": Name of the domain from which to obtain the measurements.

Returns#

dict: A dictionary form of the quality measurements.

query_mesh_statistics_histogram_data(variable: str, domain: str = 'ALL', number_of_bins: int = 20, upper_bound: float | None = None, lower_bound: float | None = None, bin_units: str = '', scale: str = 'Linear', use_absolute_values: bool = False, bin_divisions: list | None = None) → dict#

Returns data that can be used to plot mesh statistics histograms.

Parameters#

variablestr: Name of the quality measurement to query from the statistics.
domainstr, default: "ALL": Name of the domain from which to obtain the measuments.
number_of_binsint, default: 20: Number of histogram columns to use.
upper_boundfloat, default: None: The maximum limit for the horizontal axis.
lower_boundfloat, default: None: The minimum limit for the horizontal axis.
bin_unitsstr, default: "": The unit to use for the horizontal axis.
scalestr, default: "Linear": Scaling type for the horizontal axis: “linear” or “logarithmic”.
use_absolute_valuesbool, default: False: Choice of whether to use absolute or percentage values on the vertical axis.
bin_divisionslist, default: None: User-provided bin divisions.

Returns#

dict: A dictionary form of the statistics for the requested quality measurement.

query_number_of_spanwise_elements() → int#

Returns the total number of elements in the spanwise direction.

Returns#

int: Number of elements.

query_valid_topology_choices() → list#

Returns the permitted topology methods for the blade geometry in the current session.

Returns#

list: List of topology method names.

quit()#: Quit the application instance.

read_inf(filename: str)#

Read a blade model from a BladeGen *.inf file.

Parameters#

filenamestr: Name or path for the Bladegen *.inf file.

read_message_process: CUEEngineReadMessageService = 0#

read_ndf(ndffilename: str, cadfilename: str = '', flowpath: str = '', bladerow: str = '', bladename: str = '')#

Read a blade model from an NDF (*.ndf) file. TurboGrid uses the details in the NDF file to generate and import a CAD file containing the blade geometry.

Parameters#

ndffilenamestr: Name or path for the NDF (*.ndf) file.
cadfilenamestr, default: "": Name of the CAD *.x_b file to be generated.
flowpathstr, default: "": Name of the flowpath to use.
bladerowstr, default: "": Name of the blade row to select.
bladenamestr, default: "": Name of the blade to load.

read_session(filename: str)#

Read a session file to repeat a previous session.

Parameters#

filenamestr: Name of the session file.

read_state(filename: str)#

Restore a previous state from a saved state file.

Parameters#

filenamestr: Name of the state file.

read_tginit(path: str, bladerow: str = '')#

Read a blade row from a *.tginit file.

Parameters#

pathstr: Name or path for the *.tginit file.
bladerowstr: Optional blade row to be read, no entry corresponds to the first blade row.

run_read_message_process: bool = True#

run_send_message_process: bool = True#

save_image(filename: str, format: str = 'png')#

Save the current contents of the viewer window to a file.

Parameters#

filenamestr

Name of the image file to be created.

formatstr, default: "png"

Format of the saved image. Valid values are:

“png”: PNG
“avz”: AVZ (3D)
“glb2: GLB (3D) (Beta)
“jpg”: JPEG
“ppm”:PPM
“ps”: PostScript (incomplete support)
“eps”: Encapsulated PS (incomplete support)

save_mesh(filename: str, onefile: bool = True, onedomain: bool = True)#

Save generated mesh to a file.

Parameters#

filenamestr: Name of the mesh file to save.
onefilebool, default: True: If enabled (true), write all of the available meshes to a single mesh file.
onedomainbool, default: True: If enabled (true), combine any inlet and outlet domain meshes with the passage domain, to form a single assembly.

save_state(filename: str)#

Save the current state into a file.

Parameters#

filenamestr: Name of the file to save.

send_ccl(ccl: str) → bool#

Send the provided CCL to the application.

Parameters#

cclstr: The CCL to send.

send_message_process: CUEEngineSendMessageService = 0#

set_global_size_factor(global_size_factor: str)#

Set the global size factor.

Parameters#

global_size_factorstr: Value to use as size factor in string format.

set_inlet_hub_position(parametric_hub_location: str)#

Set the parametric position of the inlet line on the hub.

Parameters#

parametric_hub_locationstr: Value to be used as parametric location in string format.

set_inlet_shroud_position(parametric_shroud_location: str)#

Set the parametric position of the inlet line on the shroud.

Parameters#

parametric_shroud_locationstr: Value to be used as parametric location in string format.

set_obj_param(object: str, param_val_pairs: str)#

Update the value for a CCL object parameter.

Parameters#

objectstr: Name with full path for the CCL object.
param_val_pairsstr: Name and value pair for the parameter to set.

set_outlet_hub_position(parametric_hub_location: str)#

Set the parametric position of the outlet line on the hub.

Parameters#

parametric_hub_locationstr: Value to be used as parametric location in string format.

set_outlet_shroud_position(parametric_shroud_location: str)#

Set the parametric position of the outlet line on the shroud.

Parameters#

parametric_shroud_locationstr: Value to be used as parametric location in string format.

set_topology_choice(atm_topology_choice: str)#

Set the topology method to be used for the topology set generation process.

Example

>>> turbogrid.set_topology_choice("Single Round Round Refined")

Parameters#

atm_topology_choicestr: Name of the topology method to be used.

set_topology_list(atm_topology_list: str)#

Set the list of topology pieces to be used for topology generation.

Example

>>> turbogrid.set_topology_list("LECircleHigh_TECircleLow")

Parameters#

atm_topology_liststr: The topology piece names concatenated using underscores.

start_session(filename: str)#

Start recording a new session.

Parameters#

filenamestr: Name of the session file.

suspend(object: str)#

Suspend a TurboGrid object.

Parameters#

objectstr: String specifying the name and type of the object to be suspended.

unsuspend(object: str)#

Unsuspend a TurboGrid object.

Parameters#

objectstr: String specifying the name and type of the object to be unsuspended.

`QUERY_ERROR_PREFIX`
`already_exited`
`app_name`
`block_each_message`
`client_socket`
`console_log_file`
`engine_ccl_observers`
`engine_incoming_error_queue`
`engine_incoming_message_queue`
`engine_proc`
`engine_ready`
`host_ip`
`log_filename_suffix`
`outgoing_log_file`
`print_messages_in_console`
`proc_port`
`process_log_file`
`pyengine_log_level`
`read_message_process`
`run_read_message_process`
`run_send_message_process`
`send_message_process`