visualization.h

Go to the documentation of this file.

/*
  Copyright (C) 2011 - 2024 by the authors of the ASPECT code.

  This file is part of ASPECT.

  ASPECT is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation; either version 2, or (at your option)
  any later version.

  ASPECT 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 General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with ASPECT; see the file LICENSE.  If not see
  <http://www.gnu.org/licenses/>.
*/


#ifndef _aspect_postprocess_visualization_h
#define _aspect_postprocess_visualization_h

#include <aspect/postprocess/interface.h>
#include <aspect/simulator_access.h>
#include <aspect/plugins.h>

#include <deal.II/base/thread_management.h>
#include <deal.II/numerics/data_postprocessor.h>
#include <deal.II/base/data_out_base.h>
#include <deal.II/numerics/data_out.h>

#include <thread>

namespace aspect
{
  namespace Postprocess
  {
    namespace VisualizationPostprocessors
    {
      inline void average_quantities(std::vector<Vector<double>> &quantities)
      {
        const unsigned int N = quantities.size();
        const unsigned int M = quantities[0].size();
        for (unsigned int m=0; m<M; ++m)
          {
            double sum = 0;
            for (unsigned int q=0; q<N; ++q)
              sum += quantities[q](m);

            const double average = sum/N;
            for (unsigned int q=0; q<N; ++q)
              quantities[q](m) = average;
          }
      }

      template <int dim>
      class Interface : public Plugins::InterfaceBase
      {
        public:
          explicit Interface (const std::string &physical_units = "");

          virtual
          std::string
          get_physical_units () const;

          virtual
          std::list<std::string>
          required_other_postprocessors () const;

          virtual
          void save (std::map<std::string, std::string> &status_strings) const;

          virtual
          void load (const std::map<std::string, std::string> &status_strings);

        private:
          const std::string physical_units;
      };



      template <int dim>
      class CellDataVectorCreator : public Interface<dim>
      {
        public:
          explicit CellDataVectorCreator (const std::string &physical_units = "");

          ~CellDataVectorCreator ()  override = default;

          virtual
          std::pair<std::string, std::unique_ptr<Vector<float>>>
          execute () const = 0;
      };


      template <int dim>
      class SurfaceOnlyVisualization
      {
        public:
          virtual
          ~SurfaceOnlyVisualization () = default;
      };
    }


    template <int dim>
    class Visualization : public Interface<dim>, public ::aspect::SimulatorAccess<dim>
    {
      public:
        Visualization ();

        std::pair<std::string,std::string>
        execute (TableHandler &statistics) override;

        void
        update () override;

        static
        void
        register_visualization_postprocessor (const std::string &name,
                                              const std::string &description,
                                              void (*declare_parameters_function) (ParameterHandler &),
                                              std::unique_ptr<VisualizationPostprocessors::Interface<dim>>(*factory_function) ());

        std::list<std::string>
        required_other_postprocessors () const override;

        static
        void
        declare_parameters (ParameterHandler &prm);

        void
        parse_parameters (ParameterHandler &prm) override;

        void save (std::map<std::string, std::string> &status_strings) const override;

        void load (const std::map<std::string, std::string> &status_strings) override;

        template <class Archive>
        void serialize (Archive &ar, const unsigned int version);

        static
        void
        write_plugin_graph (std::ostream &output_stream);

        bool output_pointwise_stress_and_strain() const;

        DeclException1 (ExcPostprocessorNameNotFound,
                        std::string,
                        << "Could not find entry <"
                        << arg1
                        << "> among the names of registered postprocessors.");

      private:
        double output_interval;

        double last_output_time;

        unsigned int maximum_timesteps_between_outputs;

        unsigned int last_output_timestep;

        unsigned int output_file_number;

        std::string output_format;

        unsigned int group_files;

        std::string temporary_output_location;

        bool interpolate_output;

        bool filter_output;

        bool pointwise_stress_and_strain;

        bool write_higher_order_output;

        bool output_mesh_velocity;

        bool output_mesh_displacement;

        bool output_undeformed_mesh;

        bool output_base_variables_on_mesh_surface;

        bool write_in_background_thread;

        void set_last_output_time (const double current_time);

        void mesh_changed_signal ();

        static
        void writer (const std::string &filename,
                     const std::string &temporary_filename,
                     const std::string &file_contents);

        std::list<std::unique_ptr<VisualizationPostprocessors::Interface<dim>>> postprocessors;

        struct OutputHistory
        {
          OutputHistory ();

          ~OutputHistory ();

          template <class Archive>
          void serialize (Archive &ar, const unsigned int version);

          bool mesh_changed;

          std::string last_mesh_file_name;

          std::vector<std::pair<double,std::string>> times_and_pvtu_names;

          std::vector<std::vector<std::string>> output_file_names_by_timestep;

          std::vector<XDMFEntry>  xdmf_entries;

          std::thread background_thread;
        };

        OutputHistory cell_output_history;

        OutputHistory face_output_history;

        template <typename DataOutType>
        void write_description_files (const DataOutType &data_out,
                                      const std::string &solution_file_prefix,
                                      const std::vector<std::string> &filenames,
                                      OutputHistory                  &output_history) const;


        template <typename DataOutType>
        std::string write_data_out_data(DataOutType   &data_out,
                                        OutputHistory &output_history,
                                        const std::map<std::string,std::string> &visualization_field_names_and_units) const;
    };
  }


#define ASPECT_REGISTER_VISUALIZATION_POSTPROCESSOR(classname,name,description) \
  template class classname<2>; \
  template class classname<3>; \
  namespace ASPECT_REGISTER_VISUALIZATION_POSTPROCESSOR_ ## classname \
  { \
    aspect::internal::Plugins::RegisterHelper<aspect::Postprocess::VisualizationPostprocessors::Interface<2>,classname<2>> \
    dummy_ ## classname ## _2d (&aspect::Postprocess::Visualization<2>::register_visualization_postprocessor, \
                                name, description); \
    aspect::internal::Plugins::RegisterHelper<aspect::Postprocess::VisualizationPostprocessors::Interface<3>,classname<3>> \
    dummy_ ## classname ## _3d (&aspect::Postprocess::Visualization<3>::register_visualization_postprocessor, \
                                name, description); \
  }
}


#endif