tidal_heating.h

Go to the documentation of this file.

/*
  Copyright (C) 2025 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_heating_model_tidal_heating_h
#define _aspect_heating_model_tidal_heating_h

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


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

      public:
        void
        evaluate (const MaterialModel::MaterialModelInputs<dim> &material_model_inputs,
                  const MaterialModel::MaterialModelOutputs<dim> &material_model_outputs,
                  HeatingModel::HeatingModelOutputs &heating_model_outputs) const override;

        MaterialModel::MaterialProperties::Property
        get_required_properties () const override;

        static
        void
        declare_parameters (ParameterHandler &prm);

        void
        parse_parameters (ParameterHandler &prm) override;

      private:
        double tidal_frequency;
        double elastic_shear_modulus;
        double constant_tidal_strain_rate;

        enum StrainRateDistribution
        {
          constant,
          latitudinal_variation
        } strain_rate_distribution;

        double maximum_tidal_strain_rate;
        double minimum_tidal_strain_rate;
    };
  }
}


#endif