Name

unitcell — A unitcell definition.

Description

The unitcell element describes the supercell for condensed matter systems.

Processing expectations

Initialize the geometrical parameters of a unit cell.

Children

The following elements occur in simulation: parameter

Attributes

dimension

Optional, the Dimension of a unitcell. Default is 3.

id

Optional, ID type.

unit

Optional, the unit of the lattice vectors.

role

Reserved.

Valid parameters

The list of parameters meaningful to unitcell. The attribute datatype is implied and is set by an application and the dimension D, the value dimension attribute of unitcell.

nameconditiondatatyperesult
scaleAA | bohrscalarSet a scaling factor of a unit cell. AA(bohr) is the length unit in Angstrom (bohr). Default is 1 AA.
latticeAA | bohrtensorSet lattice vectors by a D-by-D tensor
bcondsnonecharSet the boundary conditions in the D directions. Default is p p p for periodic boundary condition. n is used to indicate that a direction is not periodic.
gridnoneintegerSet the grid partition in the D directions
mpi_gridnoneintegerSet the mpi grid partition in the D directions
omp_gridnoneintegerSet the openmp grid partition in the D directions

Examples

A cubic unit cell with the lattice parameter 5.432 A is written as

 <unitcell dimension="3">
    <parameter name="scale" condition="AA">5.432 </parameter>
    <parameter name="lattice" datatype="tensor">  
      1.0 0.0 0.0 
      0.0 1.0 0.0 
      0.0 0.0 1.0 
    </parameter>
    <parameter name="bconds" datatype="char"> p p p </parameter>
 </unitcell>