ptrace

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

Class wrapper for EnSight ptrace module

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

Methods

ptrace.add_bypart(args)	This command has not yet been documented.
ptrace.add_bypartname(p0, p1, p2)	This command has not yet been documented.
ptrace.add_default_bypart(args)	Ptrace: add_default_bypart
ptrace.add_default_file(p0)	Ptrace: add_default_file
ptrace.add_default_net(p0, p1)	Ptrace: add_default_net
ptrace.add_default_pt()	Ptrace: add_default_pt
ptrace.add_default_rake(p0)	Ptrace: add_default_rake
ptrace.add_default_surface_net(p0, p1, p2, ...)	Ptrace: add_default_surface_net
ptrace.add_default_surface_pt(p0, p1)	Ptrace: add_default_surface_pt
ptrace.add_default_surface_rake(p0, p1, p2, ...)	Ptrace: add_default_surface_rake
ptrace.add_file(p0)	Adds emitters (and thus more traces) to the current particle trace part(s) according to the time and locations as defined in the file.
ptrace.add_net(p0, p1)	Add emitters (and thus more traces) to the current particle trace part(s) from
ptrace.add_part(p0)	Ptrace: add_part
ptrace.add_partbyname(p0)	Ptrace: add_partbyname
ptrace.add_pt()	Adds emitters (and thus more traces) to the current particle trace part(s) from the current location of the cursor (a point).
ptrace.add_rake(p0)	Add emitters (and thus more traces) to the current particle trace part(s) from the current line tool.
ptrace.add_surface_net(p0, p1, p2, p3, p4, p5)	Add emitters (and thus more traces) to the current particle trace part(s) from the grid of a screen box pick.
ptrace.add_surface_pt(p0, p1)	Adds emitters (and thus more traces) to the current surface restricted particle trace part(s) from a screen point pick location.
ptrace.add_surface_rake(p0, p1, p2, p3, p4)	Add emitters (and thus more traces) to the current surface restricted particle trace part(s) from a screen pick rake location.
ptrace.animate(p0)	Toggles particle trace animation on or off for selected traces.
ptrace.arrow_size(p0)	Specify the size of arrowheads to show along particle traces.
ptrace.arrows(p0)	Specify the type of arrowheads to show along particle traces.
ptrace.begin()	Delimit the modifications for particle trace attributes.
ptrace.color_emission(p0, p1, p2, p3)	Ptrace: color_emission
ptrace.component(p0, p1, p2)	Specifies the contribution of the components of the flow field vector variable through which the particle trace will be integrated.
ptrace.compute_using_periodicity(p0)	Ptrace: compute_using_periodicity
ptrace.create_bypart(*args, **kwargs)	Ptrace: create_bypart
ptrace.create_bypartname(p0, p1, p2)	Create a particle trace from the nodes of a part, where the part is referred to by name.
ptrace.create_default()	Ptrace: create_default
ptrace.create_file(p0)	Create particle traces from the current location of the line tool.
ptrace.create_net(p0, p1)	Create particle traces from the plane tool.
ptrace.create_node_track()	This command has not yet been documented.
ptrace.create_part(p0)	Ptrace: create_part
ptrace.create_partbyname(p0)	Ptrace: create_partbyname
ptrace.create_pt()	Create a particle trace from the current location of the cursor (a point).
ptrace.create_rake(p0)	Create particle traces from the current location of the line tool.
ptrace.create_surface_net(p0, p1, p2, p3, p4, p5)	Create surface restricted particle traces from a screen box pick.
ptrace.create_surface_pt(p0, p1)	Create a surface restricted particle trace from a screen point pick location.
ptrace.create_surface_rake(p0, p1, p2, p3, p4)	Create surface restricted particle traces from a screen pick rake location.
ptrace.create_varmax_track()	This command has not yet been documented.
ptrace.create_varmin_track()	This command has not yet been documented.
ptrace.default_emit_bypart(*args, **kwargs)	This command has not yet been documented.
ptrace.default_emit_bypartname(p0, p1, p2)	This command has not yet been documented.
ptrace.default_emit_file(p0)	Set the default filename for file emitters and sets the user interface Emit From option to be File.
ptrace.default_emit_net(p0, p1)	Set the default number of x and y grid points for net emitters, and sets the user interface Emit From option to be Plane.
ptrace.default_emit_part(p0)	Ptrace: default_emit_part
ptrace.default_emit_partbyname(p0)	Ptrace: default_emit_partbyname
ptrace.default_emit_pt()	Set the user interface Emit From option to be Cursor.
ptrace.default_emit_rake(p0)	Set the default number of emission points for rake emitters, and sets the user interface Emit From option to be Line.
ptrace.delete_emitter()	Remove emitters from a particle trace part (and their associated traces).
ptrace.delta_time(p0)	Specifies the time interval between emissions from the emitters.
ptrace.display_offset(p0)	Sets the distance normal to the surface at which the surface restricted trace will be displayed.
ptrace.dummy_chng_slot(args)	Ptrace: dummy_chng_slot
ptrace.elt_part(p0)	Ptrace: elt_part
ptrace.elt_partbyname(p0)	Ptrace: elt_partbyname
ptrace.emit_at_current_time(p0)	Sets the emission time for a particle trace to be current time when the particle trace is created.
ptrace.emit_density(p0)	Ptrace: emit_density
ptrace.end()	Delimit the modifications for particle trace attributes.
ptrace.hide_emission(p0)	Ptrace: hide_emission
ptrace.massed_ballistic_coef(p0)	If the massed_use_ballistic toggle is ON then this is the ballistic coefficient to use
ptrace.massed_buoyancy(p0)	This command has not yet been documented.
ptrace.massed_coef_friction(p0)	Set the coefficient of friction for use with the massed particle rebound capability
ptrace.massed_coef_restitution(p0)	Set the coefficient of restitution for use with the massed particle rebound capability
ptrace.massed_drag(p0)	Specify whether the drag force term is used in the massed-particle calculation.
ptrace.massed_drag_coefficient(p0)	Specify the name of the drag coefficient function table to be used in the drag force term of the massed-particle calculation.
ptrace.massed_fluid_density(p0)	Specify the density of the corresponding fluid field where the massed-particles are traced.
ptrace.massed_fluid_viscosity(p0)	Specify the dynamic viscosity of the corresponding fluid field where the massed-particles are traced.
ptrace.massed_gravity(p0)	Specify whether the gravity force term is used in the massed-particle calculation.
ptrace.massed_gravity_vector(p0, p1, p2)	Specify the name of the gravity vector used in the pressure force term of the massed-particle calculation.
ptrace.massed_initial_use_fluid(p0)	Specify whether to use the velocity of the fluid at the particle emitter location as the initial velocity of the massed-particle.
ptrace.massed_initial_velocity(p0, p1, p2)	Specify the initial emitter velocity vector to be used on all the massed-particles.
ptrace.massed_particle_density(p0)	Specify the density of all the massed-particles.
ptrace.massed_particle_diameter(p0)	Specify the diameter of all the massed-particles.
ptrace.massed_particles(p0)	Enable or disable massed-particle trace calculation.
ptrace.massed_pressure(p0)	Specify whether the pressure force term is used in the massed-particle calculation.
ptrace.massed_pressure_gradient(p0)	Specify the name of the pressure gradient variable used in the pressure force term of the massed-particle calculation.
ptrace.massed_rebound(p0)	Turn on/off the use of massed particle rebound coefficients.
ptrace.massed_rebound_fraction(p0)	If using massed particle restitution this sets a termination criteria.
ptrace.massed_rebound_wallhits(p0)	If using massed particle restitution this sets a termination criteria.
ptrace.massed_use_ballistic(p0)	If using massed particle restitution this sets a termination criteria.
ptrace.max_angle(p0)	Sets the maximum angle between successive particle trace line segments that will trigger a halving of the integration step.
ptrace.min_angle(p0)	Sets the minimum angle between successive particle trace line segments that will trigger a doubling of the integration step.
ptrace.min_steps(p0)	Sets the minimum number of integration steps to perform in each element
ptrace.modify_bypartemit_byname(p0, p1, p2)	This command has not yet been documented.
ptrace.modify_bypartemit_num(args)	This command has not yet been documented.
ptrace.modify_emit_totoolloc(p0, p1)	Change the location of the emitter in a particle trace part.
ptrace.modify_fileemit_name(p0)	Change the emitter file name for a file emitter.
ptrace.modify_netemit_points(p0, p1, p2)	Change the number of emission points for a particular net emitter in a particle trace part.
ptrace.modify_partemit_byname(p0, p1)	Ptrace: modify_partemit_byname
ptrace.modify_partemit_num(p0, p1)	Ptrace: modify_partemit_num
ptrace.modify_rakeemit_points(p0, p1)	Change the number of emission points for a particular rake emitter in a particle trace part.
ptrace.node_id(args)	This command has not yet been documented.
ptrace.number_of_arrows(p0)	Ptrace: #_of_arrows
ptrace.pick_surface_oncreatecmd(p0)	Ptrace: pick_surface_oncreatecmd
ptrace.random_color_emissions()	Ptrace: random_color_emissions
ptrace.representation(p0)	Sets the display representation for a particle trace.
ptrace.ribbon_width(p0)	Sets the width for ribbon or square tube particle trace representations.
ptrace.rot_angle(p0)	Sets the angle between successive particle trace line segments that will trigger a halving of the integration step.
ptrace.select_begin(*args, **kwargs)	Ptrace: select_begin
ptrace.select_default()	Sets the currently selected particle trace parts to none, so any following attribute modifications will change the particle trace defaults.
ptrace.select_emitname_begin()	Ptrace: select_emitname_begin
ptrace.select_emitname_end()	Ptrace: select_emitname_end
ptrace.select_emitter_begin(*args, **kwargs)	Select emitters within a particle trace part for the purpose of modifying emitter attributes, deleting, etc.
ptrace.show_emissions()	Ptrace: show_emissions
ptrace.start_time(p0)	Specifies the solution time at which to begin particle emission.
ptrace.surface_restricted(p0)	Toggles trace creation to be surface restricted or not.
ptrace.time_step_begin(p0)	This command has not yet been documented.
ptrace.time_step_end(p0)	This command has not yet been documented.
ptrace.total_time(p0)	Sets the maximum length of time that the particle trace is allowed to continue.
ptrace.trace_direction(p0)	Sets the integration direction for a particle trace - forward in time, backward in time, or both.
ptrace.type(p0)	Sets the type of particle trace that will be created.
ptrace.variable(p0)	Specifies the vector variable to use for the flow field for the particle trace.
ptrace.variable_offset(p0)	Sets the distance from the surface into the flow field at which the velocity variable will be sampled.
ptrace.width_scale_factor(p0)	Ptrace: width_scale_factor