advection_field.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_advection_field_h
#define _aspect_advection_field_h

#include <aspect/global.h>
#include <aspect/parameters.h>

#include <deal.II/fe/fe_values_extractors.h>

namespace aspect
{
  using namespace dealii;

  template <int dim> struct Introspection;

  struct AdvectionField
  {
    enum FieldType { temperature_field, compositional_field };

    const FieldType    field_type;

    const unsigned int compositional_variable;

    AdvectionField (const FieldType field_type,
                    const unsigned int compositional_variable = numbers::invalid_unsigned_int);

    static
    AdvectionField temperature ();

    static
    AdvectionField composition (const unsigned int compositional_variable);

    bool
    is_temperature () const;

    template<int dim>
    bool
    is_discontinuous (const Introspection<dim> &introspection) const;

    template<int dim>
    typename Parameters<dim>::AdvectionFieldMethod::Kind
    advection_method (const Introspection<dim> &introspection) const;

    template<int dim>
    unsigned int
    component_index(const Introspection<dim> &introspection) const;

    template<int dim>
    unsigned int
    block_index(const Introspection<dim> &introspection) const;

    template<int dim>
    unsigned int
    sparsity_pattern_block_index(const Introspection<dim> &introspection) const;

    unsigned int
    field_index() const;

    template<int dim>
    unsigned int
    base_element(const Introspection<dim> &introspection) const;

    template<int dim>
    FEValuesExtractors::Scalar
    scalar_extractor(const Introspection<dim> &introspection) const;

    template<int dim>
    unsigned int
    polynomial_degree(const Introspection<dim> &introspection) const;

    template<int dim>
    std::string
    name(const Introspection<dim> &introspection) const;
  };
}


#endif