kim-api  2.1.4-git+v2.1.3-git-1-g7847914a.GNU
An Application Programming Interface (API) for the Knowledgebase of Interatomic Models (KIM).
Classes | Typedefs | Functions | Variables
KIM_ComputeArgumentName.h File Reference
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  KIM_ComputeArgumentName
 An Extensible Enumeration for the ComputeArgumentName's supported by the KIM API. More...
 

Typedefs

typedef struct KIM_DataType KIM_DataType
 Forward declaration. More...
 
typedef struct KIM_ComputeArgumentName KIM_ComputeArgumentName
 Convenience typedef. More...
 

Functions

KIM_ComputeArgumentName KIM_ComputeArgumentName_FromString (char const *const str)
 Create a ComputeArgumentName object corresponding to the provided string. If the string does not match one of the values defined by the KIM API, then an "unknown" object is generated. More...
 
int KIM_ComputeArgumentName_Known (KIM_ComputeArgumentName const computeArgumentName)
 Determines if the object is a quantity known to the KIM API. More...
 
int KIM_ComputeArgumentName_Equal (KIM_ComputeArgumentName const lhs, KIM_ComputeArgumentName const rhs)
 Compares ComputeArgumentName objects for equality. More...
 
int KIM_ComputeArgumentName_NotEqual (KIM_ComputeArgumentName const lhs, KIM_ComputeArgumentName const rhs)
 Compares ComputeArgumentName objects for inequality. More...
 
char const * KIM_ComputeArgumentName_ToString (KIM_ComputeArgumentName const computeArgumentName)
 Converts the object to a string. More...
 
void KIM_COMPUTE_ARGUMENT_NAME_GetNumberOfComputeArgumentNames (int *const numberOfComputeArgumentNames)
 Get the number of standard ComputeArgumentName's defined by the KIM API. More...
 
int KIM_COMPUTE_ARGUMENT_NAME_GetComputeArgumentName (int const index, KIM_ComputeArgumentName *const computeArgumentName)
 Get the identity of each defined standard ComputeArgumentName. More...
 
int KIM_COMPUTE_ARGUMENT_NAME_GetComputeArgumentDataType (KIM_ComputeArgumentName const computeArgumentName, KIM_DataType *const dataType)
 Get the DataType of each defined standard ComputeArgumentName. More...
 

Variables

KIM_ComputeArgumentName const KIM_COMPUTE_ARGUMENT_NAME_numberOfParticles
 The standard numberOfParticles argument. More...
 
KIM_ComputeArgumentName const KIM_COMPUTE_ARGUMENT_NAME_particleSpeciesCodes
 The standard particleSpeciesCodes argument. More...
 
KIM_ComputeArgumentName const KIM_COMPUTE_ARGUMENT_NAME_particleContributing
 The standard particleContributing argument. More...
 
KIM_ComputeArgumentName const KIM_COMPUTE_ARGUMENT_NAME_coordinates
 The standard coordinates argument. More...
 
KIM_ComputeArgumentName const KIM_COMPUTE_ARGUMENT_NAME_partialEnergy
 The standard partialEnergy argument. More...
 
KIM_ComputeArgumentName const KIM_COMPUTE_ARGUMENT_NAME_partialForces
 The standard partialForces argument. More...
 
KIM_ComputeArgumentName const KIM_COMPUTE_ARGUMENT_NAME_partialParticleEnergy
 The standard partialParticleEnergy argument. More...
 
KIM_ComputeArgumentName const KIM_COMPUTE_ARGUMENT_NAME_partialVirial
 The standard partialVirial argument. More...
 
KIM_ComputeArgumentName const KIM_COMPUTE_ARGUMENT_NAME_partialParticleVirial
 The standard partialParticleVirial argument. More...
 

Typedef Documentation

◆ KIM_ComputeArgumentName

Convenience typedef.

Since
2.0

Definition at line 79 of file KIM_ComputeArgumentName.h.

◆ KIM_DataType

typedef struct KIM_DataType KIM_DataType

Forward declaration.

Since
2.0

Definition at line 47 of file KIM_ComputeArgumentName.h.

Function Documentation

◆ KIM_COMPUTE_ARGUMENT_NAME_GetComputeArgumentDataType()

int KIM_COMPUTE_ARGUMENT_NAME_GetComputeArgumentDataType ( KIM_ComputeArgumentName const  computeArgumentName,
KIM_DataType *const  dataType 
)

Get the DataType of each defined standard ComputeArgumentName.

See also
KIM::COMPUTE_ARGUMENT_NAME::GetComputeArgumentDataType, kim_compute_argument_name_module::kim_get_compute_argument_data_type
Since
2.0

◆ KIM_COMPUTE_ARGUMENT_NAME_GetComputeArgumentName()

int KIM_COMPUTE_ARGUMENT_NAME_GetComputeArgumentName ( int const  index,
KIM_ComputeArgumentName *const  computeArgumentName 
)

Get the identity of each defined standard ComputeArgumentName.

See also
KIM::COMPUTE_ARGUMENT_NAME::GetComputeArgumentName, kim_compute_argument_name_module::kim_get_compute_argument_name
Since
2.0

◆ KIM_COMPUTE_ARGUMENT_NAME_GetNumberOfComputeArgumentNames()

void KIM_COMPUTE_ARGUMENT_NAME_GetNumberOfComputeArgumentNames ( int *const  numberOfComputeArgumentNames)

Get the number of standard ComputeArgumentName's defined by the KIM API.

See also
KIM::COMPUTE_ARGUMENT_NAME::GetNumberOfComputeArgumentNames, kim_compute_argument_name_module::kim_get_number_of_compute_argument_names
Since
2.0

◆ KIM_ComputeArgumentName_Equal()

int KIM_ComputeArgumentName_Equal ( KIM_ComputeArgumentName const  lhs,
KIM_ComputeArgumentName const  rhs 
)

Compares ComputeArgumentName objects for equality.

See also
KIM::ComputeArgumentName::operator==(), kim_compute_argument_name_module::operator(.eq.)
Since
2.0

◆ KIM_ComputeArgumentName_FromString()

KIM_ComputeArgumentName KIM_ComputeArgumentName_FromString ( char const *const  str)

Create a ComputeArgumentName object corresponding to the provided string. If the string does not match one of the values defined by the KIM API, then an "unknown" object is generated.

See also
KIM::ComputeArgumentName::ComputeArgumentName(std::string const &), kim_compute_argument_name_module::kim_from_string
Since
2.0

◆ KIM_ComputeArgumentName_Known()

int KIM_ComputeArgumentName_Known ( KIM_ComputeArgumentName const  computeArgumentName)

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

See also
KIM::ComputeArgumentName::Known, kim_compute_argument_name_module::kim_known
Since
2.0

◆ KIM_ComputeArgumentName_NotEqual()

int KIM_ComputeArgumentName_NotEqual ( KIM_ComputeArgumentName const  lhs,
KIM_ComputeArgumentName const  rhs 
)

Compares ComputeArgumentName objects for inequality.

See also
KIM::ComputeArgumentName::operator!=(), kim_compute_argument_name_module::operator(.ne.)
Since
2.0

◆ KIM_ComputeArgumentName_ToString()

char const* KIM_ComputeArgumentName_ToString ( KIM_ComputeArgumentName const  computeArgumentName)

Converts the object to a string.

See also
KIM::ComputeArgumentName::ToString, kim_compute_argument_name_module::kim_to_string
Since
2.0

Variable Documentation

◆ KIM_COMPUTE_ARGUMENT_NAME_coordinates

KIM_ComputeArgumentName const KIM_COMPUTE_ARGUMENT_NAME_coordinates

◆ KIM_COMPUTE_ARGUMENT_NAME_numberOfParticles

KIM_ComputeArgumentName const KIM_COMPUTE_ARGUMENT_NAME_numberOfParticles

◆ KIM_COMPUTE_ARGUMENT_NAME_partialEnergy

KIM_ComputeArgumentName const KIM_COMPUTE_ARGUMENT_NAME_partialEnergy

◆ KIM_COMPUTE_ARGUMENT_NAME_partialForces

KIM_ComputeArgumentName const KIM_COMPUTE_ARGUMENT_NAME_partialForces

◆ KIM_COMPUTE_ARGUMENT_NAME_partialParticleEnergy

KIM_ComputeArgumentName const KIM_COMPUTE_ARGUMENT_NAME_partialParticleEnergy

◆ KIM_COMPUTE_ARGUMENT_NAME_partialParticleVirial

KIM_ComputeArgumentName const KIM_COMPUTE_ARGUMENT_NAME_partialParticleVirial

◆ KIM_COMPUTE_ARGUMENT_NAME_partialVirial

KIM_ComputeArgumentName const KIM_COMPUTE_ARGUMENT_NAME_partialVirial

◆ KIM_COMPUTE_ARGUMENT_NAME_particleContributing

KIM_ComputeArgumentName const KIM_COMPUTE_ARGUMENT_NAME_particleContributing

◆ KIM_COMPUTE_ARGUMENT_NAME_particleSpeciesCodes

KIM_ComputeArgumentName const KIM_COMPUTE_ARGUMENT_NAME_particleSpeciesCodes