The mesh_scoping_factory.py module#

Summary#

nodal_scoping

Create a nodal ansys.dpf.core.Scoping defining a list of node IDs.

elemental_scoping

Create an elemental ansys.dpf.core.Scoping defining a list of element IDs.

face_scoping

Create a face :class:`ansys.dpf.core.Scoping`defining a list of face IDs.

named_selection_scoping

Create a ansys.dpf.core.Scoping based on a named selection in a model.

Description#

mesh_scoping_factory.

Contains functions to simplify creating a mesh scoping.

Module detail#

mesh_scoping_factory.nodal_scoping(node_ids: ansys.dpf.core.scoping.IdVectorType, server: ansys.dpf.core.server_types.AnyServerType = None) → ansys.dpf.core.Scoping#

Create a nodal ansys.dpf.core.Scoping defining a list of node IDs.

Parameters:

  • node_ids – List of node IDs.

  • server – Server with the channel connected to the remote or local instance. The default is None, in which case an attempt is made to use the global server.

Returns:

A nodal scoping containing the node IDs provided.

Return type:

scoping

mesh_scoping_factory.elemental_scoping(element_ids: ansys.dpf.core.scoping.IdVectorType, server: ansys.dpf.core.server_types.AnyServerType = None) → ansys.dpf.core.Scoping#

Create an elemental ansys.dpf.core.Scoping defining a list of element IDs.

Parameters:

  • element_ids – List of element IDs.

  • server – Server with the channel connected to the remote or local instance. The default is None, in which case an attempt is made to use the global server.

Returns:

An elemental scoping containing the element IDs provided.

Return type:

scoping

mesh_scoping_factory.face_scoping(face_ids: ansys.dpf.core.scoping.IdVectorType, server: ansys.dpf.core.server_types.AnyServerType = None) → ansys.dpf.core.Scoping#

Create a face :class:`ansys.dpf.core.Scoping`defining a list of face IDs.

Parameters:

  • face_ids – List of face IDs.

  • server – Server with the channel connected to the remote or local instance. The default is None, in which case an attempt is made to use the global server.

Returns:

A face scoping containing the face IDs provided.

Return type:

scoping

mesh_scoping_factory.named_selection_scoping(named_selection_name: str, model: ansys.dpf.core.model.Model, server: ansys.dpf.core.server_types.AnyServerType = None) → ansys.dpf.core.Scoping#

Create a ansys.dpf.core.Scoping based on a named selection in a model.

Parameters:

  • named_selection_name – Name of the named selection.

  • model – Model where the named selection exists.

Returns:

A scoping containing the IDs of the entities in the named selection. The location depends on the type of entities targeted by the named selection.

Return type:

scoping