averaging.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_material_model_averaging_h
#define _aspect_material_model_averaging_h

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

namespace aspect
{
  namespace MaterialModel
  {
    enum AveragingOperation
    {
      none,
      arithmetic_average,
      harmonic_average,
      geometric_average,
      pick_largest,
      log_average,
      nwd_arithmetic_average,
      nwd_harmonic_average,
      nwd_geometric_average
    };

    template <int dim>
    class Averaging : public MaterialModel::Interface<dim>, public ::aspect::SimulatorAccess<dim>
    {
      public:
        void
        evaluate (const typename Interface<dim>::MaterialModelInputs &in,
                  typename Interface<dim>::MaterialModelOutputs &out) const override;
        static void
        declare_parameters (ParameterHandler &prm);

        void
        parse_parameters (ParameterHandler &prm) override;

        bool is_compressible () const override;



      private:

        AveragingOperation
        parse_averaging_operation_name (const std::string &s);

        void
        average (const AveragingOperation averaging_operation,
                 const std::vector<Point<dim>>    &position,
                 std::vector<double>           &values_out) const;

        void
        create_additional_named_outputs (MaterialModel::MaterialModelOutputs<dim> &out) const override;

        double bell_shape_limit;
        AveragingOperation averaging_operation;
        std::unique_ptr<MaterialModel::Interface<dim>> base_model;
    };
  }
}

#endif