Model (hwx.inspire.core)

The active Inspire model. Model is a subclass of Assembly class.

It can be retrieved from and saved to a file. Is contains all the parts, joints, fasteners, load cases, and any other information required for its analysis.

Attributes

active: Bool	autoCalculateCG: Bool	autoCalculateMass: Bool
autoCalculateMeshSize: Bool	autoCalculateMoment: Bool	autoCalculateThickness: Bool
cg: Location	color: Color	contactPenetrationTolerance: Double
contactResolution: Enum	contactSearchDistance: Double	detectCollisions: Bool
gravityDirection: Direction	gravityMagnitude: Double	ground: Bool
ip: Inertia	limitNumberOfElements: Bool	mass: Double
material: Attribute	maxMeshSize: Double	maxThickness: Double
minMeshSize: Double	minThickness: Double	modifiable: Bool
morphable: Bool	movable: Bool	name: Attribute
numberOfElements: Int	position: Attribute	transparency: Double
visible: Bool	volume: Double

Properties

cavities	contacts	currentLoadCase
fasteners	gravityComponents	holes
loadCases	loads	measures
rigidGroups	spotWelds	systems
variables

Public Methods

classmethod getClass (cls, className)

autoColorParts (self)

destroy (self)

getAllChildren (self, type=None, **kwds)

getCenterOfGravity (self, includeGround=True)

getChild (self, name=None, recursive=False, **kwds)

getChildren (self, type=None, recursive=False, sorted=False, **kwds)

getDependents (self, recursive=False, **kwds)

getFeature (self, name=None)

getFeatures (self, type=None, **kwds)

getMass (self, includeGround=True)

getReferences (self, recursive=False, **kwds)

getSkinMesh (self, parts, local=False)

isa (self, type=None, filter=None, name=None, wildcard=None, **kwds)

modelPositions (self)

save (self, file, selected=[])

switchToDesignParts (self)

switchToOptimizedParts (self, name)

updateContacts (self, parts=None, searchDistance=None, visibleOnly=True, ignoreGroups=’rigid ground’, useExistingSearchDistances=True, penetrationTolerance=None, useExistingPenetrationTolerance=True, resolution=’Low’, useExistingResolution=True, _finder=0)

Attribute Details

active : Bool

Returns or sets the object activeness.

Setting this on or off sets all children. Setting to True sets all the parents active too.

autoCalculateCG : Bool

Determines whether the center of gravity is auto calculated.

autoCalculateMass : Bool

Determines whether the mass value is automatically calculated based upon volume and material density.

autoCalculateMeshSize : Bool

Indicates whether the minimum and average element sizes used for the solution are automatically calculated.

Set to False to enter these values manually.

Decreasing the minimum element size will increase the detail of your results in areas that use a number of small elements. The average element size controls the overall detail of your results.

autoCalculateMoment : Bool

Determines whether the mass moment of inertia is automatically calculated.

autoCalculateThickness : Bool

Determines whether the minimum and maximum thickness values are automatically calculated.

All parts are taken into account during the calculation.

cg : Location (units=”length”)

Returns the object’s global center of gravity as a point.

color : Color

Determines the color assigned to the object when it is displayed in the modeling window.

The default color for parts is gray, but a different color can be assigned.

contactPenetrationTolerance : Double (units=”length”)

The default penetration tolerance when calling updateContacts. Set to None to reset back to the auto-calculated default.

contactResolution : Enum

The default Resolution when calling updateContacts. Set to None to reset back to Low.

contactSearchDistance : Double (units=”length”)

The default searchDistance when calling updateContacts. Set to None to reset back to the auto-calculated default.

detectCollisions : Bool

Determines whether to detect collision.

It prevents parts in the model from overlapping and has been enabled by default.

gravityDirection : Direction

Returns or sets unitless gravity direction. May not be normalized.

gravityMagnitude : Double (units=”acceleration”)

Returns or sets gravity acceleration scalar.

ground : Bool

Returns or sets the object to be ground or immovable.

ip : Inertia (units=”massMI”)

Specifies the inertial properties of this object.

Resistance to change in motion (ixx, iyy, izz, ixy, izy, ixz).

limitNumberOfElements : Bool

If True, limits the mesh size by number of elements.

mass : Double (units=”m”)

The mass of the object.

material : Attribute

The material of the object.

Every part in the model has a material assigned to it. The default material is steel, but a different material can be assigned.

maxMeshSize : Double (units=”length”)

Returns or sets the maximum mesh size of the part.

maxThickness : Double (units=”length”)

The maximum thickness value.

minMeshSize : Double (units=”length”)

Returns or sets the minimum mesh size of the part.

minThickness : Double (units=”length”)

The minimum thickness value.

modifiable : Bool

Determines whether the selected object can be edited.

morphable : Bool

Determines whether the selected object shape can be changed.

movable : Bool

Determines whether the selected object can be translated in the modeling window or has been locked in place.

name : Attribute

Returns or sets the name of the object.

It can be any text string, including spaces, although it’s best to avoid using the following characters: ” ‘ * ? and $.

While these characters are allowed, they could create difficulties when you export the model to other applications.

numberOfElements : Int

Specifies the number of elements in the mesh.

position : Attribute

Specifies the global transform as a Matrix44.

transparency : Double

Specifies the transparency of the object.

Allows you to change the transparency, according to a percentage. By default, objects are 0% transparent(opaque).

visible : Bool

Determines whether the object is visible in the graphics window.

Setting this on or off sets all children. Setting to True sets all the parents visible too.

volume : Double (units=”volume”)

The volume of the object in the assembly.

Property Details

property cavities

A list of all the cavities in the model.

property contacts

List of Structures Contacts in the model.

property currentLoadCase

The LoadCase in which new loads will be added.

property fasteners

List of Fasteners in the model.

property gravityComponents

Returns gravity acceleration vector.

property holes

A list of all the holes in the model.

property loadCases

List of LoadCases in the model.

property loads

List of BoundaryConditions in the model.

property measures

List of Measures in the model.

property rigidGroups

List of RigidGroups in the model.

property spotWelds

List of SpotWelds in the model.

property systems

List of Systems in the model.

property variables

Variables used in sketching and geometry operations.

Method Details

classmethod getClass(cls, className)

Returns the class of the object.

It can be simple or qualified (with namespace). If the name is simple, we prepend the cls.namespace.

param className

The class name.

type className

Union[Part, Occurrence, Named..]

returns

The class for the specified className.

rtype

Union[Part, Occurrence, Named..]

autoColorParts(self)

Automatically assigns different colors to all the parts in the assembly.

destroy(self)

Destroys occurrences from the model.

getAllChildren(self, type=None, **kwds)

Returns a list of all children that matches the specified type.

param type

Filter to use to get the children based on object type.

type type

list[Named]

param **kwds

Additional keyword arguments to match other attributes of the object.

returns

The list of children that satisfy the supplied filters.

rtype

list[Union[Part, Motor, BoundaryCondition, …]]

getCenterOfGravity(self, includeGround=True)

Returns the centre of gravity of the assembly.

param includeGround

Include ground parts?

type includeGround

bool

returns

Point

getChild(self, name=None, recursive=False, **kwds)

Returns the child of the object which matches the specified unique name.

param name

The name of the child object.

type name

str

param recursive

Search all descendents.

type recursive

bool

param **kwds

Additional keyword arguments to match attributes of the object.

returns

The child object which satisfies the specified filters.

rtype

Named

getChildren(self, type=None, recursive=False, sorted=False, **kwds)

Returns a list of children that is of the specified type.

param type

Filter objects by class.

type type

Type[Named]

param recursive

True to get all descendent Parts and Assemblies.

type recursive

bool

param sorted

Sort the children base on id.

type sorted

bool

returns

list[Named]

getDependents(self, recursive=False, **kwds)

Get objects that reference this object through a Reference attribute.

param recursive

type recursive

bool

param **kwds

Filter objects using isa.

returns

set[Named]

getFeature(self, name=None)

Find feature by its __str__/__repr__.

param name

type name

str

returns

Feature

getFeatures(self, type=None, **kwds)

Returns features that matches the specified filters.

param type

The type of feature to return.

type type

Type[Feature]

param **kwds

Additional keyword arguments to match other attributes.

returns

A list of features that satisfies all the filter criteria.

rtype

list [Feature]

getMass(self, includeGround=True)

Returns the mass of the assembly.

param includeGround

Include ground parts.

type includeGround

bool

returns

float

getReferences(self, recursive=False, **kwds)

Get objects this object references through a Reference attribute.

param recursive

type recursive

bool

param **kwds

Filter objects using isa.

returns

set[Named]

getSkinMesh(self, parts, local=False)

Returns a dictionary of parts to the skin mesh (nodes and faces).

param parts

Specify the parts to skin mesh.

type parts

list[Part]

param local

If True, uses the local part collection, else occurrence collection. Recommended to use as defaults.

type local

bool

returns

Dictionary of parts to the skin mesh (nodes and faces).

rtype

dict

isa(self, type=None, filter=None, name=None, wildcard=None, **kwds)

Determines if the object matches the specified settings or not.

param type

The type of the object.

type type

Union[Part, Assembly, Contact..]

param filter

Return value of specified callback method.

type filter

method

param name

Name that matches exactly with object name.

type name

str

param wildcard

A pattern to match exactly with the object name.

type wildcard

str

param **kwds

Additional keyword arguments to match other attributes.

returns

True, if a match is found, otherwise False.

rtype

bool

modelPositions(self)

Forces all objects to return the original model positions instead of the current analysis positions.

Useful when defining draw methods on GeneralObjects where behaviour is different while animating.

save(self, file, selected=[])

Save the active model to the path specified in file. If selected only these get saved, similar to save selected in the Inspire application.

param file

File name and path, where the file needs to be saved.

type file

str

param selected

An assembly or a list of assemblies or part or a list of parts to save.

type selected

Assembly, list[Assembly], list[Part], Part

returns

True, if file save is successful else False.

rtype

bool

switchToDesignParts(self)

Change all part alternatives to the design space

switchToOptimizedParts(self, name)

Change part alternatives to an optimized result.

param name

The name of the optimization to switch to.

type name

str

updateContacts(self, parts=None, searchDistance=None, visibleOnly=True, ignoreGroups='rigid ground', useExistingSearchDistances=True, penetrationTolerance=None, useExistingPenetrationTolerance=True, resolution='Low', useExistingResolution=True, _finder=0)

Create or update contacts in model to account for part creation or movement.

Always call before querying Contact objects.

Note that this may also delete contacts, for example between grounded parts.

param parts

Limit contact finding to specified parts.

type parts

list[Part]

param searchDistance

Contact gap tolerance. Use ‘auto’ for auto calculated default. Defaults to model.contactSearchDistance.

type searchDistance

float

param visibleOnly

Search only visible parts.

type visibleOnly

bool

param ignoreGroups

Ignores the group parts during contact updates.

type ignoreGroups

rigid ground

param useExistingSearchDistances

Don’t update already existing contacts.

type useExistingSearchDistances

bool

Only relevant for SimSolid contacts: penetrationTolerance (float) : Penetration gap tolerance.

Use ‘auto’ for auto calculated default. Defaults to model.contactPenetrationTolerance.

useExistingPenetrationTolerance(bool)Don’t update already existing penetration

tolerance.

resolution (str) : Contacts density. It can be Low, Medium, High. useExistingResolution (bool) : Don’t update already existing resolution.

returns

True, if contacts where updated successfully else False.

rtype

bool