steady_rms_velocity.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_termination_criteria_steady_rms_velocity_h
#define _aspect_termination_criteria_steady_rms_velocity_h

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

namespace aspect
{
  namespace TerminationCriteria
  {

    template <int dim>
    class SteadyRMSVelocity : public Interface<dim>, public SimulatorAccess<dim>
    {
      public:
        bool
        execute () 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;

      private:
        double                                  time_length;

        double                                  relative_deviation;

        std::list<std::pair<double, double>>   time_rmsvel;
    };
  }
}

#endif