Homec4science
Diffusion akantu (master) Browse

rAKA/model/model.hh
bc710902c37bmaster

Last Change
Raw File

model.hh
View Options

/**
* @file model.hh
* @author Nicolas Richart <nicolas.richart@epfl.ch>
* @date Thu Jul 22 11:02:42 2010
*
* @brief Interface of a model
*
* @section LICENSE
*
* <insert license here>
*
*/
/* -------------------------------------------------------------------------- */
#ifndef __AKANTU_MODEL_HH__
#define __AKANTU_MODEL_HH__
/* -------------------------------------------------------------------------- */
#include "aka_common.hh"
#include "aka_memory.hh"
#include "mesh.hh"
#include "fem.hh"
#include "mesh_utils.hh"
#include "ghost_synchronizer.hh"
/* -------------------------------------------------------------------------- */
__BEGIN_AKANTU__
class Model : public Memory, public GhostSynchronizer {
/* ------------------------------------------------------------------------ */
/* Constructors/Destructors */
/* ------------------------------------------------------------------------ */
public:
inline Model(Mesh & mesh,
UInt spatial_dimension = 0,
const ModelID & id = "model",
const MemoryID & memory_id = 0);
inline virtual ~Model();
/* ------------------------------------------------------------------------ */
/* Methods */
/* ------------------------------------------------------------------------ */
public:
virtual void initModel() = 0;
/// function to print the containt of the class
virtual void printself(std::ostream & stream, int indent = 0) const = 0;
/* ------------------------------------------------------------------------ */
/* Accessors */
/* ------------------------------------------------------------------------ */
public:
AKANTU_GET_MACRO(SpatialDimension, spatial_dimension, UInt);
AKANTU_GET_MACRO(FEM, *fem, const FEM &);
inline FEM & getFEMBoundary();
virtual void synchronizeBoundaries() {};
/* ------------------------------------------------------------------------ */
/* Class Members */
/* ------------------------------------------------------------------------ */
protected:
/// id
ModelID id;
/// the spatial dimension
UInt spatial_dimension;
/// the main fem object present in all models
FEM * fem;
/// the fem object present in all models for boundaries
FEM * fem_boundary;
};
/* -------------------------------------------------------------------------- */
/* inline functions */
/* -------------------------------------------------------------------------- */
#include "model_inline_impl.cc"
/// standard output stream operator
inline std::ostream & operator <<(std::ostream & stream, const Model & _this)
{
_this.printself(stream);
return stream;
}
__END_AKANTU__
#endif /* __AKANTU_MODEL_HH__ */
c4science · Help