fe_variable_collection.h

Go to the documentation of this file.

// ------------------------------------------------------
//
// SPDX-License-Identifier: GPL-2.0-or-later
//
// SPDX-FileCopyrightText: Copyright (C) 2016-2025 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_fe_variable_system_h
#define _aspect_fe_variable_system_h

#include <aspect/global.h>
#include <deal.II/fe/component_mask.h>
#include <deal.II/fe/fe_values_extractors.h>
#include <deal.II/fe/fe.h>

namespace aspect
{
  template <int dim>
  struct VariableDeclaration
  {
    VariableDeclaration(const std::string &name,
                        const std::shared_ptr<FiniteElement<dim>> &fe,
                        const unsigned int multiplicity,
                        const unsigned int n_blocks);

    VariableDeclaration();

    unsigned int n_components() const;

    std::string name;

    std::shared_ptr<FiniteElement<dim>> fe;

    unsigned int multiplicity;

    unsigned int n_blocks;
  };

  template <int dim>
  struct FEVariable: public VariableDeclaration<dim>
  {
      FEVariable(const VariableDeclaration<dim> &fe_variable,
                 const unsigned int component_index,
                 const unsigned int block_index,
                 const unsigned int base_index);

      unsigned int first_component_index;

      unsigned int block_index;
      unsigned int base_index;

      ComponentMask component_mask;

      const FEValuesExtractors::Scalar &extractor_scalar() const;

      const FEValuesExtractors::Vector &extractor_vector() const;

    private:
      FEValuesExtractors::Scalar scalar_extractor;

      FEValuesExtractors::Vector vector_extractor;
  };


  template <int dim>
  class FEVariableCollection
  {
    public:
      FEVariableCollection();

      FEVariableCollection(const std::vector<VariableDeclaration<dim>> &variable_definitions);

      void initialize(const std::vector<VariableDeclaration<dim>> &variable_definitions);

      const FEVariable<dim> &variable(const std::string &name) const;

      std::vector<const FEVariable<dim>*> variables_with_name(const std::string &name) const;

      bool variable_exists(const std::string &name) const;

      const std::vector<FEVariable<dim>> &get_variables() const;

      unsigned int n_components() const;

      unsigned int n_blocks() const;

      const std::vector<const FiniteElement<dim> *> &get_fes() const;

      const std::vector<unsigned int> &get_multiplicities() const;

      const std::vector<unsigned int> &get_components_to_blocks() const;

    protected:
      std::vector<FEVariable<dim>> variables;

      unsigned int n_components_;

      unsigned int n_blocks_;

      std::vector<const FiniteElement<dim> *> fes;

      std::vector<unsigned int> multiplicities;

      std::vector<unsigned int> components_to_blocks;
  };

} // namespace aspect

#endif