data_out.h

Go to the documentation of this file.

// ---------------------------------------------------------------------
//
// Copyright (C) 2017 - 2022 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.md at
// the top level directory of deal.II.
//
// ---------------------------------------------------------------------
#ifndef dealii_particles_data_out_h
#define dealii_particles_data_out_h
 
#include <deal.II/base/config.h>
 
#include <deal.II/base/data_out_base.h>
 
#include <deal.II/numerics/data_component_interpretation.h>
 
#include <string>
#include <vector>
 
DEAL_II_NAMESPACE_OPEN
 
namespace Particles
{
  template <int dim, int spacedim>
  class ParticleHandler;
 
  template <int dim, int spacedim = dim>
  class DataOut : public ::DataOutInterface<0, spacedim>
  {
  public:
    DataOut() = default;
 
    ~DataOut() = default;
 
 
    void
    build_patches(const Particles::ParticleHandler<dim, spacedim> &particles,
                  const std::vector<std::string> &data_component_names = {},
                  const std::vector<
                    DataComponentInterpretation::DataComponentInterpretation>
                    &data_component_interpretations = {});
 
  protected:
    virtual const std::vector<DataOutBase::Patch<0, spacedim>> &
    get_patches() const override;
 
    virtual std::vector<std::string>
    get_dataset_names() const override;
 
 
    virtual std::vector<
      std::tuple<unsigned int,
                 unsigned int,
                 std::string,
                 DataComponentInterpretation::DataComponentInterpretation>>
    get_nonscalar_data_ranges() const override;
 
  private:
    std::vector<DataOutBase::Patch<0, spacedim>> patches;
 
    std::vector<std::string> dataset_names;
 
    std::vector<DataComponentInterpretation::DataComponentInterpretation>
      data_component_interpretations;
  };
 
} // namespace Particles
 
DEAL_II_NAMESPACE_CLOSE
 
#endif