31#ifndef KIM_MODEL_CREATE_HPP_
32#define KIM_MODEL_CREATE_HPP_
37#ifndef KIM_FUNCTION_TYPES_HPP_
47class ModelRoutineName;
54class ModelCreateImplementation;
127 int const numberOfNeighborLists,
128 double const *
const cutoffs,
129 int const *
const modelWillNotRequestNeighborsOfNoncontributingParticles);
209 std::string
const & name,
210 std::string
const & description);
215 std::string
const & name,
216 std::string
const & description);
304 double const lengthExponent,
305 double const energyExponent,
306 double const chargeExponent,
307 double const temperatureExponent,
308 double const timeExponent,
309 double *
const conversionFactor);
327 std::string
const & message,
328 int const lineNumber,
329 std::string
const & fileName)
const;
333 std::stringstream
const & message,
334 int const lineNumber,
335 std::string
const & fileName)
const;
357 ModelCreateImplementation * pimpl;
An Extensible Enumeration for the ChargeUnit's supported by the KIM API.
An Extensible Enumeration for the EnergyUnit's supported by the KIM API.
An Extensible Enumeration for the LanguageName's supported by the KIM API.
An Extensible Enumeration for the LengthUnit's supported by the KIM API.
An Extensible Enumeration for the LogVerbosity's supported by the KIM API.
Provides the interface to a KIM API Model object for use by models within their MODEL_ROUTINE_NAME::C...
std::string const & ToString() const
Get a string representing the internal state of the Model object.
void SetInfluenceDistancePointer(double const *const influenceDistance)
Set the Model's influence distance data pointer.
int SetRoutinePointer(ModelRoutineName const modelRoutineName, LanguageName const languageName, int const required, Function *const fptr)
Set the function pointer for the ModelRoutineName of interest.
void LogEntry(LogVerbosity const logVerbosity, std::stringstream const &message, int const lineNumber, std::string const &fileName) const
This is an overloaded member function, provided for convenience. It differs from the above function o...
int SetSpeciesCode(SpeciesName const speciesName, int const code)
Set integer code for supported SpeciesName.
void LogEntry(LogVerbosity const logVerbosity, std::string const &message, int const lineNumber, std::string const &fileName) const
Write a log entry into the log file.
int SetParameterPointer(int const extent, double *const ptr, std::string const &name, std::string const &description)
This is an overloaded member function, provided for convenience. It differs from the above function o...
int SetModelNumbering(Numbering const numbering)
Set the Model's particle Numbering.
void SetNeighborListPointers(int const numberOfNeighborLists, double const *const cutoffs, int const *const modelWillNotRequestNeighborsOfNoncontributingParticles)
Set the Model's neighbor list data pointers.
void SetModelBufferPointer(void *const ptr)
Set the Model's buffer pointer within the Model object.
static int ConvertUnit(LengthUnit const fromLengthUnit, EnergyUnit const fromEnergyUnit, ChargeUnit const fromChargeUnit, TemperatureUnit const fromTemperatureUnit, TimeUnit const fromTimeUnit, LengthUnit const toLengthUnit, EnergyUnit const toEnergyUnit, ChargeUnit const toChargeUnit, TemperatureUnit const toTemperatureUnit, TimeUnit const toTimeUnit, double const lengthExponent, double const energyExponent, double const chargeExponent, double const temperatureExponent, double const timeExponent, double *const conversionFactor)
Get the multiplicative factor to convert between a derived unit represented in two different sets of ...
int SetParameterPointer(int const extent, int *const ptr, std::string const &name, std::string const &description)
Set the next parameter data pointer to be provided by the model.
int SetUnits(LengthUnit const lengthUnit, EnergyUnit const energyUnit, ChargeUnit const chargeUnit, TemperatureUnit const temperatureUnit, TimeUnit const timeUnit)
Set the Model's base unit values.
An Extensible Enumeration for the ModelRoutineName's supported by the KIM API.
An Extensible Enumeration for the Numbering's supported by the KIM API.
An Extensible Enumeration for the SpeciesName's supported by the KIM API.
An Extensible Enumeration for the TemperatureUnit's supported by the KIM API.
An Extensible Enumeration for the TimeUnit's supported by the KIM API.
void() Function(void)
Generic function type.