Reader

class ansys.pyensight.core.libuserd.Reader(userd: LibUserd, pb: Reader)

This class represents is an instance of a user-defined reader that is actively reading a dataset.

Parameters:

userd

The LibUserd instance this query is associated with.

pb

The protobuffer that represents this object.

Attributes:

unit_systemstr

The units system provided by the dataset.

metadataDict[str, str]

The metadata for this query.

reader_api_versionfloat

The reader USERD API version number

number_of_ranksint

The number of ranks being used by the dataset reader

Notes

There can only be one reader active in a single LibUserd instance.

Methods

Reader.dynamic_update_check(changes_allowed)	When this method is called, it allows the reader to change aspects of dataset.
Reader.get_number_of_time_sets()	Get the number of timesets in the dataset.
Reader.is_geometry_changing()	Check to see if the geometry in this dataset is changing.
Reader.parts()	Get a list of the parts this reader can access.
Reader.queries()	Get a list of the queries this reader can access.
Reader.set_timestep(timestep[, timeset])	Change the current time to the specified timestep.
Reader.set_timevalue(timevalue[, timeset])	Change the current time within the selected timeset to the specified value.
Reader.timevalues([timeset])	Get a list of the time step values in this dataset for the specified timeset.
Reader.variable_value(variable[, rank])	For any "case" variable (e.g. time), the value of the variable.
Reader.variables()	Get a list of the variables this reader can access.