kim-api  2.1.4-git+v2.1.3-git-3-g4c859c7f.GNU
An Application Programming Interface (API) for the Knowledgebase of Interatomic Models (KIM).
KIM_ModelWriteParameterizedModel.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--2019, 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.git repository. */
33 /* */
34 
35 
36 #ifndef KIM_MODEL_WRITE_PARAMETERIZED_MODEL_H_
37 #define KIM_MODEL_WRITE_PARAMETERIZED_MODEL_H_
38 
39 /* Forward declarations */
40 #ifndef KIM_LOG_VERBOSITY_DEFINED_
41 #define KIM_LOG_VERBOSITY_DEFINED_
42 
48 #endif
49 
50 
51 #ifndef KIM_MODEL_WRITE_PARAMETERIZED_MODEL_DEFINED_
52 #define KIM_MODEL_WRITE_PARAMETERIZED_MODEL_DEFINED_
53 
64 #endif
65 
75  KIM_ModelWriteParameterizedModel const * const modelWriteParameterizedModel,
76  char const ** const path);
77 
87  KIM_ModelWriteParameterizedModel const * const modelWriteParameterizedModel,
88  char const ** const modelName);
89 
99  KIM_ModelWriteParameterizedModel const * const modelWriteParameterizedModel,
100  char const * const fileName);
101 
111  KIM_ModelWriteParameterizedModel const * const modelWriteParameterizedModel,
112  void ** const ptr);
113 
123  KIM_ModelWriteParameterizedModel const * const modelWriteParameterizedModel,
124  KIM_LogVerbosity const logVerbosity,
125  char const * const message,
126  int const lineNumber,
127  char const * const fileName);
128 
139  modelWriteParameterizedModel);
140 
141 #endif /* KIM_MODEL_WRITE_PARAMETERIZED_MODEL_H_ */
void KIM_ModelWriteParameterizedModel_LogEntry(KIM_ModelWriteParameterizedModel const *const modelWriteParameterizedModel, KIM_LogVerbosity const logVerbosity, char const *const message, int const lineNumber, char const *const fileName)
Write a log entry into the log file.
void KIM_ModelWriteParameterizedModel_SetParameterFileName(KIM_ModelWriteParameterizedModel const *const modelWriteParameterizedModel, char const *const fileName)
Set the file name for the next parameter file.
void KIM_ModelWriteParameterizedModel_GetModelBufferPointer(KIM_ModelWriteParameterizedModel const *const modelWriteParameterizedModel, void **const ptr)
Get the Model's buffer pointer within the Model object.
char const * KIM_ModelWriteParameterizedModel_ToString(KIM_ModelWriteParameterizedModel const *const modelWriteParameterizedModel)
Get a string representing the internal state of the Model object.
An Extensible Enumeration for the LogVerbosity's supported by the KIM API.
void KIM_ModelWriteParameterizedModel_GetModelName(KIM_ModelWriteParameterizedModel const *const modelWriteParameterizedModel, char const **const modelName)
Get the name of the new parameterized model.
struct KIM_ModelWriteParameterizedModel KIM_ModelWriteParameterizedModel
Forward declaration.
void KIM_ModelWriteParameterizedModel_GetPath(KIM_ModelWriteParameterizedModel const *const modelWriteParameterizedModel, char const **const path)
Get the directory path where the parameterized model files should be written.