KIM API V2
KIM_ModelDriverCreate.h
Go to the documentation of this file.
1 /* */
2 /* CDDL HEADER START */
3 /* */
4 /* The contents of this file are subject to the terms of the Common */
5 /* Development and Distribution License Version 1.0 (the "License"). */
6 /* */
7 /* You can obtain a copy of the license at */
8 /* http://www.opensource.org/licenses/CDDL-1.0. See the License for the */
9 /* specific language governing permissions and limitations under the License. */
10 /* */
11 /* When distributing Covered Code, include this CDDL HEADER in each file and */
12 /* include the License file in a prominent location with the name */
13 /* LICENSE.CDDL. */
14 /* If applicable, add the following below this CDDL HEADER, with the fields */
15 /* enclosed by brackets "[]" replaced with your own identifying information: */
16 /* */
17 /* Portions Copyright (c) [yyyy] [name of copyright owner]. */
18 /* All rights reserved. */
19 /* */
20 /* CDDL HEADER END */
21 /* */
22 
23 /* */
24 /* Copyright (c) 2016--2018, Regents of the University of Minnesota. */
25 /* All rights reserved. */
26 /* */
27 /* Contributors: */
28 /* Ryan S. Elliott */
29 /* */
30 
31 /* */
32 /* Release: This file is part of the kim-api-v2.0.0-alpha.0 package. */
33 /* */
34 
35 
36 #ifndef KIM_MODEL_DRIVER_CREATE_H_
37 #define KIM_MODEL_DRIVER_CREATE_H_
38 
39 #ifndef KIM_FUNC_H_
40 #include "KIM_func.h"
41 #endif
42 
43 /* Forward declarations */
44 #ifndef KIM_LOG_VERBOSITY_DEFINED_
45 #define KIM_LOG_VERBOSITY_DEFINED_
47 #endif
48 
49 #ifndef KIM_SPECIES_NAME_DEFINED_
50 #define KIM_SPECIES_NAME_DEFINED_
52 #endif
53 
54 #ifndef KIM_LANGUAGE_NAME_DEFINED_
55 #define KIM_LANGUAGE_NAME_DEFINED_
57 #endif
58 
59 #ifndef KIM_NUMBERING_DEFINED_
60 #define KIM_NUMBERING_DEFINED_
62 #endif
63 
64 #ifndef KIM_LENGTH_UNIT_DEFINED_
65 #define KIM_LENGTH_UNIT_DEFINED_
67 #endif
68 
69 #ifndef KIM_ENERGY_UNIT_DEFINED_
70 #define KIM_ENERGY_UNIT_DEFINED_
72 #endif
73 
74 #ifndef KIM_CHARGE_UNIT_DEFINED_
75 #define KIM_CHARGE_UNIT_DEFINED_
77 #endif
78 
79 #ifndef KIM_TEMPERATURE_UNIT_DEFINED_
80 #define KIM_TEMPERATURE_UNIT_DEFINED_
82 #endif
83 
84 #ifndef KIM_TIME_UNIT_DEFINED_
85 #define KIM_TIME_UNIT_DEFINED_
86 typedef struct KIM_TimeUnit KIM_TimeUnit;
87 #endif
88 
89 #ifndef KIM_SUPPORT_STATUS_DEFINED_
90 #define KIM_SUPPORT_STATUS_DEFINED_
92 #endif
93 
94 #ifndef KIM_ARGUMENT_NAME_DEFINED_
95 #define KIM_ARGUMENT_NAME_DEFINED_
97 #endif
98 
99 #ifndef KIM_CALLBACK_NAME_DEFINED_
100 #define KIM_CALLBACK_NAME_DEFINED_
102 #endif
103 
104 
105 struct KIM_ModelDriverCreate;
106 
107 #ifndef KIM_MODEL_DRIVER_CREATE_DEFINED_
108 #define KIM_MODEL_DRIVER_CREATE_DEFINED_
110 #endif
111 
112 
114  KIM_ModelDriverCreate * const modelDriverCreate,
115  int * const numberOfParameterFiles);
116 
118  KIM_ModelDriverCreate * const modelDriverCreate,
119  int const index, char const ** const parameterFileName);
120 
122  KIM_ModelDriverCreate * const modelDriverCreate,
123  KIM_Numbering const numbering);
124 
126  KIM_ModelDriverCreate * const modelDriverCreate,
127  double * const influenceDistance);
128 
130  KIM_ModelDriverCreate * const modelDriverCreate,
131  int const numberOfCutoffs, double const * const cutoffs);
132 
134  KIM_ModelDriverCreate * const modelDriverCreate,
135  KIM_LanguageName const languageName, func * const fptr);
137  KIM_ModelDriverCreate * const modelDriverCreate,
138  KIM_LanguageName const languageName, func * const fptr);
140  KIM_ModelDriverCreate * const modelDriverCreate,
141  KIM_LanguageName const languageName, func * const fptr);
142 
144  KIM_ModelDriverCreate * const modelDriverCreate,
145  KIM_SpeciesName const speciesName, int const code);
146 
148  KIM_ModelDriverCreate * const modelDriverCreate,
149  KIM_ArgumentName const argumentName, KIM_SupportStatus const supportStatus);
150 
152  KIM_ModelDriverCreate * const modelDriverCreate,
153  KIM_CallbackName const callbackName, KIM_SupportStatus const supportStatus);
154 
156  KIM_ModelDriverCreate * const modelDriverCreate,
157  int const extent, int * const ptr, char const * const description);
158 
160  KIM_ModelDriverCreate * const modelDriverCreate,
161  int const extent, double * const ptr, char const * const description);
162 
164  KIM_ModelDriverCreate * const modelDriverCreate,
165  void * const ptr);
166 
168  KIM_ModelDriverCreate * const modelDriverCreate,
169  KIM_LengthUnit const lengthUnit,
170  KIM_EnergyUnit const energyUnit,
171  KIM_ChargeUnit const chargeUnit,
172  KIM_TemperatureUnit const temperatureUnit,
173  KIM_TimeUnit const timeUnit);
174 
176  KIM_ModelDriverCreate const * const modelDriverCreate,
177  KIM_LengthUnit const fromLengthUnit,
178  KIM_EnergyUnit const fromEnergyUnit,
179  KIM_ChargeUnit const fromChargeUnit,
180  KIM_TemperatureUnit const fromTemperatureUnit,
181  KIM_TimeUnit const fromTimeUnit,
182  KIM_LengthUnit const toLengthUnit,
183  KIM_EnergyUnit const toEnergyUnit,
184  KIM_ChargeUnit const toChargeUnit,
185  KIM_TemperatureUnit const toTemperatureUnit,
186  KIM_TimeUnit const toTimeUnit,
187  double const lengthExponent,
188  double const energyExponent,
189  double const chargeExponent,
190  double const temperatureExponent,
191  double const timeExponent,
192  double * const conversionFactor);
193 
195  KIM_ModelDriverCreate const * const modelDriverCreate,
196  KIM_LogVerbosity const logVerbosity, char const * const message,
197  int const lineNumber, char const * const fileName);
198 
199 char const * const KIM_ModelDriverCreate_String(
200  KIM_ModelDriverCreate const * const modelDriverCreate);
201 
202 #endif /* KIM_MODEL_DRIVE_CREATE_H_ */
void KIM_ModelDriverCreate_GetNumberOfParameterFiles(KIM_ModelDriverCreate *const modelDriverCreate, int *const numberOfParameterFiles)
int KIM_ModelDriverCreate_SetUnits(KIM_ModelDriverCreate *const modelDriverCreate, KIM_LengthUnit const lengthUnit, KIM_EnergyUnit const energyUnit, KIM_ChargeUnit const chargeUnit, KIM_TemperatureUnit const temperatureUnit, KIM_TimeUnit const timeUnit)
char const *const KIM_ModelDriverCreate_String(KIM_ModelDriverCreate const *const modelDriverCreate)
void KIM_ModelDriverCreate_SetInfluenceDistancePointer(KIM_ModelDriverCreate *const modelDriverCreate, double *const influenceDistance)
int KIM_ModelDriverCreate_SetArgumentSupportStatus(KIM_ModelDriverCreate *const modelDriverCreate, KIM_ArgumentName const argumentName, KIM_SupportStatus const supportStatus)
int KIM_ModelDriverCreate_SetParameterPointerInteger(KIM_ModelDriverCreate *const modelDriverCreate, int const extent, int *const ptr, char const *const description)
struct KIM_ModelDriverCreate KIM_ModelDriverCreate
void KIM_ModelDriverCreate_SetNeighborListCutoffsPointer(KIM_ModelDriverCreate *const modelDriverCreate, int const numberOfCutoffs, double const *const cutoffs)
void() func()
Definition: KIM_func.h:39
int KIM_ModelDriverCreate_ConvertUnit(KIM_ModelDriverCreate const *const modelDriverCreate, KIM_LengthUnit const fromLengthUnit, KIM_EnergyUnit const fromEnergyUnit, KIM_ChargeUnit const fromChargeUnit, KIM_TemperatureUnit const fromTemperatureUnit, KIM_TimeUnit const fromTimeUnit, KIM_LengthUnit const toLengthUnit, KIM_EnergyUnit const toEnergyUnit, KIM_ChargeUnit const toChargeUnit, KIM_TemperatureUnit const toTemperatureUnit, KIM_TimeUnit const toTimeUnit, double const lengthExponent, double const energyExponent, double const chargeExponent, double const temperatureExponent, double const timeExponent, double *const conversionFactor)
int KIM_ModelDriverCreate_SetParameterPointerDouble(KIM_ModelDriverCreate *const modelDriverCreate, int const extent, double *const ptr, char const *const description)
int KIM_ModelDriverCreate_GetParameterFileName(KIM_ModelDriverCreate *const modelDriverCreate, int const index, char const **const parameterFileName)
int KIM_ModelDriverCreate_SetSpeciesCode(KIM_ModelDriverCreate *const modelDriverCreate, KIM_SpeciesName const speciesName, int const code)
int KIM_ModelDriverCreate_SetComputePointer(KIM_ModelDriverCreate *const modelDriverCreate, KIM_LanguageName const languageName, func *const fptr)
int KIM_ModelDriverCreate_SetDestroyPointer(KIM_ModelDriverCreate *const modelDriverCreate, KIM_LanguageName const languageName, func *const fptr)
void KIM_ModelDriverCreate_SetModelBufferPointer(KIM_ModelDriverCreate *const modelDriverCreate, void *const ptr)
int KIM_ModelDriverCreate_SetModelNumbering(KIM_ModelDriverCreate *const modelDriverCreate, KIM_Numbering const numbering)
int KIM_ModelDriverCreate_SetRefreshPointer(KIM_ModelDriverCreate *const modelDriverCreate, KIM_LanguageName const languageName, func *const fptr)
int KIM_ModelDriverCreate_SetCallbackSupportStatus(KIM_ModelDriverCreate *const modelDriverCreate, KIM_CallbackName const callbackName, KIM_SupportStatus const supportStatus)
void KIM_ModelDriverCreate_LogEntry(KIM_ModelDriverCreate const *const modelDriverCreate, KIM_LogVerbosity const logVerbosity, char const *const message, int const lineNumber, char const *const fileName)