`CollectionBase`#

class ansys.dpf.core.collection_base.CollectionBase(collection=None, server: ansys.dpf.core.server_types.BaseServer = None)#

Bases: Generic[TYPE]

Represents a collection of entries ordered by labels and IDs.

Parameters:

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.

Overview#

Abstract methods

create_subtype

Must be implemented by subclasses.

Methods

`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_base import CollectionBase

Property detail#

property CollectionBase.name#

Name of the Collection.

Notes

Available starting with DPF 2024 R2 pre0.

Return type:: str

property CollectionBase.labels: List[str]#

Provides for getting scoping labels as a property.

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

Attribute detail#

CollectionBase.entries_type: type[TYPE] | None#

CollectionBase.owned = False#

Method detail#

abstract CollectionBase.create_subtype(obj_by_copy)#: Must be implemented by subclasses.

static CollectionBase.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.

CollectionBase.set_labels(labels)#

Set labels for scoping the collection.

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

CollectionBase.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')

CollectionBase.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

CollectionBase.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]

CollectionBase.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)

CollectionBase.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]

CollectionBase.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

CollectionBase.__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

CollectionBase.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.

CollectionBase.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.

CollectionBase.__str__()#

Describe the entity.

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

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

CollectionBase.__del__()#: Delete the entry.

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

CollectionBase#

Overview#

Import detail#

Property detail#

Attribute detail#

Method detail#

`CollectionBase`#