You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
Alex 8217e8b51c
Initial commit with file writing and create mode working for atoms
5 years ago
src Initial commit with file writing and create mode working for atoms 5 years ago
.gitignore Initial commit 5 years ago
LICENSE Initial commit 5 years ago
README.md Initial commit with file writing and create mode working for atoms 5 years ago

README.md

CAC_Model_Builder

This is a tool for building models in CAC. Commands and usage options are below. This code is intended to follow the atomsk code fairly closely.

Modes

The modes follow similarly to the modes you find when using atomsk. The modes will be listed below alongside their syntax and other usage instructions. As a note, if a mode is being used then it has to come first.

Mode Create

cacmb --create name element_type lattice_parameter esize

Mode create has the following parameters:

name - User defined name that either defines the atom type or the lattice type if using the basis option

element_type - Specifies which element type to use, this dictates the crystal being build. Current acceptable options for element_type are:

  • FCC - Uses the Rhombohedral primitive fcc unit cell as the finite element.

lattice_parameter - The lattice parameter for the crystal structure.

esize - Number of atoms per edge of the finite element. A value of 2 signifies full atomistic resolution and is the lowest number acceptable.

Example

cacmb --create Cu fcc 3.615 11

Creates a copper element with a lattice parameter of 3.615 with 11 atoms per side

Optional keywords

Orient

orient [hkl] [hkl] [hkl]

Default orientation is [100] [010] [001]. If this keyword is present then the user must provide the orientation matrix in form [hkl] [hkl] [hkl].

Example: orient [-112] [110] [-11-1]

Basis

basis num atom_name x y z

Default basis has atom_name = name with position (0,0,0). If used then the atom_name x y z must be include num times.

Example: basis 2 Mg 0 0 0 Mg 0.5 0.288675 0.81647

Duplicate

duplicate numx numy numz

Default duplicate is 1 1 1. This is used to replicate the element along each dimensions. This cannot be used if the keyword dimensions is included. By default jagged edges along boundaries are filled if duplicate is greater than 1 1 1.

Example: duplicate 10 10 10

Dimensions

dimensions dimx dimy dimz

There is no default dimensions as duplicate is the default option. This command assigns a box with user-assigned dimensions and fills it with the desired element. By default atoms fill in the jagged edges at the boundaries if the dimensions command is included.

Example: dimensions 100 100 100

ZigZag

zigzag boolx booly boolz

Default zigzag is f f f. This command specifies whether a boundary should be left jagged (i.e. in essence not filled in). If boolx is t than the x dimension is left jagged and if it is f then the x dimension is filled.

Example: zigzag t f t gives a box with jagged edges in the x and z and filled edges in the y.

Origin

origin x y z

Default origin is 0 0 0. This command just sets the origin for where the simulation cell starts building.

Example: origin 10 0 1