shamo.core.fem.field.Field

class shamo.core.fem.field.Field(field_type, view, formula='1')[source]

Bases: dict

A FEM field.

Parameters
field_typestr

The type of the field.

viewint

The view corresponding to the field.

formulastr, optional

The formula linking the field to a physical property.

Notes

The argument formula must be a valid formatter expression with named placeholders. To reference a tissue property, use the dict accessor. Available properties are:

  • ‘sigma[tissue]’

Methods

clear

copy

fromkeys

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

gen_formula

Generate the formula to use the field in a property.

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

SCALAR

TENSOR

VECTOR

field_type

Return the type of the fied.

formula

Return the formula linking the field to a physical property.

view

Return the view corresponding to the field.

clear() → None. Remove all items from D.
copy() → a shallow copy of D
property field_type

Return the type of the fied.

Returns
str

The type of the field.

property formula

Return the formula linking the field to a physical property.

Returns
str

The formula linking the field to a physical property.

fromkeys(iterable, value=None, /)

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

gen_formula(**kwargs)[source]

Generate the formula to use the field in a property.

Returns
str

The generated formula.

get(key, default=None, /)

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

items() → a set-like object providing a view on D’s items
keys() → a set-like object providing a view on D’s keys
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
property view

Return the view corresponding to the field.

Returns
int

The view corresponding to the field.