fe_values_extractors.h

Go to the documentation of this file.

// -----------------------------------------------------------------------------
//
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR LGPL-2.1-or-later
// Copyright (C) 2012 - 2025 by the deal.II authors
//
// This file is part of the deal.II library.
//
// Detailed license information governing the source code and contributions
// can be found in LICENSE.md and CONTRIBUTING.md at the top level directory.
//
// -----------------------------------------------------------------------------
 
#ifndef dealii_fe_values_extractors_h
#define dealii_fe_values_extractors_h
 
 
#include <deal.II/base/config.h>
 
#include <deal.II/base/types.h>
 
#include <string>
#include <variant>
 
 
DEAL_II_NAMESPACE_OPEN
 
 
namespace FEValuesExtractors
{
  struct Scalar
  {
    unsigned int component;
 
    constexpr Scalar();
 
    constexpr Scalar(const unsigned int component);
 
    std::string
    get_name() const;
  };
 
 
  struct Vector
  {
    unsigned int first_vector_component;
 
    constexpr Vector();
 
    constexpr Vector(const unsigned int first_vector_component);
 
    std::string
    get_name() const;
  };
 
 
  template <int rank>
  struct SymmetricTensor
  {
    unsigned int first_tensor_component;
 
    constexpr SymmetricTensor();
 
    constexpr SymmetricTensor(const unsigned int first_tensor_component);
 
    std::string
    get_name() const;
  };
 
 
  template <int rank>
  struct Tensor
  {
    unsigned int first_tensor_component;
 
    constexpr Tensor();
 
    constexpr Tensor(const unsigned int first_tensor_component);
 
    std::string
    get_name() const;
  };
 
  template <typename Extractor>
  struct FirstCoupling
  {
    constexpr FirstCoupling(const Extractor &extractor);
 
    const Extractor extractor;
  };
 
  template <typename Extractor>
  struct SecondCoupling
  {
    constexpr SecondCoupling(const Extractor &extractor);
 
    const Extractor extractor;
  };
 
  using AnyExtractor = std::variant<FEValuesExtractors::Scalar,
                                    FEValuesExtractors::Vector,
                                    FEValuesExtractors::Tensor<2>,
                                    FEValuesExtractors::SymmetricTensor<2>>;
} // namespace FEValuesExtractors
 
 
/*-------------- Inline functions: namespace FEValuesExtractors -------------*/
 
namespace FEValuesExtractors
{
  constexpr inline Scalar::Scalar()
    : component(numbers::invalid_unsigned_int)
  {}
 
 
 
  constexpr inline Scalar::Scalar(const unsigned int component)
    : component(component)
  {}
 
 
 
  constexpr inline Vector::Vector()
    : first_vector_component(numbers::invalid_unsigned_int)
  {}
 
 
  constexpr inline Vector::Vector(const unsigned int first_vector_component)
    : first_vector_component(first_vector_component)
  {}
 
 
  template <int rank>
  constexpr inline SymmetricTensor<rank>::SymmetricTensor()
    : first_tensor_component(numbers::invalid_unsigned_int)
  {}
 
 
  template <int rank>
  constexpr inline SymmetricTensor<rank>::SymmetricTensor(
    const unsigned int first_tensor_component)
    : first_tensor_component(first_tensor_component)
  {}
 
 
  template <int rank>
  constexpr inline Tensor<rank>::Tensor()
    : first_tensor_component(numbers::invalid_unsigned_int)
  {}
 
 
  template <int rank>
  constexpr inline Tensor<rank>::Tensor(
    const unsigned int first_tensor_component)
    : first_tensor_component(first_tensor_component)
  {}
 
 
  template <typename Extractor>
  constexpr inline FirstCoupling<Extractor>::FirstCoupling(
    const Extractor &extractor)
    : extractor(extractor)
  {}
 
 
  template <typename Extractor>
  constexpr inline SecondCoupling<Extractor>::SecondCoupling(
    const Extractor &extractor)
    : extractor(extractor)
  {}
} // namespace FEValuesExtractors
 
 
DEAL_II_NAMESPACE_CLOSE
 
#endif