velocity_function.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_prescribed_solution_velocity_function_h
#define _aspect_prescribed_solution_velocity_function_h

#include <aspect/prescribed_solution/interface.h>
#include <aspect/simulator_access.h>
#include <aspect/utilities.h>

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

namespace aspect
{
  namespace PrescribedSolution
  {

    template <int dim>
    class VelocityFunction : public Interface<dim>, public SimulatorAccess<dim>
    {
      public:

        VelocityFunction ();

        void update () override;

        static
        void
        declare_parameters (ParameterHandler &prm);

        void
        parse_parameters (ParameterHandler &prm) override;


        void constrain_solution (const typename DoFHandler<dim>::active_cell_iterator &cell,
                                 const std::vector<Point<dim>> &positions,
                                 const std::vector<unsigned int> &component_indices,
                                 std::vector<bool> &should_be_constrained,
                                 std::vector<double> &solution) override;

      private:
        Functions::ParsedFunction<dim> prescribed_velocity_indicator_function;

        Functions::ParsedFunction<dim> prescribed_velocity_function;

        Utilities::Coordinates::CoordinateSystem coordinate_system;

        bool use_spherical_unit_vectors;
    };
  }
}


#endif