Homec4science
Diffusion LibMultiScale (features/reshape_compute_python) Browse

libmultiscale/src/coupling/coupling_interface.hh
3ff213eb876efeatures/reshape_comput…

Last Change
Raw File

coupling_interface.hh
View Options

/**
* @file coupling_interface.hh
*
* @author Guillaume Anciaux <guillaume.anciaux@epfl.ch>
*
* @date Wed Jan 15 17:00:43 2014
*
* @brief Interface to all coupling
*
* @section LICENSE
*
* Copyright (©) 2010-2011 EPFL (Ecole Polytechnique Fédérale de Lausanne)
* Laboratory (LSMS - Laboratoire de Simulation en Mécanique des Solides)
*
* LibMultiScale 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 3 of the License, or (at your option) any
* later version.
*
* LibMultiScale 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 LibMultiScale. If not, see <http://www.gnu.org/licenses/>.
*
*/
#ifndef __LIBMULTISCALE_COUPLING_INTERFACE_HH__
#define __LIBMULTISCALE_COUPLING_INTERFACE_HH__
/* -------------------------------------------------------------------------- */
#include "lib_continuum.hh"
#include "lib_dd.hh"
#include "lib_md.hh"
#include "lm_parsable.hh"
/* -------------------------------------------------------------------------- */
__BEGIN_LIBMULTISCALE__
class CouplingInterface : public Parsable {
/* ------------------------------------------------------------------------ */
/* Constructors/Destructors */
/* ------------------------------------------------------------------------ */
public:
CouplingInterface(){};
virtual ~CouplingInterface() {}
/* ------------------------------------------------------------------------ */
/* Methods */
/* ------------------------------------------------------------------------ */
//! function to release any memory allocated
virtual void clearAll() = 0;
//! function for applying the coupling
virtual void coupling(CouplingStage stage) = 0;
//! function for initiation
virtual void init() = 0;
/* ------------------------------------------------------------------------ */
/* Accessors */
/* ------------------------------------------------------------------------ */
const std::string &getID() { return ID; };
protected:
//! coupling ID
std::string ID;
};
__END_LIBMULTISCALE__
/* -------------------------------------------------------------------------- */
// file generated by CMake
#include "coupler_list.hh"
/* -------------------------------------------------------------------------- */
#endif /* __LIBMULTISCALE_COUPLING_INTERFACE_HH__ */
c4science · Help