ScalarFieldData

class compolyx.plot_data.ScalarFieldData(graph, obj, parent=None)

Attributes

Name	Description
ScalarFieldData.active	Whether the plot is active or not; an inactive plot is not updated and it does not contain data
ScalarFieldData.active_display_data	Returns a dictionary containing display data for this plot owned by the active scene
ScalarFieldData.all_display_data	Returns a list of all display data classes in existence for this object
ScalarFieldData.changed	Status boolean
ScalarFieldData.color_table
ScalarFieldData.component	The requested result component for a specific plot, e.g. s1 for the stress in the 1-direction
ScalarFieldData.components	Return the possible component set on this plot type
ScalarFieldData.data_scope	Data scope of the plot where results will be evaluated
ScalarFieldData.definition_id
ScalarFieldData.description_changed	Status boolean
ScalarFieldData.enabled	Whether this object is currently enabled or not
ScalarFieldData.eval_position	The finite element position at which the results are given, e.g. centroid or nodal
ScalarFieldData.has_element_wise	Whether the plot offers element-wise data
ScalarFieldData.has_ply_wise	Whether the plot offers ply-wise data
ScalarFieldData.id	ID of object
ScalarFieldData.is_dict_item	Specifies whether the object is an item of a dict
ScalarFieldData.is_list_item	Specifies whether the object is an item of a list
ScalarFieldData.link_path	Root path of the current node in the tree for links to this object
ScalarFieldData.locked	Returns the locked status of the plot
ScalarFieldData.minmax	Min and max value of current data
ScalarFieldData.minmax_last_query	Min and max value of data of last query
ScalarFieldData.name	Name of object
ScalarFieldData.parent	Parent object in tree
ScalarFieldData.ply_offset_scale_factor	Offset scale factor
ScalarFieldData.ply_wise	Whether to plot ply-wise or element-wise
ScalarFieldData.requires_solution
ScalarFieldData.root_path	Root path of the current node in the tree
ScalarFieldData.scalar_field	The underlying scalar field
ScalarFieldData.scope_entire_model	Whether the plot scope is the entire model or a subset defined by the data_scope
ScalarFieldData.show_on_solids	Whether to plot results on solid or shell elements
ScalarFieldData.show_ply_offsets
ScalarFieldData.show_supporting_point_labels	Whether to plot the labels of the supporting points
ScalarFieldData.show_supporting_points	Whether to the plot supporting points
ScalarFieldData.solution	Solution underlying the plot
ScalarFieldData.solution_set	Solution Set selection
ScalarFieldData.spot	Not applicable to a scalar field plot
ScalarFieldData.spots	Return the possible spot set on this plot type
ScalarFieldData.status	Status of the object
ScalarFieldData.status_changed	Boolean flag which is set to true in C++ when up-to-date status of object changes
ScalarFieldData.supporting_point_scale_factor	Relative scale factor for the supporting points
ScalarFieldData.uid	UID of object
ScalarFieldData.updated	Status boolean
ScalarFieldData.uptodate	Whether the plot is up-to-date
ScalarFieldData.vertex	This will throw an error if the object has been removed from the graph

Methods

Name	Description
ScalarFieldData.add_data_scope_entity(entity)	Add 1 entity to the Data Scope of a plot
ScalarFieldData.clear_data_scope()	Cleares the complete data scope of a plot, i.e. all scope entities are removed at once
ScalarFieldData.display_data_create([parent])	Function for internal use, not meant for scripting
ScalarFieldData.find_parent(type)	Function steps up the tree and returns the first parent with given type
ScalarFieldData.get_data([visible, selected])	Get data of plot
ScalarFieldData.get_deformations([visible, ...])	Function used internally to query matching nodal deformations for a given plot
ScalarFieldData.get_element_indices([...])	Get element indices (ACP internal element numbers starting from 0) of plot
ScalarFieldData.get_element_labels([...])	Get element labels (element numbers as read from / written to mesh files) of plot
ScalarFieldData.get_full_description()	This function returns information displayed together with the legend
ScalarFieldData.get_ply_offsets([visible, ...])	Get the offset between plies and reference surface
ScalarFieldData.get_support_point_coordinates()	Get the coordinates of the supporting points
ScalarFieldData.get_support_point_labels()	Get the identifiers for the supporting points
ScalarFieldData.get_support_point_values()	Get the scalar values defined at the supporting points
ScalarFieldData.obj_exists()	Checks if __obj still references the C++ object (i.e. has not been reset to None by self._delete) and exists in the graph
ScalarFieldData.remove_data_scope_entity(entity)	Remove 1 entity to the Data Scope of a plot
ScalarFieldData.serialize()	Serialize to Python string
ScalarFieldData.serialize_create_function()
ScalarFieldData.serialize_name_and_id()	Helper function to serialize name and ID
ScalarFieldData.serialize_properties()	Serialize to Python string
ScalarFieldData.serialize_python_only_attributes()
ScalarFieldData.update()
ScalarFieldData.visit(visitor)	Walk through the tree and let the visitor perform action on every descendant node