kim-api 2.3.0+AppleClang.AppleClang.GNU
An Application Programming Interface (API) for the Knowledgebase of Interatomic Models (KIM).
Loading...
Searching...
No Matches
KIM_ModelWriteParameterizedModel.h
Go to the documentation of this file.
1/* */
2/* KIM-API: An API for interatomic models */
3/* Copyright (c) 2013--2022, Regents of the University of Minnesota. */
4/* All rights reserved. */
5/* */
6/* Contributors: */
7/* Ryan S. Elliott */
8/* */
9/* SPDX-License-Identifier: LGPL-2.1-or-later */
10/* */
11/* This library is free software; you can redistribute it and/or */
12/* modify it under the terms of the GNU Lesser General Public */
13/* License as published by the Free Software Foundation; either */
14/* version 2.1 of the License, or (at your option) any later version. */
15/* */
16/* This library is distributed in the hope that it will be useful, */
17/* but WITHOUT ANY WARRANTY; without even the implied warranty of */
18/* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU */
19/* Lesser General Public License for more details. */
20/* */
21/* You should have received a copy of the GNU Lesser General Public License */
22/* along with this library; if not, write to the Free Software Foundation, */
23/* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */
24/* */
25
26/* */
27/* Release: This file is part of the kim-api-2.3.0 package. */
28/* */
29
30
31#ifndef KIM_MODEL_WRITE_PARAMETERIZED_MODEL_H_
32#define KIM_MODEL_WRITE_PARAMETERIZED_MODEL_H_
33
34/* Forward declarations */
35#ifndef KIM_LOG_VERBOSITY_DEFINED_
36#define KIM_LOG_VERBOSITY_DEFINED_
43#endif
44
45
46#ifndef KIM_MODEL_WRITE_PARAMETERIZED_MODEL_DEFINED_
47#define KIM_MODEL_WRITE_PARAMETERIZED_MODEL_DEFINED_
59#endif
60
70 KIM_ModelWriteParameterizedModel const * const modelWriteParameterizedModel,
71 char const ** const path);
72
82 KIM_ModelWriteParameterizedModel const * const modelWriteParameterizedModel,
83 char const ** const modelName);
84
94 KIM_ModelWriteParameterizedModel const * const modelWriteParameterizedModel,
95 char const * const fileName);
96
106 KIM_ModelWriteParameterizedModel const * const modelWriteParameterizedModel,
107 void ** const ptr);
108
118 KIM_ModelWriteParameterizedModel const * const modelWriteParameterizedModel,
119 KIM_LogVerbosity const logVerbosity,
120 char const * const message,
121 int const lineNumber,
122 char const * const fileName);
123
134 modelWriteParameterizedModel);
135
136#endif /* KIM_MODEL_WRITE_PARAMETERIZED_MODEL_H_ */
struct KIM_ModelWriteParameterizedModel KIM_ModelWriteParameterizedModel
Forward declaration.
char const * KIM_ModelWriteParameterizedModel_ToString(KIM_ModelWriteParameterizedModel const *const modelWriteParameterizedModel)
Get a string representing the internal state of the Model object.
void KIM_ModelWriteParameterizedModel_GetModelBufferPointer(KIM_ModelWriteParameterizedModel const *const modelWriteParameterizedModel, void **const ptr)
Get the Model's buffer pointer within the Model object.
void KIM_ModelWriteParameterizedModel_GetModelName(KIM_ModelWriteParameterizedModel const *const modelWriteParameterizedModel, char const **const modelName)
Get the name of the new parameterized model.
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_GetPath(KIM_ModelWriteParameterizedModel const *const modelWriteParameterizedModel, char const **const path)
Get the directory path where the parameterized model files should be written.
void KIM_ModelWriteParameterizedModel_SetParameterFileName(KIM_ModelWriteParameterizedModel const *const modelWriteParameterizedModel, char const *const fileName)
Set the file name for the next parameter file.
An Extensible Enumeration for the LogVerbosity's supported by the KIM API.