user_surface_child

class ansys.cfx.core.generated.post_processing.settings_261.user_surface_child.user_surface_child(name: str | None = None, parent=None)

Bases: Group

‘child_object_type’ of user_surface.

Attributes

Attribute	Summary
ansys_diagnostics_file	Specifies the file to which to write the Import and Export Diagnostics.
ansys_volumetric_temperature_transfer	Indicates whether the User Surface defines a Volumetric Temperature Transfer or not.
apply_instancing_transform	Toggles the instancing transformation for this graphics object in the viewer.
apply_rotation	Toggles rotation in the transformation.
apply_scale	Toggles scale in the transformation.
apply_texture	Toggles display of the texture.
apply_translation	Toggles translation in the transformation.
associated_boundary	The name of the boundary that the user wishes to associate with the imported ANSYS mesh.
associated_boundary_specified	Indicates whether to associate a boundary with this geometry.
blend_texture	Toggles blending of the texture.
boundary_list	A list of boundary objects.
case_name	Internal CFD-Post name for the analyzed problem or the results set to use.
chart_data_source	The data source for a scatter chart. The ‘Chart Points’ option refers to the original chart points data. The ‘Response Points’ option refers to the sampled points on the response surfaces for the chart points.
chart_path	The path of the chart specified in a user surface.
colour	A list of three numbers between 0 and 1, which represent the RGB (Red/Green/Blue) values to be used when colouring the faces of an object by constant colour.
colour_map	The name of the colour map to use when colouring the object.
colour_mode	Sets the mode used to colour the object. If set equal to “Constant” then the “Colour” parameter is used to determine the plot colour. If set equal to “Variable”, then the “Colour Variable” parameter is used.
colour_scale	Sets whether to colour the object with a Linear or Logarithmic scale. By default, the colour scale is Linear.
colour_variable	The name of the variable to be used in colouring the object. Should be set equal to the name of a currently defined VARIABLE object.
colour_variable_boundary_values	Sets the type of boundary values to be presented for colour variables in this object (Conservative or Hybrid).
contour_level	The contour level specified in a user surface.
contour_name	The name of the contour object specified in a user surface.
culling_mode	Controls the face culling of this object in the viewer.
domain_list	The list of domains over which to define this object.
draw_contours	Enables/disables drawing of the contour lines.
draw_faces	Toggles the visibility filled faces for this graphics object in the viewer.
draw_lines	Toggles the visibility of lines around each face of this graphics object.
file_units	Specifies the units of the data in the ANSYS CDB file to be imported.
input_file	The name of the file to be read that contains the definition of one or more polylines or user surfaces and associated path variables.
instancing_transform	Defines the TRANSFORM object that is used for the object instancing.
lighting	Toggles the lighting of this graphics object in the viewer.
line_colour	A list of three numbers between 0 and 1, which represent the RGB (Red/Green/Blue) values to be used for colouring the lines on a graphics object.
line_colour_mode	Determines where to get the line colour from.
line_width	Controls the width (in pixels) of lines drawn for this graphics object.
location	A locator name.
maintain_conservative_values	Indicates whether to scale the variable values by an appropriate factor to ensure that the results are conservative with respect to the values on the Associated Boundary.
max	The maximum value of a variable in the colour map when using a “User Specified” range.
min	The minimum value of a variable in the colour map when using a “User Specified” range.
number_of_contours	Specifies number of contour lines in a contour plot.
offset_direction	Specifies the offset direction vector (used in Offset From Surface mode).
offset_distance	The offset distance (used in Offset From Surface mode).
offset_mode	Specifies the offset mode (used in Offset From Surface mode).
offset_type	Specifies the offset type (used in Offset From Surface mode).
offset_variable	Specifies the variable to be used for the offset (used in Offset From Surface mode).
option	‘option’ child.
output_variable_name	The name of the output variable for a response surface.
output_variable_name_list	The list of the output variable names for a 2D response surface.
principal_axis	Specifies the principal axis used in instance rotation.
range	Sets the method used to calculate the extents of the colour map on an object. “Global” uses the range of values in the problem domain. “Local” uses the range of values on the current object.
render_edge_angle	The angle between two faces used to limit visible edges in a wireframe.
rotation_angle	Specifies the rotation angle.
rotation_axis_from	An XYZ triple defining the first point of the rotation axis.
rotation_axis_to	An XYZ triple defining the second point of the rotation axis.
rotation_axis_type	Specifies the rotation axis type in the transformation. If it is set to ‘Principal Axis’, Principal Axis parameter setting is used. It is set to ‘Rotation Axis’, parameters Rotation Axis From and Rotation Axis To are used for the axis definition.
scale_factor	The object scale factor used in the transformation.
section_name	The section name in the file to be read that contains the definition of the polyline or user surface and associated path variables.
specular_lighting	Toggles the specular lighting of this object in the viewer.
surface_drawing	Sets the algorithm used to shade the faces for this graphics object.
surface_name	The name of the surface object to offset from.
texture_angle	The texture angle in degrees.
texture_direction	The direction of texture projection to the object.
texture_file	The texture file to display on the object.
texture_material	The material to use for texture.
texture_position	X-Y position of the texture.
texture_scale	The texture scale.
texture_type	The type of texture to use.
tile_texture	Toggles tiling of the texture.
transform_texture	Toggles transforming (spherical) of the texture.
translation_vector	Specifies the translation vector.
transparency	Set between 0.0 (fully opaque) and 1.0 (fully transparent) to control the transparency of this graphics object in the viewer.
use_mid_side_nodes	Indicates whether to include reading the mid-side nodes when reading the ANSYS surface. The mid-side nodes will only be used when exporting Node Temperatures.
visibility	Toggles the visibility of this graphics object in the viewer. THIS PARAMETER IS DEPRECATED!.
x_input_variable_name	The input variable name for the X coordinate of a response surface.
x_number_of_samples	The number of sample points in X direction for building a response surface user surface.
y_input_variable_name	The input variable name for the Y coordinate of a response surface.
y_number_of_samples	The number of sample points in Y direction for building a response surface user surface.
object_view_transform	This object contains object transformation info to be processed by the viewer. Like instance transform, this object should be associated with each geometry. It is usually specified as a sub-object.

Methods

Method	Summary
hide	Hide the object in a given view(s).
show	Show the object in a given view(s).
suspend	Suspend immediate update for the object.
unsuspend	Restore immediate update for the object.

Included in:

Parent	Summary
user_surface	‘user_surface’ child.