#
# 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--2018, Regents of the University of Minnesota.
# All rights reserved.
#
# Contributors:
#    Ellad B. Tadmor
#    Ryan S. Elliott
#

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


This directory (utility_config_ener_forces) contains a Verification Check that
computes the energy and forces for a read-in isolated uster and compares them
with the expected results in the input file.

Calling format:

   ./utility_config_ener_forces

and enter model name and then data file (see format below).

Notes:

1. It generates its own KIM descriptor file in a string and uses
   kim_api_string_init to set up the KIM object.

2. It figures out which species a Model supports using
   KIM_API_get_model_partcl_typs.

3. The code supports the following NBCs:

        NEIGH_RVEC_H
        NEIGH_PURE_H
        NEIGH_RVEC_F
        NEIGH_PURE_F
        MI_OPBC_H
        MI_OPBC_F
        CLUSTER

   The code runs in sequence over all NBCs supported by the Model (from the
   above list).

4. The configuration is read in the following format:

STRUCTURE OF ATOMIC CONFIGURATION FILE

The file containing the particle configuration, energy and forces must have the
following format:

N                                   Number of particles

spec1  x-coor1  y-coor1  z-coor1    Space delimited species and positions (three
  .        .        .        .      coordinates per line) where "spec" is an
  .        .        .        .      element name (e.g. "Al", "Ar", etc.).
  .        .        .        .
specN  x-coorN  y-coorN  z-coorN

Energy                              Total energy of the configuration

x-force1  y-force1  z-force1        Components of the force vector acting
    .        .        .             on each particle
    .        .        .
    .        .        .
x-forceN  y-forceN  z-forceN

Data is read in in free format.

The following files are in the 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.

utility_config_ener_forces.F03
     Fortran 2003 program that implements the Verification Check.
