Collection#

Contains classes associated with the DPF collection.

class ansys.dpf.core.collection.Collection(dpf_type=None, collection=None, server: Optional[ansys.dpf.core.server.DpfServer] = None)#

Represents a collection of entries ordered by labels and IDs.

Parameters
  • dpf_type

  • collection (ansys.grpc.dpf.collection_pb2.Collection, optional) – Collection to create from the collection message. The default is None.

  • server (server.DPFServer, 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.

Examples

>>> from ansys.dpf import core as dpf
>>> coll = dpf.Collection(dpf.types.field)
static integral_collection(inpt, server: Optional[ansys.dpf.core.server.DpfServer] = None)#

Creates 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

Collection

Notes

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

set_labels(labels)#

Set labels for scoping the collection.

Parameters

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

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.Collection(dpf.types.field)
>>> coll.add_label('time')
property labels#

Retrieve labels scoping the collection.

Returns

labels – List of labels that entries are scoped to. For example, ["time", "complex"].

Return type

list[str]

has_label(label)#

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.Collection(dpf.types.field)
>>> coll.add_label('time')
>>> coll.has_label('time')
True
>>> coll.has_label('complex')
False
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)

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]

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 scopped to the input label.

Return type

Scoping