liblaf.apple.sim.field

Modules:

• field –

Classes:

• Field –

Field

Bases: PyTreeMixin

Parameters:

• region (Region, default: None ) –
• values (Float[Array, points * dim], default: None ) –

Methods:

• __pdoc__ –

  ...

• __repr__ –
• deformation_gradient –
• evolve –
• from_region –
• from_values –
• grad –
• tree_at –

Attributes:

• cells (Integer[Array, '{self.n_cells} {self.element.n_points}']) –
• dV (Float[Array, 'c q']) –
• dXdr (Float[Array, 'c q J J']) –
• dhdX (Float[Array, 'c q a J']) –
• dhdr (Float[Array, 'q a J']) –
• dim (Sequence[int]) –
• drdX (Float[Array, 'c q J J']) –
• element (Element) –
• geometry (Geometry) –
• h (Float[Array, 'q a']) –
• n_cells (int) –
• n_dofs (int) –
• n_points (int) –
• points (Integer[Array, '{self.n_points} {self.region.dim}']) –
• quadrature (Scheme) –
• region (Region) –
• values (Float[Array, points * dim]) –

cells property

cells: Integer[
    Array, "{self.n_cells} {self.element.n_points}"
]

dV property

dV: Float[Array, 'c q']

dXdr property

dXdr: Float[Array, 'c q J J']

dhdX property

dhdX: Float[Array, 'c q a J']

dhdr property

dhdr: Float[Array, 'q a J']

dim property

dim: Sequence[int]

drdX property

drdX: Float[Array, 'c q J J']

element property

element: Element

geometry property

geometry: Geometry

h property

h: Float[Array, 'q a']

n_cells property

n_cells: int

n_dofs property

n_dofs: int

n_points property

n_points: int

points property

points: Integer[Array, '{self.n_points} {self.region.dim}']

quadrature property

quadrature: Scheme

region class-attribute instance-attribute

region: Region = data(default=None)

values class-attribute instance-attribute

values: Float[Array, points * dim] = array(default=None)

__pdoc__

__pdoc__(**kwargs) -> AbstractDoc

...

References

1. wadler_lindig._definitions._pformat_dataclass()

Source code in src/liblaf/apple/sim/field/field.py

class Field(struct.PyTreeMixin):
    region: Region = struct.data(default=None)
    values: Float[jax.Array, "points *dim"] = struct.array(default=None)

    @classmethod
    def from_region(cls, region: Region, values: ArrayLike) -> Self:
        values = jnp.asarray(values)
        values = jnp.broadcast_to(values, (region.n_points, *values.shape[1:]))
        chex.assert_shape(values, (region.n_points, ...))
        return cls(region=region, values=values)

    # region ArrayMixin

    def from_values(self, values: ArrayLike, /) -> Self:
        return self.evolve(values=values)

    # endregion ArrayMixin

    # region Structure

    @property
    def element(self) -> Element:
        return self.region.element

    @property

__repr__

__repr__() -> str

Source code in src/liblaf/apple/sim/field/field.py

return self.region.geometry

deformation_gradient

deformation_gradient() -> Float[
    Array,
    "{self.n_cells} {self.quadrature.n_points} {self.region.dim} {self.region.dim}",
]

Source code in src/liblaf/apple/sim/field/field.py

@utils.jit_method(inline=True)
def deformation_gradient(
    self,
) -> Float[
    jax.Array,
    "{self.n_cells} {self.quadrature.n_points} {self.region.dim} {self.region.dim}",
]:
    return self.region.deformation_gradient(self.values)

evolve

evolve(**changes) -> Self

Source code in src/liblaf/apple/sim/field/field.py

def quadrature(self) -> Scheme:
    return self.region.quadrature

from_region classmethod

from_region(region: Region, values: ArrayLike) -> Self

Source code in src/liblaf/apple/sim/field/field.py

@classmethod
def from_region(cls, region: Region, values: ArrayLike) -> Self:
    values = jnp.asarray(values)
    values = jnp.broadcast_to(values, (region.n_points, *values.shape[1:]))
    chex.assert_shape(values, (region.n_points, ...))
    return cls(region=region, values=values)

from_values

from_values(values: ArrayLike) -> Self

Source code in src/liblaf/apple/sim/field/field.py

def from_values(self, values: ArrayLike, /) -> Self:
    return self.evolve(values=values)

grad

grad() -> Float[
    Array,
    "{self.n_cells} {self.quadrature.n_points} *dim {self.region.dim}",
]

Source code in src/liblaf/apple/sim/field/field.py

@utils.jit_method(inline=True)
def grad(
    self,
) -> Float[
    jax.Array, "{self.n_cells} {self.quadrature.n_points} *dim {self.region.dim}"
]:
    return self.region.gradient(self.values)

tree_at

tree_at(
    where: Callable[[Self], Node | Sequence[Node]],
    replace: Any | Sequence[Any] = ...,
    replace_fn: Callable[[Node], Any] = ...,
    is_leaf: Callable[[Any], bool] | None = None,
) -> Self

Source code in src/liblaf/apple/sim/field/field.py

# endregion Structure

# region Numbers

@property
def dim(self) -> Sequence[int]:
    return self.values.shape[1:]

@property
def n_cells(self) -> int:
    return self.region.n_cells

@property
def n_dofs(self) -> int:
    return self.values.size