data_out_stack.h

// ---------------------------------------------------------------------
//
// Copyright (C) 1999 - 2018 by the deal.II authors
//
// This file is part of the deal.II library.
//
// The deal.II library is free software; you can use it, 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 2.1 of the License, or (at your option) any later version.
// The full text of the license can be found in the file LICENSE at
// the top level of the deal.II distribution.
//
// ---------------------------------------------------------------------

#ifndef dealii_data_out_stack_h
#define dealii_data_out_stack_h


#include <deal.II/base/config.h>
#include <deal.II/base/data_out_base.h>
#include <deal.II/base/smartpointer.h>
#include <deal.II/lac/vector.h>
#include <deal.II/numerics/data_out_dof_data.h>

#include <string>
#include <vector>

DEAL_II_NAMESPACE_OPEN

template <int dim, int spacedim> class DoFHandler;

template <int dim, int spacedim=dim, typename DoFHandlerType = DoFHandler<dim,spacedim> >
class DataOutStack : public DataOutInterface<dim+1>
{
public:
  enum VectorType
  {
    cell_vector,
    dof_vector
  };

  virtual ~DataOutStack () = default;

  void new_parameter_value (const double parameter_value,
                            const double parameter_step);

  void attach_dof_handler (const DoFHandlerType &dof_handler);

  void declare_data_vector (const std::string &name,
                            const VectorType   vector_type);

  void declare_data_vector (const std::vector<std::string> &name,
                            const VectorType                vector_type);


  template <typename number>
  void add_data_vector (const Vector<number> &vec,
                        const std::string    &name);

  template <typename number>
  void add_data_vector (const Vector<number>           &vec,
                        const std::vector<std::string> &names);

  void build_patches (const unsigned int n_subdivisions = 0);

  void finish_parameter_value ();

  std::size_t memory_consumption () const;

  DeclException1 (ExcVectorNotDeclared,
                  std::string,
                  << "The data vector for which the first component has the name "
                  << arg1 << " has not been added before.");
  DeclExceptionMsg (ExcDataNotCleared,
                    "You cannot start a new time/parameter step before calling "
                    "finish_parameter_value() on the previous step.");
  DeclExceptionMsg (ExcDataAlreadyAdded,
                    "You cannot declare additional vectors after already calling "
                    "build_patches(). All data vectors need to be declared "
                    "before you call this function the first time.");
  DeclException1 (ExcNameAlreadyUsed,
                  std::string,
                  << "You tried to declare a component of a data vector with "
                  << "the name <" << arg1 << ">, but that name is already used.");

private:
  double                               parameter;

  double                               parameter_step;

  SmartPointer<const DoFHandlerType,DataOutStack<dim,spacedim,DoFHandlerType> > dof_handler;

  std::vector< ::DataOutBase::Patch<dim+1,dim+1> >   patches;

  struct DataVector
  {
    Vector<double> data;

    std::vector<std::string> names;

    std::size_t memory_consumption () const;
  };

  std::vector<DataVector> dof_data;

  std::vector<DataVector> cell_data;

  virtual const std::vector< ::DataOutBase::Patch<dim+1,dim+1> > & get_patches () const;


  virtual std::vector<std::string> get_dataset_names () const;
};


DEAL_II_NAMESPACE_CLOSE

#endif