forces

This module implements Forces field classes, which are mostly bare implementations of generic fields defined in atomsmltr.environment.fields.

See also

atomsmltr.environment.fields.generic

class atomsmltr.environment.fields.force.force.ConstantForce(field_value: ndarray = (0, 0, 0), tag: str = None)

Bases: Force, ConstantField

A constant Force

See also

atomsmltr.environment.fields.generic.ConstantField

property type

a description of the object type

Type:

str

class atomsmltr.environment.fields.force.force.Force(*args, **kwargs)

Bases: Field

A generic force field class. Used to set some properties common to all forces objects, and to have a way to identify magnetic field objects.

property type

a description of the object type

Type:

str

property unit

returns the unit of the field

Type:

str

class atomsmltr.environment.fields.force.force.GradientForce(origin: ndarray, slope: float, gradient_direction: ndarray, field_direction: ndarray, offset: float = 0.0, tag: str = None)

Bases: Force, GradientField

A perfect force gradient

See also

atomsmltr.environment.fields.generic.GradientField

property type

a description of the object type

Type:

str