58 #define EPSILON -0.0134783698072604 93 static void calc_phi(
double * epsilon,
133 ep = exp(-(*C) * (r - *Rzero));
143 *phi = (*epsilon) * (-ep2 + 2.0 * ep) + *shift;
163 ep = exp(-(*C) * (r - *Rzero));
174 *phi = (*epsilon) * (-ep2 + 2.0 * ep) + *shift;
175 *dphi = 2.0 * (*epsilon) * (*C) * (-ep + ep2);
197 ep = exp(-(*C) * (r - *Rzero));
209 *phi = (*epsilon) * (-ep2 + 2.0 * ep) + *shift;
210 *dphi = 2.0 * (*epsilon) * (*C) * (-ep + ep2);
211 *d2phi = 2.0 * (*epsilon) * (*C) * (*C) * (ep - 2.0 * ep2);
218 #undef KIM_LOGGER_FUNCTION_NAME 219 #define KIM_LOGGER_FUNCTION_NAME KIM_ModelCompute_LogEntry 220 #undef KIM_LOGGER_OBJECT_NAME 221 #define KIM_LOGGER_OBJECT_NAME modelCompute 230 double * pR_pairs = &(R_pairs[0]);
238 double * pRij = &(Rij[0]);
239 double Rij_pairs[2][3];
240 double const * pRij_pairs = &(Rij_pairs[0][0]);
244 int * pi_pairs = &(i_pairs[0]);
247 int * pj_pairs = &(j_pairs[0]);
250 int const * neighListOfCurrentPart;
253 int comp_particleEnergy;
254 int comp_process_dEdr;
255 int comp_process_d2Edr2;
270 double * particleEnergy;
278 modelComputeArguments,
282 modelComputeArguments,
284 &comp_process_d2Edr2);
288 modelComputeArguments,
292 modelComputeArguments,
294 &particleSpeciesCodes)
296 modelComputeArguments,
298 &particleContributing)
300 modelComputeArguments,
304 modelComputeArguments,
308 modelComputeArguments,
312 modelComputeArguments,
321 comp_energy = (energy != NULL);
322 comp_force = (force != NULL);
323 comp_particleEnergy = (particleEnergy != NULL);
327 (
void **) &bufferPointer);
328 cutoff = &(bufferPointer->cutoff);
329 cutsq = (*cutoff) * (*cutoff);
336 calc_phi(&epsilon, &C, &Rzero, &dummy, cutoff, *cutoff, &shift);
343 for (i = 0; i < *nParts; ++i)
345 if (
SPECCODE != particleSpeciesCodes[i])
347 LOG_ERROR(
"Unexpected species code detected");
355 if (comp_particleEnergy)
357 for (i = 0; i < *nParts; ++i) { particleEnergy[i] = 0.0; }
359 if (comp_energy) { *energy = 0.0; }
363 for (i = 0; i < *nParts; ++i)
365 for (k = 0; k <
DIM; ++k) { force[i * DIM + k] = 0.0; }
373 for (i = 0; i < *nParts; ++i)
375 if (particleContributing[i])
381 &neighListOfCurrentPart);
391 for (jj = 0; jj < numOfPartNeigh; ++jj)
393 j = neighListOfCurrentPart[jj];
395 if (!(particleContributing[j] && (j < i)))
401 for (k = 0; k <
DIM; ++k)
403 Rij[k] = coords[j * DIM + k] - coords[i * DIM + k];
406 Rsqij += Rij[k] * Rij[k];
414 if (comp_process_d2Edr2)
418 &epsilon, &C, &Rzero, &shift, cutoff, R, &phi, &dphi, &d2phi);
421 if (particleContributing[j])
429 d2Eidr = 0.5 * d2phi;
432 else if (comp_force || comp_process_dEdr)
436 &epsilon, &C, &Rzero, &shift, cutoff, R, &phi, &dphi);
439 if (particleContributing[j]) { dEidr = dphi; }
448 calc_phi(&epsilon, &C, &Rzero, &shift, cutoff, R, &phi);
452 if (comp_particleEnergy)
454 particleEnergy[i] += 0.5 * phi;
455 if (particleContributing[j]) { particleEnergy[j] += 0.5 * phi; }
459 if (particleContributing[j]) { *energy += phi; }
462 *energy += 0.5 * phi;
467 if (comp_process_dEdr)
470 modelComputeArguments, dEidr, R, pRij, i, j);
473 LOG_ERROR(
"ProcessDEDrTerm callback error");
480 if (comp_process_d2Edr2)
482 R_pairs[0] = R_pairs[1] = R;
483 Rij_pairs[0][0] = Rij_pairs[1][0] = Rij[0];
484 Rij_pairs[0][1] = Rij_pairs[1][1] = Rij[1];
485 Rij_pairs[0][2] = Rij_pairs[1][2] = Rij[2];
486 i_pairs[0] = i_pairs[1] = i;
487 j_pairs[0] = j_pairs[1] = j;
490 modelComputeArguments,
498 LOG_ERROR(
"ProcessDEDrTerm callback error");
507 for (k = 0; k <
DIM; ++k)
510 += dEidr * Rij[k] / R;
512 -= dEidr * Rij[k] / R;
529 #undef KIM_LOGGER_FUNCTION_NAME 530 #define KIM_LOGGER_FUNCTION_NAME KIM_ModelCreate_LogEntry 531 #undef KIM_LOGGER_OBJECT_NAME 532 #define KIM_LOGGER_OBJECT_NAME modelCreate 553 (void) requestedLengthUnit;
554 (void) requestedEnergyUnit;
555 (void) requestedChargeUnit;
556 (void) requestedTemperatureUnit;
557 (void) requestedTimeUnit;
632 LOG_ERROR(
"Unable to successfully initialize model");
640 #undef KIM_LOGGER_FUNCTION_NAME 641 #define KIM_LOGGER_FUNCTION_NAME KIM_ModelDestroy_LogEntry 642 #undef KIM_LOGGER_OBJECT_NAME 643 #define KIM_LOGGER_OBJECT_NAME modelDestroy 651 (
void **) &bufferPointer);
659 #undef KIM_LOGGER_FUNCTION_NAME 660 #define KIM_LOGGER_FUNCTION_NAME KIM_ModelCompute_LogEntry 661 #undef KIM_LOGGER_OBJECT_NAME 662 #define KIM_LOGGER_OBJECT_NAME modelCompute 675 modelComputeArgumentsCreate,
680 modelComputeArgumentsCreate,
685 modelComputeArgumentsCreate,
693 modelComputeArgumentsCreate,
698 modelComputeArgumentsCreate,
704 LOG_ERROR(
"Unable to successfully initialize compute arguments");
717 (void) modelComputeArgumentsDestroy;
void KIM_ModelCreate_SetInfluenceDistancePointer(KIM_ModelCreate *const modelCreate, double const *const influenceDistance)
Set the Model's influence distance data pointer.
int KIM_ModelComputeArgumentsCreateFunction(KIM_ModelCompute const *const modelCompute, KIM_ModelComputeArgumentsCreate *const modelComputeArgumentsCreate)
Prototype for MODEL_ROUTINE_NAME::ComputeArgumentsCreate routine.
KIM_SupportStatus const KIM_SUPPORT_STATUS_optional
The standard optional status.
KIM_ComputeArgumentName const KIM_COMPUTE_ARGUMENT_NAME_coordinates
The standard coordinates argument.
KIM_ComputeCallbackName const KIM_COMPUTE_CALLBACK_NAME_ProcessD2EDr2Term
The standard ProcessD2EDr2Term callback.
KIM_ComputeArgumentName const KIM_COMPUTE_ARGUMENT_NAME_partialParticleEnergy
The standard partialParticleEnergy argument.
void() KIM_Function(void)
Generic function type.
int model_create(KIM_ModelCreate *const modelCreate, KIM_LengthUnit const requestedLengthUnit, KIM_EnergyUnit const requestedEnergyUnit, KIM_ChargeUnit const requestedChargeUnit, KIM_TemperatureUnit const requestedTemperatureUnit, KIM_TimeUnit const requestedTimeUnit)
void KIM_ModelDestroy_GetModelBufferPointer(KIM_ModelDestroy const *const modelDestroy, void **const ptr)
Get the Model's buffer pointer within the Model object.
recursive subroutine, public destroy(model_destroy_handle, ierr)
KIM_LanguageName const KIM_LANGUAGE_NAME_c
The standard c language.
KIM_ComputeArgumentName const KIM_COMPUTE_ARGUMENT_NAME_partialForces
The standard partialForces argument.
#define LOG_ERROR(message)
Convenience macro for ERROR Log entries with compile-time optimization.
int KIM_ModelComputeArguments_GetArgumentPointerDouble(KIM_ModelComputeArguments const *const modelComputeArguments, KIM_ComputeArgumentName const computeArgumentName, double **const ptr)
Get the data pointer for a ComputeArgumentName.
int KIM_ModelComputeArguments_ProcessD2EDr2Term(KIM_ModelComputeArguments const *const modelComputeArguments, double const de, double const *const r, double const *const dx, int const *const i, int const *const j)
Call the Simulator's COMPUTE_CALLBACK_NAME::ProcessD2EDr2Term routine.
An Extensible Enumeration for the EnergyUnit's supported by the KIM API.
KIM_ModelRoutineName const KIM_MODEL_ROUTINE_NAME_ComputeArgumentsCreate
The standard ComputeArgumentsCreate routine.
KIM_ComputeArgumentName const KIM_COMPUTE_ARGUMENT_NAME_particleSpeciesCodes
The standard particleSpeciesCodes argument.
KIM_ModelRoutineName const KIM_MODEL_ROUTINE_NAME_Compute
The standard Compute routine.
int KIM_ModelCreateFunction(KIM_ModelCreate *const modelCreate, KIM_LengthUnit const requestedLengthUnit, KIM_EnergyUnit const requestedEnergyUnit, KIM_ChargeUnit const requestedChargeUnit, KIM_TemperatureUnit const requestedTemperatureUnit, KIM_TimeUnit const requestedTimeUnit)
Prototype for MODEL_ROUTINE_NAME::Create routine.
int KIM_ModelComputeArgumentsCreate_SetCallbackSupportStatus(KIM_ModelComputeArgumentsCreate *const modelComputeArgumentsCreate, KIM_ComputeCallbackName const computeCallbackName, KIM_SupportStatus const supportStatus)
Set the SupportStatus of a ComputeCallbackName.
An Extensible Enumeration for the LengthUnit's supported by the KIM API.
struct KIM_ModelCompute KIM_ModelCompute
Forward declaration.
An Extensible Enumeration for the ChargeUnit's supported by the KIM API.
int KIM_ModelComputeArguments_IsCallbackPresent(KIM_ModelComputeArguments const *const modelComputeArguments, KIM_ComputeCallbackName const computeCallbackName, int *const present)
Determine if the Simulator has provided a non-NULL function pointer for a ComputeCallbackName of inte...
KIM_TemperatureUnit const KIM_TEMPERATURE_UNIT_unused
Indicates that a TemperatureUnit is not used.
struct KIM_ModelComputeArgumentsCreate KIM_ModelComputeArgumentsCreate
Forward declaration.
KIM_SpeciesName const KIM_SPECIES_NAME_Ar
The standard Argon species.
ChargeUnit const C
The standard Coulomb unit of charge.
struct KIM_ModelDestroy KIM_ModelDestroy
Forward declaration.
KIM_TimeUnit const KIM_TIME_UNIT_unused
Indicates that a TimeUnit is not used.
static void calc_phi_dphi(double *epsilon, double *C, double *Rzero, double *shift, double *cutoff, double r, double *phi, double *dphi)
int KIM_ModelComputeArgumentsDestroyFunction(KIM_ModelCompute const *const modelCompute, KIM_ModelComputeArgumentsDestroy *const modelComputeArgumentsDestroy)
Prototype for MODEL_ROUTINE_NAME::ComputeArgumentsDestroy routine.
KIM_ModelRoutineName const KIM_MODEL_ROUTINE_NAME_Destroy
The standard Destroy routine.
void KIM_ModelCreate_SetModelBufferPointer(KIM_ModelCreate *const modelCreate, void *const ptr)
Set the Model's buffer pointer within the Model object.
static void calc_phi_d2phi(double *epsilon, double *C, double *Rzero, double *shift, double *cutoff, double r, double *phi, double *dphi, double *d2phi)
ComputeArgumentName const particleContributing
The standard particleContributing argument.
int KIM_ModelComputeArgumentsCreate_SetArgumentSupportStatus(KIM_ModelComputeArgumentsCreate *const modelComputeArgumentsCreate, KIM_ComputeArgumentName const computeArgumentName, KIM_SupportStatus const supportStatus)
Set the SupportStatus of a ComputeArgumentName.
struct KIM_ModelCreate KIM_ModelCreate
Forward declaration.
void KIM_ModelCompute_GetModelBufferPointer(KIM_ModelCompute const *const modelCompute, void **const ptr)
Get the Model's buffer pointer within the Model object.
KIM_ComputeArgumentName const KIM_COMPUTE_ARGUMENT_NAME_numberOfParticles
The standard numberOfParticles argument.
An Extensible Enumeration for the TimeUnit's supported by the KIM API.
static int compute_arguments_create(KIM_ModelCompute const *const modelCompute, KIM_ModelComputeArgumentsCreate *const modelComputeArgumentsCreate)
int KIM_ModelCreate_SetUnits(KIM_ModelCreate *const modelCreate, KIM_LengthUnit const lengthUnit, KIM_EnergyUnit const energyUnit, KIM_ChargeUnit const chargeUnit, KIM_TemperatureUnit const temperatureUnit, KIM_TimeUnit const timeUnit)
Set the Model's base unit values.
static int model_compute(KIM_ModelCompute const *const modelCompute, KIM_ModelComputeArguments const *const modelComputeArguments)
KIM_ModelRoutineName const KIM_MODEL_ROUTINE_NAME_ComputeArgumentsDestroy
The standard ComputeArgumentsDestroy routine.
static int compute_arguments_destroy(KIM_ModelCompute const *const modelCompute, KIM_ModelComputeArgumentsDestroy *const modelComputeArgumentsDestroy)
struct KIM_ModelComputeArgumentsDestroy KIM_ModelComputeArgumentsDestroy
Forward declaration.
int KIM_ModelCreate_SetModelNumbering(KIM_ModelCreate *const modelCreate, KIM_Numbering const numbering)
Set the Model's particle Numbering.
void KIM_ModelCreate_SetNeighborListPointers(KIM_ModelCreate *const modelCreate, int const numberOfNeighborLists, double const *const cutoffs, int const *const modelWillNotRequestNeighborsOfNoncontributingParticles)
Set the Model's neighbor list data pointers.
int KIM_ModelCreate_SetSpeciesCode(KIM_ModelCreate *const modelCreate, KIM_SpeciesName const speciesName, int const code)
Set integer code for supported SpeciesName.
int KIM_ModelComputeArguments_GetNeighborList(KIM_ModelComputeArguments const *const modelComputeArguments, int const neighborListIndex, int const particleNumber, int *const numberOfNeighbors, int const **const neighborsOfParticle)
Get the neighbor list for a particle of interest corresponding to a particular neighbor list cutoff d...
static void calc_phi(double *epsilon, double *C, double *Rzero, double *shift, double *cutoff, double r, double *phi)
KIM_EnergyUnit const KIM_ENERGY_UNIT_eV
The standard electronvolt unit of energy.
int modelWillNotRequestNeighborsOfNoncontributingParticles
KIM_ChargeUnit const KIM_CHARGE_UNIT_unused
Indicates that a ChargeUnit is not used.
ComputeArgumentName const particleSpeciesCodes
The standard particleSpeciesCodes argument.
int KIM_ModelCreate_SetRoutinePointer(KIM_ModelCreate *const modelCreate, KIM_ModelRoutineName const modelRoutineName, KIM_LanguageName const languageName, int const required, KIM_Function *const fptr)
Set the function pointer for the ModelRoutineName of interest.
int KIM_ModelComputeFunction(KIM_ModelCompute const *const modelCompute, KIM_ModelComputeArguments const *const modelComputeArguments)
Prototype for MODEL_ROUTINE_NAME::Compute routine.
#define LOG_INFORMATION(message)
Convenience macro for INFORMATION Log entries with compile-time optimization.
KIM_ComputeArgumentName const KIM_COMPUTE_ARGUMENT_NAME_partialEnergy
The standard partialEnergy argument.
static int model_destroy(KIM_ModelDestroy *const modelDestroy)
int KIM_ModelDestroyFunction(KIM_ModelDestroy *const modelDestroy)
Prototype for MODEL_ROUTINE_NAME::Destroy routine.
KIM_ComputeCallbackName const KIM_COMPUTE_CALLBACK_NAME_ProcessDEDrTerm
The standard ProcessDEDrTerm callback.
An Extensible Enumeration for the TemperatureUnit's supported by the KIM API.
int KIM_ModelComputeArguments_ProcessDEDrTerm(KIM_ModelComputeArguments const *const modelComputeArguments, double const de, double const r, double const *const dx, int const i, int const j)
Call the Simulator's COMPUTE_CALLBACK_NAME::ProcessDEDrTerm routine.
struct KIM_ModelComputeArguments KIM_ModelComputeArguments
Forward declaration.
KIM_LengthUnit const KIM_LENGTH_UNIT_A
The standard angstrom unit of length.
LogVerbosity const error
The standard error verbosity.
KIM_Numbering const KIM_NUMBERING_zeroBased
The standard zeroBased numbering.
int KIM_ModelComputeArguments_GetArgumentPointerInteger(KIM_ModelComputeArguments const *const modelComputeArguments, KIM_ComputeArgumentName const computeArgumentName, int **const ptr)
Get the data pointer for a ComputeArgumentName.
KIM_ComputeArgumentName const KIM_COMPUTE_ARGUMENT_NAME_particleContributing
The standard particleContributing argument.