Todo List

Page Explaination of CMake Files for %KIM API Items and Simulators

Add description of CMakeLists.txt files for simulators/projects that use the KIM-API library and use CMake.

Add description of getting build details via pkg-config for simulators/projects that use the KIM-API library but do not use CMake.

Member KIM::COMPUTE_ARGUMENT_NAME::coordinates

Add more detailed description of argument.

Member KIM::COMPUTE_ARGUMENT_NAME::numberOfParticles

Add more detailed description of argument.

Member KIM::COMPUTE_ARGUMENT_NAME::partialEnergy

Add more detailed description of argument.

Member KIM::COMPUTE_ARGUMENT_NAME::partialForces

Add more detailed description of argument.

Member KIM::COMPUTE_ARGUMENT_NAME::partialParticleEnergy

Add more detailed description of argument.

Member KIM::COMPUTE_ARGUMENT_NAME::partialParticleVirial

Add more detailed description of argument.

Member KIM::COMPUTE_ARGUMENT_NAME::partialVirial

Add more detailed description of argument.

Member KIM::COMPUTE_ARGUMENT_NAME::particleContributing

Add more detailed description of argument.

Member KIM::COMPUTE_ARGUMENT_NAME::particleSpeciesCodes

Add more detailed description of argument.

Member KIM::COMPUTE_CALLBACK_NAME::GetNeighborList

Add more detailed description of callback.

Member KIM::COMPUTE_CALLBACK_NAME::ProcessD2EDr2Term

Add more detailed description of callback.

Member KIM::COMPUTE_CALLBACK_NAME::ProcessDEDrTerm

Add more detailed description of callback.

Member KIM::ComputeArguments::SetArgumentPointer (ComputeArgumentName const computeArgumentName, int const *const ptr)

Add more detailed description what it means to provide a NULL or non-NULL value for various SupportStatus'es.

Member KIM::ComputeArguments::SetCallbackPointer (ComputeCallbackName const computeCallbackName, LanguageName const languageName, Function *const fptr, void *const dataObject)

Add more detailed description what it means to provide a NULL or non-NULL value for various SupportStatus'es. Also, describe dataObject.

Member KIM::DATA_TYPE::Double

Add more detailed description of data type.

Member KIM::DATA_TYPE::Integer

Add more detailed description of data type.

Member KIM::LANGUAGE_NAME::c

Add more detailed description of the language.

Member KIM::LANGUAGE_NAME::cpp

Add more detailed description of the language.

Member KIM::LANGUAGE_NAME::fortran

Add more detailed description of the language.

Member KIM::Model::GetInfluenceDistance (double *const influenceDistance) const

Add more detailed description of influenceDistance. (or link to docs elsewhere?)

Member KIM::MODEL_ROUTINE_NAME::Compute

Add more detailed description of routine.

Member KIM::MODEL_ROUTINE_NAME::ComputeArgumentsCreate

Add more detailed description of routine.

Member KIM::MODEL_ROUTINE_NAME::ComputeArgumentsDestroy

Add more detailed description of routine.

Member KIM::MODEL_ROUTINE_NAME::Create

Add more detailed description of routine.

Member KIM::MODEL_ROUTINE_NAME::Destroy

Add more detailed description of routine.

Member KIM::MODEL_ROUTINE_NAME::Extension

Add more detailed description of routine.

Member KIM::MODEL_ROUTINE_NAME::Refresh

Add more detailed description of routine.

Member KIM::MODEL_ROUTINE_NAME::WriteParameterizedModel

Add more detailed description of routine.

Member KIM::ModelComputeArguments::ProcessD2EDr2Term (double const de, double const *const r, double const *const dx, int const *const i, int const *const j) const

Add more detailed description of Process mechanism.

Member KIM::ModelComputeArguments::ProcessDEDrTerm (double const de, double const r, double const *const dx, int const i, int const j) const

Add more detailed description of Process mechanism.

Member KIM::ModelCreate::SetInfluenceDistancePointer (double const *const influenceDistance)

Add more detailed description of influenceDistance (or link to docs elsewhere?)

Member KIM::ModelCreate::SetNeighborListPointers (int const numberOfNeighborLists, double const *const cutoffs, int const *const modelWillNotRequestNeighborsOfNoncontributingParticles)

Add more detailed description

Member KIM::ModelDriverCreate::SetInfluenceDistancePointer (double const *const influenceDistance)

Add more detailed description of influenceDistance (or link to docs elsewhere?)

Member KIM::ModelDriverCreate::SetNeighborListPointers (int const numberOfNeighborLists, double const *const cutoffs, int const *const modelWillNotRequestNeighborsOfNoncontributingParticles)

Add more detailed description

Member KIM::ModelRefresh::SetInfluenceDistancePointer (double const *const influenceDistance)

Add more detailed description of influenceDistance (or link to docs elsewhere?)

Member KIM::ModelRefresh::SetNeighborListPointers (int const numberOfNeighborLists, double const *const cutoffs, int const *const modelWillNotRequestNeighborsOfNoncontributingParticles)

Add more detailed description

Member KIM::SUPPORT_STATUS::notSupported

Add more detailed description of status.

Member KIM::SUPPORT_STATUS::optional

Add more detailed description of status.

Member KIM::SUPPORT_STATUS::required

Add more detailed description of status.

Member KIM::SUPPORT_STATUS::requiredByAPI

Add more detailed description of status.