solution_time_series.h

Go to the documentation of this file.

/*
 * Copyright (c) 2011-2015:  G-CSC, Goethe University Frankfurt
 * Author: Andreas Vogel
 * 
 * This file is part of UG4.
 * 
 * UG4 is free software: you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License version 3 (as published by the
 * Free Software Foundation) with the following additional attribution
 * requirements (according to LGPL/GPL v3 §7):
 * 
 * (1) The following notice must be displayed in the Appropriate Legal Notices
 * of covered and combined works: "Based on UG4 (www.ug4.org/license)".
 * 
 * (2) The following notice must be displayed at a prominent place in the
 * terminal output of covered works: "Based on UG4 (www.ug4.org/license)".
 * 
 * (3) The following bibliography is recommended for citation and must be
 * preserved in all covered files:
 * "Reiter, S., Vogel, A., Heppner, I., Rupp, M., and Wittum, G. A massively
 *   parallel geometric multigrid solver on hierarchically distributed grids.
 *   Computing and visualization in science 16, 4 (2013), 151-164"
 * "Vogel, A., Reiter, S., Rupp, M., Nägel, A., and Wittum, G. UG4 -- a novel
 *   flexible software system for simulating pde based models on high performance
 *   computers. Computing and visualization in science 16, 4 (2013), 165-179"
 * 
 * This program 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.
 */
 
#ifndef __H__UG__LIB_DISC__TIME_DISC__PREVIOUS_SOLUTION__
#define __H__UG__LIB_DISC__TIME_DISC__PREVIOUS_SOLUTION__
 
// extern libraries
#include <deque>
 
// other ug libraries
#include "common/common.h"
 
#include "lib_disc/common/local_algebra.h"
 
namespace ug{
 
 
 
template <typename TVector>
class VectorTimeSeries
{
  public:
    typedef TVector vector_type;
 
  public:
    virtual ~VectorTimeSeries() {}
 
    SmartPtr<VectorTimeSeries<vector_type> > clone() const
    {
      SmartPtr<VectorTimeSeries<TVector> > cloneTimeSol
        = SmartPtr<VectorTimeSeries<TVector> >(new VectorTimeSeries<TVector>);
 
      for(int i = m_vTimeSol.size()-1; i >= 0 ; --i)
        cloneTimeSol->push(solution(i)->clone(), time(i));
 
      return cloneTimeSol;
    }
 
    void clear() {m_vTimeSol.clear();}
 
    size_t size() const {return m_vTimeSol.size();}
 
    number time(size_t i) const {return m_vTimeSol.at(i).time();}
 
    SmartPtr<vector_type> solution(size_t i) {return m_vTimeSol.at(i).solution();}
 
    ConstSmartPtr<vector_type> solution(size_t i) const {return m_vTimeSol.at(i).solution();}
 
    SmartPtr<vector_type> oldest() {return m_vTimeSol.back().solution();}
 
    ConstSmartPtr<vector_type> oldest() const {return m_vTimeSol.back().solution();}
 
    number oldest_time() const {return m_vTimeSol.back().time();}
 
    SmartPtr<vector_type> latest() {return m_vTimeSol.front().solution();}
 
    ConstSmartPtr<vector_type> latest() const {return m_vTimeSol.front().solution();}
 
    number latest_time() const {return m_vTimeSol.front().time();}
 
    void push(SmartPtr<vector_type> vec, number time) {m_vTimeSol.push_front(TimeSol(vec, time));}
 
    SmartPtr<vector_type> push_discard_oldest(SmartPtr<vector_type> vec, number time)
    {
      SmartPtr<vector_type> discardVec = m_vTimeSol.back().solution();
      remove_oldest(); push(vec, time);
      return discardVec;
    }
 
    void remove_latest() {m_vTimeSol.pop_front();}
 
    void remove_oldest() {m_vTimeSol.pop_back();}
 
  protected:
    class TimeSol
    {
      public:
        TimeSol() : vec(NULL), t(0.0) {}
 
        TimeSol(SmartPtr<vector_type> vec_, number t_)
          : vec(vec_), t(t_) {}
 
        SmartPtr<vector_type> solution() {return vec;}
 
        ConstSmartPtr<vector_type> solution() const {return vec;}
 
        number& time() {return t;}
 
        const number& time() const {return t;}
 
      protected:
      //  solution vector at time point
        SmartPtr<vector_type> vec;
 
      //  point in time
        number t;
    };
 
  protected:
 
  //  deque of previous solutions
    std::deque<TimeSol> m_vTimeSol;
};
 
class LocalVectorTimeSeries
{
  public:
    LocalVectorTimeSeries() {}
 
    size_t size() const {return m_vLocalVector.size();}
 
    number time(size_t i) const {return m_vTime.at(i);}
 
    const std::vector<number>& times() const {return m_vTime;}
 
    const LocalVector& solution(size_t i) const {return m_vLocalVector.at(i);}
 
    LocalVector& solution(size_t i) {return m_vLocalVector.at(i);}
 
    void access_by_map(const FunctionIndexMapping& funcMap)
    {
      for(size_t t=0; t < size(); ++t)
        solution(t).access_by_map(funcMap);
    }
 
    template <typename TVector>
    void read_values(ConstSmartPtr<VectorTimeSeries<TVector> > vecTimeSeries, LocalIndices& ind)
    {
      m_vLocalVector.resize(vecTimeSeries->size());
      for(size_t i = 0; i < m_vLocalVector.size(); ++i)
      {
        m_vLocalVector[i].resize(ind);
        GetLocalVector(m_vLocalVector[i], *vecTimeSeries->solution(i));
      }
    }
 
    template <typename TVector>
    void read_times(ConstSmartPtr<VectorTimeSeries<TVector> > vecTimeSeries)
    {
      m_vTime.resize(vecTimeSeries->size());
      for(size_t i = 0; i < m_vTime.size(); ++i)
        m_vTime[i] = vecTimeSeries->time(i);
    }
 
  protected:
    std::vector<number> m_vTime;
 
    std::vector<LocalVector> m_vLocalVector;
};
 
 
} // end namespace ug
 
#endif /* __H__UG__LIB_DISC__TIME_DISC__PREVIOUS_SOLUTION__ */