Skip to content

mkit.physics.energy

CellEnergy

Bases: EnergyFnOptional

fn instance-attribute 

fn: EnergyFn

hess cached property 

hess: EnergyFnOptional

(4, 3) -> (4, 3, 4, 3).

hess_vmap cached property 

hess_vmap: EnergyFnOptional

(C, 4, 3) -> (C, 4, 3, 4, 3).

jac cached property 

jac: EnergyFnOptional

(4, 3) -> (4, 3).

jac_vmap cached property 

jac_vmap: EnergyFnOptional

(C, 4, 3) -> (C, 4, 3).

vmap cached property 

vmap: EnergyFnOptional

(C, 4, 3) -> (C,).

__add__ 

__add__(other: EnergyFn | CellEnergy) -> CellEnergy

__call__ 

__call__(
    disp: ArrayLike,
    points: ArrayLike,
    point_data: Mapping[str, ArrayLike] = {},
    cell_data: Mapping[str, ArrayLike] = {},
    field_data: Mapping[str, ArrayLike] = {},
) -> Array

(4, 3) -> ().

__init__ 

__init__(fn: EnergyFn | CellEnergy) -> None

EnergyFn

Bases: Protocol

__call__ 

__call__(
    disp: ArrayLike,
    points: ArrayLike,
    point_data: Mapping[str, ArrayLike],
    cell_data: Mapping[str, ArrayLike],
    field_data: Mapping[str, ArrayLike],
) -> Array

EnergyFnOptional

Bases: Protocol

__call__ 

__call__(
    disp: ArrayLike,
    points: ArrayLike,
    point_data: Mapping[str, ArrayLike] = {},
    cell_data: Mapping[str, ArrayLike] = {},
    field_data: Mapping[str, ArrayLike] = {},
) -> Array

cell_energy 

cell_energy(fn: EnergyFn) -> CellEnergy