encapsulation.hpp

Go to the documentation of this file.

#ifndef _PFASST_ENCAPSULATED_HPP_
#define _PFASST_ENCAPSULATED_HPP_

#include <memory>
#include <vector>
using namespace std;

#include <Eigen/Dense>

template<typename scalar>
using Matrix = Eigen::Matrix<scalar, Eigen::Dynamic, Eigen::Dynamic, Eigen::RowMajor>;

#include "pfasst/interfaces.hpp"


namespace pfasst
{
  namespace encap
  {
    typedef enum EncapType { solution, function } EncapType;

    template<typename time = time_precision>
    class Encapsulation
    {
      public:
        virtual ~Encapsulation();

        // required for host based encap helpers
        virtual void zero();

        virtual void copy(shared_ptr<const Encapsulation<time>> other);


        virtual time norm0() const;


        virtual void saxpy(time a, shared_ptr<const Encapsulation<time>> x);

        virtual void mat_apply(vector<shared_ptr<Encapsulation<time>>> dst,
                               time a, Matrix<time> mat,
                               vector<shared_ptr<Encapsulation<time>>> src,
                               bool zero = true);

        // required for time-parallel communications
        virtual void post(ICommunicator* comm, int tag);

        virtual void send(ICommunicator* comm, int tag, bool blocking);

        virtual void recv(ICommunicator* comm, int tag, bool blocking);

        virtual void broadcast(ICommunicator* comm);
    };


    template<typename time = time_precision>
    class EncapFactory
    {
      public:
        virtual shared_ptr<Encapsulation<time>> create(const EncapType type) = 0;
    };
  }  // ::pfasst::encap
} // ::pfasst

#include "pfasst/encap/encapsulation_impl.hpp"

#endif