solution_time

class ansys.api.pyensight.ensight_api.solution_time(session: Session)

Class wrapper for EnSight solution_time module

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

Methods

solution_time.begin_simtime(p0)	Sets the solution time to be used as the beginning/ending time for subsequent time use.
solution_time.begin_step(p0)	Sets the time step to be used as the beginning/ending time step for subsequent time use.
solution_time.convergence_value(p0)	Solution_time: convergence_value
solution_time.current_simtime(p0)	Sets the current simulation time.
solution_time.current_step(p0)	Sets the current time step.
solution_time.custom_timeline_begin(p0)	Solution_time: custom_timeline_begin
solution_time.custom_timeline_end(p0)	Solution_time: custom_timeline_end
solution_time.custom_timeline_readapply(p0)	Solution_time: custom_timeline_readapply
solution_time.end_simtime(p0)	Sets the solution time to be used as the beginning/ending time for subsequent time use.
solution_time.end_step(p0)	Sets the time step to be used as the beginning/ending time step for subsequent time use.
solution_time.increment(p0)	Sets the number of steps that are moved when the solution time dialog time stepper buttons are clicked.
solution_time.master_timeline(p0)	This command has not yet been documented.
solution_time.monitor_for_new_steps(p0)	Solution_time: monitor_for_new_steps
solution_time.number_of_cycles(p0)	Solution_time: #_of_cycles
solution_time.play_backward()	Causes the model to be displayed backward/forward through time.
solution_time.play_forward()	Causes the model to be displayed backward/forward through time.
solution_time.play_style()	Solution_time: play_style
solution_time.select_all_timesteps()	This command has not yet been documented.
solution_time.set_beg_to_min()	Solution_time: set_beg_to_min
solution_time.set_end_to_max()	Solution_time: set_end_to_max
solution_time.show_as(p0)	Sets method to use for specifying time - either as solution time directly or as time steps of data.
solution_time.step_backward()	Causes the model to be displayed at previous/next time.
solution_time.step_forward()	Causes the model to be displayed at previous/next time.
solution_time.stop()	Stops the model from being displayed through time.
solution_time.time_annotation(p0)	Sets whether time annotation will automatically be displayed on the screen during animation.
solution_time.timeset_between(p0)	When the current time lies between the steps of a given timeset, this command sets how to handle the situation in the span.
solution_time.timeset_leftof(p0)	When the current time lies before the beginning step of a given timeset, this command sets how to handle the situation.
solution_time.timeset_rightof(p0)	When the current time lies after the ending step of a given timeset, this command sets how to handle the situation.
solution_time.timeset_select(p0)	Selects the timeset to modify.
solution_time.timeset_update()	Updates the selected timeset and any associated display of the model according to the span handling methods specified.
solution_time.update_time_steps()	Solution_time: update_time_steps
solution_time.update_to_current()	Causes the display and all associated computations of the model to be updated to the currently specified time or step.
solution_time.update_to_first()	Causes the display and all associated computations of the model to be updated to the first time or step of the model.
solution_time.update_to_last()	Causes the display and all associated computations of the model to be updated to the last time or step of the model.
solution_time.update_type(p0)	Sets whether times or time steps can be specified between the data steps in the model, thus causing interpolation to be needed.
solution_time.use_custom_timeline(p0)	Solution_time: use_custom_timeline
solution_time.zoomin(p0, p1)	Solution_time: zoomin
solution_time.zoomout()	Resets the begin and end steps (or begin and end simtimes) to the widest possible settings.