shamo.core.fem.group.Group

class shamo.core.fem.group.Group(dim, entities, group)

Bases: dict

A FEM physical group.

Parameters

dimint

The dimension of the group. Can be one of DIM_POINT, DIM_LINE, DIM_SURF or DIM_VOL.

entitiesint or Iterable [int]

The tags of the entities composing the physical group.

groupint

The physical group tag.

Raises

ValueError

If argument dim is not convertible to int. If an element of argument entities is not convertible to int. If argument group is not convertible to int.

Methods

clear
copy
fromkeys	Create a new dictionary with keys from iterable and values set to value.
get	Return the value for key if key is in the dictionary, else default.
items
keys
pop	If key is not found, d is returned if given, otherwise KeyError is raised
popitem	Remove and return a (key, value) pair as a 2-tuple.
setdefault	Insert key with a value of default if key is not in the dictionary.
update	If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]
values

Attributes

DIM_LINE
DIM_POINT
DIM_SURF
DIM_VOL
dim	Return the dimension of the physical group.
entities	Return the tags of the entities composing the physical group.
group	Return the tag of the physical group.
n_entities	Return the number of entities composing the physical group.

clear() → None. Remove all items from D.

copy() → a shallow copy of D

property dim

Return the dimension of the physical group.

Returns

int

The dimension of the physical group.

property entities

Return the tags of the entities composing the physical group.

Returns

set [int]

The tags of the entities composing the physical group.

fromkeys(iterable, value=None, /)

Create a new dictionary with keys from iterable and values set to value.

get(key, default=None, /)

Return the value for key if key is in the dictionary, else default.

property group

Return the tag of the physical group.

Returns

int

The tag of the physical group.

items() → a set-like object providing a view on D’s items

keys() → a set-like object providing a view on D’s keys

property n_entities

Return the number of entities composing the physical group.

Returns

int

The number of entities composing the physical group.

pop(k[, d]) → v, remove specified key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised

popitem(/)

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

setdefault(key, default=None, /)

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

update([E, ]**F) → None. Update D from dict/iterable E and F.

If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values() → an object providing a view on D’s values