A Node is like a Point, but with more information. More...

#include <node.h>

Inheritance diagram for libMesh::Node:

Public Types
typedef Real	value_type
	Helper typedef for C++98 generic programming. More...

typedef unsigned int	index_type
	Helper typedef for generic index programming. More...

Public Member Functions
	Node (const Real x=0, const Real y=0, const Real z=0, const dof_id_type id=invalid_id)
	Constructor. More...

	Node (const Node &n)
	Copy-constructor. More...

	Node (const Point &p, const dof_id_type id=invalid_id)
	Copy-constructor from a `Point`. More...

template<typename T , typename = typename boostcopy::enable_if_c<ScalarTraits<T>::value,void>::type>
	Node (const T x)
	Disambiguate constructing from non-Real scalars. More...

	~Node ()
	Destructor. More...

Node &	operator= (const Point &p)
	Assign to a node from a point. More...

bool	active () const

bool	operator== (const Node &rhs) const

void	print_info (std::ostream &os=libMesh::out) const
	Prints relevant information about the node. More...

std::string	get_info () const
	Prints relevant information about the node to a string. More...

unsigned int	packed_size () const

unsigned int	valence () const

void	set_valence (unsigned int val)
	Sets the number of nodes connected with this node. More...

processor_id_type	choose_processor_id (processor_id_type pid1, processor_id_type pid2) const
	Return which of pid1 and pid2 would be preferred by the current load-balancing heuristic applied to this node. More...

void	assign (const TypeVector< T2 > &)
	Assign to this vector without creating a temporary. More...

const Real &	operator() (const unsigned int i) const

Real &	operator() (const unsigned int i)

const Real &	slice (const unsigned int i) const

Real &	slice (const unsigned int i)

TypeVector< typename CompareTypes< Real, T2 >::supertype >	operator+ (const TypeVector< T2 > &) const
	Add two vectors. More...

const TypeVector< Real > &	operator+= (const TypeVector< T2 > &)
	Add to this vector. More...

void	add (const TypeVector< T2 > &)
	Add to this vector without creating a temporary. More...

void	add_scaled (const TypeVector< T2 > &, const Real &)
	Add a scaled value to this vector without creating a temporary. More...

TypeVector< typename CompareTypes< Real, T2 >::supertype >	operator- (const TypeVector< T2 > &) const
	Subtract from this vector. More...

TypeVector< Real >	operator- () const

const TypeVector< Real > &	operator-= (const TypeVector< T2 > &)
	Subtract from this vector. More...

void	subtract (const TypeVector< T2 > &)
	Subtract from this vector without creating a temporary. More...

void	subtract_scaled (const TypeVector< T2 > &, const Real &)
	Subtract a scaled value from this vector without creating a temporary. More...

boostcopy::enable_if_c< ScalarTraits< Scalar >::value, TypeVector< typename CompareTypes< Real, Scalar >::supertype > >::type	operator* (const Scalar &) const
	Multiply this vector by a scalar value. More...

CompareTypes< Real, T2 >::supertype	operator* (const TypeVector< T2 > &) const

const TypeVector< Real > &	operator*= (const Real &)
	Multiply this vector by a scalar value. More...

boostcopy::enable_if_c< ScalarTraits< Scalar >::value, TypeVector< typename CompareTypes< Real, Scalar >::supertype > >::type	operator/ (const Scalar &) const
	Divide each entry of this vector by scalar value. More...

const TypeVector< Real > &	operator/= (const Real &)
	Divide each entry of this vector by scalar value. More...

CompareTypes< Real, T2 >::supertype	contract (const TypeVector< T2 > &) const

TypeVector< typename CompareTypes< Real, T2 >::supertype >	cross (const TypeVector< T2 > &v) const

TypeVector< Real >	unit () const

auto	size () const -> decltype(std::norm(Real()))

auto	norm () const -> decltype(std::norm(Real()))

auto	size_sq () const -> decltype(std::norm(Real()))

auto	norm_sq () const -> decltype(std::norm(Real()))

bool	is_zero () const

void	zero ()
	Set all entries of the vector to 0. More...

bool	relative_fuzzy_equals (const TypeVector< Real > &rhs, Real tol=TOLERANCE) const

bool	absolute_fuzzy_equals (const TypeVector< Real > &rhs, Real tol=TOLERANCE) const

bool	operator== (const TypeVector< Real > &rhs) const

bool	operator!= (const TypeVector< Real > &rhs) const

bool	operator< (const TypeVector< Real > &rhs) const

bool	operator< (const TypeVector< Complex > &rhs) const

bool	operator<= (const TypeVector< Real > &rhs) const

bool	operator<= (const TypeVector< Complex > &rhs) const

bool	operator> (const TypeVector< Real > &rhs) const

bool	operator> (const TypeVector< Complex > &rhs) const

bool	operator>= (const TypeVector< Real > &rhs) const

bool	operator>= (const TypeVector< Complex > &rhs) const

void	print (std::ostream &os=libMesh::out) const
	Formatted print, by default to `libMesh::out`. More...

void	write_unformatted (std::ostream &out, const bool newline=true) const
	Unformatted print to the stream `out`. More...

void	clear_old_dof_object ()
	Sets the `old_dof_object` to nullptr. More...

void	set_old_dof_object ()
	Sets the `old_dof_object` to a copy of `this`. More...

void	clear_dofs ()
	Clear the `DofMap` data structures holding degree of freedom data. More...

void	invalidate_dofs (const unsigned int sys_num=libMesh::invalid_uint)
	Sets all degree of freedom numbers to `invalid_id`. More...

void	invalidate_id ()
	Sets the id to `invalid_id`. More...

void	invalidate_processor_id ()
	Sets the processor id to `invalid_processor_id`. More...

void	invalidate ()
	Invalidates all the indices for this `DofObject`. More...

unsigned int	n_dofs (const unsigned int s, const unsigned int var=libMesh::invalid_uint) const

dof_id_type	id () const

dof_id_type &	set_id ()

void	set_id (const dof_id_type dofid)
	Sets the `id` for this `DofObject`. More...

unique_id_type	unique_id () const

unique_id_type &	set_unique_id ()

bool	valid_id () const

bool	valid_unique_id () const

processor_id_type	processor_id () const

processor_id_type &	processor_id ()

void	processor_id (const processor_id_type pid)
	Sets the `processor_id` for this `DofObject`. More...

bool	valid_processor_id () const

unsigned int	n_systems () const

unsigned int	n_pseudo_systems () const

void	set_n_systems (const unsigned int s)
	Sets the number of systems for this `DofObject`. More...

void	set_extra_integer (const unsigned int index, const dof_id_type value)
	Sets the value on this object of the extra integer associated with `index`, which should have been obtained via a call to `MeshBase::add_elem_integer` or `MeshBase::add_node_integer`. More...

dof_id_type	get_extra_integer (const unsigned int index) const
	Gets the value on this object of the extra integer associated with `index`, which should have been obtained via a call to `MeshBase::add_elem_integer` or `MeshBase::add_node_integer`. More...

template<typename T >
void	set_extra_datum (const unsigned int index, const T value)
	Sets the value on this object of the extra datum associated with `index`, which should have been obtained via a call to `MeshBase::add_elem_datum` or `MeshBase::add_node_datum` using the same type T. More...

template<typename T >
T	get_extra_datum (const unsigned int index) const
	Gets the value on this object of the extra datum associated with `index`, which should have been obtained via a call to `MeshBase::add_elem_datum` or `MeshBase::add_node_datum` using the same type T. More...

void	add_system ()
	Adds an additional system to the `DofObject`. More...

unsigned int	n_var_groups (const unsigned int s) const

unsigned int	n_vars (const unsigned int s, const unsigned int vg) const

unsigned int	n_vars (const unsigned int s) const

void	set_n_vars_per_group (const unsigned int s, const std::vector< unsigned int > &nvpg)
	Sets number of variables in each group associated with system `s` for this `DofObject`. More...

unsigned int	n_comp (const unsigned int s, const unsigned int var) const

unsigned int	n_comp_group (const unsigned int s, const unsigned int vg) const

void	set_n_comp (const unsigned int s, const unsigned int var, const unsigned int ncomp)
	Sets the number of components for `Variable` `var` of system `s` associated with this `DofObject`. More...

void	set_n_comp_group (const unsigned int s, const unsigned int vg, const unsigned int ncomp)
	Sets the number of components for `VariableGroup` `vg` of system `s` associated with this `DofObject`. More...

dof_id_type	dof_number (const unsigned int s, const unsigned int var, const unsigned int comp) const

dof_id_type	dof_number (const unsigned int s, const unsigned int vg, const unsigned int vig, const unsigned int comp, const unsigned int n_comp) const

std::pair< unsigned int, unsigned int >	var_to_vg_and_offset (const unsigned int s, const unsigned int var) const

void	set_dof_number (const unsigned int s, const unsigned int var, const unsigned int comp, const dof_id_type dn)
	Sets the global degree of freedom number for variable `var`, component `comp` for system `s` associated with this `DofObject`. More...

bool	has_dofs (const unsigned int s=libMesh::invalid_uint) const

void	set_vg_dof_base (const unsigned int s, const unsigned int vg, const dof_id_type db)
	`VariableGroup` DoF indices are indexed as id = base + var_in_vg*ncomp + comp This method allows for direct access to the base. More...

dof_id_type	vg_dof_base (const unsigned int s, const unsigned int vg) const
	`VariableGroup` DoF indices are indexed as id = base + var_in_vg*ncomp + comp This method allows for direct access to the base. More...

void	add_extra_integers (const unsigned int n_integers)
	Assigns a set of extra integers to this `DofObject`. More...

unsigned int	n_extra_integers () const
	Returns how many extra integers are associated to the `DofObject`. More...

bool	has_extra_integers () const
	Returns whether extra integers are associated to the `DofObject`. More...

unsigned int	packed_indexing_size () const
	If we pack our indices into an buffer for communications, how many ints do we need? More...

void	unpack_indexing (std::vector< largest_id_type >::const_iterator begin)
	A method for creating our index buffer from packed data - basically with our current implementation we investigate the size term and then copy. More...

void	pack_indexing (std::back_insert_iterator< std::vector< largest_id_type >> target) const
	A method for creating packed data from our index buffer - basically a copy with prepended size with our current implementation. More...

void	debug_buffer () const
	Print our buffer for debugging. More...

void	print_dof_info () const
	Print out info for debugging. More...

void	set_buffer (const std::vector< dof_id_type > &buf)

Static Public Member Functions
static std::unique_ptr< Node >	build (const Node &n)

static std::unique_ptr< Node >	build (const Point &p, const dof_id_type id)

static std::unique_ptr< Node >	build (const Real x, const Real y, const Real z, const dof_id_type id)

static unsigned int	unpackable_indexing_size (std::vector< largest_id_type >::const_iterator begin)
	If we have indices packed into an buffer for communications, how much of that buffer applies to this dof object? More...

static std::string	get_info ()
	Gets a string containing the reference information. More...

static void	print_info (std::ostream &out=libMesh::out)
	Prints the reference information, by default to `libMesh::out`. More...

static unsigned int	n_objects ()
	Prints the number of outstanding (created, but not yet destroyed) objects. More...

static void	enable_print_counter_info ()
	Methods to enable/disable the reference counter output from print_info() More...

static void	disable_print_counter_info ()

static std::string	get_info ()
	Gets a string containing the reference information. More...

static void	print_info (std::ostream &out=libMesh::out)
	Prints the reference information, by default to `libMesh::out`. More...

static unsigned int	n_objects ()
	Prints the number of outstanding (created, but not yet destroyed) objects. More...

static void	enable_print_counter_info ()
	Methods to enable/disable the reference counter output from print_info() More...

static void	disable_print_counter_info ()

Public Attributes
DofObject *	old_dof_object
	This object on the last mesh. More...

Static Public Attributes
static const dof_id_type	invalid_id = static_cast<dof_id_type>(-1)
	An invalid `id` to distinguish an uninitialized `DofObject`. More...

static const unique_id_type	invalid_unique_id = static_cast<unique_id_type>(-1)
	An invalid `unique_id` to distinguish an uninitialized `DofObject`. More...

static const processor_id_type	invalid_processor_id = static_cast<processor_id_type>(-1)
	An invalid `processor_id` to distinguish DoFs that have not been assigned to a processor. More...

Protected Types
typedef std::map< std::string, std::pair< unsigned int, unsigned int > >	Counts
	Data structure to log the information. More...

typedef std::map< std::string, std::pair< unsigned int, unsigned int > >	Counts
	Data structure to log the information. More...

Protected Member Functions
void	increment_constructor_count (const std::string &name)
	Increments the construction counter. More...

void	increment_destructor_count (const std::string &name)
	Increments the destruction counter. More...

void	increment_constructor_count (const std::string &name)
	Increments the construction counter. More...

void	increment_destructor_count (const std::string &name)
	Increments the destruction counter. More...

Protected Attributes
Real	_coords [LIBMESH_DIM]
	The coordinates of the `TypeVector`. More...

Static Protected Attributes
static Counts	_counts
	Actually holds the data. More...

static Threads::atomic< unsigned int >	_n_objects
	The number of objects. More...

static Threads::spin_mutex	_mutex
	Mutual exclusion object to enable thread-safe reference counting. More...

static bool	_enable_print_counter = true
	Flag to control whether reference count information is printed when print_info is called. More...

static Counts	_counts
	Actually holds the data. More...

static Threads::atomic< unsigned int >	_n_objects
	The number of objects. More...

static Threads::spin_mutex	_mutex
	Mutual exclusion object to enable thread-safe reference counting. More...

static bool	_enable_print_counter = true
	Flag to control whether reference count information is printed when print_info is called. More...

Private Types
typedef unsigned char	valence_idx_t
	Type used to store node valence. More...

typedef dof_id_type	index_t
	DoF index information. More...

typedef std::vector< index_t >	index_buffer_t

Private Member Functions
unsigned int	var_to_vg (const unsigned int s, const unsigned int var) const
	Utility function - for variable `var` in system `s`, figure out what variable group it lives in. More...

unsigned int	system_var_to_vg_var (const unsigned int s, const unsigned int vg, const unsigned int var) const
	Utility function - for variable `var` in system `s`, figure out what variable group it lives in. More...

unsigned int	start_idx (const unsigned int s) const
	The starting index for system `s`. More...

unsigned int	end_idx (const unsigned int s) const
	The ending index for system `s`. More...

unsigned int	start_idx_ints () const
	The starting index for an extra_integers pseudosystem. More...

unsigned int	end_idx_ints () const
	The ending index for an extra_integers pseudosystem. More...

Private Attributes
valence_idx_t	_valence
	The number of nodes connected with this node. More...

unique_id_type	_unique_id
	A globally unique id, guaranteed not to change as the mesh is repartitioned or adapted. More...

dof_id_type	_id
	The `id` of the `DofObject`. More...

processor_id_type	_processor_id
	The `processor_id` of the `DofObject`. More...

index_buffer_t	_idx_buf

Static Private Attributes
static const index_t	ncv_magic = 256
	Above we introduced the chimera ncv, which is a hybrid of the form ncv = ncv_magic*nv + nc where nv are the number of identical variables of a given type, and nc is the number of components for this set of variables. More...

static const index_t	ncv_magic_exp = 8

Friends
class	MeshRefinement
	This class need access to the node key information, but no one else should be able to mess with it. More...

class	Elem

Detailed Description

A Node is like a Point, but with more information.

A Node is located in space and is associated with some (x,y,z) coordinates. Additionally, a Node may be enumerated with a global id. Finally, a Node may have an arbitrary number of degrees of freedom associated with it.

Author: Benjamin S. Kirk

Date: 2003

A geometric point in (x,y,z) space associated with a DOF.

Definition at line 52 of file node.h.

Member Typedef Documentation

◆ Counts [1/2]

typedef std::map<std::string, std::pair<unsigned int, unsigned int> > libMesh::ReferenceCounter::Counts

protectedinherited

Data structure to log the information.

The log is identified by the class name.

Definition at line 117 of file reference_counter.h.

◆ Counts [2/2]

typedef std::map<std::string, std::pair<unsigned int, unsigned int> > libMesh::ReferenceCounter::Counts

protectedinherited

Data structure to log the information.

The log is identified by the class name.

Definition at line 117 of file reference_counter.h.

◆ index_buffer_t

typedef std::vector<index_t> libMesh::DofObject::index_buffer_t

privateinherited

Definition at line 612 of file dof_object.h.

◆ index_t

typedef dof_id_type libMesh::DofObject::index_t

privateinherited

DoF index information.

This is packed into a contiguous buffer of the following format:

* [hdr end_0 end_1 ... end_{nps-2} (ncv_0 idx_0 ncv_1 idx_1 ... ncv_nv idx_nv)_0
*                                  (ncv_0 idx_0 ncv_1 idx_1 ... ncv_nv idx_nv)_1
*                                   ...
*                                  (ncv_0 idx_0 ncv_1 idx_1 ... ncv_nv idx_nv)_{nps-2} ]
*

'hdr' determines whether this DofObject has_extra_integers() associated with it; iff so then it is negative.

The total number of "pseudo systems" is nps := abs(hdr).

The total number of true systems is

* ns = hdr,            hdr >= 0
*    = abs(hdr) - 1,   otherwise.
*

'end_s' is the index past the end of the variable group (or integer) storage for (pseudo) system s.

Note: We specifically do not store the end for the last (pseudo) system - this always _idx_buf.size().

As a first example, consider the case of 4 systems, with 3, 0, 1, 2 variable groups, respectively. The _idx_buf then looks like:

* [4 10 10 12 () (ncv_0 idx_0 ncv_1 idx_1 ncv_2 idx_2) () (ncv_0 idx_0) (ncv_0 idx_0 ncv_1 idx_1)]
* [0  1  2  3         4     5     6     7     8     9         10    11      12    13    14    15]
*

The ending index for each (pseudo) system is then given by:

* end_s = _idx_buf.size(),                        s == (nps-1),
*       = _idx_buf[s+1] + has_extra_integers(),   otherwise.
*

The starting indices are not specifically stored, but rather inferred as follows:

start_s = abs(_idx_buf[s])

Now, the defining characteristic of the VariableGroup is that it supports an arbitrary number of variables of the same type. At the DofObject level, what that means is that each Variable in the VariableGroup will have the same number of nonzero components, and they can all be indexed from the same base number. We use this information in the ncv_# and idx_# entries as follows:

ncv_# = n_vars*ncv_magic + n_comp for variable group # idx_# = base_offset for variable group #

the DoF index for a particular component c of variable v within that group is then given by

idx_var = idx_# + n_comp*v + c

Note: There is a subtlety here - "variable v within that group" usually means nothing to the user. This class is either indexed with variable group numbers, or variable numbers counted within the system. So for a system with 2 variable groups, 4 and 8 variables each, the 5th variable in the system is the 1st variable in 2nd variable group. (Now of course 0-base everything... but you get the idea.)

When hdr is negative when cast to a signed type, then we interpret that to mean there exists one pseudo-system following the true systems, one for which the _idx_buf data stores the values associated with add_extra_integer entries, not ncv and idx data associated with system variables. We still return only the number of true systems for n_systems(), but we report has_extra_integers() as true iff hdr is negative, and abs(hdr) will reflect the total number of pseudo-systems, n_systems()+1.

E.g. if we had added two extra integers to the example case above, the _idx_buf then looks like:

* [-5 11 11 13 17 () (ncv_0 idx_0 ncv_1 idx_1 ncv_2 idx_2) () (ncv_0 idx_0) (ncv_0 idx_0 ncv_1 idx_1) (xtra1 xtra2)]
* [0   1  2  3  4         5     6     7     8     9    10         11    12      13    14    15    16      17    18]
*

Definition at line 611 of file dof_object.h.

◆ index_type

typedef unsigned int libMesh::TypeVector< Real >::index_type

inherited

Helper typedef for generic index programming.

Definition at line 141 of file type_vector.h.

◆ valence_idx_t

typedef unsigned char libMesh::Node::valence_idx_t

private

Type used to store node valence.

Definition at line 210 of file node.h.

◆ value_type

typedef Real libMesh::TypeVector< Real >::value_type

inherited

Helper typedef for C++98 generic programming.

Definition at line 136 of file type_vector.h.

Constructor & Destructor Documentation

◆ Node() [1/4]

libMesh::Node::Node	(	const Real	x = `0`,
		const Real	y = `0`,
		const Real	z = `0`,
		const dof_id_type	id = `invalid_id`
	)

inlineexplicit

Constructor.

By default sets all entries to 0. Gives the point 0 in LIBMESH_DIM dimensions with an id of Node::invalid_id.

Definition at line 238 of file node.h.

                                      :
   Point(x,y,z)
 #ifdef LIBMESH_ENABLE_NODE_VALENCE
   ,
   _valence(0)
 #endif
 {
   this->set_id() = dofid;
 }
  
  
  
 #ifdef LIBMESH_ENABLE_DEPRECATED
 inline
 Node::Node (const Node & n) :
   Point(n),
   DofObject(n),
   ReferenceCountedObject<Node>()
 #ifdef LIBMESH_ENABLE_NODE_VALENCE
   ,
   _valence(n._valence)
 #endif
 {
   libmesh_deprecated();
 }
 #endif
  
  
  
 inline
 Node::Node (const Point & p,
             const dof_id_type dofid) :
   Point(p)
 #ifdef LIBMESH_ENABLE_NODE_VALENCE
   ,
   _valence(0)
 #endif
 {
   // optionally assign the id.  We have
   // to do it like this otherwise
   // Node n = Point p would erase
   // the id!
   if (dofid != invalid_id)
     this->set_id() = dofid;
 }
  
  
  
 inline
 Node::~Node ()
 {
 }

References libMesh::DofObject::set_id().

◆ Node() [2/4]

libMesh::Node::Node ( const Node & n )

Copy-constructor.

◆ Node() [3/4]

libMesh::Node::Node	(	const Point &	p,
		const dof_id_type	id = `invalid_id`
	)

explicit

Copy-constructor from a Point.

Optionally assigned the id.

◆ Node() [4/4]

template<typename T , typename = typename boostcopy::enable_if_c<ScalarTraits<T>::value,void>::type>

libMesh::Node::Node ( const T x )

inline

Disambiguate constructing from non-Real scalars.

Definition at line 92 of file node.h.

                    :
     Point (x,0,0)
   { this->set_id() = invalid_id; }

References libMesh::DofObject::invalid_id, and libMesh::DofObject::set_id().

◆ ~Node()

libMesh::Node::~Node ( )

Destructor.

Member Function Documentation

◆ absolute_fuzzy_equals()

bool libMesh::TypeVector< Real >::absolute_fuzzy_equals	(	const TypeVector< Real > &	rhs,
		Real	tol = `TOLERANCE`
	)		const

inlineinherited

Returns: true if two vectors are equal to within an absolute tolerance of tol.

Definition at line 1017 of file type_vector.h.

 {
 #if LIBMESH_DIM == 1
   return (std::abs(_coords[0] - rhs._coords[0])
           <= tol);
 #endif
  
 #if LIBMESH_DIM == 2
   return (std::abs(_coords[0] - rhs._coords[0]) +
           std::abs(_coords[1] - rhs._coords[1])
           <= tol);
 #endif
  
 #if LIBMESH_DIM == 3
   return (std::abs(_coords[0] - rhs._coords[0]) +
           std::abs(_coords[1] - rhs._coords[1]) +
           std::abs(_coords[2] - rhs._coords[2])
           <= tol);
 #endif
 }

◆ active()

bool libMesh::Node::active ( ) const

inline

Returns: true if the node is active. An active node is defined as one for which id() is not Node::invalid_id. Inactive nodes are nodes that are in the mesh but are not connected to any elements.

Definition at line 344 of file node.h.

 {
   return (this->id() != Node::invalid_id);
 }

References libMesh::DofObject::invalid_id.

◆ add()

void libMesh::TypeVector< Real >::add ( const TypeVector< T2 > & p )

inlineinherited

Add to this vector without creating a temporary.

Definition at line 641 of file type_vector.h.

 {
 #if LIBMESH_DIM == 1
   _coords[0] += p._coords[0];
 #endif
  
 #if LIBMESH_DIM == 2
   _coords[0] += p._coords[0];
   _coords[1] += p._coords[1];
 #endif
  
 #if LIBMESH_DIM == 3
   _coords[0] += p._coords[0];
   _coords[1] += p._coords[1];
   _coords[2] += p._coords[2];
 #endif
  
 }

◆ add_extra_integers()

void libMesh::DofObject::add_extra_integers ( const unsigned int n_integers )

inherited

Assigns a set of extra integers to this DofObject.

There will now be n_integers associated; this replaces, not augments, any previous count.

If non-integer data is in the set, each datum of type T should be counted sizeof(T)/sizeof(dof_id_type) times in n_integers.

Definition at line 503 of file dof_object.C.

 {
   if (_idx_buf.empty())
     {
       if (n_integers)
         {
           _idx_buf.resize(n_integers+1, DofObject::invalid_id);
           _idx_buf[0] = dof_id_type(-1);
         }
       return;
     }
   else
     {
       const int hdr = dof_id_signed_type(_idx_buf[0]);
  
       // We already have some extra integers, but may need more or
       // less now.
       if (hdr < 0)
         {
           const unsigned int old_n_integers = this->n_extra_integers();
           if (n_integers != old_n_integers)
             {
               // Make or remove space as needed by count change
               _idx_buf.resize(_idx_buf.size()+n_integers-old_n_integers, DofObject::invalid_id);
  
               // The start index for the extra integers is unchanged.
             }
         }
       else if (n_integers)
       // We had no extra integers, but need to add some
         {
           // Mark the DofObject as holding extra integers
           _idx_buf[0] = dof_id_type(-hdr-1);
  
           // Insert the integer start position
           DofObject::index_buffer_t::iterator it = _idx_buf.begin() + hdr;
           _idx_buf.insert(it, _idx_buf.size()+1);
  
           // Increment the previous system start positions to account
           // for the new header entry creating an offset
           for (int i=1; i<hdr; i++)
             _idx_buf[i]++;
  
           // Append space for extra integers
           _idx_buf.resize(_idx_buf.size()+n_integers, DofObject::invalid_id);
         }
     }
 }

References libMesh::DofObject::_idx_buf, libMesh::DofObject::invalid_id, and libMesh::DofObject::n_extra_integers().

Referenced by libMesh::ReplicatedMesh::add_elem(), libMesh::DistributedMesh::add_elem(), libMesh::ReplicatedMesh::add_node(), libMesh::DistributedMesh::add_node(), libMesh::ReplicatedMesh::add_point(), libMesh::UnstructuredMesh::copy_nodes_and_elements(), libMesh::UnstructuredMesh::create_submesh(), libMesh::ReplicatedMesh::insert_elem(), libMesh::DistributedMesh::insert_elem(), libMesh::ReplicatedMesh::insert_node(), DofObjectTest< Node >::testAddExtraData(), DofObjectTest< Node >::testAddSystemExtraInts(), DofObjectTest< Node >::testSetNSystemsExtraInts(), and DofObjectTest< Node >::testSetNVariableGroupsExtraInts().

◆ add_scaled()

void libMesh::TypeVector< Real >::add_scaled	(	const TypeVector< T2 > &	p,
		const Real &	factor
	)

inlineinherited

Add a scaled value to this vector without creating a temporary.

Definition at line 665 of file type_vector.h.

 {
 #if LIBMESH_DIM == 1
   _coords[0] += factor*p(0);
 #endif
  
 #if LIBMESH_DIM == 2
   _coords[0] += factor*p(0);
   _coords[1] += factor*p(1);
 #endif
  
 #if LIBMESH_DIM == 3
   _coords[0] += factor*p(0);
   _coords[1] += factor*p(1);
   _coords[2] += factor*p(2);
 #endif
  
 }

◆ add_system()

void libMesh::DofObject::add_system ( )

inherited

Adds an additional system to the DofObject.

Definition at line 208 of file dof_object.C.

 {
   // quick return?
   if (this->n_systems() == 0)
     {
       this->set_n_systems(1);
       return;
     }
  
   // cache this value before we screw it up!
   const unsigned int ns_orig = this->n_systems();
  
   DofObject::index_buffer_t::iterator it = _idx_buf.begin() + ns_orig;
  
   // Create the entry for the new system indicating 0 variables.
   //
   // increment the number of systems and the offsets for each of
   // the systems including the new one we just added.
   if (this->has_extra_integers())
     {
       // this inserts the extra_integers' start position as the start
       // position for the new system.  We'll increment all those
       // counts in one sweep next, to account for header expansion.
       _idx_buf.insert(it, *it);
  
       _idx_buf[0]--;
       for (unsigned int i=1; i<ns_orig+2; i++)
         {
           libmesh_assert_less(i, _idx_buf.size());
           _idx_buf[i]++;
         }
     }
   else
     {
       // this inserts the current vector size at the position for the
       // new system
       _idx_buf.insert(it, cast_int<dof_id_type>(_idx_buf.size()));
  
       for (unsigned int i=0; i<ns_orig+1; i++)
         {
           libmesh_assert_less(i, _idx_buf.size());
           _idx_buf[i]++;
         }
     }
  
   libmesh_assert_equal_to (this->n_systems(), (ns_orig+1));
   libmesh_assert_equal_to (this->n_vars(ns_orig), 0);
   libmesh_assert_equal_to (this->n_var_groups(ns_orig), 0);
 }

References libMesh::DofObject::_idx_buf, libMesh::DofObject::has_extra_integers(), libMesh::DofObject::n_systems(), libMesh::DofObject::n_var_groups(), libMesh::DofObject::n_vars(), and libMesh::DofObject::set_n_systems().

Referenced by DofObjectTest< Node >::testAddSystemExtraInts().

◆ assign()

void libMesh::TypeVector< Real >::assign ( const TypeVector< T2 > & p )

inlineinherited

Assign to this vector without creating a temporary.

Definition at line 570 of file type_vector.h.

 {
   for (unsigned int i=0; i<LIBMESH_DIM; i++)
     _coords[i] = p._coords[i];
 }

◆ build() [1/3]

std::unique_ptr< Node > libMesh::Node::build ( const Node & n )

inlinestatic

Returns: A Node copied from n and wrapped in a smart pointer.

Definition at line 314 of file node.h.

 {
   libmesh_deprecated();
   return libmesh_make_unique<Node>(n);
 }

Referenced by libMesh::ReplicatedMesh::add_point(), and libMesh::DistributedMesh::add_point().

◆ build() [2/3]

std::unique_ptr< Node > libMesh::Node::build	(	const Point &	p,
		const dof_id_type	id
	)

inlinestatic

Returns: A Node copied from p with id == id and wrapped in a smart pointer.

Definition at line 324 of file node.h.

 {
   return libmesh_make_unique<Node>(p,id);
 }

◆ build() [3/3]

std::unique_ptr< Node > libMesh::Node::build	(	const Real	x,
		const Real	y,
		const Real	z,
		const dof_id_type	id
	)

inlinestatic

Returns: A Node created from the specified (x,y,z) positions with id == id and wrapped in a smart pointer.

Definition at line 333 of file node.h.

 {
   return libmesh_make_unique<Node>(x,y,z,id);
 }

◆ choose_processor_id()

processor_id_type libMesh::Node::choose_processor_id	(	processor_id_type	pid1,
		processor_id_type	pid2
	)		const

Return which of pid1 and pid2 would be preferred by the current load-balancing heuristic applied to this node.

Definition at line 78 of file node.C.

 {
   if (pid1 == DofObject::invalid_processor_id)
     return pid2;
  
   // Do we want the new load-balanced node partitioning heuristic
   // instead of the default partitioner-friendlier heuristic?
   static bool load_balanced_nodes =
     libMesh::on_command_line ("--load-balanced-nodes");
  
   // For better load balancing, we can use the min
   // even-numberered nodes and the max for odd-numbered.
   if (load_balanced_nodes)
     {
       if (this->id() % 2 &&
           pid2 != DofObject::invalid_processor_id)
         return std::max(pid1, pid2);
       else
         return std::min(pid1, pid2);
     }
  
   // Our default behavior, which puts too many nodes on lower MPI
   // ranks but which keeps elements' nodes on the same partition more
   // often, is simply:
   return std::min(pid1, pid2);
 }

References libMesh::DofObject::invalid_processor_id, and libMesh::on_command_line().

Referenced by libMesh::MeshTools::correct_node_proc_ids().

◆ clear_dofs()

void libMesh::DofObject::clear_dofs ( )

inlineinherited

Clear the DofMap data structures holding degree of freedom data.

If any extra integers are associated with this DofObject, their count and values are unchanged.

Definition at line 737 of file dof_object.h.

 {
   this->set_n_systems(0);
 }

References libMesh::DofObject::set_n_systems().

Referenced by libMesh::DofObject::~DofObject().

◆ clear_old_dof_object()

void libMesh::DofObject::clear_old_dof_object ( )

inherited

Sets the old_dof_object to nullptr.

Definition at line 142 of file dof_object.C.

 {
   delete this->old_dof_object;
   this->old_dof_object = nullptr;
 }

References libMesh::DofObject::old_dof_object.

Referenced by libMesh::DofObject::operator=(), libMesh::DofObject::set_old_dof_object(), libMesh::DofObject::unpack_indexing(), and libMesh::DofObject::~DofObject().

◆ contract()

CompareTypes< Real , T2 >::supertype libMesh::TypeVector< Real >::contract ( const TypeVector< T2 > & p ) const

inlineinherited

Returns: The result of TypeVector::operator*().

Definition at line 910 of file type_vector.h.

 {
   return (*this)*(p);
 }

◆ cross()

TypeVector< typename CompareTypes< Real , T2 >::supertype > libMesh::TypeVector< Real >::cross ( const TypeVector< T2 > & v ) const

inherited

Returns: The cross product of this vector with v.

Definition at line 920 of file type_vector.h.

 {
   typedef typename CompareTypes<T, T2>::supertype TS;
   libmesh_assert_equal_to (LIBMESH_DIM, 3);
  
   // |     i          j          k    |
   // |(*this)(0) (*this)(1) (*this)(2)|
   // |   p(0)       p(1)       p(2)   |
  
 #if LIBMESH_DIM == 3
   return TypeVector<TS>( _coords[1]*p._coords[2] - _coords[2]*p._coords[1],
                          -_coords[0]*p._coords[2] + _coords[2]*p._coords[0],
                          _coords[0]*p._coords[1] - _coords[1]*p._coords[0]);
 #else
   libmesh_ignore(p);
   return TypeVector<TS>(0);
 #endif
 }

◆ debug_buffer()

void libMesh::DofObject::debug_buffer ( ) const

inherited

Print our buffer for debugging.

Definition at line 654 of file dof_object.C.

 {
   libMesh::out << " [ ";
   for (const auto & idx : _idx_buf)
     libMesh::out << idx << " ";
   libMesh::out << "]\n";
 }

References libMesh::DofObject::_idx_buf, libMesh::MeshTools::Generation::Private::idx(), and libMesh::out.

◆ disable_print_counter_info() [1/2]

void libMesh::ReferenceCounter::disable_print_counter_info ( )

staticinherited

Definition at line 106 of file reference_counter.C.

 {
   _enable_print_counter = false;
   return;
 }

References libMesh::ReferenceCounter::_enable_print_counter.

Referenced by libMesh::LibMeshInit::LibMeshInit().

◆ disable_print_counter_info() [2/2]

void libMesh::ReferenceCounter::disable_print_counter_info ( )

staticinherited

Definition at line 106 of file reference_counter.C.

 {
   _enable_print_counter = false;
   return;
 }

References libMesh::ReferenceCounter::_enable_print_counter.

Referenced by libMesh::LibMeshInit::LibMeshInit().

◆ dof_number() [1/2]

dof_id_type libMesh::DofObject::dof_number	(	const unsigned int	s,
		const unsigned int	var,
		const unsigned int	comp
	)		const

inlineinherited

Returns: The global degree of freedom number for variable var, component comp for system s associated with this DofObject

When partitioning and DoF numbering have been performed by libMesh, every current DoF on this DofObject will belong to its processor.

Definition at line 956 of file dof_object.h.

 {
   libmesh_assert_less (s,    this->n_systems());
   libmesh_assert_less (var,  this->n_vars(s));
   libmesh_assert_less (comp, this->n_comp(s,var));
  
   const std::pair<unsigned int, unsigned int>
     vg_vig = this->var_to_vg_and_offset(s,var);
  
   const unsigned int
     n_comp = this->n_comp_group(s,vg_vig.first);
  
   return this->dof_number(s, vg_vig.first, vg_vig.second,
                           comp, n_comp);
 }

References libMesh::DofObject::n_comp(), libMesh::DofObject::n_comp_group(), libMesh::DofObject::n_systems(), libMesh::DofObject::n_vars(), and libMesh::DofObject::var_to_vg_and_offset().

◆ dof_number() [2/2]

dof_id_type libMesh::DofObject::dof_number	(	const unsigned int	s,
		const unsigned int	vg,
		const unsigned int	vig,
		const unsigned int	comp,
		const unsigned int	n_comp
	)		const

inlineinherited

Returns: The global degree of freedom number for variable group vg, variable index vig within the group, component comp out of n_comp, for system s on this DofObject

Even users who need to call dof_number from user code probably don't want to call this overload.

Definition at line 977 of file dof_object.h.

 {
   libmesh_assert_less (s,   this->n_systems());
   libmesh_assert_less (vg,  this->n_var_groups(s));
   libmesh_assert_less (vig, this->n_vars(s,vg));
  
   const unsigned int
     start_idx_sys = this->start_idx(s);
  
   libmesh_assert_less ((start_idx_sys + 2*vg + 1), _idx_buf.size());
  
   const dof_id_type
     base_idx = _idx_buf[start_idx_sys + 2*vg + 1];
  
   // if the first component is invalid, they
   // are all invalid
   if (base_idx == invalid_id)
     return invalid_id;
  
   // otherwise the index is the first component
   // index augmented by the component number
   else
     return cast_int<dof_id_type>(base_idx + vig*n_comp + comp);
 }

References libMesh::DofObject::_idx_buf, libMesh::DofObject::invalid_id, libMesh::DofObject::n_comp(), libMesh::DofObject::n_systems(), libMesh::DofObject::n_var_groups(), libMesh::DofObject::n_vars(), and libMesh::DofObject::start_idx().

◆ enable_print_counter_info() [1/2]

void libMesh::ReferenceCounter::enable_print_counter_info ( )

staticinherited

Methods to enable/disable the reference counter output from print_info()

Definition at line 100 of file reference_counter.C.

 {
   _enable_print_counter = true;
   return;
 }

References libMesh::ReferenceCounter::_enable_print_counter.

◆ enable_print_counter_info() [2/2]

void libMesh::ReferenceCounter::enable_print_counter_info ( )

staticinherited

Methods to enable/disable the reference counter output from print_info()

Definition at line 100 of file reference_counter.C.

 {
   _enable_print_counter = true;
   return;
 }

References libMesh::ReferenceCounter::_enable_print_counter.

◆ end_idx()

unsigned int libMesh::DofObject::end_idx ( const unsigned int s ) const

inlineprivateinherited

The ending index for system s.

Definition at line 1172 of file dof_object.h.

 {
   libmesh_assert_less (s, this->n_systems());
   libmesh_assert_less (s, _idx_buf.size());
  
   return ((s+1) == this->n_pseudo_systems()) ?
     cast_int<unsigned int>(_idx_buf.size()) :
     cast_int<unsigned int>(_idx_buf[s+1]);
 }

References libMesh::DofObject::_idx_buf, libMesh::DofObject::n_pseudo_systems(), and libMesh::DofObject::n_systems().

Referenced by libMesh::DofObject::n_var_groups(), and libMesh::DofObject::set_n_vars_per_group().

◆ end_idx_ints()

unsigned int libMesh::DofObject::end_idx_ints ( ) const

inlineprivateinherited

The ending index for an extra_integers pseudosystem.

Definition at line 1199 of file dof_object.h.

 {
   libmesh_assert (this->has_extra_integers());
  
   return cast_int<unsigned int>(_idx_buf.size());
 }

References libMesh::DofObject::_idx_buf, libMesh::DofObject::has_extra_integers(), and libMesh::libmesh_assert().

◆ get_extra_datum()

template<typename T >

T libMesh::DofObject::get_extra_datum ( const unsigned int index ) const

inlineinherited

Gets the value on this object of the extra datum associated with index, which should have been obtained via a call to MeshBase::add_elem_datum or MeshBase::add_node_datum using the same type T.

Definition at line 1062 of file dof_object.h.

 {
 #ifndef NDEBUG
   const unsigned int n_more_integers = (sizeof(T)-1)/sizeof(dof_id_type);
 #endif
   libmesh_assert_less(index+n_more_integers, this->n_extra_integers());
   libmesh_assert_less(this->n_systems(), _idx_buf.size());
  
   const unsigned int start_idx_i = this->start_idx_ints();
  
   libmesh_assert_less(start_idx_i+index+n_more_integers, _idx_buf.size());
   T returnval;
   std::memcpy(&returnval, &_idx_buf[start_idx_i+index], sizeof(T));
   return returnval;
 }

References libMesh::DofObject::_idx_buf, libMesh::DofObject::n_extra_integers(), libMesh::DofObject::n_systems(), and libMesh::DofObject::start_idx_ints().

Referenced by libMesh::FE< Dim, LAGRANGE_VEC >::shape(), libMesh::FE< Dim, LAGRANGE_VEC >::shape_deriv(), libMesh::FE< Dim, LAGRANGE_VEC >::shape_second_deriv(), and DofObjectTest< Node >::testAddExtraData().

◆ get_extra_integer()

dof_id_type libMesh::DofObject::get_extra_integer ( const unsigned int index ) const

inlineinherited

Gets the value on this object of the extra integer associated with index, which should have been obtained via a call to MeshBase::add_elem_integer or MeshBase::add_node_integer.

Definition at line 1026 of file dof_object.h.

 {
   libmesh_assert_less(index, this->n_extra_integers());
   libmesh_assert_less(this->n_systems(), _idx_buf.size());
  
   const unsigned int start_idx_i = this->start_idx_ints();
  
   libmesh_assert_less(start_idx_i+index, _idx_buf.size());
   return _idx_buf[start_idx_i+index];
 }

References libMesh::DofObject::_idx_buf, libMesh::DofObject::n_extra_integers(), libMesh::DofObject::n_systems(), and libMesh::DofObject::start_idx_ints().

Referenced by libMesh::CheckpointIO::read_connectivity(), libMesh::DofObject::set_n_vars_per_group(), DofObjectTest< Node >::testAddExtraData(), DofObjectTest< Node >::testAddSystemExtraInts(), DofObjectTest< Node >::testSetNSystemsExtraInts(), and DofObjectTest< Node >::testSetNVariableGroupsExtraInts().

◆ get_info() [1/3]

std::string libMesh::ReferenceCounter::get_info ( )

staticinherited

Gets a string containing the reference information.

Definition at line 47 of file reference_counter.C.

 {
 #if defined(LIBMESH_ENABLE_REFERENCE_COUNTING) && defined(DEBUG)
  
   std::ostringstream oss;
  
   oss << '\n'
       << " ---------------------------------------------------------------------------- \n"
       << "| Reference count information                                                |\n"
       << " ---------------------------------------------------------------------------- \n";
  
   for (const auto & pr : _counts)
     {
       const std::string name(pr.first);
       const unsigned int creations    = pr.second.first;
       const unsigned int destructions = pr.second.second;
  
       oss << "| " << name << " reference count information:\n"
           << "|  Creations:    " << creations    << '\n'
           << "|  Destructions: " << destructions << '\n';
     }
  
   oss << " ---------------------------------------------------------------------------- \n";
  
   return oss.str();
  
 #else
  
   return "";
  
 #endif
 }

References libMesh::ReferenceCounter::_counts, and libMesh::Quality::name().

Referenced by libMesh::ReferenceCounter::print_info().

◆ get_info() [2/3]

std::string libMesh::ReferenceCounter::get_info ( )

staticinherited

Gets a string containing the reference information.

Definition at line 47 of file reference_counter.C.

 {
 #if defined(LIBMESH_ENABLE_REFERENCE_COUNTING) && defined(DEBUG)
  
   std::ostringstream oss;
  
   oss << '\n'
       << " ---------------------------------------------------------------------------- \n"
       << "| Reference count information                                                |\n"
       << " ---------------------------------------------------------------------------- \n";
  
   for (const auto & pr : _counts)
     {
       const std::string name(pr.first);
       const unsigned int creations    = pr.second.first;
       const unsigned int destructions = pr.second.second;
  
       oss << "| " << name << " reference count information:\n"
           << "|  Creations:    " << creations    << '\n'
           << "|  Destructions: " << destructions << '\n';
     }
  
   oss << " ---------------------------------------------------------------------------- \n";
  
   return oss.str();
  
 #else
  
   return "";
  
 #endif
 }

References libMesh::ReferenceCounter::_counts, and libMesh::Quality::name().

Referenced by libMesh::ReferenceCounter::print_info().

◆ get_info() [3/3]

std::string libMesh::Node::get_info ( ) const

Prints relevant information about the node to a string.

Definition at line 53 of file node.C.

 {
   std::ostringstream oss;
  
   oss << "  Node id()=";
  
   if (this->valid_id())
     oss << this->id();
   else
     oss << "invalid";
  
   oss << ", processor_id()=" << this->processor_id() <<
     ", Point=" << *static_cast<const Point *>(this) << '\n';
  
   oss << "    DoFs=";
   for (auto s : IntRange<unsigned int>(0, this->n_systems()))
     for (auto v : IntRange<unsigned int>(0, this->n_vars(s)))
       for (auto c : IntRange<unsigned int>(0, this->n_comp(s,v)))
         oss << '(' << s << '/' << v << '/' << this->dof_number(s,v,c) << ") ";
  
   return oss.str();
 }

References libMesh::DofObject::dof_number(), libMesh::DofObject::id(), libMesh::DofObject::n_comp(), libMesh::DofObject::n_systems(), libMesh::DofObject::n_vars(), libMesh::DofObject::processor_id(), and libMesh::DofObject::valid_id().

Referenced by print_info().

◆ has_dofs()

bool libMesh::DofObject::has_dofs ( const unsigned int s = libMesh::invalid_uint ) const

inlineinherited

Returns: true if any system has variables which have been assigned, false otherwise.

Definition at line 1138 of file dof_object.h.

 {
   if (sys == libMesh::invalid_uint)
     {
       for (auto s : IntRange<unsigned int>(0, this->n_systems()))
         if (this->n_vars(s))
           return true;
     }
  
   else
     {
       libmesh_assert_less (sys, this->n_systems());
  
       if (this->n_vars(sys))
         return true;
     }
  
   return false;
 }

References libMesh::invalid_uint, libMesh::DofObject::n_systems(), and libMesh::DofObject::n_vars().

Referenced by libMesh::DofMap::old_dof_indices(), and libMesh::Parallel::Packing< Node * >::unpack().

◆ has_extra_integers()

bool libMesh::DofObject::has_extra_integers ( ) const

inlineinherited

Returns whether extra integers are associated to the DofObject.

Definition at line 1100 of file dof_object.h.

 {
   if (_idx_buf.empty())
     return 0;
  
   return (dof_id_signed_type(_idx_buf[0]) < 0);
 }

References libMesh::DofObject::_idx_buf.

Referenced by libMesh::DofObject::add_system(), libMesh::DofObject::end_idx_ints(), libMesh::DofObject::set_n_vars_per_group(), libMesh::DofObject::start_idx_ints(), DofObjectTest< Node >::testAddExtraData(), DofObjectTest< Node >::testAddSystemExtraInts(), and DofObjectTest< Node >::testSetNSystemsExtraInts().

◆ id()

dof_id_type libMesh::DofObject::id ( ) const

inlineinherited

Returns: The id for this DofObject

Definition at line 767 of file dof_object.h.

 {
   libmesh_assert (this->valid_id());
   return _id;
 }

References libMesh::DofObject::_id, libMesh::libmesh_assert(), and libMesh::DofObject::valid_id().

◆ increment_constructor_count() [1/2]

void libMesh::ReferenceCounter::increment_constructor_count ( const std::string & name )

inlineprotectedinherited

Increments the construction counter.

Should be called in the constructor of any derived class that will be reference counted.

Definition at line 181 of file reference_counter.h.

 {
   Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
   std::pair<unsigned int, unsigned int> & p = _counts[name];
  
   p.first++;
 }

References libMesh::ReferenceCounter::_counts, libMesh::Quality::name(), and libMesh::Threads::spin_mtx.

Referenced by libMesh::ReferenceCountedObject< RBParametrized >::ReferenceCountedObject().

◆ increment_constructor_count() [2/2]

void libMesh::ReferenceCounter::increment_constructor_count ( const std::string & name )

inlineprotectedinherited

Increments the construction counter.

Should be called in the constructor of any derived class that will be reference counted.

Definition at line 181 of file reference_counter.h.

 {
   Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
   std::pair<unsigned int, unsigned int> & p = _counts[name];
  
   p.first++;
 }

References libMesh::ReferenceCounter::_counts, libMesh::Quality::name(), and libMesh::Threads::spin_mtx.

Referenced by libMesh::ReferenceCountedObject< RBParametrized >::ReferenceCountedObject().

◆ increment_destructor_count() [1/2]

void libMesh::ReferenceCounter::increment_destructor_count ( const std::string & name )

inlineprotectedinherited

Increments the destruction counter.

Should be called in the destructor of any derived class that will be reference counted.

Definition at line 194 of file reference_counter.h.

 {
   Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
   std::pair<unsigned int, unsigned int> & p = _counts[name];
  
   p.second++;
 }

References libMesh::ReferenceCounter::_counts, libMesh::Quality::name(), and libMesh::Threads::spin_mtx.

Referenced by libMesh::ReferenceCountedObject< RBParametrized >::~ReferenceCountedObject().

◆ increment_destructor_count() [2/2]

void libMesh::ReferenceCounter::increment_destructor_count ( const std::string & name )

inlineprotectedinherited

Increments the destruction counter.

Should be called in the destructor of any derived class that will be reference counted.

Definition at line 194 of file reference_counter.h.

 {
   Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
   std::pair<unsigned int, unsigned int> & p = _counts[name];
  
   p.second++;
 }

References libMesh::ReferenceCounter::_counts, libMesh::Quality::name(), and libMesh::Threads::spin_mtx.

Referenced by libMesh::ReferenceCountedObject< RBParametrized >::~ReferenceCountedObject().

◆ invalidate()

void libMesh::DofObject::invalidate ( )

inlineinherited

Invalidates all the indices for this DofObject.

Definition at line 727 of file dof_object.h.

 {
   this->invalidate_dofs ();
   this->invalidate_id ();
   this->invalidate_processor_id ();
 }

References libMesh::DofObject::invalidate_dofs(), libMesh::DofObject::invalidate_id(), and libMesh::DofObject::invalidate_processor_id().

Referenced by libMesh::DofObject::DofObject().

◆ invalidate_dofs()

void libMesh::DofObject::invalidate_dofs ( const unsigned int sys_num = libMesh::invalid_uint )

inlineinherited

Sets all degree of freedom numbers to invalid_id.

Definition at line 690 of file dof_object.h.

 {
   const unsigned int n_sys = this->n_systems();
   // If the user does not specify the system number...
   if (sys_num >= n_sys)
     {
       for (auto s : IntRange<unsigned int>(0, n_sys))
         for (auto vg : IntRange<unsigned int>(0, this->n_var_groups(s)))
           if (this->n_comp_group(s,vg))
             this->set_vg_dof_base(s,vg,invalid_id);
     }
   // ...otherwise invalidate the dofs for all systems
   else
     for (auto vg : IntRange<unsigned int>(0, this->n_var_groups(sys_num)))
       if (this->n_comp_group(sys_num,vg))
         this->set_vg_dof_base(sys_num,vg,invalid_id);
 }

References libMesh::DofObject::invalid_id, libMesh::DofObject::n_comp_group(), libMesh::DofObject::n_systems(), libMesh::DofObject::n_var_groups(), and libMesh::DofObject::set_vg_dof_base().

Referenced by libMesh::DofObject::invalidate().

◆ invalidate_id()

void libMesh::DofObject::invalidate_id ( )

inlineinherited

Sets the id to invalid_id.

Definition at line 711 of file dof_object.h.

 {
   this->set_id (invalid_id);
 }

References libMesh::DofObject::invalid_id, and libMesh::DofObject::set_id().

Referenced by libMesh::DofObject::invalidate(), and DofObjectTest< Node >::testInvalidateId().

◆ invalidate_processor_id()

void libMesh::DofObject::invalidate_processor_id ( )

inlineinherited

Sets the processor id to invalid_processor_id.

Definition at line 719 of file dof_object.h.

 {
   this->processor_id (invalid_processor_id);
 }

References libMesh::DofObject::invalid_processor_id, and libMesh::DofObject::processor_id().

Referenced by libMesh::DofObject::invalidate(), libMesh::Partitioner::set_parent_processor_ids(), and DofObjectTest< Node >::testInvalidateProcId().

◆ is_zero()

bool libMesh::TypeVector< Real >::is_zero ( ) const

inlineinherited

Returns: True if all values in the vector are zero

Definition at line 1007 of file type_vector.h.

 {
   for (const auto & val : _coords)
     if (val != T(0))
       return false;
   return true;
 }

◆ n_comp()

unsigned int libMesh::DofObject::n_comp	(	const unsigned int	s,
		const unsigned int	var
	)		const

inlineinherited

Returns: The number of components for variable var of system s associated with this DofObject. For example, the HIERARCHIC shape functions may have multiple DoFs associated with one node. Another example is the MONOMIALs, where only the elements hold the DoFs. For the different spatial directions, and orders, see FE.

Definition at line 926 of file dof_object.h.

 {
   libmesh_assert_less (s,   this->n_systems());
   libmesh_assert_less (var, this->n_vars(s));
  
   return this->n_comp_group(s,this->var_to_vg(s,var));
 }

References libMesh::DofObject::n_comp_group(), libMesh::DofObject::n_systems(), libMesh::DofObject::n_vars(), and libMesh::DofObject::var_to_vg().

Referenced by libMesh::DofMap::allgather_recursive_constraints(), libMesh::FEGenericBase< FEOutputType< T >::type >::compute_periodic_constraints(), libMesh::DofMap::constrain_p_dofs(), libMesh::ExodusII_IO::copy_elemental_solution(), libMesh::ExodusII_IO::copy_nodal_solution(), libMesh::DofMap::distribute_dofs(), libMesh::DofObject::dof_number(), libMesh::DofObject::DofObject(), libMesh::OldSolutionCoefs< Output, point_output >::eval_at_node(), libMesh::OldSolutionValue< Output, point_output >::eval_at_node(), get_info(), libMesh::Elem::get_info(), libMesh::DofMap::local_variable_indices(), main(), libMesh::DofObject::n_dofs(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectVertices::operator()(), libMesh::DofObject::operator=(), libMesh::DofObject::print_dof_info(), libMesh::DofObject::set_dof_number(), libMesh::DofObject::set_n_vars_per_group(), and libMesh::DofMap::set_nonlocal_dof_objects().

◆ n_comp_group()

unsigned int libMesh::DofObject::n_comp_group	(	const unsigned int	s,
		const unsigned int	vg
	)		const

inlineinherited

Returns: The number of components for VariableGroup vg of system s associated with this DofObject. For example, the HIERARCHIC shape functions may have multiple DoFs associated with one node. Another example is the MONOMIALs, where only the elements hold the DoFs. For the different spatial directions, and orders, see FE.

Definition at line 939 of file dof_object.h.

 {
   libmesh_assert_less (s,  this->n_systems());
   libmesh_assert_less (vg, this->n_var_groups(s));
  
   const unsigned int
     start_idx_sys = this->start_idx(s);
  
   libmesh_assert_less ((start_idx_sys + 2*vg), _idx_buf.size());
  
   return (_idx_buf[start_idx_sys + 2*vg] % ncv_magic);
 }

References libMesh::DofObject::_idx_buf, libMesh::DofObject::n_systems(), libMesh::DofObject::n_var_groups(), libMesh::DofObject::ncv_magic, and libMesh::DofObject::start_idx().

Referenced by libMesh::DofMap::_dof_indices(), libMesh::DofMap::_node_dof_indices(), libMesh::DofMap::distribute_local_dofs_node_major(), libMesh::DofMap::distribute_local_dofs_var_major(), libMesh::DofMap::dof_indices(), libMesh::DofObject::dof_number(), libMesh::OldSolutionCoefs< Output, point_output >::eval_old_dofs(), libMesh::OldSolutionValue< Output, point_output >::eval_old_dofs(), libMesh::DofObject::invalidate_dofs(), libMesh::DofObject::n_comp(), libMesh::DofMap::old_dof_indices(), libMesh::BuildProjectionList::operator()(), libMesh::DofMap::reinit(), libMesh::DofObject::set_dof_number(), libMesh::DofObject::set_n_comp_group(), libMesh::DofObject::set_n_vars_per_group(), and libMesh::DofMap::set_nonlocal_dof_objects().

◆ n_dofs()

unsigned int libMesh::DofObject::n_dofs	(	const unsigned int	s,
		const unsigned int	var = `libMesh::invalid_uint`
	)		const

inlineinherited

Returns: The number of degrees of freedom associated with system s for this object. Optionally only counts degrees of freedom for variable number var

Definition at line 745 of file dof_object.h.

 {
   libmesh_assert_less (s, this->n_systems());
  
   unsigned int num = 0;
  
   // Count all variables
   if (var == libMesh::invalid_uint)
     for (auto v : IntRange<unsigned int>(0, this->n_vars(s)))
       num += this->n_comp(s,v);
  
   // Only count specified variable
   else
     num = this->n_comp(s,var);
  
   return num;
 }

References libMesh::invalid_uint, libMesh::DofObject::n_comp(), libMesh::DofObject::n_systems(), and libMesh::DofObject::n_vars().

Referenced by libMesh::PetscDMWrapper::add_dofs_helper().

◆ n_extra_integers()

unsigned int libMesh::DofObject::n_extra_integers ( ) const

inlineinherited

Returns how many extra integers are associated to the DofObject.

If non-integer data has been associated, each datum of type T counts for sizeof(T)/sizeof(dof_id_type) times in the return value.

Definition at line 1082 of file dof_object.h.

 {
   if (_idx_buf.empty())
     return 0;
  
   const int hdr = dof_id_signed_type(_idx_buf[0]);
   if (hdr >= 0)
     return 0;
  
   const unsigned int start_idx_i = this->start_idx_ints();
  
   return _idx_buf.size() - start_idx_i;
 }

References libMesh::DofObject::_idx_buf, and libMesh::DofObject::start_idx_ints().

Referenced by libMesh::DofObject::add_extra_integers(), libMesh::DofObject::get_extra_datum(), libMesh::DofObject::get_extra_integer(), libMesh::CheckpointIO::read_connectivity(), libMesh::CheckpointIO::read_nodes(), libMesh::Elem::refine(), libMesh::DofObject::set_extra_datum(), libMesh::DofObject::set_extra_integer(), libMesh::DofObject::set_n_systems(), libMesh::DofObject::set_n_vars_per_group(), DofObjectTest< Node >::testAddExtraData(), DofObjectTest< Node >::testAddSystemExtraInts(), DofObjectTest< Node >::testSetNSystemsExtraInts(), and DofObjectTest< Node >::testSetNVariableGroupsExtraInts().

◆ n_objects() [1/2]

static unsigned int libMesh::ReferenceCounter::n_objects ( )

inlinestaticinherited

Prints the number of outstanding (created, but not yet destroyed) objects.

Definition at line 83 of file reference_counter.h.

84 { return _n_objects; }

References libMesh::ReferenceCounter::_n_objects.

◆ n_objects() [2/2]

static unsigned int libMesh::ReferenceCounter::n_objects ( )

inlinestaticinherited

Prints the number of outstanding (created, but not yet destroyed) objects.

Definition at line 83 of file reference_counter.h.

84 { return _n_objects; }

References libMesh::ReferenceCounter::_n_objects.

◆ n_pseudo_systems()

unsigned int libMesh::DofObject::n_pseudo_systems ( ) const

inlineinherited

Returns: The total number of pseudo-systems associated with this DofObject : n_systems(), plus one iff this->has_extra_integers()

Definition at line 871 of file dof_object.h.

 {
   const int hdr = _idx_buf.empty() ?
     0 : cast_int<int>(dof_id_signed_type(_idx_buf[0]));
   return std::abs(hdr);
 }

References libMesh::DofObject::_idx_buf, and std::abs().

Referenced by libMesh::DofObject::end_idx(), libMesh::DofObject::set_extra_datum(), and libMesh::DofObject::set_extra_integer().

◆ n_systems()

unsigned int libMesh::DofObject::n_systems ( ) const

inlineinherited

Returns: The number of systems associated with this DofObject

Definition at line 861 of file dof_object.h.

 {
   const int hdr = _idx_buf.empty() ?
     0 : cast_int<int>(dof_id_signed_type(_idx_buf[0]));
   return hdr >= 0 ? hdr : (-hdr-1);
 }

References libMesh::DofObject::_idx_buf.

◆ n_var_groups()

unsigned int libMesh::DofObject::n_var_groups ( const unsigned int s ) const

inlineinherited

Returns: The number of VariableGroup variable groups associated with system s for this DofObject

Definition at line 881 of file dof_object.h.

 {
   libmesh_assert_less (s, this->n_systems());
  
   return (this->end_idx(s) - this->start_idx(s)) / 2;
 }

References libMesh::DofObject::end_idx(), libMesh::DofObject::n_systems(), and libMesh::DofObject::start_idx().

◆ n_vars() [1/2]

unsigned int libMesh::DofObject::n_vars ( const unsigned int s ) const

inlineinherited

Returns: The number of Variable variables associated with system s for this DofObject

Definition at line 908 of file dof_object.h.

 {
   libmesh_assert_less (s, this->n_systems());
  
   const unsigned int nvg = this->n_var_groups(s);
  
   unsigned int val=0;
  
   for (unsigned int vg=0; vg<nvg; vg++)
     val += this->n_vars(s,vg);
  
   return val;
 }

References libMesh::DofObject::n_systems(), libMesh::DofObject::n_var_groups(), and libMesh::DofObject::n_vars().

◆ n_vars() [2/2]

unsigned int libMesh::DofObject::n_vars	(	const unsigned int	s,
		const unsigned int	vg
	)		const

inlineinherited

Returns: The number of Variable variables associated with VariableGroup vg in system s for this DofObject

Definition at line 891 of file dof_object.h.

 {
   libmesh_assert_less (s,  this->n_systems());
   libmesh_assert_less (vg, this->n_var_groups(s));
  
   const unsigned int start_idx_sys = this->start_idx(s);
  
   libmesh_assert_less ((start_idx_sys + 2*vg), _idx_buf.size());
  
   return (cast_int<unsigned int>
           (_idx_buf[start_idx_sys + 2*vg]) >> ncv_magic_exp);
 }

References libMesh::DofObject::_idx_buf, libMesh::DofObject::n_systems(), libMesh::DofObject::n_var_groups(), libMesh::DofObject::ncv_magic_exp, and libMesh::DofObject::start_idx().

◆ norm()

auto libMesh::TypeVector< Real >::norm ( ) const-> decltype(std::norm(Real ()))

inlineinherited

Returns: The magnitude of the vector, i.e. the square-root of the sum of the elements squared.

Definition at line 955 of file type_vector.h.

 {
   return std::sqrt(this->norm_sq());
 }

◆ norm_sq()

auto libMesh::TypeVector< Real >::norm_sq ( ) const-> decltype(std::norm(Real ()))

inlineinherited

Returns: The magnitude of the vector squared, i.e. the sum of the element magnitudes squared.

Definition at line 986 of file type_vector.h.

 {
 #if LIBMESH_DIM == 1
   return (TensorTools::norm_sq(_coords[0]));
 #endif
  
 #if LIBMESH_DIM == 2
   return (TensorTools::norm_sq(_coords[0]) +
           TensorTools::norm_sq(_coords[1]));
 #endif
  
 #if LIBMESH_DIM == 3
   return (TensorTools::norm_sq(_coords[0]) +
           TensorTools::norm_sq(_coords[1]) +
           TensorTools::norm_sq(_coords[2]));
 #endif
 }

◆ operator!=()

bool libMesh::TypeVector< Real >::operator!= ( const TypeVector< Real > & rhs ) const

inlineinherited

Returns: !(*this == rhs)

Definition at line 1089 of file type_vector.h.

 {
   return (!(*this == rhs));
 }

◆ operator()() [1/2]

Real & libMesh::TypeVector< Real >::operator() ( const unsigned int i )

inlineinherited

Returns: A writable reference to the \( i^{th} \) entry of the vector.

Definition at line 591 of file type_vector.h.

 {
   libmesh_assert_less (i, LIBMESH_DIM);
  
   return _coords[i];
 }

◆ operator()() [2/2]

const Real & libMesh::TypeVector< Real >::operator() ( const unsigned int i ) const

inlineinherited

Returns: A const reference to the \( i^{th} \) entry of the vector.

Definition at line 580 of file type_vector.h.

 {
   libmesh_assert_less (i, LIBMESH_DIM);
  
   return _coords[i];
 }

◆ operator*() [1/2]

boostcopy::enable_if_c< ScalarTraits< Scalar >::value, TypeVector< typename CompareTypes< Real , Scalar >::supertype > >::type libMesh::TypeVector< Real >::operator* ( const Scalar & factor ) const

inlineinherited

Multiply this vector by a scalar value.

Returns: A copy of the result, this vector is unchanged.

Definition at line 777 of file type_vector.h.

 {
   typedef typename CompareTypes<T, Scalar>::supertype SuperType;
  
 #if LIBMESH_DIM == 1
   return TypeVector<SuperType>(_coords[0]*factor);
 #endif
  
 #if LIBMESH_DIM == 2
   return TypeVector<SuperType>(_coords[0]*factor,
                                _coords[1]*factor);
 #endif
  
 #if LIBMESH_DIM == 3
   return TypeVector<SuperType>(_coords[0]*factor,
                                _coords[1]*factor,
                                _coords[2]*factor);
 #endif
 }

◆ operator*() [2/2]

CompareTypes< Real , T2 >::supertype libMesh::TypeVector< Real >::operator* ( const TypeVector< T2 > & p ) const

inlineinherited

Returns: The dot-product of this vector with another vector.

Note: The complex conjugate is not taken in the complex-valued case.; The vectors may contain different numeric types.

Definition at line 888 of file type_vector.h.

 {
 #if LIBMESH_DIM == 1
   return _coords[0]*p._coords[0];
 #endif
  
 #if LIBMESH_DIM == 2
   return (_coords[0]*p._coords[0] +
           _coords[1]*p._coords[1]);
 #endif
  
 #if LIBMESH_DIM == 3
   return (_coords[0]*p(0) +
           _coords[1]*p(1) +
           _coords[2]*p(2));
 #endif
 }

◆ operator*=()

const TypeVector< Real > & libMesh::TypeVector< Real >::operator*= ( const Real & factor )

inlineinherited

Multiply this vector by a scalar value.

Returns: A reference to *this.

Definition at line 814 of file type_vector.h.

 {
 #if LIBMESH_DIM == 1
   _coords[0] *= factor;
 #endif
  
 #if LIBMESH_DIM == 2
   _coords[0] *= factor;
   _coords[1] *= factor;
 #endif
  
 #if LIBMESH_DIM == 3
   _coords[0] *= factor;
   _coords[1] *= factor;
   _coords[2] *= factor;
 #endif
  
   return *this;
 }

◆ operator+()

TypeVector< typename CompareTypes< Real , T2 >::supertype > libMesh::TypeVector< Real >::operator+ ( const TypeVector< T2 > & p ) const

inlineinherited

Add two vectors.

Returns: A copy of the result, this vector is unchanged.

Definition at line 604 of file type_vector.h.

 {
   typedef typename CompareTypes<T, T2>::supertype TS;
 #if LIBMESH_DIM == 1
   return TypeVector<TS> (_coords[0] + p._coords[0]);
 #endif
  
 #if LIBMESH_DIM == 2
   return TypeVector<TS> (_coords[0] + p._coords[0],
                          _coords[1] + p._coords[1]);
 #endif
  
 #if LIBMESH_DIM == 3
   return TypeVector<TS> (_coords[0] + p._coords[0],
                          _coords[1] + p._coords[1],
                          _coords[2] + p._coords[2]);
 #endif
  
 }

◆ operator+=()

const TypeVector< Real > & libMesh::TypeVector< Real >::operator+= ( const TypeVector< T2 > & p )

inlineinherited

Add to this vector.

Returns: A reference to *this.

Definition at line 629 of file type_vector.h.

 {
   this->add (p);
  
   return *this;
 }

◆ operator-() [1/2]

TypeVector< Real > libMesh::TypeVector< Real >::operator- ( ) const

inlineinherited

Returns: The negative of this vector in a separate copy.

Definition at line 749 of file type_vector.h.

 {
  
 #if LIBMESH_DIM == 1
   return TypeVector(-_coords[0]);
 #endif
  
 #if LIBMESH_DIM == 2
   return TypeVector(-_coords[0],
                     -_coords[1]);
 #endif
  
 #if LIBMESH_DIM == 3
   return TypeVector(-_coords[0],
                     -_coords[1],
                     -_coords[2]);
 #endif
  
 }

◆ operator-() [2/2]

TypeVector< typename CompareTypes< Real , T2 >::supertype > libMesh::TypeVector< Real >::operator- ( const TypeVector< T2 > & p ) const

inlineinherited

Subtract from this vector.

Returns: A copy of the result, this vector is unchanged.

Definition at line 690 of file type_vector.h.

 {
   typedef typename CompareTypes<T, T2>::supertype TS;
  
 #if LIBMESH_DIM == 1
   return TypeVector<TS>(_coords[0] - p._coords[0]);
 #endif
  
 #if LIBMESH_DIM == 2
   return TypeVector<TS>(_coords[0] - p._coords[0],
                         _coords[1] - p._coords[1]);
 #endif
  
 #if LIBMESH_DIM == 3
   return TypeVector<TS>(_coords[0] - p._coords[0],
                         _coords[1] - p._coords[1],
                         _coords[2] - p._coords[2]);
 #endif
  
 }

◆ operator-=()

const TypeVector< Real > & libMesh::TypeVector< Real >::operator-= ( const TypeVector< T2 > & p )

inlineinherited

Subtract from this vector.

Returns: A reference to *this.

Definition at line 716 of file type_vector.h.

 {
   this->subtract (p);
  
   return *this;
 }

◆ operator/()

boostcopy::enable_if_c< ScalarTraits< Scalar >::value, TypeVector< typename CompareTypes< Real , Scalar >::supertype > >::type libMesh::TypeVector< Real >::operator/ ( const Scalar & factor ) const

inlineinherited

Divide each entry of this vector by scalar value.

Returns: A copy of the result, this vector is unchanged.

Definition at line 842 of file type_vector.h.

 {
   libmesh_assert_not_equal_to (factor, static_cast<T>(0.));
  
   typedef typename CompareTypes<T, Scalar>::supertype TS;
  
 #if LIBMESH_DIM == 1
   return TypeVector<TS>(_coords[0]/factor);
 #endif
  
 #if LIBMESH_DIM == 2
   return TypeVector<TS>(_coords[0]/factor,
                         _coords[1]/factor);
 #endif
  
 #if LIBMESH_DIM == 3
   return TypeVector<TS>(_coords[0]/factor,
                         _coords[1]/factor,
                         _coords[2]/factor);
 #endif
  
 }

◆ operator/=()

const TypeVector< Real > & libMesh::TypeVector< Real >::operator/= ( const Real & factor )

inlineinherited

Divide each entry of this vector by scalar value.

Returns: A reference to *this.

Definition at line 871 of file type_vector.h.

 {
   libmesh_assert_not_equal_to (factor, static_cast<T>(0.));
  
   for (unsigned int i=0; i<LIBMESH_DIM; i++)
     _coords[i] /= factor;
  
   return *this;
 }

◆ operator<() [1/2]

bool libMesh::TypeVector< Complex >::operator< ( const TypeVector< Complex > & rhs ) const

inherited

Definition at line 140 of file type_vector.C.

 {
   for (unsigned int i=0; i<LIBMESH_DIM; i++)
     {
       if ((*this)(i).real() < rhs(i).real())
         return true;
       if ((*this)(i).real() > rhs(i).real())
         return false;
       if ((*this)(i).imag() < rhs(i).imag())
         return true;
       if ((*this)(i).imag() > rhs(i).imag())
         return false;
     }
   return false;
 }

◆ operator<() [2/2]

bool libMesh::TypeVector< Real >::operator< ( const TypeVector< Real > & rhs ) const

inherited

Returns: true if this vector is "less" than rhs.

Useful for sorting. Also used for choosing some arbitrary basis function orientations.

Definition at line 82 of file type_vector.C.

 {
   for (unsigned int i=0; i<LIBMESH_DIM; i++)
     {
       if ((*this)(i) < rhs(i))
         return true;
       if ((*this)(i) > rhs(i))
         return false;
     }
   return false;
 }

◆ operator<=() [1/2]

bool libMesh::TypeVector< Complex >::operator<= ( const TypeVector< Complex > & rhs ) const

inherited

Definition at line 159 of file type_vector.C.

 {
   for (unsigned int i=0; i<LIBMESH_DIM; i++)
     {
       if ((*this)(i).real() < rhs(i).real())
         return true;
       if ((*this)(i).real() > rhs(i).real())
         return false;
       if ((*this)(i).imag() < rhs(i).imag())
         return true;
       if ((*this)(i).imag() > rhs(i).imag())
         return false;
     }
   return true;
 }

◆ operator<=() [2/2]

bool libMesh::TypeVector< Real >::operator<= ( const TypeVector< Real > & rhs ) const

inherited

Returns: true if this vector is <= to rhs.

Useful for sorting. Also used for choosing some arbitrary constraint equation directions.

Definition at line 96 of file type_vector.C.

 {
   for (unsigned int i=0; i<LIBMESH_DIM; i++)
     {
       if ((*this)(i) < rhs(i))
         return true;
       if ((*this)(i) > rhs(i))
         return false;
     }
   return true;
 }

◆ operator=()

Node & libMesh::Node::operator= ( const Point & p )

inline

Assign to a node from a point.

Definition at line 297 of file node.h.

 {
   (*this)(0) = p(0);
 #if LIBMESH_DIM > 1
   (*this)(1) = p(1);
 #endif
 #if LIBMESH_DIM > 2
   (*this)(2) = p(2);
 #endif
  
   return *this;
 }

◆ operator==() [1/2]

bool libMesh::Node::operator== ( const Node & rhs ) const

Returns: true if this node equals rhs, false otherwise.

Definition at line 37 of file node.C.

 {
   // Explicitly calling the operator== defined in Point
   return this->Point::operator==(rhs);
 }

References libMesh::TypeVector< Real >::operator==().

◆ operator==() [2/2]

bool libMesh::TypeVector< Real >::operator== ( const TypeVector< Real > & rhs ) const

inlineinherited

Returns: true if this(i)==rhs(i) for each component of the vector.

Note: For floating point types T, the function absolute_fuzzy_equals() may be a more appropriate choice.

Definition at line 1067 of file type_vector.h.

 {
 #if LIBMESH_DIM == 1
   return (_coords[0] == rhs._coords[0]);
 #endif
  
 #if LIBMESH_DIM == 2
   return (_coords[0] == rhs._coords[0] &&
           _coords[1] == rhs._coords[1]);
 #endif
  
 #if LIBMESH_DIM == 3
   return (_coords[0] == rhs._coords[0] &&
           _coords[1] == rhs._coords[1] &&
           _coords[2] == rhs._coords[2]);
 #endif
 }

◆ operator>() [1/2]

bool libMesh::TypeVector< Complex >::operator> ( const TypeVector< Complex > & rhs ) const

inherited

Definition at line 178 of file type_vector.C.

 {
   for (unsigned int i=0; i<LIBMESH_DIM; i++)
     {
       if ((*this)(i).real() > rhs(i).real())
         return true;
       if ((*this)(i).real() < rhs(i).real())
         return false;
       if ((*this)(i).imag() > rhs(i).imag())
         return true;
       if ((*this)(i).imag() < rhs(i).imag())
         return false;
     }
   return false;
 }

◆ operator>() [2/2]

bool libMesh::TypeVector< Real >::operator> ( const TypeVector< Real > & rhs ) const

inherited

Returns: true if this vector is "greater" than rhs.

Useful for sorting. Also used for choosing some arbitrary basis function orientations.

Definition at line 111 of file type_vector.C.

 {
   for (unsigned int i=0; i<LIBMESH_DIM; i++)
     {
       if ((*this)(i) > rhs(i))
         return true;
       if ((*this)(i) < rhs(i))
         return false;
     }
   return false;
 }

◆ operator>=() [1/2]

bool libMesh::TypeVector< Complex >::operator>= ( const TypeVector< Complex > & rhs ) const

inherited

Definition at line 197 of file type_vector.C.

 {
   for (unsigned int i=0; i<LIBMESH_DIM; i++)
     {
       if ((*this)(i).real() > rhs(i).real())
         return true;
       if ((*this)(i).real() < rhs(i).real())
         return false;
       if ((*this)(i).imag() > rhs(i).imag())
         return true;
       if ((*this)(i).imag() < rhs(i).imag())
         return false;
     }
   return true;
 }

◆ operator>=() [2/2]

bool libMesh::TypeVector< Real >::operator>= ( const TypeVector< Real > & rhs ) const

inherited

Returns: true if this vector is >= rhs.

Useful for sorting. Also used for choosing some arbitrary constraint equation directions.

Definition at line 125 of file type_vector.C.

 {
   for (unsigned int i=0; i<LIBMESH_DIM; i++)
     {
       if ((*this)(i) > rhs(i))
         return true;
       if ((*this)(i) < rhs(i))
         return false;
     }
   return true;
 }

◆ pack_indexing()

void libMesh::DofObject::pack_indexing ( std::back_insert_iterator< std::vector< largest_id_type >> target ) const

inherited

A method for creating packed data from our index buffer - basically a copy with prepended size with our current implementation.

Definition at line 636 of file dof_object.C.

 {
 #ifdef LIBMESH_ENABLE_AMR
   // We might need to pack old_dof_object too
   *target++ = (old_dof_object == nullptr) ? 0 : 1;
 #endif
  
   *target++ = _idx_buf.size();
   std::copy(_idx_buf.begin(), _idx_buf.end(), target);
  
 #ifdef LIBMESH_ENABLE_AMR
   if (old_dof_object)
     old_dof_object->pack_indexing(target);
 #endif
 }

References libMesh::DofObject::_idx_buf, libMesh::DofObject::old_dof_object, and libMesh::DofObject::pack_indexing().

Referenced by libMesh::Parallel::Packing< const Node * >::pack(), libMesh::Parallel::Packing< const Elem * >::pack(), and libMesh::DofObject::pack_indexing().

◆ packed_indexing_size()

unsigned int libMesh::DofObject::packed_indexing_size ( ) const

inherited

If we pack our indices into an buffer for communications, how many ints do we need?

Definition at line 554 of file dof_object.C.

 {
   return
     cast_int<unsigned int> (
 #ifdef LIBMESH_ENABLE_AMR
                             ((old_dof_object == nullptr) ? 0 : old_dof_object->packed_indexing_size()) + 2 +
 #else
                             1 +
 #endif
                             _idx_buf.size());
 }

References libMesh::DofObject::_idx_buf, libMesh::DofObject::old_dof_object, and libMesh::DofObject::packed_indexing_size().

Referenced by libMesh::Parallel::Packing< const Node * >::packable_size(), libMesh::Parallel::Packing< const Elem * >::packable_size(), libMesh::DofObject::packed_indexing_size(), packed_size(), libMesh::Parallel::Packing< Node * >::unpack(), and libMesh::Parallel::Packing< Elem * >::unpack().

◆ packed_size()

unsigned int libMesh::Node::packed_size ( ) const

inline

Definition at line 157 of file node.h.

   {
     const unsigned int header_size = 2;
  
     // use "(a+b-1)/b" trick to get a/b to round up
     static const unsigned int idtypes_per_Real =
       (sizeof(Real) + sizeof(largest_id_type) - 1) / sizeof(largest_id_type);
  
     return header_size + LIBMESH_DIM*idtypes_per_Real +
       this->packed_indexing_size();
   }

References libMesh::DofObject::packed_indexing_size(), and libMesh::Real.

◆ print()

void libMesh::TypeVector< Real >::print ( std::ostream & os = libMesh::out ) const

inherited

Formatted print, by default to libMesh::out.

Definition at line 37 of file type_vector.C.

 {
 #if LIBMESH_DIM == 1
  
   os << "x=" << (*this)(0);
  
 #endif
 #if LIBMESH_DIM == 2
  
   os << "(x,y)=("
      << std::setw(8) << (*this)(0) << ", "
      << std::setw(8) << (*this)(1) << ")";
  
 #endif
 #if LIBMESH_DIM == 3
  
   os <<  "(x,y,z)=("
      << std::setw(8) << (*this)(0) << ", "
      << std::setw(8) << (*this)(1) << ", "
      << std::setw(8) << (*this)(2) << ")";
 #endif
 }

◆ print_dof_info()

void libMesh::DofObject::print_dof_info ( ) const

inherited

Print out info for debugging.

Definition at line 664 of file dof_object.C.

 {
   libMesh::out << this->id() << " [ ";
  
   for (auto s : IntRange<unsigned int>(0, this->n_systems()))
     {
       libMesh::out << "s:" << s << " ";
       for (auto var : IntRange<unsigned int>(0, this->n_vars(s)))
         {
           libMesh::out << "v:" << var << " ";
           for (auto comp : IntRange<unsigned int>(0, this->n_comp(s,var)))
             {
               libMesh::out << "c:" << comp << " dof:" << this->dof_number(s,var,comp) << " ";
             }
         }
     }
  
   libMesh::out << "]\n";
 }

References libMesh::DofObject::dof_number(), libMesh::DofObject::id(), libMesh::DofObject::n_comp(), libMesh::DofObject::n_systems(), libMesh::DofObject::n_vars(), and libMesh::out.

◆ print_info() [1/3]

void libMesh::Node::print_info ( std::ostream & os = libMesh::out ) const

Prints relevant information about the node.

Definition at line 45 of file node.C.

 {
   os << this->get_info()
      << std::endl;
 }

References get_info().

Referenced by libMesh::operator<<().

◆ print_info() [2/3]

void libMesh::ReferenceCounter::print_info ( std::ostream & out = libMesh::out )

staticinherited

Prints the reference information, by default to libMesh::out.

Definition at line 87 of file reference_counter.C.

 {
   if (_enable_print_counter)
     out_stream << ReferenceCounter::get_info();
 }

References libMesh::ReferenceCounter::_enable_print_counter, and libMesh::ReferenceCounter::get_info().

◆ print_info() [3/3]

void libMesh::ReferenceCounter::print_info ( std::ostream & out = libMesh::out )

staticinherited

Prints the reference information, by default to libMesh::out.

Definition at line 87 of file reference_counter.C.

 {
   if (_enable_print_counter)
     out_stream << ReferenceCounter::get_info();
 }

References libMesh::ReferenceCounter::_enable_print_counter, and libMesh::ReferenceCounter::get_info().

◆ processor_id() [1/3]

processor_id_type & libMesh::DofObject::processor_id ( )

inlineinherited

Returns: The processor that this DofObject belongs to as a writable reference.

Definition at line 837 of file dof_object.h.

 {
   return _processor_id;
 }

References libMesh::DofObject::_processor_id.

◆ processor_id() [2/3]

processor_id_type libMesh::DofObject::processor_id ( ) const

inlineinherited

Returns: The processor that this DofObject belongs to.

When partitioning and DoF numbering have been performed by libMesh, every current DoF on this DofObject will belong to its processor.

Definition at line 829 of file dof_object.h.

 {
   return _processor_id;
 }

References libMesh::DofObject::_processor_id.

Referenced by libMesh::BoundaryInfo::_find_id_maps(), libMesh::DistributedMesh::add_elem(), libMesh::BoundaryInfo::add_elements(), libMesh::DofMap::add_neighbors_to_send_list(), libMesh::DistributedMesh::add_node(), libMesh::MeshRefinement::add_node(), libMesh::ReplicatedMesh::add_point(), libMesh::DistributedMesh::add_point(), libMesh::RBConstruction::add_scaled_matrix_and_vector(), libMesh::UnstructuredMesh::all_first_order(), libMesh::UnstructuredMesh::all_second_order(), libMesh::MeshTools::Modification::all_tri(), libMesh::DofMap::allgather_recursive_constraints(), libMesh::Patch::build_around_element(), libMesh::MeshTools::Generation::build_extrusion(), libMesh::InfElemBuilder::build_inf_elem(), libMesh::Nemesis_IO_Helper::compute_num_global_nodesets(), libMesh::Nemesis_IO_Helper::compute_num_global_sidesets(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::SubProjector::construct_projection(), libMesh::UnstructuredMesh::copy_nodes_and_elements(), libMesh::UnstructuredMesh::create_submesh(), libMesh::DistributedMesh::delete_elem(), libMesh::DistributedMesh::delete_node(), libMesh::DofMap::distribute_dofs(), libMesh::DofMap::distribute_local_dofs_node_major(), libMesh::DofMap::distribute_local_dofs_var_major(), libMesh::Elem::Elem(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::SubFunctor::find_dofs_to_send(), libMesh::MeshFunction::find_element(), libMesh::UnstructuredMesh::find_neighbors(), libMesh::MeshTools::Modification::flatten(), get_info(), libMesh::Elem::get_info(), libMesh::DofMap::get_info(), libMesh::DofMap::get_local_constraints(), libMesh::DistributedMesh::insert_elem(), libMesh::DofObject::invalidate_processor_id(), libMesh::RBEIMEvaluation::legacy_write_out_interpolation_points_elem(), libMesh::MeshTools::libmesh_assert_consistent_distributed(), libMesh::MeshTools::libmesh_assert_consistent_distributed_nodes(), libMesh::MeshTools::libmesh_assert_parallel_consistent_new_node_procids(), libMesh::MeshTools::libmesh_assert_parallel_consistent_procids< Elem >(), libMesh::MeshTools::libmesh_assert_parallel_consistent_procids< Node >(), libMesh::MeshTools::libmesh_assert_topology_consistent_procids< Elem >(), libMesh::MeshTools::libmesh_assert_valid_amr_elem_ids(), libMesh::MeshTools::libmesh_assert_valid_neighbors(), libMesh::DofMap::local_variable_indices(), libMesh::MeshRefinement::make_coarsening_compatible(), libMesh::MeshCommunication::make_new_node_proc_ids_parallel_consistent(), AugmentSparsityOnInterface::mesh_reinit(), AugmentSparsityOnNodes::operator()(), OverlappingCouplingFunctor::operator()(), AugmentSparsityOnInterface::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::SortAndCopy::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectVertices::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectEdges::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectSides::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectInteriors::operator()(), libMesh::DistributedMesh::own_node(), libMesh::Parallel::Packing< const Node * >::pack(), libMesh::Parallel::Packing< const Elem * >::pack(), libMesh::XdrIO::pack_element(), libMesh::LinearPartitioner::partition_range(), libMesh::SFCPartitioner::partition_range(), libMesh::CentroidPartitioner::partition_range(), libMesh::System::point_gradient(), libMesh::System::point_hessian(), libMesh::System::point_value(), libMesh::DofObject::processor_id(), libMesh::Nemesis_IO::read(), libMesh::CheckpointIO::read_connectivity(), libMesh::XdrIO::read_serialized_connectivity(), libMesh::Elem::refine(), libMesh::DofMap::scatter_constraints(), libMesh::Partitioner::set_node_processor_ids(), libMesh::DofMap::set_nonlocal_dof_objects(), libMesh::Partitioner::set_parent_processor_ids(), ParsedFEMFunctionTest::setUp(), libMesh::Parallel::sync_dofobject_data_by_id(), libMesh::Parallel::sync_element_data_by_parent_id(), libMesh::Parallel::sync_node_data_by_element_id_once(), DefaultCouplingTest::testCoupling(), PointNeighborCouplingTest::testCoupling(), DofObjectTest< Node >::testInvalidateProcId(), EquationSystemsTest::testPostInitAddElem(), DofObjectTest< Node >::testSetProcId(), BoundaryInfoTest::testShellFaceConstraints(), DofObjectTest< Node >::testValidProcId(), libMesh::Parallel::Packing< Node * >::unpack(), libMesh::Parallel::Packing< Elem * >::unpack(), libMesh::DTKAdapter::update_variable_values(), libMesh::GmshIO::write_mesh(), and libMesh::Nemesis_IO_Helper::write_sidesets().

◆ processor_id() [3/3]

void libMesh::DofObject::processor_id ( const processor_id_type pid )

inlineinherited

Sets the processor_id for this DofObject.

Definition at line 845 of file dof_object.h.

 {
   this->processor_id() = pid;
 }

References libMesh::DofObject::processor_id().

◆ relative_fuzzy_equals()

bool libMesh::TypeVector< Real >::relative_fuzzy_equals	(	const TypeVector< Real > &	rhs,
		Real	tol = `TOLERANCE`
	)		const

inlineinherited

Returns: true if two vectors are equal to within a relative tolerance of tol.

Definition at line 1042 of file type_vector.h.

 {
 #if LIBMESH_DIM == 1
   return this->absolute_fuzzy_equals(rhs, tol *
                                      (std::abs(_coords[0]) + std::abs(rhs._coords[0])));
 #endif
  
 #if LIBMESH_DIM == 2
   return this->absolute_fuzzy_equals(rhs, tol *
                                      (std::abs(_coords[0]) + std::abs(rhs._coords[0]) +
                                       std::abs(_coords[1]) + std::abs(rhs._coords[1])));
 #endif
  
 #if LIBMESH_DIM == 3
   return this->absolute_fuzzy_equals(rhs, tol *
                                      (std::abs(_coords[0]) + std::abs(rhs._coords[0]) +
                                       std::abs(_coords[1]) + std::abs(rhs._coords[1]) +
                                       std::abs(_coords[2]) + std::abs(rhs._coords[2])));
 #endif
 }

◆ set_buffer()

void libMesh::DofObject::set_buffer ( const std::vector< dof_id_type > & buf )

inlineinherited

Definition at line 650 of file dof_object.h.

651 { _idx_buf = buf; }

References libMesh::DofObject::_idx_buf.

Referenced by DofObjectTest< Node >::testJensEftangBug().

◆ set_dof_number()

void libMesh::DofObject::set_dof_number	(	const unsigned int	s,
		const unsigned int	var,
		const unsigned int	comp,
		const dof_id_type	dn
	)

inherited

Sets the global degree of freedom number for variable var, component comp for system s associated with this DofObject.

Definition at line 467 of file dof_object.C.

 {
   libmesh_assert_less (s,    this->n_systems());
   libmesh_assert_less (var,  this->n_vars(s));
   libmesh_assert_less (comp, this->n_comp(s,var));
  
   const unsigned int
     vg            = this->var_to_vg(s,var),
 #ifndef NDEBUG
     ncg           = this->n_comp_group(s,vg),
 #endif
     vig           = this->system_var_to_vg_var(s,vg,var),
     start_idx_sys = this->start_idx(s);
  
   libmesh_assert_less ((start_idx_sys + 2*vg + 1), _idx_buf.size());
  
   dof_id_type & base_idx = _idx_buf[start_idx_sys + 2*vg + 1];
  
   // We intend to change all dof numbers together or not at all
   if (comp || vig)
     libmesh_assert ((dn == invalid_id && base_idx == invalid_id) ||
                     (dn == base_idx + vig*ncg + comp));
  
   // only explicitly store the base index for vig==0, comp==0
   else
     base_idx = dn;
  
   libmesh_assert_equal_to (this->dof_number(s, var, comp), dn);
 }

References libMesh::DofObject::_idx_buf, libMesh::DofObject::dof_number(), libMesh::DofObject::invalid_id, libMesh::libmesh_assert(), libMesh::DofObject::n_comp(), libMesh::DofObject::n_comp_group(), libMesh::DofObject::n_systems(), libMesh::DofObject::n_vars(), libMesh::DofObject::start_idx(), libMesh::DofObject::system_var_to_vg_var(), and libMesh::DofObject::var_to_vg().

◆ set_extra_datum()

template<typename T >

void libMesh::DofObject::set_extra_datum	(	const unsigned int	index,
		const T	value
	)

inlineinherited

Sets the value on this object of the extra datum associated with index, which should have been obtained via a call to MeshBase::add_elem_datum or MeshBase::add_node_datum using the same type T.

Definition at line 1042 of file dof_object.h.

 {
 #ifndef NDEBUG
   const unsigned int n_more_integers = (sizeof(T)-1)/sizeof(dof_id_type);
 #endif
   libmesh_assert_less(index+n_more_integers, this->n_extra_integers());
   libmesh_assert_less(this->n_pseudo_systems(), _idx_buf.size());
  
   const unsigned int start_idx_i = this->start_idx_ints();
  
   libmesh_assert_less(start_idx_i+index+n_more_integers, _idx_buf.size());
   std::memcpy(&_idx_buf[start_idx_i+index], &value, sizeof(T));
 }

References libMesh::DofObject::_idx_buf, libMesh::DofObject::n_extra_integers(), libMesh::DofObject::n_pseudo_systems(), libMesh::DofObject::start_idx_ints(), and value.

Referenced by libMesh::DynaIO::read_mesh(), and DofObjectTest< Node >::testAddExtraData().

◆ set_extra_integer()

void libMesh::DofObject::set_extra_integer	(	const unsigned int	index,
		const dof_id_type	value
	)

inlineinherited

Sets the value on this object of the extra integer associated with index, which should have been obtained via a call to MeshBase::add_elem_integer or MeshBase::add_node_integer.

Definition at line 1010 of file dof_object.h.

 {
   libmesh_assert_less(index, this->n_extra_integers());
   libmesh_assert_less(this->n_pseudo_systems(), _idx_buf.size());
  
   const unsigned int start_idx_i = this->start_idx_ints();
  
   libmesh_assert_less(start_idx_i+index, _idx_buf.size());
   _idx_buf[start_idx_i+index] = value;
 }

References libMesh::DofObject::_idx_buf, libMesh::DofObject::n_extra_integers(), libMesh::DofObject::n_pseudo_systems(), libMesh::DofObject::start_idx_ints(), and value.

Referenced by libMesh::UnstructuredMesh::create_submesh(), libMesh::CheckpointIO::read_connectivity(), libMesh::CheckpointIO::read_nodes(), libMesh::Elem::refine(), DofObjectTest< Node >::testAddExtraData(), DofObjectTest< Node >::testAddSystemExtraInts(), DofObjectTest< Node >::testSetNSystemsExtraInts(), and DofObjectTest< Node >::testSetNVariableGroupsExtraInts().

◆ set_id() [1/2]

dof_id_type & libMesh::DofObject::set_id ( )

inlineinherited

Returns: The id for this DofObject as a writable reference.

Definition at line 776 of file dof_object.h.

 {
   return _id;
 }

References libMesh::DofObject::_id.

Referenced by libMesh::GMVIO::_read_one_cell(), libMesh::ReplicatedMesh::add_elem(), libMesh::DistributedMesh::add_elem(), libMesh::ReplicatedMesh::add_node(), libMesh::DistributedMesh::add_node(), libMesh::UnstructuredMesh::all_first_order(), libMesh::UnstructuredMesh::all_second_order(), libMesh::MeshTools::Subdivision::all_subdivision(), libMesh::MeshTools::Generation::build_cube(), libMesh::MeshTools::Generation::build_extrusion(), libMesh::InfElemBuilder::build_inf_elem(), GetBoundaryPointsTest::build_mesh(), SlitMeshTest::build_mesh(), OverlappingTestBase::build_quad_mesh(), libMesh::UnstructuredMesh::create_submesh(), libMesh::UNVIO::elements_in(), libMesh::MeshTools::Modification::flatten(), libMesh::DofObject::invalidate_id(), libMesh::RBEIMEvaluation::legacy_write_out_interpolation_points_elem(), libMesh::RBDataDeserialization::load_rb_eim_evaluation_data(), Node(), libMesh::DistributedMesh::own_node(), libMesh::Nemesis_IO::read(), libMesh::ExodusII_IO::read(), libMesh::VTKIO::read(), libMesh::CheckpointIO::read_connectivity(), libMesh::UCDIO::read_implementation(), libMesh::GmshIO::read_mesh(), libMesh::XdrIO::read_serialized_connectivity(), libMesh::OFFIO::read_stream(), libMesh::MatlabIO::read_stream(), libMesh::RemoteElem::RemoteElem(), libMesh::ReplicatedMesh::renumber_elem(), libMesh::DistributedMesh::renumber_elem(), libMesh::ReplicatedMesh::renumber_node(), libMesh::DistributedMesh::renumber_node(), libMesh::ReplicatedMesh::renumber_nodes_and_elements(), libMesh::DofObject::set_id(), DofObjectTest< Node >::testInvalidateId(), EquationSystemsTest::testPostInitAddElem(), SystemsTest::testProjectMatrix3D(), DofObjectTest< Node >::testSetId(), DofObjectTest< Node >::testValidId(), libMesh::Parallel::Packing< Node * >::unpack(), and libMesh::Parallel::Packing< Elem * >::unpack().

◆ set_id() [2/2]

void libMesh::DofObject::set_id ( const dof_id_type dofid )

inlineinherited

Sets the id for this DofObject.

Definition at line 156 of file dof_object.h.

157 { this->set_id() = dofid; }

References libMesh::DofObject::set_id().

◆ set_n_comp()

void libMesh::DofObject::set_n_comp	(	const unsigned int	s,
		const unsigned int	var,
		const unsigned int	ncomp
	)

inherited

Sets the number of components for Variable var of system s associated with this DofObject.

Definition at line 398 of file dof_object.C.

 {
   libmesh_assert_less (s,   this->n_systems());
   libmesh_assert_less (var, this->n_vars(s));
  
   this->set_n_comp_group(s, this->var_to_vg(s,var), ncomp);
 }

References libMesh::DofObject::n_systems(), libMesh::DofObject::n_vars(), libMesh::DofObject::set_n_comp_group(), and libMesh::DofObject::var_to_vg().

◆ set_n_comp_group()

void libMesh::DofObject::set_n_comp_group	(	const unsigned int	s,
		const unsigned int	vg,
		const unsigned int	ncomp
	)

inherited

Sets the number of components for VariableGroup vg of system s associated with this DofObject.

Definition at line 410 of file dof_object.C.

 {
   libmesh_assert_less (s,  this->n_systems());
   libmesh_assert_less (vg, this->n_var_groups(s));
  
   // Check for trivial return
   if (ncomp == this->n_comp_group(s,vg)) return;
  
 #ifndef NDEBUG
   if (ncomp >= ncv_magic)
     {
       const index_t ncvm = ncv_magic;
       libmesh_error_msg("ERROR: ncomp must be less than DofObject::ncv_magic!\n" \
                         << "ncomp = "                                   \
                         << ncomp                                \
                         << ", ncv_magic = "                     \
                         << ncvm                                 \
                         << "\nrecompile and try again!");
     }
 #endif
  
   const unsigned int
     start_idx_sys = this->start_idx(s),
     n_vars_group  = this->n_vars(s,vg),
     base_offset   = start_idx_sys + 2*vg;
  
   libmesh_assert_less ((base_offset + 1), _idx_buf.size());
  
   // if (ncomp)
   //   libMesh::out << "s,vg,ncomp="
   //       << s  << ","
   //       << vg << ","
   //       << ncomp << '\n';
  
   // set the number of components, maintaining the number
   // of variables in the group
   _idx_buf[base_offset] = ncv_magic*n_vars_group + ncomp;
  
   // We use (invalid_id - 1) to signify no
   // components for this object
   _idx_buf[base_offset + 1] = (ncomp == 0) ? invalid_id - 1 : invalid_id;
  
   // this->debug_buffer();
   // libMesh::out << "s,vg = " << s << "," << vg << '\n'
   //     << "base_offset=" << base_offset << '\n'
   //     << "this->n_comp(s,vg)=" << this->n_comp(s,vg) << '\n'
   //     << "this->n_comp_group(s,vg)=" << this->n_comp_group(s,vg) << '\n'
   //     << "this->n_vars(s,vg)=" << this->n_vars(s,vg) << '\n'
   //     << "this->n_var_groups(s)=" << this->n_var_groups(s) << '\n';
  
   libmesh_assert_equal_to (ncomp, this->n_comp_group(s,vg));
 }

References libMesh::DofObject::_idx_buf, libMesh::DofObject::invalid_id, libMesh::DofObject::n_comp_group(), libMesh::DofObject::n_systems(), libMesh::DofObject::n_var_groups(), libMesh::DofObject::n_vars(), libMesh::DofObject::ncv_magic, and libMesh::DofObject::start_idx().

Referenced by libMesh::DofMap::reinit(), libMesh::DofObject::set_n_comp(), libMesh::DofObject::set_n_vars_per_group(), libMesh::DofMap::set_nonlocal_dof_objects(), and DofObjectTest< Node >::testManualDofCalculation().

◆ set_n_systems()

void libMesh::DofObject::set_n_systems ( const unsigned int s )

inherited

Sets the number of systems for this DofObject.

If this number is a change, also clears all variable count and DoF indexing associated with this DofObject.

If any extra integers are associated with this DofObject, their count and values are unchanged.

Definition at line 165 of file dof_object.C.

 {
   const unsigned int old_ns = this->n_systems();
  
   // Check for trivial return
   if (ns == old_ns)
     return;
  
   const unsigned int nei = this->n_extra_integers();
   const dof_id_type header_size = ns + bool(nei);
   const dof_id_type hdr = nei ? -header_size : header_size;
   index_buffer_t new_buf(header_size + nei, hdr);
   if (nei)
     {
       const unsigned int start_idx_ints = old_ns ?
         cast_int<unsigned int>(_idx_buf[old_ns]) :
         1;
       libmesh_assert_less(start_idx_ints, _idx_buf.size());
       std::copy(_idx_buf.begin()+start_idx_ints,
                 _idx_buf.end(),
                 new_buf.begin()+header_size);
       if (ns)
         std::fill(new_buf.begin()+1, new_buf.begin()+ns+1, ns+1);
     }
  
   // vector swap trick to force deallocation when shrinking
   new_buf.swap(_idx_buf);
  
 #ifdef DEBUG
   libmesh_assert_equal_to(nei, this->n_extra_integers());
  
   // check that all systems now exist and that they have 0 size
   libmesh_assert_equal_to (ns, this->n_systems());
   for (auto s : IntRange<unsigned int>(0, this->n_systems()))
     {
       libmesh_assert_equal_to (this->n_vars(s),       0);
       libmesh_assert_equal_to (this->n_var_groups(s), 0);
     }
 #endif
 }

References libMesh::DofObject::_idx_buf, libMesh::DofObject::n_extra_integers(), libMesh::DofObject::n_systems(), libMesh::DofObject::n_var_groups(), libMesh::DofObject::n_vars(), and libMesh::DofObject::start_idx_ints().

Referenced by libMesh::DofObject::add_system(), libMesh::DofObject::clear_dofs(), libMesh::Elem::refine(), DofObjectTest< Node >::testManualDofCalculation(), DofObjectTest< Node >::testSetNSystems(), DofObjectTest< Node >::testSetNSystemsExtraInts(), DofObjectTest< Node >::testSetNVariableGroups(), and DofObjectTest< Node >::testSetNVariableGroupsExtraInts().

◆ set_n_vars_per_group()

void libMesh::DofObject::set_n_vars_per_group	(	const unsigned int	s,
		const std::vector< unsigned int > &	nvpg
	)

inherited

Sets number of variables in each group associated with system s for this DofObject.

Implicit in this is also setting the number of VariableGroup variable groups for the system. Has the effect of setting the number of components to 0 even when called even with (nvg == this->n_var_groups(s)).

Definition at line 260 of file dof_object.C.

 {
   const unsigned int n_sys = this->n_systems();
  
   libmesh_assert_less (s, n_sys);
  
   // number of variable groups for this system - inferred
   const unsigned int nvg = cast_int<unsigned int>(nvpg.size());
  
   // BSK - note that for compatibility with the previous implementation
   // calling this method when (nvars == this->n_vars()) requires that
   // we invalidate the DOF indices and set the number of components to 0.
   // Note this was a bit of a surprise to me - there was no quick return in
   // the old method, which caused removal and readdition of the DOF indices
   // even in the case of (nvars == this->n_vars()), resulting in n_comp(s,v)
   // implicitly becoming 0 regardless of any previous value.
   // quick return?
   if (nvg == this->n_var_groups(s))
     {
       for (unsigned int vg=0; vg<nvg; vg++)
         {
           this->set_n_comp_group(s,vg,0);
           libmesh_assert_equal_to (this->n_vars(s,vg), nvpg[vg]);
         }
       return;
     }
  
   const bool hei = this->has_extra_integers();
  
   // since there is ample opportunity to screw up other systems, let us
   // cache their current sizes and later assert that they are unchanged.
 #ifdef DEBUG
   const unsigned int nei = this->n_extra_integers();
  
   DofObject::index_buffer_t old_system_sizes, old_extra_integers;
   old_system_sizes.reserve(n_sys);
   old_extra_integers.reserve(nei);
  
   for (unsigned int s_ctr=0; s_ctr<n_sys; s_ctr++)
     old_system_sizes.push_back(this->n_var_groups(s_ctr));
  
   for (unsigned int ei=0; ei != nei; ++ei)
     old_extra_integers.push_back(this->get_extra_integer(ei));
 #endif
  
   // remove current indices if we have some
   if (this->n_var_groups(s) != 0)
     {
       const unsigned int old_nvg_s = this->n_var_groups(s);
  
       DofObject::index_buffer_t::iterator
         it  = _idx_buf.begin(),
         end = _idx_buf.begin();
  
       std::advance(it,  this->start_idx(s));
       std::advance(end, this->end_idx(s));
       _idx_buf.erase(it,end);
  
       for (unsigned int ctr=(s+1); ctr<n_sys; ctr++)
         _idx_buf[ctr] -= 2*old_nvg_s;
  
       if (hei)
         _idx_buf[n_sys] -= 2*old_nvg_s;
     }
  
   // better not have any now!
   libmesh_assert_equal_to (this->n_var_groups(s), 0);
  
   // Make sure we didn't screw up any of our sizes!
 #ifdef DEBUG
   for (auto s_ctr : IntRange<unsigned int>(0, this->n_systems()))
     if (s_ctr != s)
       libmesh_assert_equal_to (this->n_var_groups(s_ctr), old_system_sizes[s_ctr]);
  
   libmesh_assert_equal_to (nei, this->n_extra_integers());
  
   for (unsigned int ei=0; ei != nei; ++ei)
     libmesh_assert_equal_to(old_extra_integers[ei], this->get_extra_integer(ei));
 #endif
  
   // OK, if the user requested 0 that is what we have
   if (nvg == 0)
     return;
  
   {
     // array to hold new indices
     DofObject::index_buffer_t var_idxs(2*nvg);
     for (unsigned int vg=0; vg<nvg; vg++)
       {
         var_idxs[2*vg    ] = ncv_magic*nvpg[vg] + 0;
         var_idxs[2*vg + 1] = invalid_id - 1;
       }
  
     DofObject::index_buffer_t::iterator it = _idx_buf.begin();
     std::advance(it, this->end_idx(s));
     _idx_buf.insert(it, var_idxs.begin(), var_idxs.end());
  
     for (unsigned int ctr=(s+1); ctr<n_sys; ctr++)
       _idx_buf[ctr] += 2*nvg;
  
     if (hei)
       _idx_buf[n_sys] += 2*nvg;
  
     // resize _idx_buf to fit so no memory is wasted.
     DofObject::index_buffer_t(_idx_buf).swap(_idx_buf);
   }
  
   libmesh_assert_equal_to (nvg, this->n_var_groups(s));
  
 #ifdef DEBUG
  
   libmesh_assert_equal_to (this->n_var_groups(s), nvpg.size());
  
   for (auto vg : IntRange<unsigned int>(0, this->n_var_groups(s)))
     {
       libmesh_assert_equal_to (this->n_vars(s,vg), nvpg[vg]);
       libmesh_assert_equal_to (this->n_comp_group(s,vg), 0);
     }
  
   for (auto v : IntRange<unsigned int>(0, this->n_vars(s)))
     libmesh_assert_equal_to (this->n_comp(s,v), 0);
  
   // again, all other system sizes should be unchanged!
   for (auto s_ctr : IntRange<unsigned int>(0, this->n_systems()))
     if (s_ctr != s)
       libmesh_assert_equal_to (this->n_var_groups(s_ctr), old_system_sizes[s_ctr]);
  
   // Extra integers count and values should also be unchanged!
   libmesh_assert_equal_to (nei, this->n_extra_integers());
  
   for (unsigned int ei=0; ei != nei; ++ei)
     libmesh_assert_equal_to(old_extra_integers[ei], this->get_extra_integer(ei));
 #endif
 }

Referenced by DofObjectTest< Node >::testManualDofCalculation(), DofObjectTest< Node >::testSetNVariableGroups(), and DofObjectTest< Node >::testSetNVariableGroupsExtraInts().

◆ set_old_dof_object()

void libMesh::DofObject::set_old_dof_object ( )

inherited

Sets the old_dof_object to a copy of this.

Definition at line 150 of file dof_object.C.

 {
   this->clear_old_dof_object();
  
   libmesh_assert (!this->old_dof_object);
  
   // Make a new DofObject, assign a copy of \p this.
   // Make sure the copy ctor for DofObject works!!
   this->old_dof_object = new DofObject(*this);
 }

References libMesh::DofObject::clear_old_dof_object(), libMesh::DofObject::DofObject(), libMesh::libmesh_assert(), and libMesh::DofObject::old_dof_object.

◆ set_unique_id()

unique_id_type & libMesh::DofObject::set_unique_id ( )

inlineinherited

Returns: The globally unique_id for this DofObject as a writable reference.

Definition at line 797 of file dof_object.h.

 {
 #ifdef LIBMESH_ENABLE_UNIQUE_ID
   return _unique_id;
 #else
   libmesh_not_implemented();
 #endif
 }

References libMesh::DofObject::_unique_id.

Referenced by libMesh::ReplicatedMesh::add_elem(), libMesh::DistributedMesh::add_elem(), libMesh::ReplicatedMesh::add_node(), libMesh::DistributedMesh::add_node(), libMesh::ReplicatedMesh::add_point(), libMesh::UnstructuredMesh::all_first_order(), libMesh::UnstructuredMesh::all_second_order(), libMesh::MeshTools::Generation::build_extrusion(), libMesh::InfElemBuilder::build_inf_elem(), libMesh::UnstructuredMesh::create_submesh(), libMesh::MeshTools::Modification::flatten(), libMesh::ReplicatedMesh::insert_elem(), libMesh::DistributedMesh::insert_elem(), libMesh::ReplicatedMesh::insert_node(), libMesh::Nemesis_IO::read(), libMesh::CheckpointIO::read_connectivity(), libMesh::CheckpointIO::read_nodes(), libMesh::XdrIO::read_serialized_connectivity(), libMesh::XdrIO::read_serialized_nodes(), libMesh::Parallel::Packing< Node * >::unpack(), and libMesh::Parallel::Packing< Elem * >::unpack().

◆ set_valence()

void libMesh::Node::set_valence ( unsigned int val )

inline

Sets the number of nodes connected with this node.

Definition at line 354 of file node.h.

 {
   _valence = cast_int<valence_idx_t>(val);
 }

References _valence.

◆ set_vg_dof_base()

void libMesh::DofObject::set_vg_dof_base	(	const unsigned int	s,
		const unsigned int	vg,
		const dof_id_type	db
	)

inlineinherited

VariableGroup DoF indices are indexed as id = base + var_in_vg*ncomp + comp This method allows for direct access to the base.

Definition at line 1209 of file dof_object.h.

 {
   libmesh_assert_less (s,  this->n_systems());
   libmesh_assert_less (vg, this->n_var_groups(s));
  
   const unsigned int
     start_idx_sys = this->start_idx(s);
  
   libmesh_assert_less ((start_idx_sys + 2*vg + 1), _idx_buf.size());
  
   _idx_buf[start_idx_sys + 2*vg + 1] = db;
  
   libmesh_assert_equal_to (this->vg_dof_base(s,vg), db);
 }

References libMesh::DofObject::_idx_buf, libMesh::DofObject::n_systems(), libMesh::DofObject::n_var_groups(), libMesh::DofObject::start_idx(), and libMesh::DofObject::vg_dof_base().

Referenced by libMesh::DofMap::distribute_local_dofs_node_major(), libMesh::DofMap::distribute_local_dofs_var_major(), libMesh::DofObject::invalidate_dofs(), libMesh::DofMap::reinit(), libMesh::DofMap::set_nonlocal_dof_objects(), and DofObjectTest< Node >::testManualDofCalculation().

◆ size()

auto libMesh::TypeVector< Real >::size ( ) const-> decltype(std::norm(Real ()))

inlineinherited

Returns: The magnitude of the vector, i.e. the square-root of the sum of the elements squared.

Definition at line 944 of file type_vector.h.

 {
   libmesh_deprecated();
   return this->norm();
 }

◆ size_sq()

auto libMesh::TypeVector< Real >::size_sq ( ) const-> decltype(std::norm(Real ()))

inlineinherited

Returns: The magnitude of the vector squared, i.e. the sum of the element magnitudes squared.

Definition at line 975 of file type_vector.h.

 {
   libmesh_deprecated();
   return this->norm_sq();
 }

◆ slice() [1/2]

Real & libMesh::TypeVector< Real >::slice ( const unsigned int i )

inlineinherited

Definition at line 180 of file type_vector.h.

180 { return (*this)(i); }

◆ slice() [2/2]

const Real & libMesh::TypeVector< Real >::slice ( const unsigned int i ) const

inlineinherited

Definition at line 174 of file type_vector.h.

174 { return (*this)(i); }

◆ start_idx()

unsigned int libMesh::DofObject::start_idx ( const unsigned int s ) const

inlineprivateinherited

The starting index for system s.

Definition at line 1161 of file dof_object.h.

 {
   libmesh_assert_less (s, this->n_systems());
   libmesh_assert_less (s, _idx_buf.size());
  
   return cast_int<unsigned int>(std::abs(dof_id_signed_type(_idx_buf[s])));
 }

References libMesh::DofObject::_idx_buf, std::abs(), and libMesh::DofObject::n_systems().

Referenced by libMesh::DofObject::dof_number(), libMesh::DofObject::n_comp_group(), libMesh::DofObject::n_var_groups(), libMesh::DofObject::n_vars(), libMesh::DofObject::set_dof_number(), libMesh::DofObject::set_n_comp_group(), libMesh::DofObject::set_n_vars_per_group(), libMesh::DofObject::set_vg_dof_base(), and libMesh::DofObject::vg_dof_base().

◆ start_idx_ints()

unsigned int libMesh::DofObject::start_idx_ints ( ) const

inlineprivateinherited

The starting index for an extra_integers pseudosystem.

Definition at line 1185 of file dof_object.h.

 {
   libmesh_assert (this->has_extra_integers());
  
   unsigned int n_sys = this->n_systems();
  
   libmesh_assert_less(this->n_systems(), _idx_buf.size());
   return n_sys ? cast_int<unsigned int>(_idx_buf[this->n_systems()]) :
                  (n_sys+1);
 }

References libMesh::DofObject::_idx_buf, libMesh::DofObject::has_extra_integers(), libMesh::libmesh_assert(), and libMesh::DofObject::n_systems().

Referenced by libMesh::DofObject::get_extra_datum(), libMesh::DofObject::get_extra_integer(), libMesh::DofObject::n_extra_integers(), libMesh::DofObject::set_extra_datum(), libMesh::DofObject::set_extra_integer(), and libMesh::DofObject::set_n_systems().

◆ subtract()

void libMesh::TypeVector< Real >::subtract ( const TypeVector< T2 > & p )

inlineinherited

Subtract from this vector without creating a temporary.

Definition at line 728 of file type_vector.h.

 {
   for (unsigned int i=0; i<LIBMESH_DIM; i++)
     _coords[i] -= p._coords[i];
 }

◆ subtract_scaled()

void libMesh::TypeVector< Real >::subtract_scaled	(	const TypeVector< T2 > &	p,
		const Real &	factor
	)

inlineinherited

Subtract a scaled value from this vector without creating a temporary.

Definition at line 739 of file type_vector.h.

 {
   for (unsigned int i=0; i<LIBMESH_DIM; i++)
     _coords[i] -= factor*p(i);
 }

◆ system_var_to_vg_var()

unsigned int libMesh::DofObject::system_var_to_vg_var	(	const unsigned int	s,
		const unsigned int	vg,
		const unsigned int	var
	)		const

inlineprivateinherited

Utility function - for variable var in system s, figure out what variable group it lives in.

Definition at line 1271 of file dof_object.h.

 {
   unsigned int accumulated_sum=0;
  
   for (unsigned int vgc=0; vgc<vg; vgc++)
     accumulated_sum += this->n_vars(s,vgc);
  
   libmesh_assert_less_equal (accumulated_sum, var);
  
   return (var - accumulated_sum);
 }

References libMesh::DofObject::n_vars().

Referenced by libMesh::DofObject::set_dof_number().

◆ unique_id()

unique_id_type libMesh::DofObject::unique_id ( ) const

inlineinherited

Returns: The globally unique_id for this DofObject

Definition at line 784 of file dof_object.h.

 {
 #ifdef LIBMESH_ENABLE_UNIQUE_ID
   libmesh_assert (this->valid_unique_id());
   return _unique_id;
 #else
   return invalid_unique_id;
 #endif
 }

References libMesh::DofObject::_unique_id, libMesh::DofObject::invalid_unique_id, libMesh::libmesh_assert(), and libMesh::DofObject::valid_unique_id().

Referenced by libMesh::ReplicatedMesh::add_elem(), libMesh::UnstructuredMesh::all_second_order(), libMesh::MeshTools::Modification::all_tri(), libMesh::MeshTools::Generation::build_extrusion(), libMesh::MeshTools::Modification::flatten(), libMesh::Elem::get_info(), libMesh::MeshTools::libmesh_assert_valid_unique_ids(), libMesh::Parallel::Packing< const Node * >::pack(), libMesh::Parallel::Packing< const Elem * >::pack(), libMesh::XdrIO::pack_element(), libMesh::ExodusII_IO::read_elemental_variable(), SlitMeshRefinedSystemTest::testRestart(), and libMesh::XdrIO::write_serialized_nodes().

◆ unit()

TypeVector< Real > libMesh::TypeVector< Real >::unit ( ) const

inlineinherited

Returns: A unit vector in the direction of *this.

Definition at line 1158 of file type_vector.h.

 {
  
   auto && length = norm();
  
   libmesh_assert_not_equal_to (length, static_cast<Real>(0.));
  
 #if LIBMESH_DIM == 1
   return TypeVector<T>(_coords[0]/length);
 #endif
  
 #if LIBMESH_DIM == 2
   return TypeVector<T>(_coords[0]/length,
                        _coords[1]/length);
 #endif
  
 #if LIBMESH_DIM == 3
   return TypeVector<T>(_coords[0]/length,
                        _coords[1]/length,
                        _coords[2]/length);
 #endif
  
 }

◆ unpack_indexing()

void libMesh::DofObject::unpack_indexing ( std::vector< largest_id_type >::const_iterator begin )

inherited

A method for creating our index buffer from packed data - basically with our current implementation we investigate the size term and then copy.

Definition at line 589 of file dof_object.C.

 {
   _idx_buf.clear();
  
 #ifdef LIBMESH_ENABLE_AMR
   this->clear_old_dof_object();
   const bool has_old_dof_object = cast_int<bool>(*begin++);
 #endif
  
   const largest_id_type size = *begin++;
   _idx_buf.reserve(size);
   std::copy(begin, begin+size, back_inserter(_idx_buf));
  
   // Check as best we can for internal consistency now
   libmesh_assert(_idx_buf.empty() ||
                  (std::abs(dof_id_signed_type(_idx_buf[0])) <=
                   cast_int<dof_id_signed_type>(_idx_buf.size())));
 #ifdef DEBUG
   if (!_idx_buf.empty())
     {
       const int hdr = cast_int<int>(dof_id_signed_type(_idx_buf[0]));
       const unsigned int ns = hdr >= 0 ? hdr : (-hdr-1);
       for (unsigned int i=1; i < ns; ++i)
         {
           libmesh_assert_greater_equal (_idx_buf[i], _idx_buf[i-1]);
           libmesh_assert_equal_to ((_idx_buf[i] - _idx_buf[i-1])%2, 0);
           libmesh_assert_less_equal (_idx_buf[i], _idx_buf.size());
         }
       if (hdr < 0 && ns > 0)
         {
           libmesh_assert_greater_equal(_idx_buf[ns], _idx_buf[ns-1]);
           libmesh_assert_less_equal(_idx_buf[ns], _idx_buf.size());
         }
     }
 #endif
  
 #ifdef LIBMESH_ENABLE_AMR
   if (has_old_dof_object)
     {
       this->old_dof_object = new DofObject();
       this->old_dof_object->unpack_indexing(begin+size);
     }
 #endif
 }

References libMesh::DofObject::_idx_buf, std::abs(), libMesh::DofObject::clear_old_dof_object(), libMesh::DofObject::DofObject(), libMesh::libmesh_assert(), libMesh::DofObject::old_dof_object, and libMesh::DofObject::unpack_indexing().

Referenced by libMesh::Parallel::Packing< Node * >::unpack(), libMesh::Parallel::Packing< Elem * >::unpack(), and libMesh::DofObject::unpack_indexing().

◆ unpackable_indexing_size()

unsigned int libMesh::DofObject::unpackable_indexing_size ( std::vector< largest_id_type >::const_iterator begin )

staticinherited

If we have indices packed into an buffer for communications, how much of that buffer applies to this dof object?

Definition at line 569 of file dof_object.C.

 {
 #ifdef LIBMESH_ENABLE_AMR
   const bool has_old_dof_object = cast_int<bool>(*begin++);
  
   static const int dof_header_size = 2;
 #else
   static const bool has_old_dof_object = false;
   static const int dof_header_size = 1;
 #endif
  
   const largest_id_type this_indexing_size = *begin++;
  
   return cast_int<unsigned int>
     (dof_header_size + this_indexing_size +
      (has_old_dof_object ?
       unpackable_indexing_size(begin+this_indexing_size) : 0));
 }

Referenced by libMesh::Parallel::Packing< const Elem * >::packed_size(), libMesh::Parallel::Packing< const Node * >::packed_size(), and libMesh::Parallel::Packing< Node * >::unpack().

◆ valence()

unsigned int libMesh::Node::valence ( ) const

inline

Returns: The number of nodes connected with this node. Currently, this value is invalid (zero) except for subdivision meshes.

Definition at line 176 of file node.h.

   {
 #ifdef LIBMESH_ENABLE_NODE_VALENCE
     return _valence;
 #else
     libmesh_not_implemented();
     return libMesh::invalid_uint;
 #endif
   }

References _valence, and libMesh::invalid_uint.

Referenced by libMesh::Tri3Subdivision::get_ordered_valence().

◆ valid_id()

bool libMesh::DofObject::valid_id ( ) const

inlineinherited

Returns: true if this DofObject has a valid id set, false otherwise.

Definition at line 809 of file dof_object.h.

 {
   return (DofObject::invalid_id != _id);
 }

References libMesh::DofObject::_id, and libMesh::DofObject::invalid_id.

Referenced by libMesh::ReplicatedMesh::add_elem(), libMesh::DistributedMesh::add_elem(), libMesh::ReplicatedMesh::add_node(), libMesh::DistributedMesh::add_node(), get_info(), libMesh::Elem::get_info(), libMesh::DofObject::id(), libMesh::Elem::libmesh_assert_valid_node_pointers(), DofObjectTest< Node >::testInvalidateId(), and DofObjectTest< Node >::testValidId().

◆ valid_processor_id()

bool libMesh::DofObject::valid_processor_id ( ) const

inlineinherited

Returns: true if this DofObject has a valid id set, false otherwise.

Definition at line 853 of file dof_object.h.

 {
   return (DofObject::invalid_processor_id != _processor_id);
 }

References libMesh::DofObject::_processor_id, and libMesh::DofObject::invalid_processor_id.

Referenced by DofObjectTest< Node >::testInvalidateProcId(), and DofObjectTest< Node >::testValidProcId().

◆ valid_unique_id()

bool libMesh::DofObject::valid_unique_id ( ) const

inlineinherited

Returns: true if this DofObject has a valid unique_id set, false otherwise.

Definition at line 817 of file dof_object.h.

 {
 #ifdef LIBMESH_ENABLE_UNIQUE_ID
   return (DofObject::invalid_unique_id != _unique_id);
 #else
   return false;
 #endif
 }

References libMesh::DofObject::_unique_id, and libMesh::DofObject::invalid_unique_id.

Referenced by libMesh::ReplicatedMesh::add_elem(), libMesh::DistributedMesh::add_elem(), libMesh::ReplicatedMesh::add_node(), libMesh::DistributedMesh::add_node(), libMesh::ReplicatedMesh::add_point(), libMesh::Elem::get_info(), libMesh::ReplicatedMesh::insert_elem(), libMesh::DistributedMesh::insert_elem(), libMesh::ReplicatedMesh::insert_node(), libMesh::Parallel::Packing< const Node * >::pack(), libMesh::Parallel::Packing< const Elem * >::pack(), and libMesh::DofObject::unique_id().

◆ var_to_vg()

unsigned int libMesh::DofObject::var_to_vg	(	const unsigned int	s,
		const unsigned int	var
	)		const

inlineprivateinherited

Utility function - for variable var in system s, figure out what variable group it lives in.

Definition at line 1253 of file dof_object.h.

 {
   const unsigned int
     nvg = this->n_var_groups(s);
  
   for (unsigned int vg=0, vg_end=0; vg<nvg; vg++)
     {
       vg_end += this->n_vars(s,vg);
       if (var < vg_end) return vg;
     }
  
   libmesh_error_msg("Error: could not map variable " << var << " to variable group.");
 }

References libMesh::DofObject::n_var_groups(), and libMesh::DofObject::n_vars().

Referenced by libMesh::DofObject::n_comp(), libMesh::DofObject::set_dof_number(), and libMesh::DofObject::set_n_comp().

◆ var_to_vg_and_offset()

std::pair< unsigned int, unsigned int > libMesh::DofObject::var_to_vg_and_offset	(	const unsigned int	s,
		const unsigned int	var
	)		const

inlineinherited

Returns: A pair consisting of the variable group number and the offset index from the start of that group for variable var on system s associated with this DofObject

Definition at line 1112 of file dof_object.h.

 {
   std::pair<unsigned int, unsigned int> returnval(0,0);
  
   unsigned int & vg = returnval.first;
   unsigned int & offset = returnval.second;
  
   unsigned int vg_start = 0;
   for (; ; vg++)
     {
       libmesh_assert_less(vg, this->n_var_groups(s));
  
       const unsigned int vg_end = vg_start + this->n_vars(s,vg);
       if (var < vg_end)
         {
           offset = var - vg_start;
           return returnval;
         }
       vg_start = vg_end;
     }
 }

References libMesh::DofObject::n_var_groups(), and libMesh::DofObject::n_vars().

Referenced by libMesh::DofMap::_dof_indices(), libMesh::DofMap::_node_dof_indices(), libMesh::DofObject::dof_number(), libMesh::OldSolutionCoefs< Output, point_output >::eval_old_dofs(), and libMesh::OldSolutionValue< Output, point_output >::eval_old_dofs().

◆ vg_dof_base()

dof_id_type libMesh::DofObject::vg_dof_base	(	const unsigned int	s,
		const unsigned int	vg
	)		const

inlineinherited

VariableGroup DoF indices are indexed as id = base + var_in_vg*ncomp + comp This method allows for direct access to the base.

Definition at line 1229 of file dof_object.h.

 {
   libmesh_assert_less (s,  this->n_systems());
   libmesh_assert_less (vg, this->n_var_groups(s));
  
   const unsigned int
     start_idx_sys = this->start_idx(s);
  
   libmesh_assert_less ((start_idx_sys + 2*vg + 1), _idx_buf.size());
  
   // #ifdef DEBUG
   //   std::cout << " [ ";
   //   for (auto i : _idx_buf)
   //     std::cout << i << " ";
   //   std::cout << "]\n";
   // #endif
  
   return _idx_buf[start_idx_sys + 2*vg + 1];
 }

References libMesh::DofObject::_idx_buf, libMesh::DofObject::n_systems(), libMesh::DofObject::n_var_groups(), and libMesh::DofObject::start_idx().

Referenced by libMesh::DofMap::distribute_local_dofs_node_major(), libMesh::DofMap::distribute_local_dofs_var_major(), libMesh::DofMap::reinit(), libMesh::DofMap::set_nonlocal_dof_objects(), libMesh::DofObject::set_vg_dof_base(), and DofObjectTest< Node >::testManualDofCalculation().

◆ write_unformatted()

void libMesh::TypeVector< Real >::write_unformatted	(	std::ostream &	out,
		const bool	newline = `true`
	)		const

inherited

Unformatted print to the stream out.

Simply prints the elements of the vector separated by spaces. Also prints a newline by default, however, this behavior can be controlled with the newline parameter.

Definition at line 65 of file type_vector.C.

 {
   libmesh_assert (os);
  
   os << std::setiosflags(std::ios::showpoint)
      << (*this)(0) << " "
      << (*this)(1) << " "
      << (*this)(2) << " ";
  
   if (newline)
     os << '\n';
 }

◆ zero()

void libMesh::TypeVector< Real >::zero ( )

inlineinherited

Set all entries of the vector to 0.

Definition at line 964 of file type_vector.h.

 {
   for (unsigned int i=0; i<LIBMESH_DIM; i++)
     _coords[i] = 0.;
 }

Friends And Related Function Documentation

◆ Elem

friend class Elem

friend

Definition at line 204 of file node.h.

◆ MeshRefinement

friend class MeshRefinement

friend

This class need access to the node key information, but no one else should be able to mess with it.

Definition at line 203 of file node.h.

Member Data Documentation

◆ _coords

Real libMesh::TypeVector< Real >::_coords[LIBMESH_DIM]

protectedinherited

The coordinates of the TypeVector.

Definition at line 445 of file type_vector.h.

◆ _counts [1/2]

ReferenceCounter::Counts libMesh::ReferenceCounter::_counts

staticprotectedinherited

Actually holds the data.

Definition at line 122 of file reference_counter.h.

Referenced by libMesh::ReferenceCounter::get_info(), libMesh::ReferenceCounter::increment_constructor_count(), and libMesh::ReferenceCounter::increment_destructor_count().

◆ _counts [2/2]

ReferenceCounter::Counts libMesh::ReferenceCounter::_counts

staticprotectedinherited

Actually holds the data.

Definition at line 122 of file reference_counter.h.

Referenced by libMesh::ReferenceCounter::get_info(), libMesh::ReferenceCounter::increment_constructor_count(), and libMesh::ReferenceCounter::increment_destructor_count().

◆ _enable_print_counter [1/2]

bool libMesh::ReferenceCounter::_enable_print_counter = true

staticprotectedinherited

Flag to control whether reference count information is printed when print_info is called.

Definition at line 141 of file reference_counter.h.

Referenced by libMesh::ReferenceCounter::disable_print_counter_info(), libMesh::ReferenceCounter::enable_print_counter_info(), and libMesh::ReferenceCounter::print_info().

◆ _enable_print_counter [2/2]

bool libMesh::ReferenceCounter::_enable_print_counter = true

staticprotectedinherited

Flag to control whether reference count information is printed when print_info is called.

Definition at line 141 of file reference_counter.h.

Referenced by libMesh::ReferenceCounter::disable_print_counter_info(), libMesh::ReferenceCounter::enable_print_counter_info(), and libMesh::ReferenceCounter::print_info().

◆ _id

dof_id_type libMesh::DofObject::_id

privateinherited

The id of the DofObject.

Definition at line 516 of file dof_object.h.

Referenced by libMesh::DofObject::id(), libMesh::DofObject::operator=(), libMesh::DofObject::set_id(), and libMesh::DofObject::valid_id().

◆ _idx_buf

index_buffer_t libMesh::DofObject::_idx_buf

privateinherited

Definition at line 613 of file dof_object.h.

◆ _mutex [1/2]

Threads::spin_mutex libMesh::ReferenceCounter::_mutex

staticprotectedinherited

Mutual exclusion object to enable thread-safe reference counting.

Definition at line 135 of file reference_counter.h.

◆ _mutex [2/2]

Threads::spin_mutex libMesh::ReferenceCounter::_mutex

staticprotectedinherited

Mutual exclusion object to enable thread-safe reference counting.

Definition at line 135 of file reference_counter.h.

◆ _n_objects [1/2]

Threads::atomic< unsigned int > libMesh::ReferenceCounter::_n_objects

staticprotectedinherited

The number of objects.

Print the reference count information when the number returns to 0.

Definition at line 130 of file reference_counter.h.

Referenced by libMesh::ReferenceCounter::n_objects(), libMesh::ReferenceCounter::ReferenceCounter(), and libMesh::ReferenceCounter::~ReferenceCounter().

◆ _n_objects [2/2]

Threads::atomic< unsigned int > libMesh::ReferenceCounter::_n_objects

staticprotectedinherited

The number of objects.

Print the reference count information when the number returns to 0.

Definition at line 130 of file reference_counter.h.

Referenced by libMesh::ReferenceCounter::n_objects(), libMesh::ReferenceCounter::ReferenceCounter(), and libMesh::ReferenceCounter::~ReferenceCounter().

◆ _processor_id

processor_id_type libMesh::DofObject::_processor_id

privateinherited

The processor_id of the DofObject.

Degrees of freedom are wholly owned by processors, however they may be duplicated on other processors.

This is stored as an unsigned short int since we cannot expect to be solving on 65000+ processors any time soon, can we??

Definition at line 527 of file dof_object.h.

Referenced by libMesh::DofObject::operator=(), libMesh::DofObject::processor_id(), and libMesh::DofObject::valid_processor_id().

◆ _unique_id

unique_id_type libMesh::DofObject::_unique_id

privateinherited

A globally unique id, guaranteed not to change as the mesh is repartitioned or adapted.

Definition at line 510 of file dof_object.h.

Referenced by libMesh::DofObject::operator=(), libMesh::DofObject::set_unique_id(), libMesh::DofObject::unique_id(), and libMesh::DofObject::valid_unique_id().

◆ _valence

valence_idx_t libMesh::Node::_valence

private

The number of nodes connected with this node.

Currently, this value is invalid (zero) except for subdivision meshes.

Definition at line 217 of file node.h.

Referenced by set_valence(), and valence().

◆ invalid_id

const dof_id_type libMesh::DofObject::invalid_id = static_cast<dof_id_type>(-1)

staticinherited

An invalid id to distinguish an uninitialized DofObject.

Definition at line 421 of file dof_object.h.

◆ invalid_processor_id

const processor_id_type libMesh::DofObject::invalid_processor_id = static_cast<processor_id_type>(-1)

staticinherited

An invalid processor_id to distinguish DoFs that have not been assigned to a processor.

Definition at line 432 of file dof_object.h.

Referenced by libMesh::BoundaryInfo::_find_id_maps(), libMesh::DistributedMesh::add_elem(), libMesh::DistributedMesh::add_node(), libMesh::MeshRefinement::add_node(), libMesh::UnstructuredMesh::all_second_order(), libMesh::MeshCommunication::allgather(), choose_processor_id(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::SubProjector::construct_projection(), libMesh::MeshTools::create_bounding_box(), libMesh::MeshTools::create_nodal_bounding_box(), libMesh::DistributedMesh::delete_elem(), libMesh::DistributedMesh::delete_node(), libMesh::MeshCommunication::delete_remote_elements(), libMesh::Elem::Elem(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::SubFunctor::find_dofs_to_send(), libMesh::MeshCommunication::find_global_indices(), libMesh::DistributedMesh::insert_elem(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::SubFunctor::insert_id(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::SubFunctor::insert_ids(), libMesh::DofObject::invalidate_processor_id(), libMesh::MeshTools::libmesh_assert_consistent_distributed(), libMesh::MeshTools::libmesh_assert_consistent_distributed_nodes(), libMesh::DistributedMesh::libmesh_assert_valid_parallel_object_ids(), libMesh::MeshCommunication::make_new_node_proc_ids_parallel_consistent(), libMesh::DistributedMesh::n_active_elem(), libMesh::MeshBase::n_unpartitioned_elem(), libMesh::MeshBase::n_unpartitioned_nodes(), libMesh::SparsityPattern::Build::operator()(), libMesh::Partitioner::processor_pairs_to_interface_nodes(), libMesh::DistributedMesh::renumber_dof_objects(), OverlappingFunctorTest::run_coupling_functor_test(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::send_and_insert_dof_values(), libMesh::Partitioner::set_node_processor_ids(), libMesh::DofMap::set_nonlocal_dof_objects(), libMesh::Partitioner::set_parent_processor_ids(), libMesh::Parallel::sync_dofobject_data_by_id(), libMesh::Parallel::sync_dofobject_data_by_xyz(), libMesh::Parallel::sync_element_data_by_parent_id(), libMesh::Parallel::sync_node_data_by_element_id_once(), DofObjectTest< Node >::testValidProcId(), libMesh::MeshTools::total_weight(), libMesh::Parallel::Packing< Node * >::unpack(), libMesh::Parallel::Packing< Elem * >::unpack(), libMesh::DofObject::valid_processor_id(), and libMesh::CheckpointIO::write().

◆ invalid_unique_id

const unique_id_type libMesh::DofObject::invalid_unique_id = static_cast<unique_id_type>(-1)

staticinherited

An invalid unique_id to distinguish an uninitialized DofObject.

Definition at line 426 of file dof_object.h.

Referenced by libMesh::Parallel::Packing< const Node * >::pack(), libMesh::Parallel::Packing< const Elem * >::pack(), libMesh::DistributedMesh::renumber_dof_objects(), libMesh::DofObject::unique_id(), and libMesh::DofObject::valid_unique_id().

◆ ncv_magic

const index_t libMesh::DofObject::ncv_magic = 256

staticprivateinherited

Above we introduced the chimera ncv, which is a hybrid of the form ncv = ncv_magic*nv + nc where nv are the number of identical variables of a given type, and nc is the number of components for this set of variables.

It is hoped that by setting this to a power of two, an optimizing compiler will recognize later that #/ncv_magic is simply a bitshift

Definition at line 624 of file dof_object.h.

Referenced by libMesh::DofObject::n_comp_group(), libMesh::DofObject::set_n_comp_group(), and libMesh::DofObject::set_n_vars_per_group().

◆ ncv_magic_exp

const index_t libMesh::DofObject::ncv_magic_exp = 8

staticprivateinherited

Definition at line 625 of file dof_object.h.

Referenced by libMesh::DofObject::n_vars().

◆ old_dof_object

DofObject* libMesh::DofObject::old_dof_object

inherited

This object on the last mesh.

Useful for projecting solutions from one mesh to another.

Definition at line 81 of file dof_object.h.

Referenced by libMesh::OldSolutionBase< Output, point_output >::check_old_context(), libMesh::DofObject::clear_old_dof_object(), libMesh::OldSolutionCoefs< Output, point_output >::eval_at_node(), libMesh::OldSolutionValue< Output, point_output >::eval_at_node(), libMesh::OldSolutionCoefs< Output, point_output >::eval_old_dofs(), libMesh::OldSolutionValue< Output, point_output >::eval_old_dofs(), libMesh::DofMap::old_dof_indices(), libMesh::BuildProjectionList::operator()(), libMesh::DofObject::operator=(), libMesh::DofObject::pack_indexing(), libMesh::DofObject::packed_indexing_size(), libMesh::DofObject::set_old_dof_object(), and libMesh::DofObject::unpack_indexing().

The documentation for this class was generated from the following files:

include/geom/node.h
src/geom/node.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Counts [1/2]

◆ Counts [2/2]

◆ index_buffer_t

◆ index_t

◆ index_type

◆ valence_idx_t

◆ value_type

Constructor & Destructor Documentation

◆ Node() [1/4]

◆ Node() [2/4]

◆ Node() [3/4]

◆ Node() [4/4]

◆ ~Node()

Member Function Documentation

◆ absolute_fuzzy_equals()

◆ active()

◆ add()

◆ add_extra_integers()

◆ add_scaled()

◆ add_system()

◆ assign()

◆ build() [1/3]

◆ build() [2/3]

◆ build() [3/3]

◆ choose_processor_id()

◆ clear_dofs()

◆ clear_old_dof_object()

◆ contract()

◆ cross()

◆ debug_buffer()

◆ disable_print_counter_info() [1/2]

◆ disable_print_counter_info() [2/2]

◆ dof_number() [1/2]

◆ dof_number() [2/2]

◆ enable_print_counter_info() [1/2]

◆ enable_print_counter_info() [2/2]

◆ end_idx()

◆ end_idx_ints()

◆ get_extra_datum()

◆ get_extra_integer()

◆ get_info() [1/3]

◆ get_info() [2/3]

◆ get_info() [3/3]

◆ has_dofs()

◆ has_extra_integers()

◆ id()

◆ increment_constructor_count() [1/2]

◆ increment_constructor_count() [2/2]

◆ increment_destructor_count() [1/2]

◆ increment_destructor_count() [2/2]

◆ invalidate()

◆ invalidate_dofs()

◆ invalidate_id()

◆ invalidate_processor_id()

◆ is_zero()

◆ n_comp()

◆ n_comp_group()

◆ n_dofs()

◆ n_extra_integers()

◆ n_objects() [1/2]

◆ n_objects() [2/2]

◆ n_pseudo_systems()

◆ n_systems()

◆ n_var_groups()