KIM_ComputeCallbackName.h File Reference

Go to the source code of this file.

Classes
struct	KIM_ComputeCallbackName
	An Extensible Enumeration for the ComputeCallbackName's supported by the KIM API. More...

Functions
KIM_ComputeCallbackName	KIM_ComputeCallbackName_FromString (char const *const str)
	KIM::ComputeCallbackName::ComputeCallbackName(std::string const &)
int	KIM_ComputeCallbackName_Known (KIM_ComputeCallbackName const computeCallbackName)
	Determines if the object is a quantity known to the KIM API.
int	KIM_ComputeCallbackName_Equal (KIM_ComputeCallbackName const lhs, KIM_ComputeCallbackName const rhs)
	Compares ComputeCallbackName objects for equality.
int	KIM_ComputeCallbackName_NotEqual (KIM_ComputeCallbackName const lhs, KIM_ComputeCallbackName const rhs)
	Compares ComputeCallbackName objects for inequality.
char const *	KIM_ComputeCallbackName_ToString (KIM_ComputeCallbackName const computeCallbackName)
	Converts the object to a string.
void	KIM_COMPUTE_CALLBACK_NAME_GetNumberOfComputeCallbackNames (int *const numberOfComputeCallbackNames)
int	KIM_COMPUTE_CALLBACK_NAME_GetComputeCallbackName (int const index, KIM_ComputeCallbackName *const computeCallbackName)
	Get the identity of each defined standard ComputeCallbackName.

Variables
KIM_ComputeCallbackName const	KIM_COMPUTE_CALLBACK_NAME_GetNeighborList
	The standard GetNeighborList callback.
KIM_ComputeCallbackName const	KIM_COMPUTE_CALLBACK_NAME_ProcessDEDrTerm
	The standard ProcessDEDrTerm callback.
KIM_ComputeCallbackName const	KIM_COMPUTE_CALLBACK_NAME_ProcessD2EDr2Term
	The standard ProcessD2EDr2Term callback.

Function Documentation

KIM_COMPUTE_CALLBACK_NAME_GetComputeCallbackName()

int KIM_COMPUTE_CALLBACK_NAME_GetComputeCallbackName	(	int const	index,
		KIM_ComputeCallbackName *const	computeCallbackName )

Get the identity of each defined standard ComputeCallbackName.

See also

KIM::COMPUTE_CALLBACK_NAME::GetComputeCallbackName, kim_compute_callback_name_module::kim_get_compute_callback_name

Since

2.0

KIM_COMPUTE_CALLBACK_NAME_GetNumberOfComputeCallbackNames()

void KIM_COMPUTE_CALLBACK_NAME_GetNumberOfComputeCallbackNames

(

int *const

numberOfComputeCallbackNames

)

KIM_ComputeCallbackName_Equal()

int KIM_ComputeCallbackName_Equal	(	KIM_ComputeCallbackName const	lhs,
		KIM_ComputeCallbackName const	rhs )

Compares ComputeCallbackName objects for equality.

See also

KIM::ComputeCallbackName::operator==(), kim_compute_callback_name_module::operator(.eq.)

Since

2.0

KIM_ComputeCallbackName_FromString()

KIM_ComputeCallbackName KIM_ComputeCallbackName_FromString

(

char const *const

str

)

KIM::ComputeCallbackName::ComputeCallbackName(std::string const &)

See also

KIM::ComputeCallbackName::ComputeCallbackName(std::string const &), kim_compute_callback_name_module::kim_from_string

Since

2.0

KIM_ComputeCallbackName_Known()

int KIM_ComputeCallbackName_Known

(

KIM_ComputeCallbackName const

computeCallbackName

)

Determines if the object is a quantity known to the KIM API.

See also

KIM::ComputeCallbackName::Known, kim_compute_callback_name_module::kim_known

Since

2.0

KIM_ComputeCallbackName_NotEqual()

int KIM_ComputeCallbackName_NotEqual	(	KIM_ComputeCallbackName const	lhs,
		KIM_ComputeCallbackName const	rhs )

Compares ComputeCallbackName objects for inequality.

See also

KIM::ComputeCallbackName::operator!=(), kim_compute_callback_name_module::operator(.ne.)

Since

2.0

KIM_ComputeCallbackName_ToString()

char const * KIM_ComputeCallbackName_ToString

(

KIM_ComputeCallbackName const

computeCallbackName

)

Converts the object to a string.

See also

KIM::ComputeCallbackName::ToString, kim_compute_callback_name_module::kim_to_string

Since

2.0

Variable Documentation

KIM_COMPUTE_CALLBACK_NAME_GetNeighborList

KIM_ComputeCallbackName const KIM_COMPUTE_CALLBACK_NAME_GetNeighborList

extern

The standard GetNeighborList callback.

See also

KIM::COMPUTE_CALLBACK_NAME::GetNeighborList, kim_compute_callback_name_module:: kim_compute_callback_name_get_neighbor_list

Since

2.0

KIM_COMPUTE_CALLBACK_NAME_ProcessD2EDr2Term

KIM_ComputeCallbackName const KIM_COMPUTE_CALLBACK_NAME_ProcessD2EDr2Term

extern

The standard ProcessD2EDr2Term callback.

See also

KIM::COMPUTE_CALLBACK_NAME::ProcessD2EDr2Term, kim_compute_callback_name_module:: kim_compute_callback_name_process_d2edr2_term

Since

2.0

KIM_COMPUTE_CALLBACK_NAME_ProcessDEDrTerm

KIM_ComputeCallbackName const KIM_COMPUTE_CALLBACK_NAME_ProcessDEDrTerm

extern

The standard ProcessDEDrTerm callback.

See also

KIM::COMPUTE_CALLBACK_NAME::ProcessDEDrTerm, kim_compute_callback_name_module:: kim_compute_callback_name_process_dedr_term

Since

2.0