=========================== Material (hwx.inspire.core) =========================== A material is the physical substance that a part is made of, such as steel, aluminum, or plastic. The type of material does not determine the visual appearance of a part, only its physical properties. Base class for all user defined material. ---------- Attributes ---------- +---------------------------+---------------------------+---------------------------+ | active_: Bool | density_: Double | name_: Attribute | +---------------------------+---------------------------+---------------------------+ | poissonRatio_: Double | stress_: Double | thermalExpansion_: Double | +---------------------------+---------------------------+---------------------------+ | visible_: Bool | youngModulus_: Double | | +---------------------------+---------------------------+---------------------------+ -------------- Public Methods -------------- +-----------------------------------------------------------------------+ | classmethod get_ (cls, material=None) | +-----------------------------------------------------------------------+ | classmethod getClass_ (cls, className) | +-----------------------------------------------------------------------+ | classmethod getDefault_ (cls) | +-----------------------------------------------------------------------+ | classmethod getMaterials_ (cls) | +-----------------------------------------------------------------------+ | classmethod setDefault_ (cls, material) | +-----------------------------------------------------------------------+ | __new__ (cls, name='', **kwds) | +-----------------------------------------------------------------------+ | destroy_ (self) | +-----------------------------------------------------------------------+ | getAllChildren_ (self, type=None, **kwds) | +-----------------------------------------------------------------------+ | getChild_ (self, name=None, recursive=False, **kwds) | +-----------------------------------------------------------------------+ | getChildren_ (self, type=None, recursive=False, sorted=False, **kwds) | +-----------------------------------------------------------------------+ | getDependents_ (self, recursive=False, **kwds) | +-----------------------------------------------------------------------+ | getReferences_ (self, recursive=False, **kwds) | +-----------------------------------------------------------------------+ | isa_ (self, type=None, filter=None, name=None, wildcard=None, **kwds) | +-----------------------------------------------------------------------+ | modelPositions_ (self) | +-----------------------------------------------------------------------+ ----------------- Attribute Details ----------------- .. _active: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ active : :ref:`Bool ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Returns or sets the object activeness. Setting this on or off sets all children. Setting to True sets all the parents active too. .. _density: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ density : :ref:`Double ` (units="density") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies density as a mass of a unit volume of a material. .. _name: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ name : :ref:`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. .. _poissonRatio: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ poissonRatio : :ref:`Double ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Poisson ratio is the ratio of the change in the width per unit width of a material, to the change in its length per unit length. .. _stress: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ stress : :ref:`Double ` (units="stress") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies the yield stress of the material. The stress value at which the behaviour of the material changes from elastic to plastic. It is the minimum stress at which a solid will undergo permanent deformation or plastic flow without a significant increase in the load or external force. .. _thermalExpansion: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ thermalExpansion : :ref:`Double ` (units="e") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies the heat value on the material, when the size and volume increase in small increments. .. _visible: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ visible : :ref:`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. .. _youngModulus: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ youngModulus : :ref:`Double ` (units="stress") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies the young modulus of the material as a ratio of tensile stress and tensile strain. This property of the material tells, how easily the material can stretch and deform. -------------- Method Details -------------- .. _get: .. classmethod:: get(cls, material=None) Returns the material by its name. :param material: Name of the material. :type material: str :returns: Material found by its name. :rtype: Material .. _getClass: .. 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..] .. _getDefault: .. classmethod:: getDefault(cls) Returns project default material. :returns: The default material. :rtype: Material .. _getMaterials: .. classmethod:: getMaterials(cls) Returns a dictionary of the defined material keys to the material name. :returns: Return a dictionary of all the material keyed by name. :rtype: dict .. _setDefault: .. classmethod:: setDefault(cls, material) Sets projects default material. :param material: Material to be set for the project. :type material: Material :returns: The default material. :rtype: Material .. ___new__: .. method:: __new__(cls, name='', **kwds) Create and return a material. :param name: Name of the material. :type name: str :param \*\*kwds: To set attributes like "density", 'E',... :returns: Return the created material. :rtype: Material .. _destroy: .. method:: destroy(self) Removes the material from the database. :returns: True, if deleted, else False. :rtype: bool .. _getAllChildren: .. method:: 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, ...]] .. _getChild: .. method:: 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: .. method:: 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: .. method:: 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] .. _getReferences: .. method:: 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] .. _isa: .. method:: 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: .. method:: 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.