cfdm.Field.domain_topologies

Field.domain_topologies(*identities, **filter_kwargs)

Return domain topology constructs.

Note that f.domain_topologies(*identities, **filter_kwargs) is equivalent to

f.constructs.filter(filter_by_type=["domain_topology"], filter_by_identity=identities, **filter_kwargs).

Added in version (cfdm): 1.11.0.0

See also

constructs, domain_topology

Parameters:

identities: optional

Select domain topology constructs that have an identity, defined by their identities methods, that matches any of the given values.

If no identities are provided then all domain topology constructs are selected.

A value may be any object that can match via the == operator, or a re.Pattern object that matches via its search method.

Note that in the output of a dump method or print call, a construct is always described by an identity that will select it.

filter_kwargs: optional

Keyword arguments as accepted by Constructs.filter that define additional construct selection criteria.

Returns:

The selected constructs in a new Constructs object, unless modified by any filter_kwargs parameters. The returned object will contain no constructs if none were selected.

Examples:

>>> f = cfdm.example_field(8)
>>> print(f.domain_topologies())
Constructs:
{'domaintopology0': <DomainTopology: 'cell:face(3) >}