FieldDefinitionData

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

Attributes

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

Methods

Name	Description
FieldDefinitionData.add_data_scope_entity(entity)	Add 1 entity to the Data Scope of a plot
FieldDefinitionData.clear_data_scope()	Cleares the complete data scope of a plot, i.e. all scope entities are removed at once
FieldDefinitionData.display_data_create([parent])	Function for internal use, not meant for scripting
FieldDefinitionData.find_parent(type)	Function steps up the tree and returns the first parent with given type
FieldDefinitionData.get_data([visible, selected])	Get data of plot
FieldDefinitionData.get_deformations([...])	Function used internally to query matching nodal deformations for a given plot
FieldDefinitionData.get_element_indices([...])	Get element indices (ACP internal element numbers starting from 0) of plot
FieldDefinitionData.get_element_labels([...])	Get element labels (element numbers as read from / written to mesh files) of plot
FieldDefinitionData.get_full_description()	This function returns information displayed together with the legend
FieldDefinitionData.get_ply_offsets([...])	Get the offset between plies and reference surface
FieldDefinitionData.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
FieldDefinitionData.remove_data_scope_entity(entity)	Remove 1 entity to the Data Scope of a plot
FieldDefinitionData.serialize()	Serialize to Python string
FieldDefinitionData.serialize_create_function()
FieldDefinitionData.serialize_name_and_id()	Helper function to serialize name and ID
FieldDefinitionData.serialize_properties()	Serialize to Python string
FieldDefinitionData.serialize_python_only_attributes()
FieldDefinitionData.update()
FieldDefinitionData.visit(visitor)	Walk through the tree and let the visitor perform action on every descendant node