KIM_ModelExtension.hpp

Go to the documentation of this file.

//
// KIM-API: An API for interatomic models
// Copyright (c) 2013--2022, Regents of the University of Minnesota.
// All rights reserved.
//
// Contributors:
//    Ryan S. Elliott
//
// SPDX-License-Identifier: LGPL-2.1-or-later
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with this library; if not, write to the Free Software Foundation,
// Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
//

//
// Release: This file is part of the kim-api.git repository.
//


#ifndef KIM_MODEL_EXTENSION_HPP_
#define KIM_MODEL_EXTENSION_HPP_

#include <sstream>
#include <string>

namespace KIM
{
// Forward declarations
class LogVerbosity;
class Model;
class ModelCompute;
class ModelCreate;
class ModelDestroy;
class ModelDriverCreate;
class ModelRefresh;
class ModelWriteParameterizedModel;
class ComputeArguments;
class ModelComputeArguments;
class ModelComputeArgumentsCreate;
class ModelComputeArgumentsDestroy;
class ModelExtensionImplementation;


class ModelExtension
{
 public:
  void GetExtensionID(std::string const ** const extensionID) const;

  KIM::Model * Model();

  KIM::ModelCompute * ModelCompute();

  KIM::ModelCreate * ModelCreate();

  KIM::ModelDestroy * ModelDestroy();

  KIM::ModelDriverCreate * ModelDriverCreate();

  KIM::ModelRefresh * ModelRefresh();

  KIM::ModelWriteParameterizedModel * ModelWriteParameterizedModel();

  KIM::ModelComputeArguments *
  ModelComputeArguments(ComputeArguments * const computeArguments) const;

  KIM::ModelComputeArgumentsCreate *
  ModelComputeArgumentsCreate(ComputeArguments * const computeArguments) const;

  KIM::ModelComputeArgumentsDestroy *
  ModelComputeArgumentsDestroy(ComputeArguments * const computeArguments) const;

  void GetModelBufferPointer(void ** const ptr) const;

  void LogEntry(LogVerbosity const logVerbosity,
                std::string const & message,
                int const lineNumber,
                std::string const & fileName) const;

  void LogEntry(LogVerbosity const logVerbosity,
                std::stringstream const & message,
                int const lineNumber,
                std::string const & fileName) const;

  std::string const & ToString() const;

 private:
  // do not allow copy constructor or operator=
  ModelExtension(ModelExtension const &);
  void operator=(ModelExtension const &);

  ModelExtension();
  ~ModelExtension();

  ModelExtensionImplementation * pimpl;
};  // class ModelExtension
}  // namespace KIM

#endif  // KIM_MODEL_EXTENSION_HPP_