dof_map_base.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_DOF_MAP_BASE_H
#define LIBMESH_DOF_MAP_BASE_H

#include "libmesh/id_types.h"
#include "libmesh/parallel_object.h"
#include <vector>

namespace libMesh
{
class Variable;
class Elem;
class Node;

class DofMapBase : public ParallelObject
{
public:
  DofMapBase(const Parallel::Communicator & comm);

  virtual unsigned int n_variables() const = 0;

  virtual const Variable & variable(const unsigned int c) const = 0;

  dof_id_type first_dof(const processor_id_type proc) const;

  dof_id_type first_dof() const { return this->first_dof(this->processor_id()); }

  dof_id_type end_dof(const processor_id_type proc) const;

  dof_id_type end_dof() const { return this->end_dof(this->processor_id()); }

  virtual void dof_indices(const Elem * const elem,
                           std::vector<dof_id_type> & di,
                           const unsigned int vn,
                           int p_level = -12345) const = 0;

  virtual void dof_indices(const Node * const node,
                           std::vector<dof_id_type> & di,
                           const unsigned int vn) const = 0;
  dof_id_type n_dofs() const { return _n_dfs; }

  dof_id_type n_dofs_on_processor(const processor_id_type proc) const;

  dof_id_type n_local_dofs() const { return this->n_dofs_on_processor(this->processor_id()); }

  virtual void clear();

#ifdef LIBMESH_ENABLE_AMR

  dof_id_type n_old_dofs() const { return _n_old_dfs; }

  dof_id_type first_old_dof(const processor_id_type proc) const;

  dof_id_type first_old_dof() const { return this->first_old_dof(this->processor_id()); }

  dof_id_type end_old_dof(const processor_id_type proc) const;

  dof_id_type end_old_dof() const { return this->end_old_dof(this->processor_id()); }
#endif // LIBMESH_ENABLE_AMR

protected:
  std::size_t compute_dof_info(dof_id_type n_local_dofs);

  std::vector<dof_id_type> _first_df;

  std::vector<dof_id_type> _end_df;

  dof_id_type _n_dfs;

#ifdef LIBMESH_ENABLE_AMR

  dof_id_type _n_old_dfs;

  std::vector<dof_id_type> _first_old_df;

  std::vector<dof_id_type> _end_old_df;
#endif
};

inline dof_id_type DofMapBase::first_dof(const processor_id_type proc) const
{
  libmesh_assert_less(proc, _first_df.size());
  return _first_df[proc];
}

inline dof_id_type DofMapBase::end_dof(const processor_id_type proc) const
{
  libmesh_assert_less(proc, _end_df.size());
  return _end_df[proc];
}

inline dof_id_type DofMapBase::n_dofs_on_processor(const processor_id_type proc) const
{
  libmesh_assert_less(proc, _first_df.size());
  return cast_int<dof_id_type>(_end_df[proc] - _first_df[proc]);
}

#ifdef LIBMESH_ENABLE_AMR
inline dof_id_type DofMapBase::first_old_dof(const processor_id_type proc) const
{
  libmesh_assert_less(proc, _first_old_df.size());
  return _first_old_df[proc];
}

inline dof_id_type DofMapBase::end_old_dof(const processor_id_type proc) const
{
  libmesh_assert_less(proc, _end_old_df.size());
  return _end_old_df[proc];
}
#endif // LIBMESH_ENABLE_AMR
}
#endif // LIBMESH_DOF_MAP_BASE_H