boundary_velocity_residual_statistics.h

Go to the documentation of this file.

/*
  Copyright (C) 2014 - 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_boundary_velocity_residual_statistics_h
#define _aspect_postprocess_boundary_velocity_residual_statistics_h

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


namespace aspect
{
  namespace Postprocess
  {

    template <int dim>
    class BoundaryVelocityResidualStatistics : public Interface<dim>, public ::aspect::SimulatorAccess<dim>
    {
      public:
        void initialize () override;

        Tensor<1,dim>
        get_data_velocity (const Point<dim> &p) const;

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

        static
        void
        declare_parameters (ParameterHandler &prm);

        void
        parse_parameters (ParameterHandler &prm) override;

      private:
        bool use_spherical_unit_vectors;

        bool use_ascii_data;

        std::unique_ptr<BoundaryVelocity::internal::GPlatesLookup<dim>> gplates_lookup;

        std::unique_ptr<Utilities::StructuredDataLookup<dim>> data_lookup;

        std::string data_directory;

        std::string data_file_name;

        double scale_factor;
    };
  }
}


#endif