data#

class ansys.api.pyensight.ensight_api.data(session: Session)#

Class wrapper for EnSight data module

This class acts as a proxy for the EnSight Python module ensight.data

Methods

data.add(p0)

Adds a new case and reads the given filename via the extension-to-reader mapping file (ensight_reader_extension.map).

data.binary_files_are(p0)

Sets the byte (endian) order for binary geometry, result, and measured data files.

data.boundary(p0)

Specify the name for the boundary file.

data.format(p0)

Set the format type for the geometry and result files.

data.geometry(p0)

Set the name for the file containing geometric information.

data.mcfile_begin(args)

Data: mcfile_begin

data.mcfile_end()

Data: mcfile_end

data.mcfile_generate(p0)

Data: mcfile_generate

data.mcfile_name(p0)

Data: mcfile_name

data.measured(p0)

Specify the name for the measured particle file.

data.multiple_case_read(p0)

Data: multiple_case_read

data.native_binary(p0)

Data: native_binary

data.new_static_done(p0)

Informs the client that the static data files have been modified.

data.new_static_ready()

Informs the client that the static data files are about to be modified.

data.new_time(p0)

Informs client that a new transient time step is available

data.new_transient_time(p0)

Informs client of last transient time step available

data.newviewport_on_add(p0)

Data: newviewport_on_add

data.path(p0)

Specify the directory under which the data files are located.

data.plot3ddimension(p0)

When the format is plot3d, specifies the dimensionality of the data.

data.plot3diblank(p0)

When the format is plot3d, specifies the iblanking value for the geometry file.

data.plot3dmulti_zone(p0)

When the format is plot3d, specifies that the file is single or multi zone.

data.plot3dread_as(p0)

When the format is plot3d, specifies how the file is formatted.

data.read()

Read the geometry, result, and/or measured data files.

data.read_all()

This command has not yet been documented.

data.read_gui()

Data: read_gui

data.reader_option(p0)

Set user defined reader (UDR) optional flag.

data.replace(p0)

Replaces the current case and reads the given filename via the extension-to-reader mapping file (ensight_reader_extension.map).

data.resource(p0)

Sets the resource file name that will be passed to the EnSigtht SOS for reading and processing.

data.result(p0)

Set the name for the file containing result information.

data.select_case_begin()

Data: select_case_begin

data.select_case_end()

Data: select_case_end

data.shift_time(p0, p1, p2)

This command has not yet been documented.

data.sos_auto_distrib(p0)

When using EnSight SOS data can be automatically decomposed by either the EnSight server or by User Defined Readers which implement this capability (e.g. Silo, ExodusII, CTH).

data.sos_decompose_type(p0)

Data: sos_decompose_type

data.sos_pass_wildcards(p0)

Depending upon which data format is selected for use with SOS and with EnSight resources, a file name may contain wild card symbols ('*').

data.start_time(p0)

When reading transient data load the timestep indicated as the initial time step.
On this page
Show Source