single_predicates.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2026 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_SINGLE_PREDICATES_H
#define LIBMESH_SINGLE_PREDICATES_H
 
// Local includes
#include "libmesh/libmesh_common.h"
#include "libmesh/id_types.h"
 
// C++ includes
#include <cstddef>
#include <vector>
#include <set>
#include <memory>
 
namespace libMesh
{
 
// Forward declarations
class BoundaryInfo;
class DofMap;
enum ElemType : int;
 
namespace Predicates
{
// Forward declaration
template <typename T> struct abstract_multi_predicate;
 
// abstract single predicate.  Derived classes must implement the clone()
// function.  Be careful using it since it allocates memory!  The clone()
// function is necessary since the predicate class has pure virtual
// functions.
template <typename T>
struct predicate
{
  virtual ~predicate() = default;
  virtual bool operator()(const T & it) const = 0;
 
protected:
  friend struct abstract_multi_predicate<T>;
  virtual std::unique_ptr<predicate> clone() const = 0;
};
 
 
template <typename T>
struct is_null : predicate<T>
{
  virtual ~is_null() = default;
  virtual bool operator()(const T & it) const override { return *it == nullptr; }
 
protected:
  virtual std::unique_ptr<predicate<T>> clone() const override { return std::make_unique<is_null<T>>(*this); }
};
 
template <typename T>
struct not_null : is_null<T>
{
  virtual bool operator()(const T & it) const override { return !is_null<T>::operator()(it); }
 
protected:
  virtual std::unique_ptr<predicate<T>> clone() const override { return std::make_unique<not_null<T>>(*this); }
};
 
 
template <typename T>
struct active : predicate<T>
{
  virtual ~active() = default;
  virtual bool operator()(const T & it) const override { return (*it)->active(); }
 
protected:
  virtual std::unique_ptr<predicate<T>> clone() const override { return std::make_unique<active<T>>(*this); }
};
 
template <typename T>
struct not_active : active<T>
{
  virtual bool operator()(const T & it) const override { return !active<T>::operator()(it); }
 
protected:
  virtual std::unique_ptr<predicate<T>> clone() const override { return std::make_unique<not_active<T>>(*this); }
};
 
 
template <typename T>
struct ancestor : predicate<T>
{
  virtual ~ancestor() = default;
  virtual bool operator()(const T & it) const override { return (*it)->ancestor(); }
 
protected:
  virtual std::unique_ptr<predicate<T>> clone() const override { return std::make_unique<ancestor<T>>(*this); }
};
 
template <typename T>
struct not_ancestor : ancestor<T>
{
  virtual bool operator()(const T & it) const override { return !ancestor<T>::operator()(it); }
 
protected:
  virtual std::unique_ptr<predicate<T>> clone() const override { return std::make_unique<not_ancestor<T>>(*this); }
};
 
 
template <typename T>
struct subactive : predicate<T>
{
  virtual ~subactive() = default;
  virtual bool operator()(const T & it) const override { return (*it)->subactive(); }
 
protected:
  virtual std::unique_ptr<predicate<T>> clone() const override { return std::make_unique<subactive<T>>(*this); }
};
 
template <typename T>
struct not_subactive : subactive<T>
{
  virtual bool operator()(const T & it) const override { return !subactive<T>::operator()(it); }
 
protected:
  virtual std::unique_ptr<predicate<T>> clone() const override { return std::make_unique<not_subactive<T>>(*this); }
};
 
 
 
template <typename T>
struct pid : predicate<T>
{
  pid(processor_id_type p) : _pid(p) {}
  virtual ~pid() = default;
 
  // op()
  virtual bool operator()(const T & it) const override { return (*it)->processor_id() == _pid; }
 
protected:
  virtual std::unique_ptr<predicate<T>> clone() const override { return std::make_unique<pid<T>>(*this); }
  const processor_id_type _pid;
};
 
 
 
template <typename T>
struct bid : predicate<T>
{
  bid(boundary_id_type b_id,
      const BoundaryInfo & bndry_info) :
    _bid(b_id),
    _bndry_info(bndry_info)
  {}
  virtual ~bid() = default;
 
  // op()
  virtual bool operator()(const T & it) const override;
 
protected:
  virtual std::unique_ptr<predicate<T>> clone() const override { return std::make_unique<bid<T>>(*this); }
  const boundary_id_type _bid;
  const BoundaryInfo & _bndry_info;
};
 
 
 
template <typename T>
struct bnd : predicate<T>
{
  bnd(const BoundaryInfo & bndry_info) :
    _bndry_info(bndry_info)
  {}
  virtual ~bnd() = default;
 
  // op()
  virtual bool operator()(const T & it) const override;
 
protected:
  virtual std::unique_ptr<predicate<T>> clone() const override { return std::make_unique<bnd<T>>(*this); }
  const BoundaryInfo & _bndry_info;
};
 
 
 
template <typename T>
struct semilocal_pid : predicate<T>
{
  semilocal_pid(processor_id_type p) : _pid(p) {}
  virtual ~semilocal_pid() = default;
 
  // op()
  virtual bool operator()(const T & it) const override { return (*it)->is_semilocal(_pid); }
 
protected:
  virtual std::unique_ptr<predicate<T>> clone() const override { return std::make_unique<semilocal_pid<T>>(*this); }
  const processor_id_type _pid;
};
 
 
 
template <typename T>
struct facelocal_pid : predicate<T>
{
  facelocal_pid(processor_id_type p) : _pid(p) {}
  virtual ~facelocal_pid() = default;
 
  // op()
  virtual bool operator()(const T & it) const override
  {
    if ((*it)->processor_id() == _pid)
      return true;
    for (auto n : (*it)->neighbor_ptr_range())
      if (n && n->processor_id() == _pid)
        return true;
    return false;
  }
 
protected:
  virtual std::unique_ptr<predicate<T>> clone() const override { return std::make_unique<facelocal_pid<T>>(*this); }
  const processor_id_type _pid;
};
 
 
 
template <typename T>
struct not_pid : pid<T>
{
  not_pid(processor_id_type p) : pid<T>(p) {}
 
  virtual bool operator()(const T & it) const override { return !pid<T>::operator()(it); }
 
protected:
  virtual std::unique_ptr<predicate<T>> clone() const override { return std::make_unique<not_pid<T>>(*this); }
};
 
 
template <typename T>
struct elem_type : predicate<T>
{
  elem_type (ElemType t) : _elem_type(t) {}
  virtual ~elem_type() = default;
 
  virtual bool operator()(const T & it) const override { return (*it)->type() == _elem_type; }
 
protected:
  virtual std::unique_ptr<predicate<T>> clone() const override { return std::make_unique<elem_type<T>>(*this); }
  const ElemType _elem_type;
};
 
 
 
#ifdef LIBMESH_ENABLE_AMR
template <typename T>
struct flagged : predicate<T>
{
  flagged (unsigned char rflag) : _rflag(rflag) {}
  virtual ~flagged() = default;
 
  virtual bool operator()(const T & it) const override { return (*it)->refinement_flag() == _rflag; }
 
protected:
  virtual std::unique_ptr<predicate<T>> clone() const override { return std::make_unique<flagged<T>>(*this); }
  const unsigned char _rflag;
};
#endif // LIBMESH_ENABLE_AMR
 
 
 
 
 
 
template <typename T>
struct level : predicate<T>
{
  level (unsigned int l) : _level(l) {}
  virtual ~level() = default;
 
  virtual bool operator()(const T & it) const override { return (*it)->level() == _level; }
 
protected:
  virtual std::unique_ptr<predicate<T>> clone() const override { return std::make_unique<level<T>>(*this); }
  const unsigned int _level;
};
 
 
 
template <typename T>
struct not_level : level<T>
{
  not_level(unsigned int l) : level<T>(l) {}
 
  virtual bool operator()(const T & it) const override { return !level<T>::operator()(it); }
 
protected:
  virtual std::unique_ptr<predicate<T>> clone() const override { return std::make_unique<not_level<T>>(*this); }
};
 
 
 
 
template <typename T>
struct null_neighbor : predicate<T>
{
  virtual ~null_neighbor() = default;
  virtual bool operator()(const T & it) const override
  {
    return (*it)->on_boundary();
  }
 
protected:
  virtual std::unique_ptr<predicate<T>> clone() const override { return std::make_unique<null_neighbor<T>>(*this); }
};
 
 
 
template <typename T>
struct boundary_side : predicate<T>
{
  virtual ~boundary_side() = default;
  virtual bool operator()(const T & it) const override
  {
    return it.side_on_boundary();
  }
 
protected:
  virtual std::unique_ptr<predicate<T>> clone() const override { return std::make_unique<boundary_side<T>>(*this); }
};
 
template <typename T>
struct subdomain : predicate<T>
{
  subdomain(subdomain_id_type sid) : _subdomain(sid) {}
  virtual ~subdomain() = default;
 
  // op()
  virtual bool operator()(const T & it) const override { return (*it)->subdomain_id() == _subdomain; }
 
protected:
  virtual std::unique_ptr<predicate<T>> clone() const override { return std::make_unique<subdomain<T>>(*this); }
  const subdomain_id_type _subdomain;
};
 
 
template <typename T>
struct subdomain_set : predicate<T>
{
  subdomain_set(std::set<subdomain_id_type> sset) : _subdomain_set(sset) {}
  virtual ~subdomain_set() = default;
 
  // op()
  virtual bool operator()(const T & it) const override { return _subdomain_set.count((*it)->subdomain_id()); }
 
protected:
  virtual std::unique_ptr<predicate<T>> clone() const override { return std::make_unique<subdomain_set<T>>(*this); }
  const std::set<subdomain_id_type> _subdomain_set;
};
 
 
template <typename T>
struct evaluable : predicate<T>
{
  evaluable(const DofMap & dof_map,
            unsigned int var_num) :
    _dof_map(dof_map), _var_num(var_num) {}
  virtual ~evaluable() = default;
 
  // op()
  virtual bool operator()(const T & it) const override;
 
protected:
  virtual std::unique_ptr<predicate<T>> clone() const override { return std::make_unique<evaluable<T>>(*this); }
  const DofMap & _dof_map;
  unsigned int _var_num;
};
 
template <typename T>
struct multi_evaluable : predicate<T>
{
  multi_evaluable(std::vector<const DofMap *> dof_maps) :
      _dof_maps(dof_maps) {}
  virtual ~multi_evaluable() = default;
 
  // op()
  virtual bool operator()(const T & it) const override;
 
protected:
  virtual std::unique_ptr<predicate<T>> clone() const override { return std::make_unique<multi_evaluable<T>>(*this); }
  std::vector<const DofMap *> _dof_maps;
};
 
 
} // namespace Predicates
 
 
} // namespace libMesh
 
#endif // LIBMESH_SINGLE_PREDICATES_H