#
# CDDL HEADER START
#
# The contents of this file are subject to the terms of the Common Development
# and Distribution License Version 1.0 (the "License").
#
# You can obtain a copy of the license at
# http://www.opensource.org/licenses/CDDL-1.0.  See the License for the
# specific language governing permissions and limitations under the License.
#
# When distributing Covered Code, include this CDDL HEADER in each file and
# include the License file in a prominent location with the name LICENSE.CDDL.
# If applicable, add the following below this CDDL HEADER, with the fields
# enclosed by brackets "[]" replaced with your own identifying information:
#
# Portions Copyright (c) [yyyy] [name of copyright owner]. All rights reserved.
#
# CDDL HEADER END
#

#
# Copyright (c) 2013--2014, Regents of the University of Minnesota.
# All rights reserved.
#
# Contributors:
#    Ryan S. Elliott
#    Ellad B. Tadmor
#    Valeriu Smirichinski
#

#
# Release: This file is part of the kim-api-v1.6.3 package.
#


This directory (ex_model_driver_P_Morse) contains a shifted Morse pair potential
Model driver written in C.

   phi(r) = epsilon * ( - exp[ -2*C*(r - Rzero) ] + 2*exp[ -C*(r - Rzero) ] )
            + shift

where shift is computed so that phi(rcut) = 0.0

It complies with the KIM API interface standard, using any NBC and iterator or
locator mode, publishes its parameters, and supports optional computation of
`energy', `forces', `particleEnergy', `process_dEdr', and `process_dE2dr2'.
Its initialization routine takes a KIM API object pointer, a pointer to a
two-dimensional character array (each row of which contains the full path to a
parameter file) of the form a[b][c], a pointer to the value of c, and a pointer
to the value of b.  This Model Driver expects that only b=1 and that the
associated parameter file contains the cutoff and Morse parameters which define
a KIM Model based on this KIM Model Driver.

To create a KIM Model from this Model Driver, a parameter file is required.
This file must have the following format:
   Line 1: `cutoff' value in angstroms
   Line 2: Morse `epsilon' value in eV
   Line 3: Morse `C' value in 1/Angstroms
   Line 4: Morse `Rzero' value in Angstroms
Any additional lines will be silently ignored.


The following files are in this directory (before any compilation is performed):

LICENSE.CDDL
     The Common Development and Distribution License (CDDL) Version 1.0 file

Makefile
    Makefile to build executables with GNU or Intel compilers

README
    This file

ex_model_driver_P_Morse.c
    C file that contains the implementation of the Morse potential Model Driver

model_driver_P_Morse.kim.tpl
    Template KIM descriptor file containing all variables and methods that are
    exposed by the driver through the KIM API interface.  This file will be
    used (by the build system) to generate a KIM descriptor file for each KIM
    Model based on this Model Driver.
