landlab.h

Go to the documentation of this file.

/*
  Copyright (C) 2025 - 2026 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_mesh_deformation_landlab_h
#define _aspect_mesh_deformation_landlab_h

#include <aspect/mesh_deformation/interface.h>
#include <aspect/mesh_deformation/parallel_unstructured_interface.h>
#include <aspect/simulator_access.h>

#include <aspect/python_helper.h>

namespace aspect
{
  namespace MeshDeformation
  {
    template <int dim>
    class Landlab : public ParallelUnstructuredInterface<dim>
    {
      public:
        void initialize() override;

        void update() override;

        virtual
        double boundary_composition (const types::boundary_id boundary_indicator,
                                     const Point<dim> &position,
                                     const unsigned int compositional_field) const override;

        virtual
        std::vector<Tensor<1,dim>>
        compute_updated_velocities_at_points (const std::vector<std::vector<double>> &current_solution_at_points) const override;

        void
        evaluate_derived_quantities_at_points (std::vector<std::vector<double>> &variable_data,
                                               std::vector<std::string> &variable_names) const;

        void
        compute_initial_deformation_as_constraints(const Mapping<dim> &mapping,
                                                   const DoFHandler<dim> &mesh_deformation_dof_handler,
                                                   const types::boundary_id boundary_indicator,
                                                   AffineConstraints<double> &constraints) const override;

        static
        void declare_parameters (ParameterHandler &prm);

        void parse_parameters (ParameterHandler &prm) override;

#if defined(ASPECT_WITH_LANDLAB)
      private:
        unsigned int n_landlab_ranks;

        MPI_Comm landlab_communicator;

        bool this_rank_runs_landlab;

        std::string script_path;

        std::string script_module_name;

        bool is_spherical;

        std::vector<std::string> additional_named_quantities;

        PyObject *pModule;
#endif
    };
  }
}

#endif