NEML2 2.0.0
All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
[Data]

Note
Clicking on the option with a triangle bullet ▸ next to it will expand/collapse its detailed information.
Type name written in PascalCase typically refer to a NEML2 object type, oftentimes a primitive tensor type.
The 🔗 symbol means that the tensor value can be cross-reference another object. See Model parameters (revisited) for details.
You can always use Ctrl+F or Cmd+F to search the entire page.

Available objects and their input file syntax

Refer to System Documentation for detailed explanation about this system.

CrystalGeometry

A Data object storing basic crystallographic information for a given crystal system.

crystal_class 🇧 The set of symmetry operations defining the crystal class.

  • Type: R2 🔗
lattice_vectors 🇧 The three lattice vectors defining the crystal translational symmetry

  • Type: Vec 🔗
slip_directions 🇧 A list of Miller indices defining the slip directions

  • Type: MillerIndex 🔗
slip_planes 🇧 A list of Miller indices defining the slip planes

  • Type: MillerIndex 🔗

Detailed documentation link

CubicCrystal

A specialization of the general CrystalGeometry class defining a cubic crystal system.

lattice_parameter The lattice parameter

  • Type: Scalar 🔗
slip_directions 🇧 A list of Miller indices defining the slip directions

  • Type: MillerIndex 🔗
slip_planes 🇧 A list of Miller indices defining the slip planes

  • Type: MillerIndex 🔗

Detailed documentation link