variable.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2025 Benjamin S. Kirk, John W. Peterson, Roy H. Stogner

// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.

// This library 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
// Lesser General Public License for more details.

// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

#ifndef LIBMESH_VARIABLE_H
#define LIBMESH_VARIABLE_H

// Local Includes
#include "libmesh/libmesh_common.h"
#include "libmesh/fe_type.h"
#include "libmesh/id_types.h"

// C++ includes
#include <set>
#include <string>
#include <vector>

namespace libMesh
{

// Forward Declaration
class System;
class MeshBase;

class Variable
{
public:

  Variable (System * sys,
            std::string var_name,
            const unsigned int var_number,
            const unsigned int first_scalar_num,
            const FEType & var_type) :
    _sys(sys),
    _name(std::move(var_name)),
    _active_subdomains(),
    _number(var_number),
    _first_scalar_number(first_scalar_num),
    _type(var_type)
  {}

  Variable (System * sys,
            std::string var_name,
            const unsigned int var_number,
            const unsigned int first_scalar_num,
            const FEType & var_type,
            const std::set<subdomain_id_type> & var_active_subdomains) :
    _sys(sys),
    _name(std::move(var_name)),
    _active_subdomains(var_active_subdomains),
    _number(var_number),
    _first_scalar_number(first_scalar_num),
    _type(var_type)
  {}

  Variable (const Variable &) = default;
  Variable & operator= (const Variable &) = default;
  Variable (Variable &&) = default;
  Variable & operator= (Variable &&) = default;

  bool operator== ( const Variable & other) const
  {
    return (_sys == other._sys) &&
           (_name == other._name) &&
           (_active_subdomains == other._active_subdomains) &&
           (_first_scalar_number == other._first_scalar_number) &&
           (_type == other._type);
  }

  System * system() const
  {
    return _sys;
  }

  const std::string & name() const
  { return _name; }

  unsigned int number() const
  { return _number; }

  unsigned int first_scalar_number() const
  { return _first_scalar_number; }

  const FEType & type() const
  { return _type; }

  unsigned int n_components() const;

  unsigned int n_components(const MeshBase & mesh) const;

  bool active_on_subdomain (subdomain_id_type sid) const
  { return (_active_subdomains.empty() || _active_subdomains.count(sid));  }

  bool implicitly_active () const
  { return _active_subdomains.empty(); }

  const std::set<subdomain_id_type> & active_subdomains() const
  { return _active_subdomains; }

protected:
  System *                _sys;
  std::string             _name;
  std::set<subdomain_id_type> _active_subdomains;
  unsigned int            _number;
  unsigned int            _first_scalar_number;
  FEType                  _type;
};



class VariableGroup : public Variable
{
public:
  VariableGroup (System * sys,
                 std::vector<std::string> var_names,
                 const unsigned int var_number,
                 const unsigned int first_scalar_num,
                 const FEType & var_type) :
    Variable (sys,
              "var_group",
              var_number,
              first_scalar_num,
              var_type),
    _names(std::move(var_names))
  {}


  VariableGroup (System * sys,
                 std::vector<std::string> var_names,
                 const unsigned int var_number,
                 const unsigned int first_scalar_num,
                 const FEType & var_type,
                 const std::set<subdomain_id_type> & var_active_subdomains) :

    Variable (sys,
              "var_group",
              var_number,
              first_scalar_num,
              var_type,
              var_active_subdomains),
    _names(std::move(var_names))
  {}

  VariableGroup (const VariableGroup &) = default;
  VariableGroup & operator= (const VariableGroup &) = default;
  VariableGroup (VariableGroup &&) = default;
  VariableGroup & operator= (VariableGroup &&) = default;

  bool operator== ( const VariableGroup & other) const
  {
    return (this->Variable::operator==(other)) &&
           (_names == other._names);
  }

  unsigned int n_variables () const
  { return cast_int<unsigned int>(_names.size()); }

  Variable variable (unsigned int v) const
  {
    libmesh_assert_less (v, this->n_variables());
    return Variable (this->system(),
                     this->name(v),
                     this->number(v),
                     this->first_scalar_number(v),
                     this->type(),
                     this->active_subdomains());
  }

  Variable operator() (unsigned int v) const
  { return this->variable(v); }

  const std::string & name(unsigned int v) const
  {
    libmesh_assert_less (v, this->n_variables());
    return _names[v];
  }

  unsigned int number(unsigned int v) const
  {
    libmesh_assert_less (v, this->n_variables());
    return _number + v;
  }

  // Don't let number(uint) hide number()
  using Variable::number;

  unsigned int first_scalar_number(unsigned int v) const
  {
    libmesh_assert_less (v, this->n_variables());
    return _first_scalar_number+v;
  }

  void append (std::string var_name)
  { _names.push_back (std::move(var_name)); }

protected:
  std::vector<std::string> _names;
};

} // namespace libMesh

#endif // LIBMESH_VARIABLE_H