depth_average.h

Go to the documentation of this file.

/*
  Copyright (C) 2011 - 2021 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_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