depth_average.h

Go to the documentation of this file.

// ------------------------------------------------------
//
// SPDX-License-Identifier: GPL-2.0-or-later
//
// SPDX-FileCopyrightText: Copyright (C) 2011-2026 by the ASPECT authors.
//
// This file is part of ASPECT.
//
// Detailed license information governing the source code and
// contributions can be found in the folder LICENSES and in
// LICENSE and CONTRIBUTING.md at the top level directory.
//
// ------------------------------------------------------


#ifndef _aspect_postprocess_depth_average_h
#define _aspect_postprocess_depth_average_h

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

#include <deal.II/base/data_out_base.h>


namespace aspect
{
  namespace Postprocess
  {

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

        std::pair<std::string,std::string>
        execute (TableHandler &statistics) 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);

      private:
        double output_interval;

        double last_output_time;

        std::vector<std::string> output_formats;

        unsigned int n_depth_zones;

        std::vector<double> depth_bounds;

        std::vector<std::string> variables;

        struct DataPoint
        {
          double time;
          std::vector<std::vector<double>> values;

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

        std::vector<DataPoint> entries;

        void set_last_output_time (const double current_time);
    };
  }
}


#endif