Homec4science
Diffusion LibMultiScale (features/components) Browse

libmultiscale/src/filter/filter.hh
b05d5f2aba78features/components

Last Change
Raw File

filter.hh
View Options

/**
* @file filter.hh
*
* @author Guillaume Anciaux <guillaume.anciaux@epfl.ch>
*
* @date Thu Jul 24 14:21:58 2014
*
* @brief This is the mother class of all filters
*
* @section LICENSE
*
* Copyright INRIA and CEA
*
* The LibMultiScale is a C++ parallel framework for the multiscale
* coupling methods dedicated to material simulations. This framework
* provides an API which makes it possible to program coupled simulations
* and integration of already existing codes.
*
* This Project was initiated in a collaboration between INRIA Futurs Bordeaux
* within ScAlApplix team and CEA/DPTA Ile de France.
* The project is now continued at the Ecole Polytechnique Fédérale de Lausanne
* within the LSMS/ENAC laboratory.
*
* This software is governed by the CeCILL-C license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL-C
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL-C license and that you accept its terms.
*
*/
#ifndef __LIBMULTISCALE_FILTER_HH__
#define __LIBMULTISCALE_FILTER_HH__
/* -------------------------------------------------------------------------- */
#include "filter_interface.hh"
#include "component_libmultiscale.hh"
/* -------------------------------------------------------------------------- */
__BEGIN_LIBMULTISCALE__
template <typename _Input>
class Filter : public ComponentLMContainer<_Input,typename _Input::ContainerSubset,OUTPUT_REF>,
public FilterInterface {
/* ------------------------------------------------------------------------ */
/* Typedefs */
/* ------------------------------------------------------------------------ */
public:
typedef _Input ContainerSubset;
/* ------------------------------------------------------------------------ */
/* Constructors/Destructors */
/* ------------------------------------------------------------------------ */
protected :
Filter(const std::string & name, ComponentLMInterface & d):
ComponentLMContainer<_Input,typename _Input::ContainerSubset,OUTPUT_REF>(d),
FilterInterface(name){};
Filter(const std::string & name, UInt dim):
ComponentLMContainer<_Input,typename _Input::ContainerSubset,OUTPUT_REF>(dim),
FilterInterface(name){};
virtual ~Filter(){};
/* ------------------------------------------------------------------------ */
/* Methods */
/* ------------------------------------------------------------------------ */
private:
virtual void build(_Input & cont) = 0;
public:
//! function to print the contain of the class
virtual void printself(std::ostream & stream, int indent = 0) const{
};
//! connect and build the adapted object
virtual void connect(FilterManager & f);
//! connect and build the adapted object
virtual void connect(ActionManager & f);
Filter<_Input> & getContainer(){return *this;};
virtual void visit(ComponentLMOut<_Input> & obj);
virtual void build();
virtual void manualBuild(_Input & obj);
virtual void declareParams();
/* ------------------------------------------------------------------------ */
/* Class Members */
/* ------------------------------------------------------------------------ */
protected :
DOFType dt;
};
/* -------------------------------------------------------------------------- */
#include <boost/preprocessor.hpp>
#define BOOST_INSTANCIATE_FILTER_TEMPLATE(r,data,x) \
template class data<BOOST_PP_TUPLE_ELEM(3,0,x)::ContainerPoints>; \
template class data<BOOST_PP_TUPLE_ELEM(3,0,x)::ContainerSubset>;
#define DECLARE_FILTER(obj,list) \
BOOST_PP_SEQ_FOR_EACH(BOOST_INSTANCIATE_FILTER_TEMPLATE,obj,list)
#define DECLARE_FILTER_REFPOINT(data) \
template class data<ContainerArray<RefPointData> >;
#define DECLARE_FILTER_GENERIC_MESH(data) \
template class data<ContainerGenericMesh>;
/* -------------------------------------------------------------------------- */
__END_LIBMULTISCALE__
/* -------------------------------------------------------------------------- */
#include "filter_compatibility.hh"
/* -------------------------------------------------------------------------- */
#endif /* __LIBMULTISCALE_FILTER_HH__ */
c4science · Help