`Collection`#

class ansys.dpf.core.collection.Collection(collection=None, server=None, entries_type: type = None)#

Bases: ansys.dpf.core.collection_base.CollectionBase[ansys.dpf.core.collection_base.TYPE]

Represents a collection of dpf objects organised by label spaces.

Parameters:

collection (ansys.grpc.dpf.collection_message_pb2.Collection or) – ansys.dpf.core.Collection, optional Create a collection from a collection message or create a copy from an existing collection. The default is None.
server (ansys.dpf.core.server, optional) – 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.
entries_type (type) – Type of the entries in the collection.

Notes

Class available with server’s version starting at 8.1 (Ansys 2024 R2 pre1).

Overview#

Methods

`create_subtype`	Create dpf instance of any type, which has been cast to its original type.
`get_entries`	Retrieve the entries at a label space.
`get_entry`	Retrieve the entry at a requested index or label space.
`add_entry`	Add or update the entry at a requested label space.
`set_labels`	Set labels for scoping the collection.
`add_label`	Add the requested label to scope the collection.
`has_label`	Check if a collection has a specified label.
`get_entries_indices`	Retrieve the indices of the entries corresponding a requested label space .
`get_label_space`	Retrieve the label space of an entry at a requested index.
`get_available_ids_for_label`	Retrieve the IDs assigned to an input label.
`get_label_scoping`	Retrieve the scoping for an input label.
`set_support`	Set the support of the collection for a given label.
`get_support`	Get the support of the collection for a given label.

Properties

`name`	Name of the Collection.
`labels`	Provides for getting scoping labels as a property.

Attributes

`entries_type`
`owned`

Static methods

integral_collection

Create a collection of integral type with a list.

Special methods

`__getitem__`	Retrieve the entry at a requested index value.
`__str__`	Describe the entity.
`__len__`	Retrieve the number of entries.
`__del__`	Delete the entry.
`__iter__`	Provide for looping through entry items.

Import detail#

from ansys.dpf.core.collection import Collection

Property detail#

property Collection.name#

Name of the Collection.

Notes

Available starting with DPF 2024 R2 pre0.

Return type:: str

property Collection.labels: List[str]#

Provides for getting scoping labels as a property.

Returns:: List of labels scoping the collection.
Return type:: List[str]

Attribute detail#

Collection.entries_type: type[TYPE] | None#

Collection.owned = False#

Method detail#

Collection.create_subtype(obj_by_copy)#: Create dpf instance of any type, which has been cast to its original type.

Collection.get_entries(label_space)#

Retrieve the entries at a label space.

Parameters:: label_space (dict[str,int]) – Entries corresponding to a filter (label space) in the input. For example: {"elshape":1, "body":12}
Returns:: entries – Entries corresponding to the request.
Return type:: list[self.type]

Collection.get_entry(label_space_or_index) → ansys.dpf.core.collection_base.TYPE#

Retrieve the entry at a requested index or label space.

Raises an exception if the request returns more than one entry.

Parameters:: label_space_or_index (dict[str,int] , int) – Scoping of the requested entry, such as {"time": 1, "complex": 0} or the index of the mesh.
Returns:: entry – Entry corresponding to the request.
Return type:: self.type

Collection.add_entry(label_space, entry)#

Add or update the entry at a requested label space.

Parameters:

label_space (dict[str,int]) – Label space of the requested meshes. For example, {“elshape”:1, “body”:12}.
entry (self.type) – DPF entry to add or update.

static Collection.integral_collection(inpt, server: ansys.dpf.core.server_types.BaseServer = None)#

Create a collection of integral type with a list.

The collection of integral is the equivalent of an array of data sent server side. It can be used to efficiently stream large data to the server.

Parameters:: inpt (list[float], list[int], numpy.array) – list to transfer server side
Return type:: IntegralCollection

Notes

Used by default by the 'Operator' and the``’Workflow’`` when a list is connected or returned.

Collection.set_labels(labels)#

Set labels for scoping the collection.

Parameters:: labels (list[str], optional) – Labels to scope entries to. For example, ["time", "complex"].

Collection.add_label(label, default_value=None)#

Add the requested label to scope the collection.

Parameters:

label (str) – Labels to scope the entries to. For example, "time".
default_value (int, optional) – Default value for existing fields in the collection. The default is None.

Examples

>>> from ansys.dpf import core as dpf
>>> coll = dpf.FieldsContainer()
>>> coll.add_label('time')

Collection.has_label(label) → bool#

Check if a collection has a specified label.

Parameters:: label (str) – Label to search for. For example, "time".
Returns:: True when successful, False when failed.
Return type:: bool

Examples

>>> from ansys.dpf import core as dpf
>>> coll = dpf.FieldsContainer()
>>> coll.add_label('time')
>>> coll.has_label('time')
True

>>> coll.has_label('complex')
False

Collection.get_entries_indices(label_space)#

Retrieve the indices of the entries corresponding a requested label space .

Notes

Available starting with DPF 2025R1.

Parameters:: label_space (dict[str,int]) – Label space or index. For example, {"time": 1, "complex": 0} or the index of the field.
Returns:: indices – Indices of the entries corresponding to the request.
Return type:: list[int], list[Field], list[MeshedRegion]

Collection.get_label_space(index)#

Retrieve the label space of an entry at a requested index.

Parameters:: index (int) – Index of the entry.
Returns:: label_space – Scoping of the requested entry. For example, {"time": 1, "complex": 0}.
Return type:: dict(str:int)

Collection.get_available_ids_for_label(label='time')#

Retrieve the IDs assigned to an input label.

Parameters:: label (str) – Name of the input label. The default is "time".
Returns:: ids – List of IDs assigned to the input label.
Return type:: list[int]

Collection.get_label_scoping(label='time')#

Retrieve the scoping for an input label.

This method allows you to retrieve a list of IDs for a given input label in the collection. For example, if the label el_type exists in the collection, you can use the get_lable_scoping method to retrieve a list of IDS with this label. You can then use these IDs to request a given entity inside the collection.

Parameters:: label (str) – Name of the input label.
Returns:: scoping – IDs scoped to the input label.
Return type:: Scoping

Collection.__getitem__(index)#

Retrieve the entry at a requested index value.

Parameters:: index (int) – Index value.
Returns:: entry – Entry at the index value.
Return type:: Field , Scoping

Collection.set_support(label: str, support: ansys.dpf.core.support.Support) → None#

Set the support of the collection for a given label.

Notes

Available starting with DPF 2023 R1.

Collection.get_support(label: str) → ansys.dpf.core.support.Support#

Get the support of the collection for a given label.

Notes

Available starting with DPF 2023 R1.

Collection.__str__()#

Describe the entity.

Returns:: description – Description of the entity.
Return type:: str

Collection.__len__()#: Retrieve the number of entries.

Collection.__del__()#: Delete the entry.

Collection.__iter__()#: Provide for looping through entry items.

Collection#

Overview#

Import detail#

Property detail#

Attribute detail#

Method detail#

`Collection`#