rk_2.h

Go to the documentation of this file.

// ------------------------------------------------------
//
// SPDX-License-Identifier: GPL-2.0-or-later
//
// SPDX-FileCopyrightText: Copyright (C) 2015-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_particle_integrator_rk_2_h
#define _aspect_particle_integrator_rk_2_h

#include <aspect/particle/integrator/interface.h>

#include <aspect/simulator_access.h>


namespace aspect
{
  namespace Particle
  {
    namespace Integrator
    {
      template <int dim>
      class RK2 : public Interface<dim>, public SimulatorAccess<dim>
      {
        public:
          RK2();

          void
          initialize () override;

          void
          local_integrate_step(const typename ParticleHandler<dim>::particle_iterator &begin_particle,
                               const typename ParticleHandler<dim>::particle_iterator &end_particle,
                               const std::vector<Tensor<1,dim>> &old_velocities,
                               const std::vector<Tensor<1,dim>> &velocities,
                               const double dt) override;

          bool new_integration_step() override;

          std::array<bool, 3> required_solution_vectors() const override;

          static
          void
          declare_parameters (ParameterHandler &prm);

          void
          parse_parameters (ParameterHandler &prm) override;

          static constexpr unsigned int n_integrator_properties = dim;

        private:
          unsigned int integrator_substep;

          unsigned int property_index_old_location;

          bool higher_order_in_time;
      };

    }
  }
}

#endif