In parallel meshes where a ghost element has neighbors which do not exist on the local processor, the ghost element's neighbors are set to point to the singleton RemoteElement instead. More...

#include <remote_elem.h>

Inheritance diagram for libMesh::RemoteElem:

[legend]

Public Types
enum	RefinementState { COARSEN = 0, DO_NOTHING, REFINE, JUST_REFINED, JUST_COARSENED, INACTIVE, COARSEN_INACTIVE, INVALID_REFINEMENTSTATE }
	Enumeration of possible element refinement states. More...

typedef Elem const	NeighborPtrIter
	Nested "classes" for use iterating over all neighbors of an element. More...

typedef Predicates::multi_predicate	Predicate
	Useful iterator typedefs. More...

Public Member Functions
	RemoteElem (RemoteElem &&)=delete

	RemoteElem (const RemoteElem &)=delete

RemoteElem &	operator= (const RemoteElem &)=delete

RemoteElem &	operator= (RemoteElem &&)=delete

virtual	~RemoteElem ()
	Sets remote_elem to nullptr. More...

virtual Point	master_point (const unsigned int) const override

virtual Node *&	set_node (const unsigned int i) override

virtual dof_id_type	key (const unsigned int) const override

virtual unsigned int	which_node_am_i (unsigned int, unsigned int) const override

virtual bool	is_remote () const override

virtual void	connectivity (const unsigned int, const IOPackage, std::vector< dof_id_type > &) const override

virtual ElemType	type () const override

virtual unsigned short	dim () const override

virtual unsigned int	n_nodes () const override

virtual unsigned int	n_sides () const override

virtual unsigned int	n_vertices () const override

virtual unsigned int	n_edges () const override

virtual unsigned int	n_faces () const override

virtual unsigned int	n_children () const override

virtual bool	is_vertex (const unsigned int) const override

virtual bool	is_edge (const unsigned int) const override

virtual bool	is_face (const unsigned int) const override

virtual bool	is_node_on_side (const unsigned int, const unsigned int) const override

virtual std::vector< unsigned int >	nodes_on_side (const unsigned int) const override

virtual bool	is_child_on_side (const unsigned int, const unsigned int) const override

virtual bool	is_edge_on_side (const unsigned int, const unsigned int) const override

virtual bool	is_node_on_edge (const unsigned int, const unsigned int) const override

virtual unsigned int	n_sub_elem () const override

virtual std::unique_ptr< Elem >	side_ptr (const unsigned int) override

virtual void	side_ptr (std::unique_ptr< Elem > &, const unsigned int) override
	Resets the loose element `side`, which may currently point to a different side than `i` or even a different element than `this`, to point to side `i` on `this`. More...

virtual std::unique_ptr< Elem >	build_side_ptr (const unsigned int, bool) override

virtual void	build_side_ptr (std::unique_ptr< Elem > &, const unsigned int) override
	Resets the loose element `side`, which may currently point to a different side than `i` or even a different element than `this`, to point to side `i` on `this`. More...

virtual std::unique_ptr< Elem >	build_edge_ptr (const unsigned int) override

virtual Order	default_order () const override

virtual bool	infinite () const override

virtual float	embedding_matrix (const unsigned int, const unsigned int, const unsigned int) const override
	Matrix that transforms the parents nodes into the children's nodes. More...

virtual dof_id_type	key (const unsigned int s) const=0
	Don't hide Elem::key() defined in the base class. More...

virtual dof_id_type	key () const
	Don't hide Elem::key() defined in the base class. More...

const Point &	point (const unsigned int i) const

Point &	point (const unsigned int i)

dof_id_type	node_id (const unsigned int i) const

unsigned int	local_node (const dof_id_type i) const

unsigned int	get_node_index (const Node *node_ptr) const

const Node const	get_nodes () const

const Node *	node_ptr (const unsigned int i) const

Node *	node_ptr (const unsigned int i)

const Node &	node_ref (const unsigned int i) const

Node &	node_ref (const unsigned int i)

SimpleRange< NodeRefIter >	node_ref_range ()
	Returns a range with all nodes of an element, usable in range-based for loops. More...

SimpleRange< ConstNodeRefIter >	node_ref_range () const

subdomain_id_type	subdomain_id () const

subdomain_id_type &	subdomain_id ()

const Elem *	reference_elem () const

virtual dof_id_type	key () const

bool	operator== (const Elem &rhs) const

const Elem *	neighbor_ptr (unsigned int i) const

Elem *	neighbor_ptr (unsigned int i)

SimpleRange< NeighborPtrIter >	neighbor_ptr_range ()
	Returns a range with all neighbors of an element, usable in range-based for loops. More...

SimpleRange< ConstNeighborPtrIter >	neighbor_ptr_range () const

const Elem *	topological_neighbor (const unsigned int i, const MeshBase &mesh, const PointLocatorBase &point_locator, const PeriodicBoundaries *pb) const

Elem *	topological_neighbor (const unsigned int i, MeshBase &mesh, const PointLocatorBase &point_locator, const PeriodicBoundaries *pb)

bool	has_topological_neighbor (const Elem elem, const MeshBase &mesh, const PointLocatorBase &point_locator, const PeriodicBoundaries pb) const

void	set_neighbor (const unsigned int i, Elem *n)
	Assigns `n` as the \( i^{th} \) neighbor. More...

bool	has_neighbor (const Elem *elem) const

Elem *	child_neighbor (Elem *elem)

const Elem *	child_neighbor (const Elem *elem) const

bool	on_boundary () const

bool	is_semilocal (const processor_id_type my_pid) const

unsigned int	which_neighbor_am_i (const Elem *e) const
	This function tells you which neighbor `e` is. More...

unsigned int	which_side_am_i (const Elem *e) const
	This function tells you which side the boundary element `e` is. More...

bool	contains_vertex_of (const Elem *e) const

bool	contains_edge_of (const Elem *e) const

void	find_point_neighbors (const Point &p, std::set< const Elem * > &neighbor_set) const
	This function finds all active elements (including this one) which are in the same manifold as this element and which touch the current active element at the specified point, which should be a point in the current element. More...

void	find_point_neighbors (std::set< const Elem * > &neighbor_set) const
	This function finds all active elements (including this one) in the same manifold as this element which touch this active element at any point. More...

void	find_point_neighbors (std::set< const Elem * > &neighbor_set, const Elem *start_elem) const
	This function finds all active elements (including this one) in the same manifold as start_elem (which must be active and must touch this element) which touch this element at any point. More...

void	find_point_neighbors (std::set< Elem * > &neighbor_set, Elem *start_elem)
	Non-const version of function above. More...

void	find_edge_neighbors (const Point &p1, const Point &p2, std::set< const Elem * > &neighbor_set) const
	This function finds all active elements in the same manifold as this element which touch the current active element along the whole edge defined by the two points `p1` and `p2`. More...

void	find_edge_neighbors (std::set< const Elem * > &neighbor_set) const
	This function finds all active elements in the same manifold as this element which touch the current active element along any edge (more precisely, at at least two points). More...

void	find_interior_neighbors (std::set< const Elem * > &neighbor_set) const
	This function finds all active elements (not including this one) in the parent manifold of this element whose intersection with this element has non-zero measure. More...

void	find_interior_neighbors (std::set< Elem * > &neighbor_set)
	Non-const version of function above that fills up a vector of non-const Elem pointers instead. More...

void	remove_links_to_me ()
	Resets this element's neighbors' appropriate neighbor pointers and its parent's and children's appropriate pointers to point to null instead of to this. More...

void	make_links_to_me_remote ()
	Resets this element's neighbors' appropriate neighbor pointers and its parent's and children's appropriate pointers to point to the global remote_elem instead of this. More...

void	make_links_to_me_local (unsigned int n, unsigned int neighbor_side)
	Resets the `neighbor_side` pointers of our nth neighbor (and its descendants, if appropriate) to point to this Elem instead of to the global remote_elem. More...

void	write_connectivity (std::ostream &out, const IOPackage iop) const
	Writes the element connectivity for various IO packages to the passed ostream "out". More...

IntRange< unsigned short >	node_index_range () const

virtual unsigned int	n_nodes_in_child (unsigned int) const

IntRange< unsigned short >	side_index_range () const

unsigned int	n_neighbors () const

IntRange< unsigned short >	edge_index_range () const

virtual unsigned int	is_vertex_on_child (unsigned int, unsigned int n) const

virtual bool	is_vertex_on_parent (unsigned int c, unsigned int n) const

virtual unsigned int	opposite_side (const unsigned int s) const

virtual unsigned int	opposite_node (const unsigned int n, const unsigned int s) const

std::unique_ptr< const Elem >	side_ptr (unsigned int i) const

void	side_ptr (std::unique_ptr< const Elem > &side, const unsigned int i) const

std::unique_ptr< const Elem >	build_side_ptr (const unsigned int i, bool proxy=true) const

void	build_side_ptr (std::unique_ptr< const Elem > &side, const unsigned int i) const

std::unique_ptr< const Elem >	build_edge_ptr (const unsigned int i) const

virtual Point	centroid () const

virtual Real	hmin () const

virtual Real	hmax () const

virtual Real	volume () const

virtual BoundingBox	loose_bounding_box () const

virtual Real	quality (const ElemQuality q) const

virtual std::pair< Real, Real >	qual_bounds (const ElemQuality) const

virtual bool	contains_point (const Point &p, Real tol=TOLERANCE) const

virtual bool	close_to_point (const Point &p, Real tol) const

virtual bool	has_affine_map () const

virtual bool	is_linear () const

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

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

bool	active () const

bool	ancestor () const

bool	subactive () const

bool	has_children () const

bool	has_ancestor_children () const

bool	is_ancestor_of (const Elem *descendant) const

const Elem *	parent () const

Elem *	parent ()

void	set_parent (Elem *p)
	Sets the pointer to the element's parent. More...

const Elem *	top_parent () const

const Elem *	interior_parent () const

Elem *	interior_parent ()

void	set_interior_parent (Elem *p)
	Sets the pointer to the element's interior_parent. More...

Real	length (const unsigned int n1, const unsigned int n2) const

virtual unsigned int	n_second_order_adjacent_vertices (const unsigned int n) const

virtual unsigned short int	second_order_adjacent_vertex (const unsigned int n, const unsigned int v) const

virtual std::pair< unsigned short int, unsigned short int >	second_order_child_vertex (const unsigned int n) const

unsigned int	level () const

unsigned int	p_level () const

ElemMappingType	mapping_type () const

void	set_mapping_type (const ElemMappingType type)
	Sets the value of the mapping type for the element. More...

unsigned char	mapping_data () const

void	set_mapping_data (const unsigned char data)
	Sets the value of the mapping data for the element. More...

const Elem *	raw_child_ptr (unsigned int i) const

const Elem *	child_ptr (unsigned int i) const

Elem *	child_ptr (unsigned int i)

SimpleRange< ChildRefIter >	child_ref_range ()
	Returns a range with all children of a parent element, usable in range-based for loops. More...

SimpleRange< ConstChildRefIter >	child_ref_range () const

unsigned int	which_child_am_i (const Elem *e) const

virtual bool	is_child_on_edge (const unsigned int c, const unsigned int e) const

void	add_child (Elem *elem)
	Adds a child pointer to the array of children of this element. More...

void	add_child (Elem *elem, unsigned int c)
	Adds a new child pointer to the specified index in the array of children of this element. More...

void	replace_child (Elem *elem, unsigned int c)
	Replaces the child pointer at the specified index in the child array. More...

void	family_tree (std::vector< const Elem * > &family, bool reset=true) const
	Fills the vector `family` with the children of this element, recursively. More...

void	family_tree (std::vector< Elem * > &family, bool reset=true)
	Non-const version of function above; fills a vector of non-const pointers. More...

void	total_family_tree (std::vector< const Elem * > &family, bool reset=true) const
	Same as the `family_tree()` member, but also adds any subactive descendants. More...

void	total_family_tree (std::vector< Elem * > &family, bool reset=true)
	Non-const version of function above; fills a vector of non-const pointers. More...

void	active_family_tree (std::vector< const Elem * > &active_family, bool reset=true) const
	Same as the `family_tree()` member, but only adds the active children. More...

void	active_family_tree (std::vector< Elem * > &active_family, bool reset=true)
	Non-const version of function above; fills a vector of non-const pointers. More...

void	family_tree_by_side (std::vector< const Elem * > &family, unsigned int side, bool reset=true) const
	Same as the `family_tree()` member, but only adds elements which are next to `side`. More...

void	family_tree_by_side (std::vector< Elem * > &family, unsigned int side, bool reset=true)
	Non-const version of function above; fills a vector of non-const pointers. More...

void	active_family_tree_by_side (std::vector< const Elem * > &family, unsigned int side, bool reset=true) const
	Same as the `active_family_tree()` member, but only adds elements which are next to `side`. More...

void	active_family_tree_by_side (std::vector< Elem * > &family, unsigned int side, bool reset=true)
	Non-const version of function above; fills a vector of non-const pointers. More...

void	family_tree_by_neighbor (std::vector< const Elem * > &family, const Elem *neighbor, bool reset=true) const
	Same as the `family_tree()` member, but only adds elements which are next to `neighbor`. More...

void	family_tree_by_neighbor (std::vector< Elem * > &family, Elem *neighbor, bool reset=true)
	Non-const version of function above; fills a vector of non-const pointers. More...

void	total_family_tree_by_neighbor (std::vector< const Elem * > &family, const Elem *neighbor, bool reset=true) const
	Same as the `family_tree_by_neighbor()` member, but also adds any subactive descendants. More...

void	total_family_tree_by_neighbor (std::vector< Elem * > &family, Elem *neighbor, bool reset=true)
	Non-const version of function above; fills a vector of non-const pointers. More...

void	family_tree_by_subneighbor (std::vector< const Elem * > &family, const Elem neighbor, const Elem subneighbor, bool reset=true) const
	Same as the `family_tree()` member, but only adds elements which are next to `subneighbor`. More...

void	family_tree_by_subneighbor (std::vector< Elem * > &family, Elem neighbor, Elem subneighbor, bool reset=true)
	Non-const version of function above; fills a vector of non-const pointers. More...

void	total_family_tree_by_subneighbor (std::vector< const Elem * > &family, const Elem neighbor, const Elem subneighbor, bool reset=true) const
	Same as the `family_tree_by_subneighbor()` member, but also adds any subactive descendants. More...

void	total_family_tree_by_subneighbor (std::vector< Elem * > &family, Elem neighbor, Elem subneighbor, bool reset=true)
	Non-const version of function above; fills a vector of non-const pointers. More...

void	active_family_tree_by_neighbor (std::vector< const Elem * > &family, const Elem *neighbor, bool reset=true) const
	Same as the `active_family_tree()` member, but only adds elements which are next to `neighbor`. More...

void	active_family_tree_by_neighbor (std::vector< Elem * > &family, Elem *neighbor, bool reset=true)
	Non-const version of function above; fills a vector of non-const pointers. More...

void	active_family_tree_by_topological_neighbor (std::vector< const Elem * > &family, const Elem neighbor, const MeshBase &mesh, const PointLocatorBase &point_locator, const PeriodicBoundaries pb, bool reset=true) const
	Same as the `active_family_tree_by_neighbor()` member, but the `neighbor` here may be a topological (e.g. More...

void	active_family_tree_by_topological_neighbor (std::vector< Elem * > &family, Elem neighbor, const MeshBase &mesh, const PointLocatorBase &point_locator, const PeriodicBoundaries pb, bool reset=true)
	Non-const version of function above; fills a vector of non-const pointers. More...

RefinementState	refinement_flag () const

void	set_refinement_flag (const RefinementState rflag)
	Sets the value of the refinement flag for the element. More...

RefinementState	p_refinement_flag () const

void	set_p_refinement_flag (const RefinementState pflag)
	Sets the value of the p-refinement flag for the element. More...

unsigned int	max_descendant_p_level () const

unsigned int	min_p_level_by_neighbor (const Elem *neighbor, unsigned int current_min) const

unsigned int	min_new_p_level_by_neighbor (const Elem *neighbor, unsigned int current_min) const

void	set_p_level (const unsigned int p)
	Sets the value of the p-refinement level for the element. More...

void	hack_p_level (const unsigned int p)
	Sets the value of the p-refinement level for the element without altering the p-level of its ancestors. More...

virtual void	refine (MeshRefinement &mesh_refinement)
	Refine the element. More...

void	coarsen ()
	Coarsen the element. More...

void	contract ()
	Contract an active element, i.e. More...

void	libmesh_assert_valid_neighbors () const
	Checks for consistent neighbor links on this element. More...

void	libmesh_assert_valid_node_pointers () const
	Checks for a valid id and pointers to nodes with valid ids on this element. More...

side_iterator	boundary_sides_begin ()
	Iterator accessor functions. More...

side_iterator	boundary_sides_end ()

virtual bool	is_mid_infinite_edge_node (const unsigned int) const

virtual Point	origin () const

virtual unsigned int	as_parent_node (unsigned int c, unsigned int n) const

virtual const std::vector< std::pair< unsigned char, unsigned char > > &	parent_bracketing_nodes (unsigned int c, unsigned int n) const

virtual const std::vector< std::pair< dof_id_type, dof_id_type > >	bracketing_nodes (unsigned int c, unsigned int n) const

virtual unsigned int	embedding_matrix_version () const

void	nullify_neighbors ()
	Replaces this element with `nullptr` for all of its neighbors. 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 const Elem &	create ()
	Return a reference to the global `RemoteElem` singleton object. More...

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

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

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

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

static ElemType	second_order_equivalent_type (const ElemType et, const bool full_ordered=true)

static ElemType	first_order_equivalent_type (const ElemType et)

static std::unique_ptr< Elem >	build (const ElemType type, Elem *p=nullptr)

static unsigned int	n_objects ()
	Prints the number of outstanding (created, but not yet destroyed) objects. 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	enable_print_counter_info ()
	Methods to enable/disable the reference counter output from print_info() More...

static void	disable_print_counter_info ()

static void	disable_print_counter_info ()

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 void	setup ()
	Setup function. More...

static void	cleanup ()
	Cleanup function. More...

Public Attributes
	LIBMESH_ENABLE_TOPOLOGY_CACHES

const typedef Elem const	ConstNeighborPtrIter

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

Static Public Attributes
static const dof_id_type	remote_elem_id = static_cast<dof_id_type>(-2)
	A unique `id` to distinguish remote element links. More...

static const subdomain_id_type	invalid_subdomain_id = std::numeric_limits<subdomain_id_type>::max()
	A static integral constant representing an invalid subdomain id. More...

static const unsigned int	type_to_n_nodes_map [INVALID_ELEM]
	This array maps the integer representation of the `ElemType` enum to the number of nodes in the element. More...

static const unsigned int	max_n_nodes = 27
	The maximum number of nodes any element can contain. More...

static const unsigned int	type_to_n_sides_map [INVALID_ELEM]
	This array maps the integer representation of the `ElemType` enum to the number of sides on the element. More...

static const unsigned int	type_to_n_edges_map [INVALID_ELEM]
	This array maps the integer representation of the `ElemType` enum to the number of edges on the element. More...

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
template<typename Subclass >
void	simple_build_side_ptr (std::unique_ptr< Elem > &side, const unsigned int i, ElemType sidetype)
	An implementation for simple (all sides equal) elements. More...

template<typename Subclass , typename Mapclass >
void	simple_side_ptr (std::unique_ptr< Elem > &side, const unsigned int i, ElemType sidetype)
	An implementation for simple (all sides equal) elements. More...

virtual std::vector< std::vector< std::vector< std::vector< std::pair< unsigned char, unsigned char > > > > > &	_get_bracketing_node_cache () const
	Elem subclasses which don't do their own bracketing node calculations will need to supply a static cache, since the default calculation is slow. More...

virtual std::vector< std::vector< std::vector< signed char > > > &	_get_parent_indices_cache () const
	Elem subclasses which don't do their own child-to-parent node calculations will need to supply a static cache, since the default calculation is slow. More...

void	increment_constructor_count (const std::string &name)
	Increments the construction 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...

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

Static Protected Member Functions
static dof_id_type	compute_key (dof_id_type n0)

static dof_id_type	compute_key (dof_id_type n0, dof_id_type n1)

static dof_id_type	compute_key (dof_id_type n0, dof_id_type n1, dof_id_type n2)

static dof_id_type	compute_key (dof_id_type n0, dof_id_type n1, dof_id_type n2, dof_id_type n3)

Protected Attributes
Elem *	_elemlinks_data [1]
	Data for link to (nullptr!) parent. More...

Node **	_nodes
	Pointers to the nodes we are connected to. More...

Elem **	_elemlinks
	Pointers to this element's parent and neighbors, and for lower-dimensional elements' interior_parent. More...

Elem **	_children
	Pointers to this element's children. More...

subdomain_id_type	_sbd_id
	The subdomain to which this element belongs. More...

unsigned char	_rflag
	h refinement flag. More...

unsigned char	_pflag
	p refinement flag. More...

unsigned char	_p_level
	p refinement level - the difference between the polynomial degree on this element and the minimum polynomial degree on the mesh. More...

unsigned char	_map_type
	Mapping function type; currently either 0 (LAGRANGE) or 1 (RATIONAL_BERNSTEIN). More...

unsigned char	_map_data
	Mapping function data; currently used when needed to store the RATIONAL_BERNSTEIN nodal weight data index. More...

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

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

static Threads::atomic< unsigned int >	_n_objects
	The number of objects. 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 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 bool	_enable_print_counter = true
	Flag to control whether reference count information is printed when print_info is called. More...

Private Types
typedef dof_id_type	index_t
	DoF index information. More...

typedef std::vector< index_t >	index_buffer_t

Private Member Functions
	RemoteElem ()
	Constructor. More...

bool	point_test (const Point &p, Real box_tol, Real map_tol) const
	Shared private implementation used by the contains_point() and close_to_point() routines. More...

void	set_child (unsigned int c, Elem *elem)
	Sets the pointer to the \( i^{th} \) child for this element. More...

SideIter	_first_side ()
	Side iterator helper functions. More...

SideIter	_last_side ()

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
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

Detailed Description

In parallel meshes where a ghost element has neighbors which do not exist on the local processor, the ghost element's neighbors are set to point to the singleton RemoteElement instead.

Library code can then distinguish between such elements and boundary elements (with nullptr neighbors).

Author: Roy H. Stogner

Date: 2007

Used by ParallelMesh to represent an Elem owned by another processor.

Definition at line 44 of file remote_elem.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.

◆ NeighborPtrIter

typedef Elem* const * libMesh::Elem::NeighborPtrIter

inherited

Nested "classes" for use iterating over all neighbors of an element.

Definition at line 298 of file elem.h.

◆ Predicate

typedef Predicates::multi_predicate libMesh::Elem::Predicate

inherited

Useful iterator typedefs.

Definition at line 1539 of file elem.h.

Member Enumeration Documentation

◆ RefinementState

enum libMesh::Elem::RefinementState

inherited

Enumeration of possible element refinement states.

Enumerator
COARSEN
DO_NOTHING
REFINE
JUST_REFINED
JUST_COARSENED
INACTIVE
COARSEN_INACTIVE
INVALID_REFINEMENTSTATE

Definition at line 1169 of file elem.h.

                        { COARSEN = 0,
                          DO_NOTHING,
                          REFINE,
                          JUST_REFINED,
                          JUST_COARSENED,
                          INACTIVE,
                          COARSEN_INACTIVE,
                          INVALID_REFINEMENTSTATE };

Constructor & Destructor Documentation

◆ RemoteElem() [1/3]

libMesh::RemoteElem::RemoteElem ( )

inlineprivate

Constructor.

Private to force use of the create() member.

Definition at line 58 of file remote_elem.h.

                 : Elem(0,
                        0,
                        nullptr,
                        _elemlinks_data,
                        nullptr)
   { this->set_id(remote_elem_id); }

References libMesh::DofObject::set_id().

Referenced by create().

◆ RemoteElem() [2/3]

libMesh::RemoteElem::RemoteElem ( RemoteElem && )

delete

◆ RemoteElem() [3/3]

libMesh::RemoteElem::RemoteElem ( const RemoteElem & )

delete

◆ ~RemoteElem()

libMesh::RemoteElem::~RemoteElem ( )

virtual

Sets remote_elem to nullptr.

Definition at line 60 of file remote_elem.C.

 {
   RemoteElemMutex::scoped_lock lock(remote_elem_mtx);
  
   remote_elem = nullptr;
 }

References libMesh::remote_elem.

Member Function Documentation

◆ _first_side()

Elem::SideIter libMesh::Elem::_first_side ( )

inlineprivateinherited

Side iterator helper functions.

Used to replace the begin() and end() functions of the STL containers.

Definition at line 2884 of file elem.h.

 {
   return SideIter(0, this);
 }

Referenced by libMesh::Elem::boundary_sides_begin().

◆ _get_bracketing_node_cache()

virtual std::vector<std::vector<std::vector<std::vector<std::pair<unsigned char, unsigned char> > > > >& libMesh::Elem::_get_bracketing_node_cache ( ) const

inlineprotectedvirtualinherited

Elem subclasses which don't do their own bracketing node calculations will need to supply a static cache, since the default calculation is slow.

Definition at line 1707 of file elem.h.

   {
     static std::vector<std::vector<std::vector<std::vector<std::pair<unsigned char, unsigned char>>>>> c;
     libmesh_error();
     return c;
   }

Referenced by libMesh::Elem::parent_bracketing_nodes().

◆ _get_parent_indices_cache()

virtual std::vector<std::vector<std::vector<signed char> > >& libMesh::Elem::_get_parent_indices_cache ( ) const

inlineprotectedvirtualinherited

Elem subclasses which don't do their own child-to-parent node calculations will need to supply a static cache, since the default calculation is slow.

Definition at line 1721 of file elem.h.

   {
     static std::vector<std::vector<std::vector<signed char>>> c;
     libmesh_error();
     return c;
   }

Referenced by libMesh::Elem::as_parent_node().

◆ _last_side()

Elem::SideIter libMesh::Elem::_last_side ( )

inlineprivateinherited

Definition at line 2892 of file elem.h.

 {
   return SideIter(this->n_neighbors(), this);
 }

References libMesh::Elem::n_neighbors().

Referenced by libMesh::Elem::boundary_sides_begin(), and libMesh::Elem::boundary_sides_end().

◆ active()

bool libMesh::Elem::active ( ) const

inlineinherited

Returns: true if the element is active (i.e. has no active descendants) or AMR is disabled, false otherwise.

Note: It suffices to check the first child only.

Definition at line 2345 of file elem.h.

 {
 #ifdef LIBMESH_ENABLE_AMR
   if ((this->refinement_flag() == INACTIVE) ||
       (this->refinement_flag() == COARSEN_INACTIVE))
     return false;
   else
     return true;
 #else
   return true;
 #endif
 }

References libMesh::Elem::COARSEN_INACTIVE, libMesh::Elem::INACTIVE, and libMesh::Elem::refinement_flag().

Referenced by libMesh::DofMap::_dof_indices(), libMesh::DofMap::_node_dof_indices(), libMesh::HPCoarsenTest::add_projection(), libMesh::Elem::ancestor(), assemble_ellipticdg(), libMesh::Patch::build_around_element(), libMesh::Elem::coarsen(), compute_jacobian(), libMesh::FEGenericBase< FEOutputType< T >::type >::compute_periodic_constraints(), libMesh::FEAbstract::compute_periodic_node_constraints(), libMesh::FEGenericBase< FEOutputType< T >::type >::compute_proj_constraints(), compute_residual(), libMesh::connect_families(), libMesh::UnstructuredMesh::contract(), libMesh::Elem::contract(), libMesh::DofMap::dof_indices(), libMesh::JumpErrorEstimator::estimate_error(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::SubFunctor::find_dofs_to_send(), libMesh::UnstructuredMesh::find_neighbors(), libMesh::Elem::find_point_neighbors(), libMesh::ReplicatedMesh::get_disconnected_subdomains(), libMesh::Elem::get_info(), libMesh::ErrorVector::is_active_elem(), libMesh::DistributedMesh::libmesh_assert_valid_parallel_flags(), libMesh::DistributedMesh::libmesh_assert_valid_parallel_p_levels(), libMesh::MeshRefinement::make_coarsening_compatible(), libMesh::Elem::make_links_to_me_local(), libMesh::MeshRefinement::make_refinement_compatible(), libMesh::Elem::max_descendant_p_level(), libMesh::Elem::min_new_p_level_by_neighbor(), libMesh::Elem::min_p_level_by_neighbor(), libMesh::DofMap::old_dof_indices(), libMesh::PointLocatorTree::operator()(), libMesh::Elem::refine(), libMesh::Elem::subactive(), libMesh::Parallel::sync_element_data_by_parent_id(), libMesh::MeshRefinement::test_level_one(), EquationSystemsTest::testRefineThenReinitPreserveFlags(), and libMesh::Parallel::Packing< Elem * >::unpack().

◆ active_family_tree() [1/2]

void libMesh::Elem::active_family_tree	(	std::vector< const Elem * > &	active_family,
		bool	reset = `true`
	)		const

inherited

Same as the family_tree() member, but only adds the active children.

Can be thought of as removing all the inactive elements from the vector created by family_tree, but is implemented more efficiently.

Definition at line 1473 of file elem.C.

 {
   ElemInternal::active_family_tree(this, active_family, reset);
 }

References libMesh::ElemInternal::active_family_tree().

Referenced by libMesh::MeshCommunication::delete_remote_elements(), and libMesh::SiblingCoupling::operator()().

◆ active_family_tree() [2/2]

void libMesh::Elem::active_family_tree	(	std::vector< Elem * > &	active_family,
		bool	reset = `true`
	)

inherited

Non-const version of function above; fills a vector of non-const pointers.

Definition at line 1481 of file elem.C.

 {
   ElemInternal::active_family_tree(this, active_family, reset);
 }

References libMesh::ElemInternal::active_family_tree().

◆ active_family_tree_by_neighbor() [1/2]

void libMesh::Elem::active_family_tree_by_neighbor	(	std::vector< const Elem * > &	family,
		const Elem *	neighbor,
		bool	reset = `true`
	)		const

inherited

Same as the active_family_tree() member, but only adds elements which are next to neighbor.

Definition at line 1601 of file elem.C.

 {
   ElemInternal::active_family_tree_by_neighbor(this, family, neighbor, reset);
 }

References libMesh::ElemInternal::active_family_tree_by_neighbor().

Referenced by libMesh::DefaultCoupling::operator()().

◆ active_family_tree_by_neighbor() [2/2]

void libMesh::Elem::active_family_tree_by_neighbor	(	std::vector< Elem * > &	family,
		Elem *	neighbor,
		bool	reset = `true`
	)

inherited

Non-const version of function above; fills a vector of non-const pointers.

Definition at line 1610 of file elem.C.

 {
   ElemInternal::active_family_tree_by_neighbor(this, family, neighbor, reset);
 }

References libMesh::ElemInternal::active_family_tree_by_neighbor().

◆ active_family_tree_by_side() [1/2]

void libMesh::Elem::active_family_tree_by_side	(	std::vector< const Elem * > &	family,
		unsigned int	side,
		bool	reset = `true`
	)		const

inherited

Same as the active_family_tree() member, but only adds elements which are next to side.

Definition at line 1507 of file elem.C.

 {
   ElemInternal::active_family_tree_by_side(this, family, side, reset);
 }

References libMesh::ElemInternal::active_family_tree_by_side().

Referenced by libMesh::Nemesis_IO_Helper::write_sidesets().

◆ active_family_tree_by_side() [2/2]

void libMesh::Elem::active_family_tree_by_side	(	std::vector< Elem * > &	family,
		unsigned int	side,
		bool	reset = `true`
	)

inherited

Non-const version of function above; fills a vector of non-const pointers.

Definition at line 1516 of file elem.C.

 {
   ElemInternal::active_family_tree_by_side(this, family, side, reset);
 }

References libMesh::ElemInternal::active_family_tree_by_side().

◆ active_family_tree_by_topological_neighbor() [1/2]

void libMesh::Elem::active_family_tree_by_topological_neighbor	(	std::vector< const Elem * > &	family,
		const Elem *	neighbor,
		const MeshBase &	mesh,
		const PointLocatorBase &	point_locator,
		const PeriodicBoundaries *	pb,
		bool	reset = `true`
	)		const

inherited

Same as the active_family_tree_by_neighbor() member, but the neighbor here may be a topological (e.g.

periodic boundary condition) neighbor, not just a local neighbor.

Definition at line 1619 of file elem.C.

 {
   ElemInternal::active_family_tree_by_topological_neighbor(this, family, neighbor,
                                                            mesh, point_locator, pb,
                                                            reset);
 }

References libMesh::ElemInternal::active_family_tree_by_topological_neighbor(), and mesh.

Referenced by libMesh::DefaultCoupling::operator()().

◆ active_family_tree_by_topological_neighbor() [2/2]

void libMesh::Elem::active_family_tree_by_topological_neighbor	(	std::vector< Elem * > &	family,
		Elem *	neighbor,
		const MeshBase &	mesh,
		const PointLocatorBase &	point_locator,
		const PeriodicBoundaries *	pb,
		bool	reset = `true`
	)

inherited

Non-const version of function above; fills a vector of non-const pointers.

Definition at line 1633 of file elem.C.

 {
   ElemInternal::active_family_tree_by_topological_neighbor(this, family, neighbor,
                                                            mesh, point_locator, pb,
                                                            reset);
 }

References libMesh::ElemInternal::active_family_tree_by_topological_neighbor(), and mesh.

◆ add_child() [1/2]

void libMesh::Elem::add_child ( Elem * elem )

inherited

Adds a child pointer to the array of children of this element.

If this is the first child to be added, this method allocates memory in the parent's _children array, otherwise, it just sets the pointer.

Definition at line 1384 of file elem.C.

 {
   const unsigned int nc = this->n_children();
  
   if (_children == nullptr)
     {
       _children = new Elem *[nc];
  
       for (unsigned int c = 0; c != nc; c++)
         this->set_child(c, nullptr);
     }
  
   for (unsigned int c = 0; c != nc; c++)
     {
       if (this->_children[c] == nullptr || this->_children[c] == remote_elem)
         {
           libmesh_assert_equal_to (this, elem->parent());
           this->set_child(c, elem);
           return;
         }
     }
  
   libmesh_error_msg("Error: Tried to add a child to an element with full children array");
 }

References libMesh::Elem::_children, libMesh::Elem::n_children(), libMesh::Elem::parent(), libMesh::remote_elem, and libMesh::Elem::set_child().

Referenced by libMesh::UnstructuredMesh::all_first_order(), libMesh::UnstructuredMesh::copy_nodes_and_elements(), libMesh::CheckpointIO::read_connectivity(), libMesh::CheckpointIO::read_remote_elem(), libMesh::XdrIO::read_serialized_connectivity(), and libMesh::Parallel::Packing< Elem * >::unpack().

◆ add_child() [2/2]

void libMesh::Elem::add_child	(	Elem *	elem,
		unsigned int	c
	)

inherited

Adds a new child pointer to the specified index in the array of children of this element.

If this is the first child to be added, this method allocates memory in the parent's _children array, otherwise, it just sets the pointer.

Definition at line 1411 of file elem.C.

 {
   if (!this->has_children())
     {
       const unsigned int nc = this->n_children();
       _children = new Elem *[nc];
  
       for (unsigned int i = 0; i != nc; i++)
         this->set_child(i, nullptr);
     }
  
   libmesh_assert (this->_children[c] == nullptr || this->child_ptr(c) == remote_elem);
   libmesh_assert (elem == remote_elem || this == elem->parent());
  
   this->set_child(c, elem);
 }

References libMesh::Elem::_children, libMesh::Elem::child_ptr(), libMesh::Elem::has_children(), libMesh::libmesh_assert(), libMesh::Elem::n_children(), libMesh::Elem::parent(), libMesh::remote_elem, and libMesh::Elem::set_child().

◆ 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_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().

◆ ancestor()

bool libMesh::Elem::ancestor ( ) const

inherited

Returns: true if the element is an ancestor (i.e. has an active child or ancestor child), false otherwise or when AMR is disabled.

Definition at line 1350 of file elem.C.

 {
 #ifdef LIBMESH_ENABLE_AMR
  
   // Use a fast, DistributedMesh-safe definition
   const bool is_ancestor =
     !this->active() && !this->subactive();
  
   // But check for inconsistencies if we have time
 #ifdef DEBUG
   if (!is_ancestor && this->has_children())
     {
       for (auto & c : this->child_ref_range())
         {
           if (&c != remote_elem)
             {
               libmesh_assert(!c.active());
               libmesh_assert(!c.ancestor());
             }
         }
     }
 #endif // DEBUG
  
   return is_ancestor;
  
 #else
   return false;
 #endif
 }

References libMesh::Elem::active(), libMesh::Elem::child_ref_range(), libMesh::Elem::has_children(), libMesh::libmesh_assert(), libMesh::remote_elem, and libMesh::Elem::subactive().

Referenced by libMesh::UnstructuredMesh::contract(), libMesh::UnstructuredMesh::find_neighbors(), libMesh::Elem::get_info(), and libMesh::Elem::refine().

◆ as_parent_node()

unsigned int libMesh::Elem::as_parent_node	(	unsigned int	c,
		unsigned int	n
	)		const

virtualinherited

Returns: The local node id on the parent which corresponds to node n of child c, or invalid_uint if no such parent node exists.

Definition at line 1726 of file elem.C.

 {
   const unsigned int nc = this->n_children();
   libmesh_assert_less(child, nc);
  
   // Cached return values, indexed first by embedding_matrix version,
   // then by child number, then by child node number.
   std::vector<std::vector<std::vector<signed char>>> &
     cached_parent_indices = this->_get_parent_indices_cache();
  
   unsigned int em_vers = this->embedding_matrix_version();
  
   // We may be updating the cache on one thread, and while that
   // happens we can't safely access the cache from other threads.
   Threads::spin_mutex::scoped_lock lock(parent_indices_mutex);
  
   if (em_vers >= cached_parent_indices.size())
     cached_parent_indices.resize(em_vers+1);
  
   if (child >= cached_parent_indices[em_vers].size())
     {
       const signed char nn = cast_int<signed char>(this->n_nodes());
  
       cached_parent_indices[em_vers].resize(nc);
  
       for (unsigned int c = 0; c != nc; ++c)
         {
           const unsigned int ncn = this->n_nodes_in_child(c);
           cached_parent_indices[em_vers][c].resize(ncn);
           for (unsigned int cn = 0; cn != ncn; ++cn)
             {
               for (signed char n = 0; n != nn; ++n)
                 {
                   const float em_val = this->embedding_matrix
                     (c, cn, n);
                   if (em_val == 1)
                     {
                       cached_parent_indices[em_vers][c][cn] = n;
                       break;
                     }
  
                   if (em_val != 0)
                     {
                       cached_parent_indices[em_vers][c][cn] =
                         -1;
                       break;
                     }
  
                   // We should never see an all-zero embedding matrix
                   // row
                   libmesh_assert_not_equal_to (n+1, nn);
                 }
             }
         }
     }
  
   const signed char cache_val =
     cached_parent_indices[em_vers][child][child_node];
   if (cache_val == -1)
     return libMesh::invalid_uint;
  
   return cached_parent_indices[em_vers][child][child_node];
 }

References libMesh::Elem::_get_parent_indices_cache(), libMesh::Elem::embedding_matrix(), libMesh::Elem::embedding_matrix_version(), libMesh::invalid_uint, libMesh::Elem::n_children(), libMesh::Elem::n_nodes(), libMesh::Elem::n_nodes_in_child(), and libMesh::parent_indices_mutex.

Referenced by libMesh::MeshRefinement::add_node(), and libMesh::Elem::parent_bracketing_nodes().

◆ boundary_sides_begin()

Elem::side_iterator libMesh::Elem::boundary_sides_begin ( )

inherited

Iterator accessor functions.

Definition at line 2599 of file elem.C.

 {
   Predicates::BoundarySide<SideIter> bsp;
   return side_iterator(this->_first_side(), this->_last_side(), bsp);
 }

References libMesh::Elem::_first_side(), and libMesh::Elem::_last_side().

◆ boundary_sides_end()

Elem::side_iterator libMesh::Elem::boundary_sides_end ( )

inherited

Definition at line 2608 of file elem.C.

 {
   Predicates::BoundarySide<SideIter> bsp;
   return side_iterator(this->_last_side(), this->_last_side(), bsp);
 }

References libMesh::Elem::_last_side().

◆ bracketing_nodes()

const std::vector< std::pair< dof_id_type, dof_id_type > > libMesh::Elem::bracketing_nodes	(	unsigned int	c,
		unsigned int	n
	)		const

virtualinherited

Returns: All the pairs of nodes (indexed by global node id) which should bracket node n of child c.

Definition at line 1999 of file elem.C.

 {
   std::vector<std::pair<dof_id_type, dof_id_type>> returnval;
  
   const std::vector<std::pair<unsigned char, unsigned char>> & pbc =
     this->parent_bracketing_nodes(child,child_node);
  
   for (const auto & pb : pbc)
     {
       const unsigned short n_n = this->n_nodes();
       if (pb.first < n_n && pb.second < n_n)
         returnval.push_back(std::make_pair(this->node_id(pb.first),
                                            this->node_id(pb.second)));
       else
         {
           // We must be on a non-full-order higher order element...
           libmesh_assert_not_equal_to(this->default_order(), FIRST);
           libmesh_assert_not_equal_to
             (second_order_equivalent_type (this->type(), true),
              this->type());
           libmesh_assert_equal_to
             (second_order_equivalent_type (this->type(), false),
              this->type());
  
           // And that's a shame, because this is a nasty search:
  
           // Build the full-order type
           ElemType full_type =
             second_order_equivalent_type(this->type(), /*full_ordered=*/ true);
           std::unique_ptr<Elem> full_elem = Elem::build(full_type);
  
           dof_id_type pt1 = DofObject::invalid_id;
           dof_id_type pt2 = DofObject::invalid_id;
  
           // Find the bracketing nodes by figuring out what
           // already-created children will have them.
  
           // This only doesn't break horribly because we add children
           // and nodes in straightforward + hierarchical orders...
           for (unsigned int c=0; c <= child; ++c)
             for (auto n : IntRange<unsigned int>(0, this->n_nodes_in_child(c)))
               {
                 if (c == child && n == child_node)
                   break;
  
                 if (pb.first == full_elem->as_parent_node(c,n))
                   {
                     // We should be consistent
                     if (pt1 != DofObject::invalid_id)
                       libmesh_assert_equal_to(pt1, this->child_ptr(c)->node_id(n));
  
                     pt1 = this->child_ptr(c)->node_id(n);
                   }
  
                 if (pb.second == full_elem->as_parent_node(c,n))
                   {
                     // We should be consistent
                     if (pt2 != DofObject::invalid_id)
                       libmesh_assert_equal_to(pt2, this->child_ptr(c)->node_id(n));
  
                     pt2 = this->child_ptr(c)->node_id(n);
                   }
               }
  
           // We should *usually* find all bracketing nodes by the time
           // we query them (again, because of the child & node add
           // order)
           //
           // The exception is if we're a HEX20, in which case we will
           // find pairs of vertex nodes and edge nodes bracketing the
           // new central node but we *won't* find the pairs of face
           // nodes which we would have had on a HEX27.  In that case
           // we'll still have enough bracketing nodes for a
           // topological lookup, but we won't be able to make the
           // following assertions.
           if (this->type() != HEX20)
             {
               libmesh_assert_not_equal_to (pt1, DofObject::invalid_id);
               libmesh_assert_not_equal_to (pt2, DofObject::invalid_id);
             }
  
           if (pt1 != DofObject::invalid_id &&
               pt2 != DofObject::invalid_id)
             returnval.push_back(std::make_pair(pt1, pt2));
         }
     }
  
   return returnval;
 }

References libMesh::Elem::build(), libMesh::Elem::child_ptr(), libMesh::Elem::default_order(), libMesh::FIRST, libMesh::HEX20, libMesh::DofObject::invalid_id, libMesh::Elem::n_nodes(), libMesh::Elem::n_nodes_in_child(), libMesh::Elem::node_id(), libMesh::Elem::parent_bracketing_nodes(), libMesh::Elem::second_order_equivalent_type(), and libMesh::Elem::type().

Referenced by libMesh::MeshRefinement::add_node(), and libMesh::TopologyMap::fill().

◆ build()

std::unique_ptr< Elem > libMesh::Elem::build	(	const ElemType	type,
		Elem *	p = `nullptr`
	)

staticinherited

Returns: An Elem of type type wrapped in a smart pointer.

Definition at line 246 of file elem.C.

 {
   switch (type)
     {
       // 0D elements
     case NODEELEM:
       return libmesh_make_unique<NodeElem>(p);
  
       // 1D elements
     case EDGE2:
       return libmesh_make_unique<Edge2>(p);
     case EDGE3:
       return libmesh_make_unique<Edge3>(p);
     case EDGE4:
       return libmesh_make_unique<Edge4>(p);
  
       // 2D elements
     case TRI3:
       return libmesh_make_unique<Tri3>(p);
     case TRISHELL3:
       return libmesh_make_unique<TriShell3>(p);
     case TRI3SUBDIVISION:
       return libmesh_make_unique<Tri3Subdivision>(p);
     case TRI6:
       return libmesh_make_unique<Tri6>(p);
     case QUAD4:
       return libmesh_make_unique<Quad4>(p);
     case QUADSHELL4:
       return libmesh_make_unique<QuadShell4>(p);
     case QUAD8:
       return libmesh_make_unique<Quad8>(p);
     case QUADSHELL8:
       return libmesh_make_unique<QuadShell8>(p);
     case QUAD9:
       return libmesh_make_unique<Quad9>(p);
  
       // 3D elements
     case TET4:
       return libmesh_make_unique<Tet4>(p);
     case TET10:
       return libmesh_make_unique<Tet10>(p);
     case HEX8:
       return libmesh_make_unique<Hex8>(p);
     case HEX20:
       return libmesh_make_unique<Hex20>(p);
     case HEX27:
       return libmesh_make_unique<Hex27>(p);
     case PRISM6:
       return libmesh_make_unique<Prism6>(p);
     case PRISM15:
       return libmesh_make_unique<Prism15>(p);
     case PRISM18:
       return libmesh_make_unique<Prism18>(p);
     case PYRAMID5:
       return libmesh_make_unique<Pyramid5>(p);
     case PYRAMID13:
       return libmesh_make_unique<Pyramid13>(p);
     case PYRAMID14:
       return libmesh_make_unique<Pyramid14>(p);
  
 #ifdef LIBMESH_ENABLE_INFINITE_ELEMENTS
       // 1D infinite elements
     case INFEDGE2:
       return libmesh_make_unique<InfEdge2>(p);
  
       // 2D infinite elements
     case INFQUAD4:
       return libmesh_make_unique<InfQuad4>(p);
     case INFQUAD6:
       return libmesh_make_unique<InfQuad6>(p);
  
       // 3D infinite elements
     case INFHEX8:
       return libmesh_make_unique<InfHex8>(p);
     case INFHEX16:
       return libmesh_make_unique<InfHex16>(p);
     case INFHEX18:
       return libmesh_make_unique<InfHex18>(p);
     case INFPRISM6:
       return libmesh_make_unique<InfPrism6>(p);
     case INFPRISM12:
       return libmesh_make_unique<InfPrism12>(p);
 #endif
  
     default:
       libmesh_error_msg("ERROR: Undefined element type!");
     }
 }

References libMesh::EDGE2, libMesh::EDGE3, libMesh::EDGE4, libMesh::HEX20, libMesh::HEX27, libMesh::HEX8, libMesh::INFEDGE2, libMesh::INFHEX16, libMesh::INFHEX18, libMesh::INFHEX8, libMesh::INFPRISM12, libMesh::INFPRISM6, libMesh::INFQUAD4, libMesh::INFQUAD6, libMesh::NODEELEM, libMesh::PRISM15, libMesh::PRISM18, libMesh::PRISM6, libMesh::PYRAMID13, libMesh::PYRAMID14, libMesh::PYRAMID5, libMesh::QUAD4, libMesh::QUAD8, libMesh::QUAD9, libMesh::QUADSHELL4, libMesh::QUADSHELL8, libMesh::TET10, libMesh::TET4, libMesh::TRI3, libMesh::TRI3SUBDIVISION, libMesh::TRI6, libMesh::TRISHELL3, and libMesh::Elem::type().

Referenced by libMesh::GMVIO::_read_one_cell(), libMesh::UnstructuredMesh::all_first_order(), libMesh::UnstructuredMesh::all_second_order(), libMesh::Elem::bracketing_nodes(), libMesh::Nemesis_IO_Helper::build_element_and_node_maps(), ExtraIntegersTest::build_mesh(), ContainsPointTest::containsPointTri3Helper(), libMesh::UnstructuredMesh::copy_nodes_and_elements(), libMesh::UnstructuredMesh::create_submesh(), libMesh::MeshTools::Modification::flatten(), libMesh::RBEIMEvaluation::legacy_write_out_interpolation_points_elem(), libMesh::RBDataDeserialization::load_rb_eim_evaluation_data(), libMesh::Elem::parent_bracketing_nodes(), libMesh::Nemesis_IO::read(), libMesh::ExodusII_IO::read(), libMesh::VTKIO::read(), libMesh::CheckpointIO::read_connectivity(), libMesh::ExodusII_IO_Helper::read_edge_blocks(), libMesh::AbaqusIO::read_elements(), libMesh::UCDIO::read_implementation(), libMesh::DynaIO::read_mesh(), libMesh::GmshIO::read_mesh(), libMesh::XdrIO::read_serialized_connectivity(), libMesh::Elem::refine(), ElemTest< elem_type >::setUp(), RationalMapTest< elem_type >::setUp(), FETest< order, family, elem_type >::setUp(), ContainsPointTest::testContainsPointTet4(), DefaultCouplingTest::testCoupling(), PointNeighborCouplingTest::testCoupling(), DofMapTest::testDofOwner(), PointLocatorTest::testLocator(), EquationSystemsTest::testPostInitAddElem(), libMesh::Parallel::Packing< Elem * >::unpack(), and libMesh::GMVIO::write_ascii_old_impl().

◆ build_edge_ptr() [1/2]

std::unique_ptr< const Elem > libMesh::Elem::build_edge_ptr ( const unsigned int i ) const

inlineinherited

Definition at line 2301 of file elem.h.

 {
   // Call the non-const version of this function, return the result as
   // a std::unique_ptr<const Elem>.
   Elem * me = const_cast<Elem *>(this);
   const Elem * e = const_cast<const Elem *>(me->build_edge_ptr(i).release());
   return std::unique_ptr<const Elem>(e);
 }

References libMesh::Elem::build_edge_ptr().

◆ build_edge_ptr() [2/2]

virtual std::unique_ptr<Elem> libMesh::RemoteElem::build_edge_ptr ( const unsigned int i )

inlineoverridevirtual

Returns: An element coincident with edge i wrapped in a smart pointer.

The element returned is full-ordered. For example, calling build_edge_ptr(0) on a 20-noded hex will build a 3-noded edge coincident with edge 0 and pass back the pointer. A std::unique_ptr<Elem> is returned to prevent a memory leak. This way the user need not remember to delete the object.

The const version of this function is non-virtual; it simply calls the virtual non-const version and const_casts the return type.

Implements libMesh::Elem.

Definition at line 182 of file remote_elem.h.

183 { libmesh_not_implemented(); return std::unique_ptr<Elem>(); }

◆ build_side_ptr() [1/4]

std::unique_ptr< const Elem > libMesh::Elem::build_side_ptr	(	const unsigned int	i,
		bool	proxy = `true`
	)		const

inlineinherited

Definition at line 2224 of file elem.h.

 {
   // Call the non-const version of this function, return the result as
   // a std::unique_ptr<const Elem>.
   Elem * me = const_cast<Elem *>(this);
   const Elem * s = const_cast<const Elem *>(me->build_side_ptr(i, proxy).release());
   return std::unique_ptr<const Elem>(s);
 }

References libMesh::Elem::build_side_ptr().

◆ build_side_ptr() [2/4]

virtual std::unique_ptr<Elem> libMesh::RemoteElem::build_side_ptr	(	const unsigned int	i,
		bool	proxy
	)

inlineoverridevirtual

Returns: An element coincident with side i wrapped in a smart pointer.

The element returned is full-ordered, in contrast to the side method. For example, calling build_side_ptr(0) on a 20-noded hex will build a 8-noded quadrilateral coincident with face 0 and pass back the pointer. A std::unique_ptr<Elem> is returned to prevent a memory leak. This way the user need not remember to delete the object.

The second argument, which is true by default, specifies that a "proxy" element (of type Side) will be returned. This type of value is useful because it does not allocate additional memory, and is usually sufficient for FE calculation purposes. If you really need a full-ordered, non-proxy side object, call this function with proxy=false.

The const version of this function is non-virtual; it simply calls the virtual non-const version and const_casts the return type.

Implements libMesh::Elem.

Definition at line 174 of file remote_elem.h.

176 { libmesh_not_implemented(); return std::unique_ptr<Elem>(); }

◆ build_side_ptr() [3/4]

void libMesh::Elem::build_side_ptr	(	std::unique_ptr< const Elem > &	side,
		const unsigned int	i
	)		const

inlineinherited

Definition at line 2237 of file elem.h.

 {
   // Hand off to the non-const version of this function
   Elem * me = const_cast<Elem *>(this);
   std::unique_ptr<Elem> e {const_cast<Elem *>(elem.release())};
   me->build_side_ptr(e, i);
   elem.reset(e.release());
 }

References libMesh::Elem::build_side_ptr().

◆ build_side_ptr() [4/4]

virtual void libMesh::RemoteElem::build_side_ptr	(	std::unique_ptr< Elem > &	side,
		const unsigned int	i
	)

inlineoverridevirtual

Resets the loose element side, which may currently point to a different side than i or even a different element than this, to point to side i on this.

If side is currently an element of the wrong type, it will be freed and a new element allocated; otherwise no memory allocation will occur.

This should not be called with proxy Side elements. This will cause side to be a full-ordered element, even if it is handed a lower-ordered element that must be replaced.

The const version of this function is non-virtual; it simply calls the virtual non-const version and const_casts the return type.

Implements libMesh::Elem.

Definition at line 178 of file remote_elem.h.

180 { libmesh_not_implemented(); }

◆ centroid()

Point libMesh::Elem::centroid ( ) const

virtualinherited

Returns: The centroid of the element. The centroid is computed as the average of all the element vertices.

This method is virtual since some derived elements might want to use shortcuts to compute their centroid.

Definition at line 345 of file elem.C.

 {
   Point cp;
  
   const auto n_vertices = this->n_vertices();
  
   for (unsigned int n=0; n<n_vertices; n++)
     cp.add (this->point(n));
  
   return (cp /= static_cast<Real>(n_vertices));
 }

References libMesh::TypeVector< T >::add(), and libMesh::Elem::n_vertices().

Referenced by libMesh::UnstructuredMesh::find_neighbors(), A0::interior_assembly(), A1::interior_assembly(), OutputAssembly::interior_assembly(), SlitFunc::operator()(), libMesh::LocationMap< T >::point_of(), libMesh::FE< Dim, LAGRANGE_VEC >::shape(), libMesh::FE< Dim, LAGRANGE_VEC >::shape_deriv(), libMesh::FE< Dim, LAGRANGE_VEC >::shape_second_deriv(), DefaultCouplingTest::testCoupling(), and PointNeighborCouplingTest::testCoupling().

◆ child_neighbor() [1/2]

const Elem * libMesh::Elem::child_neighbor ( const Elem * elem ) const

inlineinherited

Returns: If elem is a neighbor of a child of this element, a pointer to that child, otherwise nullptr.

Definition at line 2139 of file elem.h.

 {
   for (auto n : elem->neighbor_ptr_range())
     if (n && n->parent() == this)
       return n;
  
   return nullptr;
 }

References libMesh::Elem::neighbor_ptr_range().

◆ child_neighbor() [2/2]

Elem * libMesh::Elem::child_neighbor ( Elem * elem )

inlineinherited

Returns: If elem is a neighbor of a child of this element, a pointer to that child, otherwise nullptr.

Definition at line 2127 of file elem.h.

 {
   for (auto n : elem->neighbor_ptr_range())
     if (n && n->parent() == this)
       return n;
  
   return nullptr;
 }

References libMesh::Elem::neighbor_ptr_range().

◆ child_ptr() [1/2]

Elem * libMesh::Elem::child_ptr ( unsigned int i )

inlineinherited

Returns: A non-constant pointer to the \( i^{th} \) child for this element. Do not call if this element has no children, i.e. is active.

Definition at line 2576 of file elem.h.

 {
   libmesh_assert(_children);
   libmesh_assert(_children[i]);
  
   return _children[i];
 }

References libMesh::Elem::_children, and libMesh::libmesh_assert().

◆ child_ptr() [2/2]

const Elem * libMesh::Elem::child_ptr ( unsigned int i ) const

inlineinherited

Returns: A constant pointer to the \( i^{th} \) child for this element. Do not call if this element has no children, i.e. is active.

Definition at line 2567 of file elem.h.

 {
   libmesh_assert(_children);
   libmesh_assert(_children[i]);
  
   return _children[i];
 }

References libMesh::Elem::_children, and libMesh::libmesh_assert().

Referenced by libMesh::Elem::add_child(), libMesh::UnstructuredMesh::all_first_order(), libMesh::Elem::bracketing_nodes(), libMesh::Elem::coarsen(), libMesh::FEGenericBase< FEOutputType< T >::type >::coarsened_dof_values(), libMesh::TopologyMap::fill(), libMesh::UnstructuredMesh::find_neighbors(), libMesh::Elem::is_vertex_on_parent(), libMesh::Elem::make_links_to_me_remote(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectEdges::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectSides::operator()(), libMesh::Elem::refine(), libMesh::Elem::replace_child(), libMesh::Parallel::sync_element_data_by_parent_id(), EquationSystemsTest::testRefineThenReinitPreserveFlags(), libMesh::Parallel::Packing< Elem * >::unpack(), libMesh::Elem::which_child_am_i(), and libMesh::CheckpointIO::write_remote_elem().

◆ child_ref_range() [1/2]

SimpleRange< Elem::ChildRefIter > libMesh::Elem::child_ref_range ( )

inlineinherited

Returns a range with all children of a parent element, usable in range-based for loops.

The exact type of the return value here may be subject to change in future libMesh releases, but the iterators will always dereference to produce a reference to a child element.

Definition at line 1839 of file elem.h.

 {
   libmesh_assert(_children);
   return {_children, _children + this->n_children()};
 }

References libMesh::Elem::_children, libMesh::libmesh_assert(), and libMesh::Elem::n_children().

Referenced by libMesh::HPCoarsenTest::add_projection(), libMesh::Elem::ancestor(), libMesh::OldSolutionBase< Output, point_output >::check_old_context(), libMesh::Elem::coarsen(), libMesh::FEGenericBase< FEOutputType< T >::type >::coarsened_dof_values(), libMesh::connect_children(), libMesh::JumpErrorEstimator::estimate_error(), libMesh::ExactErrorEstimator::estimate_error(), libMesh::UnstructuredMesh::find_neighbors(), libMesh::MeshRefinement::flag_elements_by_nelem_target(), libMesh::Elem::has_ancestor_children(), libMesh::MeshTools::libmesh_assert_topology_consistent_procids< Elem >(), libMesh::MeshRefinement::make_coarsening_compatible(), libMesh::Elem::make_links_to_me_remote(), libMesh::MeshRefinement::make_refinement_compatible(), libMesh::Elem::max_descendant_p_level(), libMesh::Elem::min_new_p_level_by_neighbor(), libMesh::Elem::min_p_level_by_neighbor(), libMesh::Elem::set_p_level(), and libMesh::Partitioner::set_parent_processor_ids().

◆ child_ref_range() [2/2]

SimpleRange< Elem::ConstChildRefIter > libMesh::Elem::child_ref_range ( ) const

inlineinherited

Definition at line 1847 of file elem.h.

 {
   libmesh_assert(_children);
   return {_children, _children + this->n_children()};
 }

References libMesh::Elem::_children, libMesh::libmesh_assert(), and libMesh::Elem::n_children().

◆ cleanup()

void libMesh::Singleton::cleanup ( )

staticinherited

Cleanup function.

Removes all dynamically created Singleton objects.

Definition at line 96 of file libmesh_singleton.C.

 {
   SingletonMutex::scoped_lock lock(singleton_mtx);
  
   SingletonList & singleton_cache = get_singleton_cache();
  
   for (auto & item : as_range(singleton_cache.rbegin(),
                               singleton_cache.rend()))
     {
       libmesh_assert (item);
       delete item;
       item = nullptr;
     }
  
   singleton_cache.clear();
 }

References libMesh::as_range(), and libMesh::libmesh_assert().

◆ 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().

◆ close_to_point()

bool libMesh::Elem::close_to_point	(	const Point &	p,
		Real	tol
	)		const

virtualinherited

Returns: true if this element is "close" to the point p, where "close" is determined by the tolerance tol.

Definition at line 2119 of file elem.C.

 {
   // This test uses the user's passed-in tolerance for the
   // bounding box test as well, thereby allowing the routine to
   // find points which are not only "in" the element, but also
   // "nearby" to within some tolerance.
   return this->point_test(p, tol, tol);
 }

References libMesh::Elem::point_test().

Referenced by assemble_SchroedingerEquation().

◆ coarsen()

void libMesh::Elem::coarsen ( )

inherited

Coarsen the element.

This function is non-virtual since it is the same for all element types.

Definition at line 163 of file elem_refinement.C.

 {
   libmesh_assert_equal_to (this->refinement_flag(), Elem::COARSEN_INACTIVE);
   libmesh_assert (!this->active());
  
   // We no longer delete children until MeshRefinement::contract()
   // delete [] _children;
   // _children = nullptr;
  
   unsigned int parent_p_level = 0;
  
   const unsigned int n_n = this->n_nodes();
  
   // re-compute hanging node nodal locations
   for (unsigned int c = 0, nc = this->n_children(); c != nc; ++c)
     {
       Elem * mychild = this->child_ptr(c);
       if (mychild == remote_elem)
         continue;
       for (auto cnode : mychild->node_index_range())
         {
           Point new_pos;
           bool calculated_new_pos = false;
  
           for (unsigned int n=0; n<n_n; n++)
             {
               // The value from the embedding matrix
               const float em_val = this->embedding_matrix(c,cnode,n);
  
               // The node location is somewhere between existing vertices
               if ((em_val != 0.) && (em_val != 1.))
                 {
                   new_pos.add_scaled (this->point(n), em_val);
                   calculated_new_pos = true;
                 }
             }
  
           if (calculated_new_pos)
             {
               //Move the existing node back into it's original location
               for (unsigned int i=0; i<LIBMESH_DIM; i++)
                 {
                   Point & child_node = mychild->point(cnode);
                   child_node(i)=new_pos(i);
                 }
             }
         }
     }
  
   for (auto & mychild : this->child_ref_range())
     {
       if (&mychild == remote_elem)
         continue;
       libmesh_assert_equal_to (mychild.refinement_flag(), Elem::COARSEN);
       mychild.set_refinement_flag(Elem::INACTIVE);
       if (mychild.p_level() > parent_p_level)
         parent_p_level = mychild.p_level();
     }
  
   this->set_refinement_flag(Elem::JUST_COARSENED);
   this->set_p_level(parent_p_level);
  
   libmesh_assert (this->active());
 }

References libMesh::Elem::active(), libMesh::TypeVector< T >::add_scaled(), libMesh::Elem::child_ptr(), libMesh::Elem::child_ref_range(), libMesh::Elem::COARSEN, libMesh::Elem::COARSEN_INACTIVE, libMesh::Elem::embedding_matrix(), libMesh::Elem::INACTIVE, libMesh::Elem::JUST_COARSENED, libMesh::libmesh_assert(), libMesh::Elem::n_children(), libMesh::Elem::n_nodes(), libMesh::Elem::node_index_range(), libMesh::Elem::point(), libMesh::Elem::refinement_flag(), libMesh::remote_elem, libMesh::Elem::set_p_level(), and libMesh::Elem::set_refinement_flag().

◆ compute_key() [1/4]

dof_id_type libMesh::Elem::compute_key ( dof_id_type n0 )

inlinestaticprotectedinherited

Returns: A hash key computed from a single node id.

Definition at line 2683 of file elem.h.

 {
   return n0;
 }

Referenced by libMesh::Tet::key(), libMesh::Prism::key(), libMesh::Tri::key(), libMesh::Pyramid::key(), libMesh::Hex::key(), libMesh::Edge::key(), libMesh::InfPrism::key(), libMesh::InfQuad6::key(), libMesh::Quad::key(), libMesh::InfHex::key(), libMesh::Quad9::key(), libMesh::Quad8::key(), libMesh::Tri6::key(), libMesh::InfQuad::key(), libMesh::Edge2::key(), libMesh::Hex27::key(), libMesh::Prism18::key(), libMesh::Pyramid14::key(), libMesh::Edge4::key(), libMesh::InfHex18::key(), libMesh::Edge3::key(), and libMesh::Tet4::key().

◆ compute_key() [2/4]

dof_id_type libMesh::Elem::compute_key	(	dof_id_type	n0,
		dof_id_type	n1
	)

inlinestaticprotectedinherited

Returns: A hash key computed from two node ids.

Definition at line 2691 of file elem.h.

 {
   // Order the two so that n0 < n1
   if (n0 > n1) std::swap (n0, n1);
  
   return Utility::hashword2(n0, n1);
 }

References libMesh::Utility::hashword2(), and swap().

◆ compute_key() [3/4]

dof_id_type libMesh::Elem::compute_key	(	dof_id_type	n0,
		dof_id_type	n1,
		dof_id_type	n2
	)

inlinestaticprotectedinherited

Returns: A hash key computed from three node ids.

Definition at line 2703 of file elem.h.

 {
   // Order the numbers such that n0 < n1 < n2.
   // We'll do it in 3 steps like this:
   //
   //     n0         n1                n2
   //     min(n0,n1) max(n0,n1)        n2
   //     min(n0,n1) min(n2,max(n0,n1) max(n2,max(n0,n1)
   //           |\   /|                  |
   //           | \ / |                  |
   //           |  /  |                  |
   //           | /  \|                  |
   //  gb min= min   max              gb max
  
   // Step 1
   if (n0 > n1) std::swap (n0, n1);
  
   // Step 2
   if (n1 > n2) std::swap (n1, n2);
  
   // Step 3
   if (n0 > n1) std::swap (n0, n1);
  
   libmesh_assert ((n0 < n1) && (n1 < n2));
  
   dof_id_type array[3] = {n0, n1, n2};
   return Utility::hashword(array, 3);
 }

References libMesh::Utility::hashword(), libMesh::libmesh_assert(), and swap().

◆ compute_key() [4/4]

dof_id_type libMesh::Elem::compute_key	(	dof_id_type	n0,
		dof_id_type	n1,
		dof_id_type	n2,
		dof_id_type	n3
	)

inlinestaticprotectedinherited

Returns: A hash key computed from four node ids.

Definition at line 2737 of file elem.h.

 {
   // Sort first
   // Step 1
   if (n0 > n1) std::swap (n0, n1);
  
   // Step 2
   if (n2 > n3) std::swap (n2, n3);
  
   // Step 3
   if (n0 > n2) std::swap (n0, n2);
  
   // Step 4
   if (n1 > n3) std::swap (n1, n3);
  
   // Finally sort step 5
   if (n1 > n2) std::swap (n1, n2);
  
   libmesh_assert ((n0 < n1) && (n1 < n2) && (n2 < n3));
  
   dof_id_type array[4] = {n0, n1, n2, n3};
   return Utility::hashword(array, 4);
 }

References libMesh::Utility::hashword(), libMesh::libmesh_assert(), and swap().

◆ connectivity()

virtual void libMesh::RemoteElem::connectivity	(	const unsigned int	sc,
		const	iop,
		std::vector< dof_id_type > &	conn
	)		const

inlineoverridevirtual

Returns: The connectivity for this element in a specific format, which is specified by the IOPackage tag.

Implements libMesh::Elem.

Definition at line 104 of file remote_elem.h.

107 { libmesh_not_implemented(); }

◆ contains_edge_of()

bool libMesh::Elem::contains_edge_of ( const Elem * e ) const

inherited

Returns: true if an edge of e is contained in this element. (Internally, this is done by checking whether at least two vertices of e are contained in this element).

Definition at line 539 of file elem.C.

 {
   unsigned int num_contained_edges = 0;
  
   // Our vertices are the first numbered nodes
   for (auto n : IntRange<unsigned int>(0, e->n_vertices()))
     {
       if (this->contains_point(e->point(n)))
         {
           num_contained_edges++;
           if (num_contained_edges>=2)
             {
               return true;
             }
         }
     }
   return false;
 }

References libMesh::Elem::contains_point(), libMesh::Elem::n_vertices(), and libMesh::Elem::point().

Referenced by libMesh::Elem::find_edge_neighbors().

◆ contains_point()

bool libMesh::Elem::contains_point	(	const Point &	p,
		Real	tol = `TOLERANCE`
	)		const

virtualinherited

Returns: true if the point p is contained in this element, false otherwise.

For linear elements, performs an initial tight bounding box check (as an optimization step) and (if that passes) then uses the user-defined tolerance "tol" in a call to inverse_map() to actually test if the point is in the element. For quadratic elements, the bounding box optimization is skipped, and only the inverse_map() steps are performed.

Note: This routine should not be used to determine if a point is merely "nearby" an element to within some tolerance. For that, use Elem::close_to_point() instead.

Reimplemented in libMesh::InfHex, libMesh::InfPrism, libMesh::InfQuad4, libMesh::Tet4, and libMesh::Tri3.

Definition at line 2094 of file elem.C.

 {
   // We currently allow the user to enlarge the bounding box by
   // providing a tol > TOLERANCE (so this routine is identical to
   // Elem::close_to_point()), but print a warning so that the
   // user can eventually switch his code over to calling close_to_point()
   // instead, which is intended to be used for this purpose.
   if (tol > TOLERANCE)
     {
       libmesh_do_once(libMesh::err
                       << "WARNING: Resizing bounding box to match user-specified tolerance!\n"
                       << "In the future, calls to Elem::contains_point() with tol > TOLERANCE\n"
                       << "will be more optimized, but should not be used\n"
                       << "to search for points 'close to' elements!\n"
                       << "Instead, use Elem::close_to_point() for this purpose.\n"
                       << std::endl;);
       return this->point_test(p, tol, tol);
     }
   else
     return this->point_test(p, TOLERANCE, tol);
 }

References libMesh::err, libMesh::Elem::point_test(), and libMesh::TOLERANCE.

Referenced by libMesh::Elem::contains_edge_of(), libMesh::Elem::contains_vertex_of(), libMesh::Elem::find_edge_neighbors(), libMesh::Elem::find_point_neighbors(), libMesh::PointLocatorTree::operator()(), libMesh::System::point_gradient(), libMesh::System::point_hessian(), libMesh::System::point_value(), NavierSystem::side_constraint(), RationalMapTest< elem_type >::testContainsPoint(), FETest< order, family, elem_type >::testGradU(), FETest< order, family, elem_type >::testGradUComp(), PointLocatorTest::testLocator(), and FETest< order, family, elem_type >::testU().

◆ contains_vertex_of()

bool libMesh::Elem::contains_vertex_of ( const Elem * e ) const

inherited

Returns: true if a vertex of e is contained in this element.

Definition at line 528 of file elem.C.

 {
   // Our vertices are the first numbered nodes
   for (auto n : IntRange<unsigned int>(0, e->n_vertices()))
     if (this->contains_point(e->point(n)))
       return true;
   return false;
 }

References libMesh::Elem::contains_point(), libMesh::Elem::n_vertices(), and libMesh::Elem::point().

◆ contract()

void libMesh::Elem::contract ( )

inherited

Contract an active element, i.e.

remove pointers to any subactive children. This should only be called via MeshRefinement::contract, which will also remove subactive children from the mesh.

Definition at line 230 of file elem_refinement.C.

 {
   // Subactive elements get deleted entirely, not contracted
   libmesh_assert (this->active());
  
   // Active contracted elements no longer can have children
   delete [] _children;
   _children = nullptr;
  
   if (this->refinement_flag() == Elem::JUST_COARSENED)
     this->set_refinement_flag(Elem::DO_NOTHING);
 }

References libMesh::Elem::_children, libMesh::Elem::active(), libMesh::Elem::DO_NOTHING, libMesh::Elem::JUST_COARSENED, libMesh::libmesh_assert(), libMesh::Elem::refinement_flag(), and libMesh::Elem::set_refinement_flag().

Referenced by libMesh::UnstructuredMesh::contract().

◆ create()

const Elem & libMesh::RemoteElem::create ( )

static

Return a reference to the global RemoteElem singleton object.

Definition at line 69 of file remote_elem.C.

 {
   if (remote_elem != nullptr)
     return *remote_elem;
  
   RemoteElemMutex::scoped_lock lock(remote_elem_mtx);
  
   // check again - object could have been created while waiting
   // for the lock to acquire!
   if (remote_elem == nullptr)
     remote_elem = new RemoteElem;
  
   return *remote_elem;
 }

References libMesh::remote_elem, and RemoteElem().

◆ 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.

◆ default_order()

virtual Order libMesh::RemoteElem::default_order ( ) const

inlineoverridevirtual

Returns: The default approximation order for this element type. This is the order that will be used to compute the map to the reference element.

Implements libMesh::Elem.

Definition at line 185 of file remote_elem.h.

186 { libmesh_not_implemented(); return static_cast<Order>(1); }

◆ dim()

virtual unsigned short libMesh::RemoteElem::dim ( ) const

inlineoverridevirtual

Returns: The dimensionality of the object.

Implements libMesh::Elem.

Definition at line 112 of file remote_elem.h.

113 { libmesh_not_implemented(); return 0; }

◆ 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().

◆ edge_index_range()

IntRange< unsigned short > libMesh::Elem::edge_index_range ( ) const

inlineinherited

Returns: An integer range from 0 up to (but not including) the number of edges this element has.

Definition at line 2179 of file elem.h.

 {
   return {0, cast_int<unsigned short>(this->n_edges())};
 }

References libMesh::Elem::n_edges().

Referenced by libMesh::FEGenericBase< FEOutputType< T >::type >::coarsened_dof_values(), libMesh::BoundaryInfo::copy_boundary_ids(), libMesh::ElemCutter::find_intersection_points(), libMesh::Parallel::Packing< const Elem * >::pack(), and libMesh::Parallel::Packing< Elem * >::unpack().

◆ embedding_matrix()

virtual float libMesh::RemoteElem::embedding_matrix	(	const unsigned int	,
		const unsigned int	,
		const unsigned int
	)		const

inlineoverridevirtual

Matrix that transforms the parents nodes into the children's nodes.

Implements libMesh::Elem.

Definition at line 201 of file remote_elem.h.

204 { libmesh_not_implemented(); return 0.; }

◆ embedding_matrix_version()

virtual unsigned int libMesh::Elem::embedding_matrix_version ( ) const

inlinevirtualinherited

Returns: A "version number" that identifies which embedding matrix is in use.

Some element types may use a different embedding matrix depending on their geometric characteristics.

Reimplemented in libMesh::Tet.

Definition at line 1649 of file elem.h.

1649 { return 0; }

Referenced by libMesh::Elem::as_parent_node(), and libMesh::Elem::parent_bracketing_nodes().

◆ 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().

◆ family_tree() [1/2]

void libMesh::Elem::family_tree	(	std::vector< const Elem * > &	family,
		bool	reset = `true`
	)		const

inherited

Fills the vector family with the children of this element, recursively.

Calling this method on a twice-refined element will give you the element itself, its direct children, and their children, etc... When the optional parameter reset is true, the vector will be cleared before the element and its descendants are added.

The family tree only includes ancestor and active elements. To include subactive elements as well, use total_family_tree().

Definition at line 1441 of file elem.C.

 {
   ElemInternal::family_tree(this, family, reset);
 }

References libMesh::ElemInternal::family_tree().

◆ family_tree() [2/2]

void libMesh::Elem::family_tree	(	std::vector< Elem * > &	family,
		bool	reset = `true`
	)

inherited

Non-const version of function above; fills a vector of non-const pointers.

Definition at line 1449 of file elem.C.

 {
   ElemInternal::family_tree(this, family, reset);
 }

References libMesh::ElemInternal::family_tree().

◆ family_tree_by_neighbor() [1/2]

void libMesh::Elem::family_tree_by_neighbor	(	std::vector< const Elem * > &	family,
		const Elem *	neighbor,
		bool	reset = `true`
	)		const

inherited

Same as the family_tree() member, but only adds elements which are next to neighbor.

Definition at line 1525 of file elem.C.

 {
   ElemInternal::family_tree_by_neighbor(this, family, neighbor, reset);
 }

References libMesh::ElemInternal::family_tree_by_neighbor().

◆ family_tree_by_neighbor() [2/2]

void libMesh::Elem::family_tree_by_neighbor	(	std::vector< Elem * > &	family,
		Elem *	neighbor,
		bool	reset = `true`
	)

inherited

Non-const version of function above; fills a vector of non-const pointers.

Definition at line 1534 of file elem.C.

 {
   ElemInternal::family_tree_by_neighbor(this, family, neighbor, reset);
 }

References libMesh::ElemInternal::family_tree_by_neighbor().

◆ family_tree_by_side() [1/2]

void libMesh::Elem::family_tree_by_side	(	std::vector< const Elem * > &	family,
		unsigned int	side,
		bool	reset = `true`
	)		const

inherited

Same as the family_tree() member, but only adds elements which are next to side.

Definition at line 1489 of file elem.C.

 {
   ElemInternal::family_tree_by_side(this, family, side, reset);
 }

References libMesh::ElemInternal::family_tree_by_side().

Referenced by libMesh::Elem::make_links_to_me_local().

◆ family_tree_by_side() [2/2]

void libMesh::Elem::family_tree_by_side	(	std::vector< Elem * > &	family,
		unsigned int	side,
		bool	reset = `true`
	)

inherited

Non-const version of function above; fills a vector of non-const pointers.

Definition at line 1498 of file elem.C.

 {
   ElemInternal::family_tree_by_side(this, family, side, reset);
 }

References libMesh::ElemInternal::family_tree_by_side().

◆ family_tree_by_subneighbor() [1/2]

void libMesh::Elem::family_tree_by_subneighbor	(	std::vector< const Elem * > &	family,
		const Elem *	neighbor,
		const Elem *	subneighbor,
		bool	reset = `true`
	)		const

inherited

Same as the family_tree() member, but only adds elements which are next to subneighbor.

Only applicable when this->has_neighbor(neighbor) and neighbor->is_ancestor(subneighbor)

Definition at line 1561 of file elem.C.

 {
   ElemInternal::family_tree_by_subneighbor(this, family, neighbor, subneighbor, reset);
 }

References libMesh::ElemInternal::family_tree_by_subneighbor().

◆ family_tree_by_subneighbor() [2/2]

void libMesh::Elem::family_tree_by_subneighbor	(	std::vector< Elem * > &	family,
		Elem *	neighbor,
		Elem *	subneighbor,
		bool	reset = `true`
	)

inherited

Non-const version of function above; fills a vector of non-const pointers.

Definition at line 1571 of file elem.C.

 {
   ElemInternal::family_tree_by_subneighbor(this, family, neighbor, subneighbor, reset);
 }

References libMesh::ElemInternal::family_tree_by_subneighbor().

◆ find_edge_neighbors() [1/2]

void libMesh::Elem::find_edge_neighbors	(	const Point &	p1,
		const Point &	p2,
		std::set< const Elem * > &	neighbor_set
	)		const

inherited

This function finds all active elements in the same manifold as this element which touch the current active element along the whole edge defined by the two points p1 and p2.

Definition at line 646 of file elem.C.

 {
   // Simple but perhaps suboptimal code: find elements containing the
   // first point, then winnow this set down by removing elements which
   // don't also contain the second point
  
   libmesh_assert(this->contains_point(p2));
   this->find_point_neighbors(p1, neighbor_set);
  
   std::set<const Elem *>::iterator        it = neighbor_set.begin();
   const std::set<const Elem *>::iterator end = neighbor_set.end();
  
   while (it != end)
     {
       // As of C++11, set::erase returns an iterator to the element
       // following the erased element, or end.
       if (!(*it)->contains_point(p2))
         it = neighbor_set.erase(it);
       else
         ++it;
     }
 }

References libMesh::Elem::contains_point(), end, libMesh::Elem::find_point_neighbors(), and libMesh::libmesh_assert().

Referenced by libMesh::MeshRefinement::enforce_mismatch_limit_prior_to_refinement().

◆ find_edge_neighbors() [2/2]

void libMesh::Elem::find_edge_neighbors ( std::set< const Elem * > & neighbor_set ) const

inherited

This function finds all active elements in the same manifold as this element which touch the current active element along any edge (more precisely, at at least two points).

In this case, elements are included even if they do not touch a whole edge of this element.

Definition at line 673 of file elem.C.

 {
   neighbor_set.clear();
   neighbor_set.insert(this);
  
   std::set<const Elem *> untested_set, next_untested_set;
   untested_set.insert(this);
  
   while (!untested_set.empty())
     {
       // Loop over all the elements in the patch that haven't already
       // been tested
       for (const auto & elem : untested_set)
         {
           for (auto current_neighbor : elem->neighbor_ptr_range())
             {
               if (current_neighbor &&
                   current_neighbor != remote_elem)    // we have a real neighbor on this side
                 {
                   if (current_neighbor->active())                // ... if it is active
                     {
                       if (this->contains_edge_of(current_neighbor) // ... and touches us
                           || current_neighbor->contains_edge_of(this))
                         {
                           // Make sure we'll test it
                           if (!neighbor_set.count(current_neighbor))
                             next_untested_set.insert (current_neighbor);
  
                           // And add it
                           neighbor_set.insert (current_neighbor);
                         }
                     }
 #ifdef LIBMESH_ENABLE_AMR
                   else                                 // ... the neighbor is *not* active,
                     {                                  // ... so add *all* neighboring
                                                        // active children
                       std::vector<const Elem *> active_neighbor_children;
  
                       current_neighbor->active_family_tree_by_neighbor
                         (active_neighbor_children, elem);
  
                       for (const auto & current_child : active_neighbor_children)
                         if (this->contains_edge_of(current_child) || current_child->contains_edge_of(this))
                           {
                             // Make sure we'll test it
                             if (!neighbor_set.count(current_child))
                               next_untested_set.insert (current_child);
  
                             neighbor_set.insert (current_child);
                           }
                     }
 #endif // #ifdef LIBMESH_ENABLE_AMR
                 }
             }
         }
       untested_set.swap(next_untested_set);
       next_untested_set.clear();
     }
 }

References libMesh::Elem::contains_edge_of(), and libMesh::remote_elem.

◆ find_interior_neighbors() [1/2]

void libMesh::Elem::find_interior_neighbors ( std::set< const Elem * > & neighbor_set ) const

inherited

This function finds all active elements (not including this one) in the parent manifold of this element whose intersection with this element has non-zero measure.

Definition at line 735 of file elem.C.

 {
   ElemInternal::find_interior_neighbors(this, neighbor_set);
 }

References libMesh::ElemInternal::find_interior_neighbors().

◆ find_interior_neighbors() [2/2]

void libMesh::Elem::find_interior_neighbors ( std::set< Elem * > & neighbor_set )

inherited

Non-const version of function above that fills up a vector of non-const Elem pointers instead.

Definition at line 742 of file elem.C.

 {
   ElemInternal::find_interior_neighbors(this, neighbor_set);
 }

References libMesh::ElemInternal::find_interior_neighbors().

◆ find_point_neighbors() [1/4]

void libMesh::Elem::find_point_neighbors	(	const Point &	p,
		std::set< const Elem * > &	neighbor_set
	)		const

inherited

This function finds all active elements (including this one) which are in the same manifold as this element and which touch the current active element at the specified point, which should be a point in the current element.

Elements which are not "in the same manifold" (e.g. the interior_parent of a boundary element) will not be found with this method.

Elements which overlap the specified point but which are only connected to the current element via elements which do not overlap that point (e.g. in a folded or tangled mesh) are not considered to "touch" the current element and will not be found with this method.

Definition at line 560 of file elem.C.

 {
   libmesh_assert(this->contains_point(p));
   libmesh_assert(this->active());
  
   neighbor_set.clear();
   neighbor_set.insert(this);
  
   std::set<const Elem *> untested_set, next_untested_set;
   untested_set.insert(this);
  
   while (!untested_set.empty())
     {
       // Loop over all the elements in the patch that haven't already
       // been tested
       for (const auto & elem : untested_set)
           for (auto current_neighbor : elem->neighbor_ptr_range())
             {
               if (current_neighbor &&
                   current_neighbor != remote_elem)    // we have a real neighbor on this side
                 {
                   if (current_neighbor->active())                // ... if it is active
                     {
                       if (current_neighbor->contains_point(p))   // ... and touches p
                         {
                           // Make sure we'll test it
                           if (!neighbor_set.count(current_neighbor))
                             next_untested_set.insert (current_neighbor);
  
                           // And add it
                           neighbor_set.insert (current_neighbor);
                         }
                     }
 #ifdef LIBMESH_ENABLE_AMR
                   else                                 // ... the neighbor is *not* active,
                     {                                  // ... so add *all* neighboring
                                                        // active children that touch p
                       std::vector<const Elem *> active_neighbor_children;
  
                       current_neighbor->active_family_tree_by_neighbor
                         (active_neighbor_children, elem);
  
                       for (const auto & current_child : active_neighbor_children)
                           if (current_child->contains_point(p))
                             {
                               // Make sure we'll test it
                               if (!neighbor_set.count(current_child))
                                 next_untested_set.insert (current_child);
  
                               neighbor_set.insert (current_child);
                             }
                     }
 #endif // #ifdef LIBMESH_ENABLE_AMR
                 }
             }
       untested_set.swap(next_untested_set);
       next_untested_set.clear();
     }
 }

References libMesh::Elem::active(), libMesh::Elem::contains_point(), libMesh::libmesh_assert(), and libMesh::remote_elem.

Referenced by libMesh::MeshRefinement::enforce_mismatch_limit_prior_to_refinement(), libMesh::Elem::find_edge_neighbors(), libMesh::MeshFunction::find_element(), libMesh::Elem::find_point_neighbors(), libMesh::ReplicatedMesh::get_boundary_points(), and libMesh::Elem::is_semilocal().

◆ find_point_neighbors() [2/4]

void libMesh::Elem::find_point_neighbors ( std::set< const Elem * > & neighbor_set ) const

inherited

This function finds all active elements (including this one) in the same manifold as this element which touch this active element at any point.

Definition at line 623 of file elem.C.

 {
   this->find_point_neighbors(neighbor_set, this);
 }

References libMesh::Elem::find_point_neighbors().

◆ find_point_neighbors() [3/4]

void libMesh::Elem::find_point_neighbors	(	std::set< const Elem * > &	neighbor_set,
		const Elem *	start_elem
	)		const

inherited

This function finds all active elements (including this one) in the same manifold as start_elem (which must be active and must touch this element) which touch this element at any point.

Definition at line 630 of file elem.C.

 {
   ElemInternal::find_point_neighbors(this, neighbor_set, start_elem);
 }

References libMesh::ElemInternal::find_point_neighbors().

◆ find_point_neighbors() [4/4]

void libMesh::Elem::find_point_neighbors	(	std::set< Elem * > &	neighbor_set,
		Elem *	start_elem
	)

inherited

Non-const version of function above.

Fills a set of non-const Elem pointers.

Definition at line 638 of file elem.C.

 {
   ElemInternal::find_point_neighbors(this, neighbor_set, start_elem);
 }

References libMesh::ElemInternal::find_point_neighbors().

◆ first_order_equivalent_type()

ElemType libMesh::Elem::first_order_equivalent_type ( const ElemType et )

staticinherited

Returns: The element type of the associated first-order element, or INVALID_ELEM for first-order or other elements that cannot be converted into lower order equivalents.

For example, when this is a TET10, then TET4 is returned.

Definition at line 2369 of file elem.C.

 {
   switch (et)
     {
     case NODEELEM:
       return NODEELEM;
     case EDGE2:
     case EDGE3:
     case EDGE4:
       return EDGE2;
     case TRI3:
     case TRI6:
       return TRI3;
     case TRISHELL3:
       return TRISHELL3;
     case QUAD4:
     case QUAD8:
     case QUAD9:
       return QUAD4;
     case QUADSHELL4:
     case QUADSHELL8:
       return QUADSHELL4;
     case TET4:
     case TET10:
       return TET4;
     case HEX8:
     case HEX27:
     case HEX20:
       return HEX8;
     case PRISM6:
     case PRISM15:
     case PRISM18:
       return PRISM6;
     case PYRAMID5:
     case PYRAMID13:
     case PYRAMID14:
       return PYRAMID5;
  
 #ifdef LIBMESH_ENABLE_INFINITE_ELEMENTS
  
     case INFEDGE2:
       return INFEDGE2;
     case INFQUAD4:
     case INFQUAD6:
       return INFQUAD4;
     case INFHEX8:
     case INFHEX16:
     case INFHEX18:
       return INFHEX8;
     case INFPRISM6:
     case INFPRISM12:
       return INFPRISM6;
  
 #endif
  
     default:
       // unknown element
       return INVALID_ELEM;
     }
 }

References libMesh::EDGE2, libMesh::EDGE3, libMesh::EDGE4, libMesh::HEX20, libMesh::HEX27, libMesh::HEX8, libMesh::INFEDGE2, libMesh::INFHEX16, libMesh::INFHEX18, libMesh::INFHEX8, libMesh::INFPRISM12, libMesh::INFPRISM6, libMesh::INFQUAD4, libMesh::INFQUAD6, libMesh::INVALID_ELEM, libMesh::NODEELEM, libMesh::PRISM15, libMesh::PRISM18, libMesh::PRISM6, libMesh::PYRAMID13, libMesh::PYRAMID14, libMesh::PYRAMID5, libMesh::QUAD4, libMesh::QUAD8, libMesh::QUAD9, libMesh::QUADSHELL4, libMesh::QUADSHELL8, libMesh::TET10, libMesh::TET4, libMesh::TRI3, libMesh::TRI6, and libMesh::TRISHELL3.

Referenced by libMesh::UnstructuredMesh::all_first_order(), SideTest< ElemClass, side_type, indexbegin, indexend >::testSidePtr(), SideTest< ElemClass, side_type, indexbegin, indexend >::testSidePtrFill(), and libMesh::GMVIO::write_ascii_old_impl().

◆ 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::Elem::get_info ( ) const

inherited

Prints relevant information about the element to a string.

Definition at line 2233 of file elem.C.

 {
   std::ostringstream oss;
  
   oss << "  Elem Information"                                      << '\n'
       << "   id()=";
  
   if (this->valid_id())
     oss << this->id();
   else
     oss << "invalid";
  
 #ifdef LIBMESH_ENABLE_UNIQUE_ID
   oss << ", unique_id()=";
   if (this->valid_unique_id())
     oss << this->unique_id();
   else
     oss << "invalid";
 #endif
  
   oss << ", processor_id()=" << this->processor_id()               << '\n';
  
   oss << "   type()="    << Utility::enum_to_string(this->type())  << '\n'
       << "   dim()="     << this->dim()                            << '\n'
       << "   n_nodes()=" << this->n_nodes()                        << '\n';
  
   for (auto n : this->node_index_range())
     oss << "    " << n << this->node_ref(n);
  
   oss << "   n_sides()=" << this->n_sides()                        << '\n';
  
   for (auto s : this->side_index_range())
     {
       oss << "    neighbor(" << s << ")=";
       if (this->neighbor_ptr(s))
         oss << this->neighbor_ptr(s)->id() << '\n';
       else
         oss << "nullptr\n";
     }
  
 #ifdef LIBMESH_ENABLE_INFINITE_ELEMENTS
   if (!this->infinite())
     {
 #endif
     oss << "   hmin()=" << this->hmin()
         << ", hmax()=" << this->hmax()                             << '\n'
         << "   volume()=" << this->volume()                        << '\n';
 #ifdef LIBMESH_ENABLE_INFINITE_ELEMENTS
     }
 #endif
     oss << "   active()=" << this->active()
       << ", ancestor()=" << this->ancestor()
       << ", subactive()=" << this->subactive()
       << ", has_children()=" << this->has_children()               << '\n'
       << "   parent()=";
   if (this->parent())
     oss << this->parent()->id() << '\n';
   else
     oss << "nullptr\n";
   oss << "   level()=" << this->level()
       << ", p_level()=" << this->p_level()                         << '\n'
 #ifdef LIBMESH_ENABLE_AMR
       << "   refinement_flag()=" << Utility::enum_to_string(this->refinement_flag())        << '\n'
       << "   p_refinement_flag()=" << Utility::enum_to_string(this->p_refinement_flag())    << '\n'
 #endif
 #ifdef LIBMESH_ENABLE_INFINITE_ELEMENTS
       << "   infinite()=" << this->infinite()    << '\n';
   if (this->infinite())
     oss << "   origin()=" << this->origin()    << '\n'
 #endif
       ;
  
   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();
 }

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

◆ get_node_index()

unsigned int libMesh::Elem::get_node_index ( const Node * node_ptr ) const

inlineinherited

Returns: The local index for the Node pointer node_ptr, or invalid_id if node_ptr is not a local node.

Definition at line 2047 of file elem.h.

 {
   for (auto n : IntRange<unsigned int>(0, this->n_nodes()))
     if (this->_nodes[n] == node_ptr)
       return n;
  
   return libMesh::invalid_uint;
 }

References libMesh::Elem::_nodes, libMesh::invalid_uint, libMesh::Elem::n_nodes(), and libMesh::Elem::node_ptr().

Referenced by libMesh::OldSolutionValue< Output, point_output >::eval_at_node(), libMesh::ElemCutter::find_intersection_points(), and libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectVertices::operator()().

◆ get_nodes()

const Node *const * libMesh::Elem::get_nodes ( ) const

inlineinherited

Returns: A pointer to an array of local node pointers.

Definition at line 2001 of file elem.h.

 {
   return _nodes;
 }

References libMesh::Elem::_nodes.

Referenced by libMesh::DofMap::dof_indices(), and libMesh::DofMap::old_dof_indices().

◆ hack_p_level()

void libMesh::Elem::hack_p_level ( const unsigned int p )

inlineinherited

Sets the value of the p-refinement level for the element without altering the p-level of its ancestors.

Definition at line 2668 of file elem.h.

 {
   if (p == 0)
     libmesh_assert_not_equal_to
       (this->p_refinement_flag(), Elem::JUST_REFINED);
  
   _p_level = cast_int<unsigned char>(p);
 }

References libMesh::Elem::_p_level, libMesh::Elem::JUST_REFINED, and libMesh::Elem::p_refinement_flag().

Referenced by libMesh::CheckpointIO::read_connectivity(), libMesh::XdrIO::read_serialized_connectivity(), libMesh::HPCoarsenTest::select_refinement(), and libMesh::Parallel::Packing< Elem * >::unpack().

◆ has_affine_map()

virtual bool libMesh::Elem::has_affine_map ( ) const

inlinevirtualinherited

Returns: true if the element map is definitely affine (i.e. the same at every quadrature point) within numerical tolerances.

Reimplemented in libMesh::NodeElem, libMesh::Pyramid14, libMesh::Prism15, libMesh::Prism18, libMesh::Pyramid13, libMesh::Hex20, libMesh::Hex27, libMesh::Tet10, libMesh::Tet4, libMesh::Tri6, libMesh::Hex8, libMesh::Quad8, libMesh::Quad9, libMesh::Tri3, libMesh::Edge4, libMesh::Prism6, libMesh::Pyramid5, libMesh::Edge3, libMesh::Quad4, libMesh::Edge2, and libMesh::Tri3Subdivision.

Definition at line 938 of file elem.h.

938 { return false; }

Referenced by libMesh::FEMap::compute_map().

◆ has_ancestor_children()

bool libMesh::Elem::has_ancestor_children ( ) const

inlineinherited

Returns: true if the element has any descendants other than its immediate children, false otherwise, or if AMR is disabled.

Definition at line 2397 of file elem.h.

 {
 #ifdef LIBMESH_ENABLE_AMR
   if (_children == nullptr)
     return false;
   else
     for (auto & c : child_ref_range())
       if (c.has_children())
         return true;
 #endif
   return false;
 }

References libMesh::Elem::_children, and libMesh::Elem::child_ref_range().

◆ has_children()

bool libMesh::Elem::has_children ( ) const

inlineinherited

Returns: true if the element has any children (active or not), false otherwise, or if AMR is disabled.

Definition at line 2383 of file elem.h.

 {
 #ifdef LIBMESH_ENABLE_AMR
   if (_children == nullptr)
     return false;
   else
     return true;
 #else
   return false;
 #endif
 }

References libMesh::Elem::_children.

Referenced by libMesh::Elem::add_child(), libMesh::Elem::ancestor(), libMesh::connect_children(), libMesh::connect_families(), libMesh::UnstructuredMesh::find_neighbors(), libMesh::MeshRefinement::flag_elements_by_nelem_target(), libMesh::Elem::get_info(), libMesh::MeshTools::libmesh_assert_topology_consistent_procids< Elem >(), libMesh::MeshRefinement::make_coarsening_compatible(), libMesh::Elem::make_links_to_me_local(), libMesh::Elem::make_links_to_me_remote(), libMesh::MeshRefinement::make_refinement_compatible(), libMesh::FEMSystem::mesh_position_set(), libMesh::Parallel::Packing< const Elem * >::pack(), libMesh::Elem::remove_links_to_me(), libMesh::Elem::replace_child(), libMesh::Elem::set_child(), libMesh::Elem::subactive(), libMesh::Parallel::sync_element_data_by_parent_id(), libMesh::Parallel::Packing< Elem * >::unpack(), and libMesh::Elem::which_child_am_i().

◆ 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().

◆ has_neighbor()

bool libMesh::Elem::has_neighbor ( const Elem * elem ) const

inlineinherited

Returns: true if the element elem in question is a neighbor of this element, false otherwise.

Definition at line 2115 of file elem.h.

 {
   for (auto n : this->neighbor_ptr_range())
     if (n == elem)
       return true;
  
   return false;
 }

References libMesh::Elem::neighbor_ptr_range().

Referenced by libMesh::Elem::has_topological_neighbor(), libMesh::MeshRefinement::has_topological_neighbor(), libMesh::Elem::min_new_p_level_by_neighbor(), libMesh::Elem::min_p_level_by_neighbor(), and libMesh::Elem::on_boundary().

◆ has_topological_neighbor()

bool libMesh::Elem::has_topological_neighbor	(	const Elem *	elem,
		const MeshBase &	mesh,
		const PointLocatorBase &	point_locator,
		const PeriodicBoundaries *	pb
	)		const

inherited

Returns: true if the element elem in question is a neighbor or topological neighbor of this element, false otherwise.

Definition at line 902 of file elem.C.

 {
   // First see if this is a normal "interior" neighbor
   if (has_neighbor(elem))
     return true;
  
   for (auto n : this->side_index_range())
     if (this->topological_neighbor(n, mesh, point_locator, pb))
       return true;
  
   return false;
 }

References libMesh::Elem::has_neighbor(), mesh, libMesh::Elem::side_index_range(), and libMesh::Elem::topological_neighbor().

Referenced by libMesh::MeshRefinement::has_topological_neighbor().

◆ hmax()

Real libMesh::Elem::hmax ( ) const

virtualinherited

Returns: The maximum vertex separation for the element.

Definition at line 379 of file elem.C.

 {
   Real h_max=0;
  
   // Avoid calling a virtual a lot of times
   const auto n_vertices = this->n_vertices();
  
   for (unsigned int n_outer=0; n_outer<n_vertices; n_outer++)
     for (unsigned int n_inner=n_outer+1; n_inner<n_vertices; n_inner++)
       {
         const auto diff = (this->point(n_outer) - this->point(n_inner));
  
         h_max = std::max(h_max, diff.norm_sq());
       }
  
   return std::sqrt(h_max);
 }

References libMesh::Elem::n_vertices(), libMesh::Elem::point(), libMesh::Real, and std::sqrt().

Referenced by libMesh::DiscontinuityMeasure::boundary_side_integration(), libMesh::KellyErrorEstimator::boundary_side_integration(), libMesh::OldSolutionBase< Output, point_output >::check_old_context(), libMesh::Elem::get_info(), libMesh::LaplacianErrorEstimator::internal_side_integration(), libMesh::DiscontinuityMeasure::internal_side_integration(), libMesh::KellyErrorEstimator::internal_side_integration(), and libMesh::Elem::point_test().

◆ hmin()

Real libMesh::Elem::hmin ( ) const

virtualinherited

Returns: The minimum vertex separation for the element.

Definition at line 359 of file elem.C.

 {
   Real h_min=std::numeric_limits<Real>::max();
  
   // Avoid calling a virtual a lot of times
   const auto n_vertices = this->n_vertices();
  
   for (unsigned int n_outer=0; n_outer<n_vertices; n_outer++)
     for (unsigned int n_inner=n_outer+1; n_inner<n_vertices; n_inner++)
       {
         const auto diff = (this->point(n_outer) - this->point(n_inner));
  
         h_min = std::min(h_min, diff.norm_sq());
       }
  
   return std::sqrt(h_min);
 }

References libMesh::Elem::n_vertices(), libMesh::Elem::point(), libMesh::Real, and std::sqrt().

Referenced by assemble_SchroedingerEquation(), libMesh::FEGenericBase< FEOutputType< T >::type >::compute_periodic_constraints(), libMesh::MeshTools::Modification::distort(), libMesh::UnstructuredMesh::find_neighbors(), libMesh::Elem::get_info(), libMesh::FEMSystem::numerical_jacobian(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectVertices::operator()(), and libMesh::ReplicatedMesh::stitching_helper().

◆ 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().

◆ infinite()

virtual bool libMesh::RemoteElem::infinite ( ) const

inlineoverridevirtual

Returns: true if the element is an infinite element, false otherwise.

Implements libMesh::Elem.

Definition at line 190 of file remote_elem.h.

191 { libmesh_not_implemented(); return false; }

◆ interior_parent() [1/2]

Elem * libMesh::Elem::interior_parent ( )

inherited

Definition at line 784 of file elem.C.

 {
   // See the const version for comments
   libmesh_assert_less (this->dim(), LIBMESH_DIM);
   Elem * interior_p = _elemlinks[1+this->n_sides()];
  
   libmesh_assert (!interior_p ||
                   (interior_p == remote_elem) ||
                   (interior_p->dim() > this->dim()));
   if (interior_p && (interior_p != remote_elem))
     libmesh_assert_less_equal (interior_p->level(), this->level());
  
   return interior_p;
 }

References libMesh::Elem::_elemlinks, libMesh::Elem::dim(), libMesh::Elem::level(), libMesh::libmesh_assert(), libMesh::Elem::n_sides(), and libMesh::remote_elem.

◆ interior_parent() [2/2]

const Elem * libMesh::Elem::interior_parent ( ) const

inherited

Returns: The higher-dimensional Elem for which this Elem is a face.

In some cases it is desirable to extract the boundary (or a subset thereof) of a D-dimensional mesh as a (D-1)-dimensional manifold. In this case we may want to know the 'parent' element from which the manifold elements were extracted. We can easily do that for the level-0 manifold elements by storing the D-dimensional parent. This method provides access to that element.

This method is not safe to call if this->dim() == LIBMESH_DIM; in such cases no data storage for an interior parent pointer has been allocated.

Definition at line 749 of file elem.C.

 {
   // interior parents make no sense for full-dimensional elements.
   libmesh_assert_less (this->dim(), LIBMESH_DIM);
  
   // they USED TO BE only good for level-0 elements, but we now
   // support keeping interior_parent() valid on refined boundary
   // elements.
   // if (this->level() != 0)
   // return this->parent()->interior_parent();
  
   // We store the interior_parent pointer after both the parent
   // neighbor and neighbor pointers
   Elem * interior_p = _elemlinks[1+this->n_sides()];
  
   // If we have an interior_parent, we USED TO assume it was a
   // one-higher-dimensional interior element, but we now allow e.g.
   // edge elements to have a 3D interior_parent with no
   // intermediate 2D element.
   // libmesh_assert (!interior_p ||
   //                interior_p->dim() == (this->dim()+1));
   libmesh_assert (!interior_p ||
                   (interior_p == remote_elem) ||
                   (interior_p->dim() > this->dim()));
  
   // We require consistency between AMR of interior and of boundary
   // elements
   if (interior_p && (interior_p != remote_elem))
     libmesh_assert_less_equal (interior_p->level(), this->level());
  
   return interior_p;
 }

References libMesh::Elem::_elemlinks, libMesh::Elem::dim(), libMesh::Elem::level(), libMesh::libmesh_assert(), libMesh::Elem::n_sides(), and libMesh::remote_elem.

Referenced by libMesh::UnstructuredMesh::find_neighbors(), libMesh::BoundaryInfo::get_side_and_node_maps(), libMesh::MeshTools::libmesh_assert_valid_amr_interior_parents(), libMesh::Parallel::Packing< const Elem * >::pack(), BoundaryMeshTest::sanityCheck(), MixedDimensionMeshTest::testMesh(), MixedDimensionNonUniformRefinement::testMesh(), MixedDimensionNonUniformRefinementTriangle::testMesh(), MixedDimensionNonUniformRefinement3D::testMesh(), libMesh::BoundaryVolumeSolutionTransfer::transfer_boundary_volume(), libMesh::BoundaryVolumeSolutionTransfer::transfer_volume_boundary(), and libMesh::Parallel::Packing< Elem * >::unpack().

◆ 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_ancestor_of()

bool libMesh::Elem::is_ancestor_of ( const Elem * descendant ) const

inlineinherited

Returns: true if descendant is a child of this, or a child of a child of this, etc., false otherwise or if AMR is disabled.

Definition at line 2413 of file elem.h.

 {
 #ifdef LIBMESH_ENABLE_AMR
   const Elem * e = descendant;
   while (e)
     {
       if (this == e)
         return true;
       e = e->parent();
     }
 #endif
   return false;
 }

References libMesh::Elem::parent().

Referenced by libMesh::UnstructuredMesh::find_neighbors().

◆ is_child_on_edge()

bool libMesh::Elem::is_child_on_edge	(	const unsigned int	c,
		const unsigned int	e
	)		const

virtualinherited

Returns: true if the specified child is on the specified edge.

Definition at line 1646 of file elem.C.

 {
   libmesh_assert_less (c, this->n_children());
   libmesh_assert_less (e, this->n_edges());
  
   std::unique_ptr<const Elem> my_edge = this->build_edge_ptr(e);
   std::unique_ptr<const Elem> child_edge = this->build_edge_ptr(e);
  
   // We're assuming that an overlapping child edge has the same
   // number and orientation as its parent
   return (child_edge->node_id(0) == my_edge->node_id(0) ||
           child_edge->node_id(1) == my_edge->node_id(1));
 }

References libMesh::Elem::build_edge_ptr(), libMesh::Elem::n_children(), and libMesh::Elem::n_edges().

Referenced by libMesh::FEGenericBase< FEOutputType< T >::type >::coarsened_dof_values(), libMesh::BoundaryInfo::edge_boundary_ids(), and libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectEdges::operator()().

◆ is_child_on_side()

virtual bool libMesh::RemoteElem::is_child_on_side	(	const unsigned int	c,
		const unsigned int	s
	)		const

inlineoverridevirtual

Returns: true if the specified child is on the specified side.

Implements libMesh::Elem.

Definition at line 152 of file remote_elem.h.

154 { libmesh_not_implemented(); return false; }

◆ is_edge()

virtual bool libMesh::RemoteElem::is_edge ( const unsigned int i ) const

inlineoverridevirtual

Returns: true if the specified (local) node number is an edge.

Implements libMesh::Elem.

Definition at line 136 of file remote_elem.h.

137 { libmesh_not_implemented(); return false; }

◆ is_edge_on_side()

virtual bool libMesh::RemoteElem::is_edge_on_side	(	const unsigned int	e,
		const unsigned int	s
	)		const

inlineoverridevirtual

Returns: true if the specified edge is on the specified side.

Implements libMesh::Elem.

Definition at line 156 of file remote_elem.h.

158 { libmesh_not_implemented(); return false; }

◆ is_face()

virtual bool libMesh::RemoteElem::is_face ( const unsigned int i ) const

inlineoverridevirtual

Returns: true if the specified (local) node number is a face.

Implements libMesh::Elem.

Definition at line 139 of file remote_elem.h.

140 { libmesh_not_implemented(); return false; }

◆ is_linear()

virtual bool libMesh::Elem::is_linear ( ) const

inlinevirtualinherited

Returns: true if the Lagrange shape functions on this element are linear.

Reimplemented in libMesh::NodeElem, libMesh::Tet4, libMesh::Tri3, libMesh::Edge2, and libMesh::Tri3Subdivision.

Definition at line 944 of file elem.h.

944 { return false; }

Referenced by libMesh::FEMap::init_reference_to_physical_map().

◆ is_mid_infinite_edge_node()

virtual bool libMesh::Elem::is_mid_infinite_edge_node ( const unsigned int ) const

inlinevirtualinherited

Returns: true if the specified (local) node number is a "mid-edge" node on an infinite element edge.

This is false for all nodes on non-infinite elements, so we won't make it pure virtual, to simplify their code.

Reimplemented in libMesh::InfQuad, libMesh::InfPrism, libMesh::InfHex, and libMesh::InfEdge2.

Definition at line 1584 of file elem.h.

1585 { libmesh_assert (!this->infinite()); return false; }

References libMesh::Elem::infinite(), and libMesh::libmesh_assert().

Referenced by libMesh::Elem::parent_bracketing_nodes().

◆ is_node_on_edge()

virtual bool libMesh::RemoteElem::is_node_on_edge	(	const unsigned int	n,
		const unsigned int	e
	)		const

inlineoverridevirtual

Returns: true if the specified (local) node number is on the specified edge.

Implements libMesh::Elem.

Definition at line 160 of file remote_elem.h.

162 { libmesh_not_implemented(); return false; }

◆ is_node_on_side()

virtual bool libMesh::RemoteElem::is_node_on_side	(	const unsigned int	n,
		const unsigned int	s
	)		const

inlineoverridevirtual

Returns: true if the specified (local) node number is on the specified side.

Implements libMesh::Elem.

Definition at line 142 of file remote_elem.h.

144 { libmesh_not_implemented(); return false; }

◆ is_remote()

virtual bool libMesh::RemoteElem::is_remote ( ) const

inlineoverridevirtual

Returns: true if this element is remote, false otherwise.

A remote element (see RemoteElem) is a syntactic convenience – it is a placeholder for an element which exists on some other processor. Local elements are required to have valid neighbors, and these ghost elements may have remote neighbors for data structure consistency. The use of remote elements helps ensure that any element we may access has a nullptr neighbor only if it lies on the physical boundary of the domain.

Reimplemented from libMesh::Elem.

Definition at line 101 of file remote_elem.h.

102 { return true; }

◆ is_semilocal()

bool libMesh::Elem::is_semilocal ( const processor_id_type my_pid ) const

inherited

Returns: true if this element is semilocal to the calling processor, which must specify its rank.

Definition at line 460 of file elem.C.

 {
   std::set<const Elem *> point_neighbors;
  
   this->find_point_neighbors(point_neighbors);
  
   for (const auto & elem : point_neighbors)
     if (elem->processor_id() == my_pid)
       return true;
  
   return false;
 }

References libMesh::Elem::find_point_neighbors().

◆ is_vertex()

virtual bool libMesh::RemoteElem::is_vertex ( const unsigned int i ) const

inlineoverridevirtual

Returns: true if the specified (local) node number is a vertex.

Implements libMesh::Elem.

Definition at line 133 of file remote_elem.h.

134 { libmesh_not_implemented(); return false; }

◆ is_vertex_on_child()

virtual unsigned int libMesh::Elem::is_vertex_on_child	(	unsigned int	,
		unsigned int	n
	)		const

inlinevirtualinherited

Returns: true if the specified child has a vertex at the specified (child-local) node number. Except in odd cases like pyramid refinement the child will have the same local structure as the parent element.

Definition at line 681 of file elem.h.

683 { return this->is_vertex(n); }

References libMesh::Elem::is_vertex().

Referenced by libMesh::Elem::parent_bracketing_nodes().

◆ is_vertex_on_parent()

bool libMesh::Elem::is_vertex_on_parent	(	unsigned int	c,
		unsigned int	n
	)		const

virtualinherited

Returns: true if this element has a vertex at the specified (child-local) node number n of the specified child c.

Definition at line 2671 of file elem.C.

 {
 #ifdef LIBMESH_ENABLE_AMR
  
   unsigned int my_n_vertices = this->n_vertices();
   for (unsigned int n_parent = 0; n_parent != my_n_vertices;
        ++n_parent)
     if (this->node_ptr(n_parent) == this->child_ptr(c)->node_ptr(n))
       return true;
   return false;
  
 #else
  
   // No AMR?
   libmesh_ignore(c,n);
   libmesh_error_msg("ERROR: AMR disabled, how did we get here?");
   return true;
  
 #endif
 }

References libMesh::Elem::child_ptr(), libMesh::libmesh_ignore(), libMesh::Elem::n_vertices(), and libMesh::Elem::node_ptr().

Referenced by libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectVertices::operator()().

◆ key() [1/4]

dof_id_type libMesh::Elem::key

Don't hide Elem::key() defined in the base class.

Definition at line 410 of file elem.C.

 {
   const unsigned short n_n = this->n_nodes();
  
   std::array<dof_id_type, Elem::max_n_nodes> node_ids;
  
   for (unsigned short n=0; n != n_n; ++n)
     node_ids[n] = this->node_id(n);
  
   // Always sort, so that different local node numberings hash to the
   // same value.
   std::sort (node_ids.begin(), node_ids.begin()+n_n);
  
   return Utility::hashword(node_ids.data(), n_n);
 }

◆ key() [2/4]

dof_id_type libMesh::Elem::key ( ) const

virtualinherited

Returns: An id associated with the global node ids of this element. The id is not necessarily unique, but should be close. Uses the same hash as the key(s) function, so for example if "tri3" is side 0 of "tet4", then tri3->key()==tet4->key(0).

Reimplemented in libMesh::Tri, libMesh::Tet4, libMesh::Edge3, libMesh::Edge4, libMesh::Edge2, libMesh::Quad9, and libMesh::Quad.

Definition at line 410 of file elem.C.

 {
   const unsigned short n_n = this->n_nodes();
  
   std::array<dof_id_type, Elem::max_n_nodes> node_ids;
  
   for (unsigned short n=0; n != n_n; ++n)
     node_ids[n] = this->node_id(n);
  
   // Always sort, so that different local node numberings hash to the
   // same value.
   std::sort (node_ids.begin(), node_ids.begin()+n_n);
  
   return Utility::hashword(node_ids.data(), n_n);
 }

References libMesh::Utility::hashword(), libMesh::Elem::n_nodes(), and libMesh::Elem::node_id().

Referenced by libMesh::InfQuad6::key(), libMesh::Prism18::key(), libMesh::Pyramid14::key(), and libMesh::InfHex18::key().

◆ key() [3/4]

virtual dof_id_type libMesh::Elem::key

Don't hide Elem::key() defined in the base class.

◆ key() [4/4]

virtual dof_id_type libMesh::RemoteElem::key ( const unsigned int s ) const

inlineoverridevirtual

Returns: An id associated with the s side of this element. The id is not necessarily unique, but should be close. This is particularly useful in the MeshBase::find_neighbors() routine.

Implements libMesh::Elem.

Definition at line 94 of file remote_elem.h.

95 { libmesh_not_implemented(); return 0; }

◆ length()

Real libMesh::Elem::length	(	const unsigned int	n1,
		const unsigned int	n2
	)		const

inherited

Returns: The distance between nodes n1 and n2.

Useful for computing the lengths of the sides of elements.

Definition at line 399 of file elem.C.

 {
   libmesh_assert_less ( n1, this->n_vertices() );
   libmesh_assert_less ( n2, this->n_vertices() );
  
   return (this->point(n1) - this->point(n2)).norm();
 }

References libMesh::Elem::n_vertices(), and libMesh::Elem::point().

Referenced by libMesh::Hex::quality(), libMesh::InfHex::quality(), and libMesh::Quad::quality().

◆ level()

unsigned int libMesh::Elem::level ( ) const

inlineinherited

Returns: The refinement level of the current element.

If the element's parent is nullptr then by convention it is at level 0, otherwise it is simply at one level greater than its parent.

Definition at line 2478 of file elem.h.

 {
 #ifdef LIBMESH_ENABLE_AMR
  
   // if I don't have a parent I was
   // created directly from file
   // or by the user, so I am a
   // level-0 element
   if (this->parent() == nullptr)
     return 0;
  
   // if the parent and this element are of different
   // dimensionality we are at the same level as
   // the parent (e.g. we are the 2D side of a
   // 3D element)
   if (this->dim() != this->parent()->dim())
     return this->parent()->level();
  
   // otherwise we are at a level one
   // higher than our parent
   return (this->parent()->level() + 1);
  
 #else
  
   // Without AMR all elements are
   // at level 0.
   return 0;
  
 #endif
 }

References libMesh::Elem::dim(), libMesh::Elem::level(), and libMesh::Elem::parent().

◆ libmesh_assert_valid_neighbors()

void libMesh::Elem::libmesh_assert_valid_neighbors ( ) const

inherited

Checks for consistent neighbor links on this element.

Definition at line 935 of file elem.C.

 {
   for (auto n : this->side_index_range())
     {
       const Elem * neigh = this->neighbor_ptr(n);
  
       // Any element might have a remote neighbor; checking
       // to make sure that's not inaccurate is tough.
       if (neigh == remote_elem)
         continue;
  
       if (neigh)
         {
           // Only subactive elements have subactive neighbors
           libmesh_assert (this->subactive() || !neigh->subactive());
  
           const Elem * elem = this;
  
           // If we're subactive but our neighbor isn't, its
           // return neighbor link will be to our first active
           // ancestor OR to our inactive ancestor of the same
           // level as neigh,
           if (this->subactive() && !neigh->subactive())
             {
               for (elem = this; !elem->active();
                    elem = elem->parent())
                 libmesh_assert(elem);
             }
           else
             {
               unsigned int rev = neigh->which_neighbor_am_i(elem);
               libmesh_assert_less (rev, neigh->n_neighbors());
  
               if (this->subactive() && !neigh->subactive())
                 {
                   while (neigh->neighbor_ptr(rev) != elem)
                     {
                       libmesh_assert(elem->parent());
                       elem = elem->parent();
                     }
                 }
               else
                 {
                   const Elem * nn = neigh->neighbor_ptr(rev);
                   libmesh_assert(nn);
  
                   for (; elem != nn; elem = elem->parent())
                     libmesh_assert(elem);
                 }
             }
         }
       // If we don't have a neighbor and we're not subactive, our
       // ancestors shouldn't have any neighbors in this same
       // direction.
       else if (!this->subactive())
         {
           const Elem * my_parent = this->parent();
           if (my_parent &&
               // A parent with a different dimension isn't really one of
               // our ancestors, it means we're on a boundary mesh and this
               // is an interior mesh element for which we're on a side.
               // Nothing to test for in that case.
               (my_parent->dim() == this->dim()))
             libmesh_assert (!my_parent->neighbor_ptr(n));
         }
     }
 }

References libMesh::Elem::dim(), libMesh::libmesh_assert(), libMesh::Elem::n_neighbors(), libMesh::Elem::neighbor_ptr(), libMesh::Elem::parent(), libMesh::remote_elem, libMesh::Elem::side_index_range(), libMesh::Elem::subactive(), and libMesh::Elem::which_neighbor_am_i().

◆ libmesh_assert_valid_node_pointers()

void libMesh::Elem::libmesh_assert_valid_node_pointers ( ) const

inherited

Checks for a valid id and pointers to nodes with valid ids on this element.

Definition at line 923 of file elem.C.

 {
   libmesh_assert(this->valid_id());
   for (auto n : this->node_index_range())
     {
       libmesh_assert(this->node_ptr(n));
       libmesh_assert(this->node_ptr(n)->valid_id());
     }
 }

References libMesh::libmesh_assert(), libMesh::Elem::node_index_range(), libMesh::Elem::node_ptr(), and libMesh::DofObject::valid_id().

◆ local_node()

unsigned int libMesh::Elem::local_node ( const dof_id_type i ) const

inlineinherited

Returns: The local id number of global Node id i, or invalid_uint if Node id i is not local.

Definition at line 1989 of file elem.h.

 {
   for (auto n : IntRange<unsigned int>(0, this->n_nodes()))
     if (this->node_id(n) == i)
       return n;
  
   return libMesh::invalid_uint;
 }

References libMesh::invalid_uint, libMesh::Elem::n_nodes(), and libMesh::Elem::node_id().

Referenced by libMesh::ReplicatedMesh::stitching_helper().

◆ loose_bounding_box()

BoundingBox libMesh::Elem::loose_bounding_box ( ) const

virtualinherited

Returns: A bounding box (not necessarily the minimal bounding box) containing the geometric element.

The base class implementation determines a bounding box for the element nodes, which should be sufficient for first order finite elements. Higher order geometric elements will need to override with an implementation which takes curved elements into account.

Reimplemented in libMesh::Quad9, libMesh::Tri6, libMesh::Quad8, libMesh::Hex8, libMesh::Prism6, libMesh::Tri3, libMesh::Pyramid5, libMesh::Edge3, libMesh::Quad4, libMesh::Edge4, and libMesh::Cell.

Definition at line 2649 of file elem.C.

 {
   Point pmin = this->point(0);
   Point pmax = pmin;
  
   unsigned int n_points = this->n_nodes();
   for (unsigned int p=0; p != n_points; ++p)
     for (unsigned d=0; d<LIBMESH_DIM; ++d)
       {
         const Point & pt = this->point(p);
         if (pmin(d) > pt(d))
           pmin(d) = pt(d);
  
         if (pmax(d) < pt(d))
           pmax(d) = pt(d);
       }
  
   return BoundingBox(pmin, pmax);
 }

References libMesh::Elem::n_nodes(), and libMesh::Elem::point().

Referenced by libMesh::TreeNode< N >::insert(), libMesh::Quad4::loose_bounding_box(), libMesh::Pyramid5::loose_bounding_box(), libMesh::Tri3::loose_bounding_box(), libMesh::Prism6::loose_bounding_box(), and libMesh::Hex8::loose_bounding_box().

◆ make_links_to_me_local()

void libMesh::Elem::make_links_to_me_local	(	unsigned int	n,
		unsigned int	neighbor_side
	)

inherited

Resets the neighbor_side pointers of our nth neighbor (and its descendants, if appropriate) to point to this Elem instead of to the global remote_elem.

Used by the library when a formerly remote element is being added to the local processor.

Definition at line 1007 of file elem.C.

 {
   Elem * neigh = this->neighbor_ptr(n);
  
   // Don't bother calling this function unless it's necessary
   libmesh_assert(neigh);
   libmesh_assert(!neigh->is_remote());
  
   // We never have neighbors more refined than us
   libmesh_assert_less_equal (neigh->level(), this->level());
  
   // We never have subactive neighbors of non subactive elements
   libmesh_assert(!neigh->subactive() || this->subactive());
  
   // If we have a neighbor less refined than us then it must not
   // have any more refined descendants we could have pointed to
   // instead.
   libmesh_assert((neigh->level() == this->level()) ||
                  (neigh->active() && !this->subactive()) ||
                  (!neigh->has_children() && this->subactive()));
  
   // If neigh is at our level, then its family might have
   // remote_elem neighbor links which need to point to us
   // instead, but if not, then we're done.
   if (neigh->level() != this->level())
     return;
  
   // What side of neigh are we on?  nn.
   //
   // We can't use the usual Elem method because we're in the middle of
   // restoring topology.  We can't compare side_ptr nodes because
   // users want to abuse neighbor_ptr to point to
   // not-technically-neighbors across mesh slits.  We can't compare
   // node locations because users want to move those
   // not-technically-neighbors until they're
   // not-even-geometrically-neighbors.
  
   // Find any elements that ought to point to elem
   std::vector<Elem *> neigh_family;
 #ifdef LIBMESH_ENABLE_AMR
   if (this->active())
     neigh->family_tree_by_side(neigh_family, nn);
   else
 #endif
     neigh_family.push_back(neigh);
  
   // And point them to elem
   for (auto & neigh_family_member : neigh_family)
     {
       // Only subactive elements point to other subactive elements
       if (this->subactive() && !neigh_family_member->subactive())
         continue;
  
       // Ideally, the neighbor link ought to either be correct
       // already or ought to be to remote_elem.
       //
       // However, if we're redistributing a newly created elem,
       // after an AMR step but before find_neighbors has fixed up
       // neighbor links, we might have an out of date neighbor
       // link to elem's parent instead.
 #ifdef LIBMESH_ENABLE_AMR
       libmesh_assert((neigh_family_member->neighbor_ptr(nn) &&
                       (neigh_family_member->neighbor_ptr(nn)->active() ||
                        neigh_family_member->neighbor_ptr(nn)->is_ancestor_of(this))) ||
                      (neigh_family_member->neighbor_ptr(nn) == remote_elem) ||
                      ((this->refinement_flag() == JUST_REFINED) &&
                       (this->parent() != nullptr) &&
                       (neigh_family_member->neighbor_ptr(nn) == this->parent())));
 #else
       libmesh_assert((neigh_family_member->neighbor_ptr(nn) == this) ||
                      (neigh_family_member->neighbor_ptr(nn) == remote_elem));
 #endif
  
       neigh_family_member->set_neighbor(nn, this);
     }
 }

References libMesh::Elem::active(), libMesh::Elem::family_tree_by_side(), libMesh::Elem::has_children(), libMesh::Elem::is_remote(), libMesh::Elem::JUST_REFINED, libMesh::Elem::level(), libMesh::libmesh_assert(), libMesh::Elem::neighbor_ptr(), libMesh::Elem::parent(), libMesh::Elem::refinement_flag(), libMesh::remote_elem, and libMesh::Elem::subactive().

Referenced by libMesh::Parallel::Packing< Elem * >::unpack().

◆ make_links_to_me_remote()

void libMesh::Elem::make_links_to_me_remote ( )

inherited

Resets this element's neighbors' appropriate neighbor pointers and its parent's and children's appropriate pointers to point to the global remote_elem instead of this.

Used by the library before an element becomes remote on the local processor.

Definition at line 1085 of file elem.C.

 {
   libmesh_assert_not_equal_to (this, remote_elem);
  
   // We need to have handled any children first
 #if defined(LIBMESH_ENABLE_AMR) && defined(DEBUG)
   if (this->has_children())
     for (auto & child : this->child_ref_range())
       libmesh_assert_equal_to (&child, remote_elem);
 #endif
  
   // Remotify any neighbor links
   for (auto neigh : this->neighbor_ptr_range())
     {
       if (neigh && neigh != remote_elem)
         {
           // My neighbor should never be more refined than me; my real
           // neighbor would have been its parent in that case.
           libmesh_assert_greater_equal (this->level(), neigh->level());
  
           if (this->level() == neigh->level() &&
               neigh->has_neighbor(this))
             {
 #ifdef LIBMESH_ENABLE_AMR
               // My neighbor may have descendants which also consider me a
               // neighbor
               std::vector<Elem *> family;
               neigh->total_family_tree_by_neighbor (family, this);
  
               // FIXME - There's a lot of ugly const_casts here; we
               // may want to make remote_elem non-const
               for (auto & n : family)
                 {
                   libmesh_assert (n);
                   if (n == remote_elem)
                     continue;
                   unsigned int my_s = n->which_neighbor_am_i(this);
                   libmesh_assert_less (my_s, n->n_neighbors());
                   libmesh_assert_equal_to (n->neighbor_ptr(my_s), this);
                   n->set_neighbor(my_s, const_cast<RemoteElem *>(remote_elem));
                 }
 #else
               unsigned int my_s = neigh->which_neighbor_am_i(this);
               libmesh_assert_less (my_s, neigh->n_neighbors());
               libmesh_assert_equal_to (neigh->neighbor_ptr(my_s), this);
               neigh->set_neighbor(my_s, const_cast<RemoteElem *>(remote_elem));
 #endif
             }
 #ifdef LIBMESH_ENABLE_AMR
           // Even if my neighbor doesn't link back to me, it might
           // have subactive descendants which do
           else if (neigh->has_children())
             {
               // If my neighbor at the same level doesn't have me as a
               // neighbor, I must be subactive
               libmesh_assert(this->level() > neigh->level() ||
                              this->subactive());
  
               // My neighbor must have some ancestor of mine as a
               // neighbor
               Elem * my_ancestor = this->parent();
               libmesh_assert(my_ancestor);
               while (!neigh->has_neighbor(my_ancestor))
                 {
                   my_ancestor = my_ancestor->parent();
                   libmesh_assert(my_ancestor);
                 }
  
               // My neighbor may have descendants which consider me a
               // neighbor
               std::vector<Elem *> family;
               neigh->total_family_tree_by_subneighbor (family, my_ancestor, this);
  
               for (auto & n : family)
                 {
                   libmesh_assert (n);
                   if (n->is_remote())
                     continue;
                   unsigned int my_s = n->which_neighbor_am_i(this);
                   libmesh_assert_less (my_s, n->n_neighbors());
                   libmesh_assert_equal_to (n->neighbor_ptr(my_s), this);
                   // TODO: we may want to make remote_elem non-const.
                   n->set_neighbor(my_s, const_cast<RemoteElem *>(remote_elem));
                 }
             }
 #endif
         }
     }
  
 #ifdef LIBMESH_ENABLE_AMR
   // Remotify parent's child link
   Elem * my_parent = this->parent();
   if (my_parent &&
       // As long as it's not already remote
       my_parent != remote_elem &&
       // And it's a real parent, not an interior parent
       this->dim() == my_parent->dim())
     {
       unsigned int me = my_parent->which_child_am_i(this);
       libmesh_assert_equal_to (my_parent->child_ptr(me), this);
       my_parent->set_child(me, const_cast<RemoteElem *>(remote_elem));
     }
 #endif
 }

References libMesh::Elem::child_ptr(), libMesh::Elem::child_ref_range(), libMesh::Elem::dim(), libMesh::Elem::has_children(), libMesh::Elem::level(), libMesh::libmesh_assert(), libMesh::Elem::neighbor_ptr_range(), libMesh::Elem::parent(), libMesh::remote_elem, libMesh::Elem::set_child(), libMesh::Elem::subactive(), and libMesh::Elem::which_child_am_i().

Referenced by libMesh::MeshCommunication::delete_remote_elements().

◆ mapping_data()

unsigned char libMesh::Elem::mapping_data ( ) const

inlineinherited

Returns: The value of the mapping data for the element.

Definition at line 2540 of file elem.h.

 {
   return _map_data;
 }

References libMesh::Elem::_map_data.

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

◆ mapping_type()

ElemMappingType libMesh::Elem::mapping_type ( ) const

inlineinherited

Returns: The value of the mapping type for the element.

Definition at line 2524 of file elem.h.

 {
   return static_cast<ElemMappingType>(_map_type);
 }

References libMesh::Elem::_map_type.

Referenced by libMesh::QComposite< QSubCell >::init(), libMesh::FEMap::map_fe_type(), libMesh::Quad8::volume(), libMesh::Tri6::volume(), libMesh::Quad9::volume(), libMesh::Pyramid13::volume(), libMesh::Tet10::volume(), libMesh::Hex20::volume(), libMesh::Prism15::volume(), libMesh::Pyramid14::volume(), libMesh::Prism18::volume(), and libMesh::Hex27::volume().

◆ master_point()

virtual Point libMesh::RemoteElem::master_point ( const unsigned int i ) const

inlineoverridevirtual

Returns: The Point associated with local Node i, in master element rather than physical coordinates.

Implements libMesh::Elem.

Definition at line 83 of file remote_elem.h.

84 { libmesh_not_implemented(); return Point(); }

◆ max_descendant_p_level()

unsigned int libMesh::Elem::max_descendant_p_level ( ) const

inlineinherited

Returns: The maximum value of the p-refinement levels of an ancestor element's descendants.

Definition at line 2650 of file elem.h.

 {
   // This is undefined for subactive elements,
   // which have no active descendants
   libmesh_assert (!this->subactive());
   if (this->active())
     return this->p_level();
  
   unsigned int max_p_level = _p_level;
   for (auto & c : child_ref_range())
     max_p_level = std::max(max_p_level,
                            c.max_descendant_p_level());
   return max_p_level;
 }

References libMesh::Elem::_p_level, libMesh::Elem::active(), libMesh::Elem::child_ref_range(), libMesh::libmesh_assert(), libMesh::Elem::p_level(), and libMesh::Elem::subactive().

Referenced by libMesh::FEGenericBase< FEOutputType< T >::type >::coarsened_dof_values().

◆ min_new_p_level_by_neighbor()

unsigned int libMesh::Elem::min_new_p_level_by_neighbor	(	const Elem *	neighbor,
		unsigned int	current_min
	)		const

inherited

Returns: The minimum new p-refinement level (i.e. after refinement and coarsening is done) of elements which are descended from this element and which share a side with the active neighbor.

Definition at line 1692 of file elem.C.

 {
   libmesh_assert(!this->subactive());
   libmesh_assert(neighbor_in->active());
  
   // If we're an active element this is simple
   if (this->active())
     {
       unsigned int new_p_level = this->p_level();
       if (this->p_refinement_flag() == Elem::REFINE)
         new_p_level += 1;
       if (this->p_refinement_flag() == Elem::COARSEN)
         {
           libmesh_assert_greater (new_p_level, 0);
           new_p_level -= 1;
         }
       return std::min(current_min, new_p_level);
     }
  
   libmesh_assert(has_neighbor(neighbor_in));
  
   unsigned int min_p_level = current_min;
  
   for (auto & c : this->child_ref_range())
     if (&c != remote_elem && c.has_neighbor(neighbor_in))
       min_p_level =
         c.min_new_p_level_by_neighbor(neighbor_in, min_p_level);
  
   return min_p_level;
 }

References libMesh::Elem::active(), libMesh::Elem::child_ref_range(), libMesh::Elem::COARSEN, libMesh::Elem::has_neighbor(), libMesh::libmesh_assert(), libMesh::Elem::p_level(), libMesh::Elem::p_refinement_flag(), libMesh::Elem::REFINE, libMesh::remote_elem, and libMesh::Elem::subactive().

◆ min_p_level_by_neighbor()

unsigned int libMesh::Elem::min_p_level_by_neighbor	(	const Elem *	neighbor,
		unsigned int	current_min
	)		const

inherited

Returns: The minimum p-refinement level of elements which are descended from this element, and which share a side with the active neighbor.

Definition at line 1663 of file elem.C.

 {
   libmesh_assert(!this->subactive());
   libmesh_assert(neighbor_in->active());
  
   // If we're an active element this is simple
   if (this->active())
     return std::min(current_min, this->p_level());
  
   libmesh_assert(has_neighbor(neighbor_in));
  
   // The p_level() of an ancestor element is already the minimum
   // p_level() of its children - so if that's high enough, we don't
   // need to examine any children.
   if (current_min <= this->p_level())
     return current_min;
  
   unsigned int min_p_level = current_min;
  
   for (auto & c : this->child_ref_range())
     if (&c != remote_elem && c.has_neighbor(neighbor_in))
       min_p_level =
         c.min_p_level_by_neighbor(neighbor_in, min_p_level);
  
   return min_p_level;
 }

References libMesh::Elem::active(), libMesh::Elem::child_ref_range(), libMesh::Elem::has_neighbor(), libMesh::libmesh_assert(), libMesh::Elem::p_level(), libMesh::remote_elem, and libMesh::Elem::subactive().

Referenced by libMesh::FEGenericBase< FEOutputType< T >::type >::compute_periodic_constraints(), and libMesh::FEGenericBase< FEOutputType< T >::type >::compute_proj_constraints().

◆ n_children()

virtual unsigned int libMesh::RemoteElem::n_children ( ) const

inlineoverridevirtual

Returns: The number of children the element that has been derived from this class may have.

Implements libMesh::Elem.

Definition at line 130 of file remote_elem.h.

131 { libmesh_not_implemented(); return 0; }

◆ 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(), libMesh::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_edges()

virtual unsigned int libMesh::RemoteElem::n_edges ( ) const

inlineoverridevirtual

Returns: The number of edges the element that has been derived from this class has.

Implements libMesh::Elem.

Definition at line 124 of file remote_elem.h.

125 { libmesh_not_implemented(); return 0; }

◆ 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_faces()

virtual unsigned int libMesh::RemoteElem::n_faces ( ) const

inlineoverridevirtual

Returns: The number of faces the element that has been derived from this class has.

Implements libMesh::Elem.

Definition at line 127 of file remote_elem.h.

128 { libmesh_not_implemented(); return 0; }

◆ n_neighbors()

unsigned int libMesh::Elem::n_neighbors ( ) const

inlineinherited

Returns: The number of neighbors the element that has been derived from this class has.

Only face (or edge in 2D) neighbors are stored, so this method returns n_sides(). At one point we intended to allow derived classes to override this, but too much current libMesh code assumes n_neighbors==n_sides.

Definition at line 631 of file elem.h.

632 { return this->n_sides(); }

References libMesh::Elem::n_sides().

Referenced by libMesh::Elem::_last_side(), assemble_SchroedingerEquation(), libMesh::FEGenericBase< FEOutputType< T >::type >::compute_proj_constraints(), libMesh::MeshTools::find_hanging_nodes_and_parents(), libMesh::Tri3Subdivision::get_ordered_valence(), libMesh::MeshTools::libmesh_assert_valid_neighbors(), libMesh::Elem::libmesh_assert_valid_neighbors(), libMesh::Elem::neighbor_ptr(), libMesh::Elem::neighbor_ptr_range(), libMesh::Elem::nullify_neighbors(), libMesh::Elem::set_neighbor(), and libMesh::Elem::topological_neighbor().

◆ n_nodes()

virtual unsigned int libMesh::RemoteElem::n_nodes ( ) const

inlineoverridevirtual

Returns: The number of nodes this element contains.

Implements libMesh::Elem.

Definition at line 115 of file remote_elem.h.

116 { libmesh_not_implemented(); return 0; }

◆ n_nodes_in_child()

virtual unsigned int libMesh::Elem::n_nodes_in_child ( unsigned int ) const

inlinevirtualinherited

Returns: The number of nodes the given child of this element contains. Except in odd cases like pyramid refinement this will be the same as the number of nodes in the parent element.

Definition at line 600 of file elem.h.

601 { return this->n_nodes(); }

References libMesh::Elem::n_nodes().

Referenced by libMesh::Elem::as_parent_node(), libMesh::Elem::bracketing_nodes(), and libMesh::Elem::parent_bracketing_nodes().

◆ 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_second_order_adjacent_vertices()

unsigned int libMesh::Elem::n_second_order_adjacent_vertices ( const unsigned int n ) const

virtualinherited

Returns: The number of adjacent vertices that uniquely define the location of the \( n^{th} \) second-order node, or 0 for linear elements.

This method is useful when converting linear elements to quadratic elements.

Note: n has to be greater than or equal to this->n_vertices().

Reimplemented in libMesh::InfHex18, libMesh::Hex27, libMesh::Prism18, libMesh::InfHex16, libMesh::Hex20, libMesh::Prism15, libMesh::Tet10, libMesh::Tri6, libMesh::InfPrism12, libMesh::Quad8, libMesh::InfQuad6, libMesh::Edge4, libMesh::Edge3, libMesh::Pyramid14, libMesh::Pyramid13, and libMesh::Quad9.

Definition at line 2343 of file elem.C.

 {
   // for linear elements, always return 0
   return 0;
 }

Referenced by libMesh::UnstructuredMesh::all_second_order(), and libMesh::MeshTools::Modification::smooth().

◆ n_sides()

virtual unsigned int libMesh::RemoteElem::n_sides ( ) const

inlineoverridevirtual

Returns: The number of sides the element that has been derived from this class has. In 2D the number of sides is the number of edges, in 3D the number of sides is the number of faces.

Implements libMesh::Elem.

Definition at line 118 of file remote_elem.h.

119 { libmesh_not_implemented(); return 0; }

◆ n_sub_elem()

virtual unsigned int libMesh::RemoteElem::n_sub_elem ( ) const

inlineoverridevirtual

Returns: The number of sub-elements this element may be broken down into for visualization purposes. For example, 1 for a linear triangle, 4 for a quadratic (6-noded) triangle, etc...

Implements libMesh::Elem.

Definition at line 164 of file remote_elem.h.

165 { libmesh_not_implemented(); return 0; }

◆ 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().

◆ n_vertices()

virtual unsigned int libMesh::RemoteElem::n_vertices ( ) const

inlineoverridevirtual

Returns: The number of vertices the element that has been derived from this class has.

Implements libMesh::Elem.

Definition at line 121 of file remote_elem.h.

122 { libmesh_not_implemented(); return 0; }

◆ neighbor_ptr() [1/2]

Elem * libMesh::Elem::neighbor_ptr ( unsigned int i )

inlineinherited

Returns: A non-const pointer to the \( i^{th} \) neighbor of this element.

Definition at line 2095 of file elem.h.

 {
   libmesh_assert_less (i, this->n_neighbors());
  
   return _elemlinks[i+1];
 }

References libMesh::Elem::_elemlinks, and libMesh::Elem::n_neighbors().

◆ neighbor_ptr() [2/2]

const Elem * libMesh::Elem::neighbor_ptr ( unsigned int i ) const

inlineinherited

Returns: A const pointer to the \( i^{th} \) neighbor of this element, or nullptr if MeshBase::find_neighbors() has not been called.

Note: If MeshBase::find_neighbors() has been called and this function still returns nullptr, then the side is on a boundary of the domain.

Definition at line 2085 of file elem.h.

 {
   libmesh_assert_less (i, this->n_neighbors());
  
   return _elemlinks[i+1];
 }

References libMesh::Elem::_elemlinks, and libMesh::Elem::n_neighbors().

Referenced by libMesh::BoundaryInfo::_find_id_maps(), libMesh::MeshTools::Subdivision::add_boundary_ghosts(), libMesh::BoundaryInfo::add_elements(), libMesh::RBConstruction::add_scaled_matrix_and_vector(), libMesh::UnstructuredMesh::all_second_order(), libMesh::MeshTools::Modification::all_tri(), assemble_ellipticdg(), assemble_SchroedingerEquation(), assembly_with_dg_fem_context(), libMesh::BoundaryInfo::boundary_ids(), libMesh::InfElemBuilder::build_inf_elem(), compute_jacobian(), libMesh::FEAbstract::compute_node_constraints(), libMesh::FEGenericBase< FEOutputType< T >::type >::compute_periodic_constraints(), libMesh::FEAbstract::compute_periodic_node_constraints(), libMesh::FEGenericBase< FEOutputType< T >::type >::compute_proj_constraints(), compute_residual(), libMesh::UnstructuredMesh::copy_nodes_and_elements(), libMesh::BoundaryInfo::edge_boundary_ids(), libMesh::JumpErrorEstimator::estimate_error(), libMesh::MeshTools::find_hanging_nodes_and_parents(), libMesh::UnstructuredMesh::find_neighbors(), libMesh::MeshTools::Subdivision::find_one_ring(), libMesh::MeshTools::Modification::flatten(), libMesh::ReplicatedMesh::get_boundary_points(), libMesh::ReplicatedMesh::get_disconnected_subdomains(), libMesh::Elem::get_info(), libMesh::MeshTools::libmesh_assert_valid_neighbors(), libMesh::Elem::libmesh_assert_valid_neighbors(), libMesh::Elem::make_links_to_me_local(), libMesh::Elem::nullify_neighbors(), libMesh::DefaultCoupling::operator()(), libMesh::CheckpointIO::read_remote_elem(), libMesh::FE< Dim, LAGRANGE_VEC >::reinit(), libMesh::FE< Dim, LAGRANGE_VEC >::side_map(), libMesh::Elem::SideIter::side_on_boundary(), libMesh::BoundaryInfo::side_with_boundary_id(), libMesh::MeshTools::Modification::smooth(), libMesh::ReplicatedMesh::stitching_helper(), DefaultCouplingTest::testCoupling(), PointNeighborCouplingTest::testCoupling(), libMesh::Elem::topological_neighbor(), libMesh::MeshRefinement::topological_neighbor(), libMesh::Parallel::Packing< Elem * >::unpack(), libMesh::Elem::which_neighbor_am_i(), and libMesh::CheckpointIO::write_remote_elem().

◆ neighbor_ptr_range() [1/2]

SimpleRange< Elem::NeighborPtrIter > libMesh::Elem::neighbor_ptr_range ( )

inlineinherited

Returns a range with all neighbors of an element, usable in range-based for loops.

The exact type of the return value here may be subject to change in future libMesh releases, but the iterators will always dereference to produce a pointer to a neighbor element (or a null pointer, for sides which have no neighbors).

Definition at line 2917 of file elem.h.

 {
   return {_elemlinks+1, _elemlinks + 1 + this->n_neighbors()};
 }

References libMesh::Elem::_elemlinks, and libMesh::Elem::n_neighbors().

Referenced by libMesh::Elem::child_neighbor(), libMesh::UnstructuredMesh::find_neighbors(), libMesh::Elem::has_neighbor(), libMesh::Elem::make_links_to_me_remote(), libMesh::Parallel::Packing< const Elem * >::pack(), and libMesh::Elem::remove_links_to_me().

◆ neighbor_ptr_range() [2/2]

SimpleRange< Elem::ConstNeighborPtrIter > libMesh::Elem::neighbor_ptr_range ( ) const

inlineinherited

Definition at line 2924 of file elem.h.

 {
   return {_elemlinks+1, _elemlinks + 1 + this->n_neighbors()};
 }

References libMesh::Elem::_elemlinks, and libMesh::Elem::n_neighbors().

◆ node_id()

dof_id_type libMesh::Elem::node_id ( const unsigned int i ) const

inlineinherited

Returns: The global id number of local Node i.

Definition at line 1977 of file elem.h.

 {
   libmesh_assert_less (i, this->n_nodes());
   libmesh_assert(_nodes[i]);
   libmesh_assert_not_equal_to (_nodes[i]->id(), Node::invalid_id);
  
   return _nodes[i]->id();
 }

References libMesh::Elem::_nodes, libMesh::DofObject::id(), libMesh::DofObject::invalid_id, libMesh::libmesh_assert(), and libMesh::Elem::n_nodes().

◆ node_index_range()

IntRange< unsigned short > libMesh::Elem::node_index_range ( ) const

inlineinherited

Returns: An integer range from 0 up to (but not including) the number of nodes this element contains.

Definition at line 2170 of file elem.h.

 {
   return {0, cast_int<unsigned short>(this->n_nodes())};
 }

References libMesh::Elem::n_nodes().

Referenced by libMesh::MeshRefinement::add_node(), libMesh::TetGenMeshInterface::assign_nodes_to_elem(), libMesh::Elem::coarsen(), libMesh::FEMap::compute_map(), libMesh::FEGenericBase< FEOutputType< T >::type >::compute_periodic_constraints(), libMesh::MeshTools::Modification::flatten(), libMesh::Elem::get_info(), libMesh::Elem::libmesh_assert_valid_node_pointers(), libMesh::XdrIO::pack_element(), libMesh::TetGenMeshInterface::pointset_convexhull(), libMesh::VTKIO::read(), libMesh::UCDIO::read_implementation(), libMesh::Elem::refine(), libMesh::FE< Dim, LAGRANGE_VEC >::reinit(), libMesh::FE< Dim, LAGRANGE_VEC >::side_map(), libMesh::MeshTools::Modification::smooth(), libMesh::TetGenMeshInterface::triangulate_conformingDelaunayMesh_carvehole(), libMesh::TetGenMeshInterface::triangulate_pointset(), libMesh::Elem::write_connectivity(), and libMesh::ExodusII_IO_Helper::write_elements().

◆ node_ptr() [1/2]

Node * libMesh::Elem::node_ptr ( const unsigned int i )

inlineinherited

Returns: A non-const pointer to local Node i.

Definition at line 2020 of file elem.h.

 {
   libmesh_assert_less (i, this->n_nodes());
   libmesh_assert(_nodes[i]);
  
   return _nodes[i];
 }

References libMesh::Elem::_nodes, libMesh::libmesh_assert(), and libMesh::Elem::n_nodes().

◆ node_ptr() [2/2]

const Node * libMesh::Elem::node_ptr ( const unsigned int i ) const

inlineinherited

Returns: A const pointer to local Node i.

Definition at line 2009 of file elem.h.

 {
   libmesh_assert_less (i, this->n_nodes());
   libmesh_assert(_nodes[i]);
  
   return _nodes[i];
 }

References libMesh::Elem::_nodes, libMesh::libmesh_assert(), and libMesh::Elem::n_nodes().

◆ node_ref() [1/2]

Node & libMesh::Elem::node_ref ( const unsigned int i )

inlineinherited

Returns: A writable reference to local Node i.

Definition at line 2039 of file elem.h.

 {
   return *this->node_ptr(i);
 }

References libMesh::Elem::node_ptr().

◆ node_ref() [2/2]

const Node & libMesh::Elem::node_ref ( const unsigned int i ) const

inlineinherited

Returns: A const reference to local Node i.

Definition at line 2031 of file elem.h.

 {
   return *this->node_ptr(i);
 }

References libMesh::Elem::node_ptr().

Referenced by libMesh::RBDataSerialization::add_elem_to_builder(), libMesh::FEGenericBase< FEOutputType< T >::type >::compute_periodic_constraints(), libMesh::DofMap::constrain_p_dofs(), libMesh::DofMap::dof_indices(), libMesh::TopologyMap::fill(), libMesh::Elem::get_info(), libMesh::MeshCommunication::make_new_node_proc_ids_parallel_consistent(), libMesh::DofMap::old_dof_indices(), ParsedFEMFunctionTest::setUp(), libMesh::FE< Dim, LAGRANGE_VEC >::shape(), libMesh::FE< Dim, LAGRANGE_VEC >::shape_deriv(), libMesh::FE< Dim, LAGRANGE_VEC >::shape_second_deriv(), libMesh::Parallel::sync_node_data_by_element_id_once(), and SlitMeshRefinedSystemTest::testRestart().

◆ node_ref_range() [1/2]

SimpleRange< Elem::NodeRefIter > libMesh::Elem::node_ref_range ( )

inlineinherited

Returns a range with all nodes of an element, usable in range-based for loops.

The exact type of the return value here may be subject to change in future libMesh releases, but the iterators will always dereference to produce a reference to a Node.

Definition at line 2152 of file elem.h.

 {
   return {_nodes, _nodes+this->n_nodes()};
 }

References libMesh::Elem::_nodes, and libMesh::Elem::n_nodes().

Referenced by libMesh::MeshTools::Modification::distort(), libMesh::MeshCommunication::make_new_node_proc_ids_parallel_consistent(), libMesh::Parallel::Packing< const Elem * >::pack(), libMesh::Elem::point_test(), libMesh::reconnect_nodes(), libMesh::ReplicatedMesh::renumber_nodes_and_elements(), libMesh::DistributedMesh::renumber_nodes_and_elements(), libMesh::FE< Dim, LAGRANGE_VEC >::shape(), libMesh::FE< Dim, LAGRANGE_VEC >::shape_deriv(), libMesh::FE< Dim, LAGRANGE_VEC >::shape_second_deriv(), libMesh::BoundaryVolumeSolutionTransfer::transfer_boundary_volume(), and libMesh::BoundaryVolumeSolutionTransfer::transfer_volume_boundary().

◆ node_ref_range() [2/2]

SimpleRange< Elem::ConstNodeRefIter > libMesh::Elem::node_ref_range ( ) const

inlineinherited

Definition at line 2161 of file elem.h.

 {
   return {_nodes, _nodes+this->n_nodes()};
 }

References libMesh::Elem::_nodes, and libMesh::Elem::n_nodes().

◆ nodes_on_side()

virtual std::vector<unsigned int> libMesh::RemoteElem::nodes_on_side ( const unsigned int ) const

inlineoverridevirtual

Returns: the (local) node numbers on the specified side

Implements libMesh::Elem.

Definition at line 146 of file remote_elem.h.

   {
     libmesh_not_implemented();
     return {0};
   }

◆ nullify_neighbors()

void libMesh::Elem::nullify_neighbors ( )

inherited

Replaces this element with nullptr for all of its neighbors.

This is useful when deleting an element.

Definition at line 2317 of file elem.C.

 {
   // Tell any of my neighbors about my death...
   // Looks strange, huh?
   for (auto n : this->side_index_range())
     {
       Elem * current_neighbor = this->neighbor_ptr(n);
       if (current_neighbor && current_neighbor != remote_elem)
         {
           // Note:  it is possible that I see the neighbor
           // (which is coarser than me)
           // but they don't see me, so avoid that case.
           if (current_neighbor->level() == this->level())
             {
               const unsigned int w_n_a_i = current_neighbor->which_neighbor_am_i(this);
               libmesh_assert_less (w_n_a_i, current_neighbor->n_neighbors());
               current_neighbor->set_neighbor(w_n_a_i, nullptr);
               this->set_neighbor(n, nullptr);
             }
         }
     }
 }

References libMesh::Elem::level(), libMesh::Elem::n_neighbors(), libMesh::Elem::neighbor_ptr(), libMesh::remote_elem, libMesh::Elem::set_neighbor(), libMesh::Elem::side_index_range(), and libMesh::Elem::which_neighbor_am_i().

◆ on_boundary()

bool libMesh::Elem::on_boundary ( ) const

inlineinherited

Returns: true if this element has a side coincident with a boundary (indicated by a nullptr neighbor), false otherwise.

Definition at line 2313 of file elem.h.

 {
   // By convention, the element is on the boundary
   // if it has a nullptr neighbor.
   return this->has_neighbor(nullptr);
 }

References libMesh::Elem::has_neighbor().

◆ operator=() [1/2]

RemoteElem& libMesh::RemoteElem::operator= ( const RemoteElem & )

delete

◆ operator=() [2/2]

RemoteElem& libMesh::RemoteElem::operator= ( RemoteElem && )

delete

◆ operator==()

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

inherited

Returns: true if two elements are identical, false otherwise. This is true if the elements are connected to identical global nodes, regardless of how those nodes might be numbered local to the elements.

Definition at line 428 of file elem.C.

 {
   // If the elements aren't the same type, they aren't equal
   if (this->type() != rhs.type())
     return false;
  
   const unsigned short n_n = this->n_nodes();
   libmesh_assert_equal_to(n_n, rhs.n_nodes());
  
   // Make two sorted arrays of global node ids and compare them for
   // equality.
   std::array<dof_id_type, Elem::max_n_nodes> this_ids, rhs_ids;
  
   for (unsigned short n = 0; n != n_n; n++)
     {
       this_ids[n] = this->node_id(n);
       rhs_ids[n] = rhs.node_id(n);
     }
  
   // Sort the vectors to rule out different local node numberings.
   std::sort(this_ids.begin(), this_ids.begin()+n_n);
   std::sort(rhs_ids.begin(), rhs_ids.begin()+n_n);
  
   // If the node ids match, the elements are equal!
   for (unsigned short n = 0; n != n_n; ++n)
     if (this_ids[n] != rhs_ids[n])
       return false;
   return true;
 }

References libMesh::Elem::n_nodes(), libMesh::Elem::node_id(), and libMesh::Elem::type().

◆ opposite_node()

unsigned int libMesh::Elem::opposite_node	(	const unsigned int	n,
		const unsigned int	s
	)		const

virtualinherited

Returns: The local node number for the node opposite to node n on side opposite_side(s) (for a tensor product element), or throws an error otherwise.

Reimplemented in libMesh::Quad, libMesh::Edge, and libMesh::Hex.

Definition at line 2703 of file elem.C.

 {
   // If the subclass didn't rederive this, using it is an error
   libmesh_not_implemented();
 }

◆ opposite_side()

unsigned int libMesh::Elem::opposite_side ( const unsigned int s ) const

virtualinherited

Returns: The side number opposite to s (for a tensor product element), or throws an error otherwise.

Reimplemented in libMesh::Quad, libMesh::Edge, and libMesh::Hex.

Definition at line 2695 of file elem.C.

 {
   // If the subclass didn't rederive this, using it is an error
   libmesh_not_implemented();
 }

◆ origin()

virtual Point libMesh::Elem::origin ( ) const

inlinevirtualinherited

Returns: The origin for an infinite element.

Currently, all infinite elements used in a mesh share the same origin. Override this in infinite element classes.

Reimplemented in libMesh::InfQuad, libMesh::InfEdge2, and libMesh::InfCell.

Definition at line 1593 of file elem.h.

1593 { libmesh_not_implemented(); return Point(); }

Referenced by libMesh::InfFE< Dim, T_radial, T_map >::combine_base_radial(), libMesh::InfFE< Dim, T_radial, T_map >::compute_data(), libMesh::Elem::get_info(), libMesh::InfFEMap::inverse_map(), and libMesh::InfFEMap::map().

◆ p_level()

unsigned int libMesh::Elem::p_level ( ) const

inlineinherited

Returns: The value of the p refinement level of an active element, or the minimum value of the p refinement levels of an ancestor element's descendants.

Definition at line 2512 of file elem.h.

 {
 #ifdef LIBMESH_ENABLE_AMR
   return _p_level;
 #else
   return 0;
 #endif
 }

References libMesh::Elem::_p_level.

◆ p_refinement_flag()

Elem::RefinementState libMesh::Elem::p_refinement_flag ( ) const

inlineinherited

Returns: The value of the p-refinement flag for the element.

Definition at line 2630 of file elem.h.

 {
   return static_cast<RefinementState>(_pflag);
 }

References libMesh::Elem::_pflag.

Referenced by libMesh::Elem::get_info(), libMesh::Elem::hack_p_level(), libMesh::DistributedMesh::libmesh_assert_valid_parallel_flags(), libMesh::MeshRefinement::make_coarsening_compatible(), libMesh::MeshRefinement::make_flags_parallel_consistent(), libMesh::MeshRefinement::make_refinement_compatible(), libMesh::Elem::min_new_p_level_by_neighbor(), libMesh::DofMap::old_dof_indices(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectEdges::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectSides::operator()(), libMesh::Parallel::Packing< const Elem * >::pack(), libMesh::Elem::refine(), and libMesh::Parallel::Packing< Elem * >::unpack().

◆ 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(), libMesh::Node::packed_size(), libMesh::Parallel::Packing< Node * >::unpack(), and libMesh::Parallel::Packing< Elem * >::unpack().

◆ parent() [1/2]

Elem * libMesh::Elem::parent ( )

inlineinherited

Returns: A pointer to the element's parent, or nullptr if the element was not created via refinement.

Definition at line 2442 of file elem.h.

 {
   return _elemlinks[0];
 }

References libMesh::Elem::_elemlinks.

◆ parent() [2/2]

const Elem * libMesh::Elem::parent ( ) const

inlineinherited

Returns: A const pointer to the element's parent, or nullptr if the element was not created via refinement.

Definition at line 2434 of file elem.h.

 {
   return _elemlinks[0];
 }

References libMesh::Elem::_elemlinks.

◆ parent_bracketing_nodes()

const std::vector< std::pair< unsigned char, unsigned char > > & libMesh::Elem::parent_bracketing_nodes	(	unsigned int	c,
		unsigned int	n
	)		const

virtualinherited

Returns: All the pairs of nodes (indexed by local node id) which should bracket node n of child c.

Definition at line 1794 of file elem.C.

 {
   // Indexed first by embedding matrix type, then by child id, then by
   // child node, then by bracketing pair
   std::vector<std::vector<std::vector<std::vector<std::pair<unsigned char, unsigned char>>>>> &
     cached_bracketing_nodes = this->_get_bracketing_node_cache();
  
   const unsigned int em_vers = this->embedding_matrix_version();
  
   // We may be updating the cache on one thread, and while that
   // happens we can't safely access the cache from other threads.
   Threads::spin_mutex::scoped_lock lock(parent_bracketing_nodes_mutex);
  
   if (cached_bracketing_nodes.size() <= em_vers)
     cached_bracketing_nodes.resize(em_vers+1);
  
   const unsigned int nc = this->n_children();
  
   // If we haven't cached the bracketing nodes corresponding to this
   // embedding matrix yet, let's do so now.
   if (cached_bracketing_nodes[em_vers].size() < nc)
     {
       // If we're a second-order element but we're not a full-order
       // element, then some of our bracketing nodes may not exist
       // except on the equivalent full-order element.  Let's build an
       // equivalent full-order element and make a copy of its cache to
       // use.
       if (this->default_order() != FIRST &&
           second_order_equivalent_type(this->type(), /*full_ordered=*/ true) != this->type())
         {
           // Check that we really are the non-full-order type
           libmesh_assert_equal_to
             (second_order_equivalent_type (this->type(), false),
              this->type());
  
           // Build the full-order type
           ElemType full_type =
             second_order_equivalent_type(this->type(), /*full_ordered=*/ true);
           std::unique_ptr<Elem> full_elem = Elem::build(full_type);
  
           // This won't work for elements with multiple
           // embedding_matrix versions, but every such element is full
           // order anyways.
           libmesh_assert_equal_to(em_vers, 0);
  
           // Make sure its cache has been built.  We temporarily
           // release our mutex lock so that the inner call can
           // re-acquire it.
           lock.release();
           full_elem->parent_bracketing_nodes(0,0);
  
           // And then we need to lock again, so that if someone *else*
           // grabbed our lock before we did we don't risk accessing
           // cached_bracketing_nodes while they're working on it.
           // Threading is hard.
           lock.acquire(parent_bracketing_nodes_mutex);
  
           // Copy its cache
           cached_bracketing_nodes =
             full_elem->_get_bracketing_node_cache();
  
           // Now we don't need to build the cache ourselves.
           return cached_bracketing_nodes[em_vers][child][child_node];
         }
  
       cached_bracketing_nodes[em_vers].resize(nc);
  
       const unsigned int nn = this->n_nodes();
  
       // We have to examine each child
       for (unsigned int c = 0; c != nc; ++c)
         {
           const unsigned int ncn = this->n_nodes_in_child(c);
  
           cached_bracketing_nodes[em_vers][c].resize(ncn);
  
           // We have to examine each node in that child
           for (unsigned int n = 0; n != ncn; ++n)
             {
               // If this child node isn't a vertex or an infinite
               // child element's mid-infinite-edge node, then we need
               // to find bracketing nodes on the child.
               if (!this->is_vertex_on_child(c, n)
 #ifdef LIBMESH_ENABLE_INFINITE_ELEMENTS
                   && !this->is_mid_infinite_edge_node(n)
 #endif
                   )
                 {
                   // Use the embedding matrix to find the child node
                   // location in parent master element space
                   Point bracketed_pt;
  
                   for (unsigned int pn = 0; pn != nn; ++pn)
                     {
                       const float em_val =
                         this->embedding_matrix(c,n,pn);
  
                       libmesh_assert_not_equal_to (em_val, 1);
                       if (em_val != 0.)
                         bracketed_pt.add_scaled(this->master_point(pn), em_val);
                     }
  
                   // Check each pair of nodes on the child which are
                   // also both parent nodes
                   for (unsigned int n1 = 0; n1 != ncn; ++n1)
                     {
                       if (n1 == n)
                         continue;
  
                       unsigned int parent_n1 =
                         this->as_parent_node(c,n1);
  
                       if (parent_n1 == libMesh::invalid_uint)
                         continue;
  
                       Point p1 = this->master_point(parent_n1);
  
                       for (unsigned int n2 = n1+1; n2 < nn; ++n2)
                         {
                           if (n2 == n)
                             continue;
  
                           unsigned int parent_n2 =
                             this->as_parent_node(c,n2);
  
                           if (parent_n2 == libMesh::invalid_uint)
                             continue;
  
                           Point p2 = this->master_point(parent_n2);
  
                           Point pmid = (p1 + p2)/2;
  
                           if (pmid == bracketed_pt)
                             {
                               cached_bracketing_nodes[em_vers][c][n].push_back
                                 (std::make_pair(parent_n1,parent_n2));
                               break;
                             }
                           else
                             libmesh_assert(!pmid.absolute_fuzzy_equals(bracketed_pt));
                         }
                     }
                 }
               // If this child node is a parent node, we need to
               // find bracketing nodes on the parent.
               else
                 {
                   unsigned int parent_node = this->as_parent_node(c,n);
  
                   Point bracketed_pt;
  
                   // If we're not a parent node, use the embedding
                   // matrix to find the child node location in parent
                   // master element space
                   if (parent_node == libMesh::invalid_uint)
                     {
                       for (unsigned int pn = 0; pn != nn; ++pn)
                         {
                           const float em_val =
                             this->embedding_matrix(c,n,pn);
  
                           libmesh_assert_not_equal_to (em_val, 1);
                           if (em_val != 0.)
                             bracketed_pt.add_scaled(this->master_point(pn), em_val);
                         }
                     }
                   // If we're a parent node then we need no arithmetic
                   else
                     bracketed_pt = this->master_point(parent_node);
  
                   for (unsigned int n1 = 0; n1 != nn; ++n1)
                     {
                       if (n1 == parent_node)
                         continue;
  
                       Point p1 = this->master_point(n1);
  
                       for (unsigned int n2 = n1+1; n2 < nn; ++n2)
                         {
                           if (n2 == parent_node)
                             continue;
  
                           Point pmid = (p1 + this->master_point(n2))/2;
  
                           if (pmid == bracketed_pt)
                             {
                               cached_bracketing_nodes[em_vers][c][n].push_back
                                 (std::make_pair(n1,n2));
                               break;
                             }
                           else
                             libmesh_assert(!pmid.absolute_fuzzy_equals(bracketed_pt));
                         }
                     }
                 }
             }
         }
     }
  
   return cached_bracketing_nodes[em_vers][child][child_node];
 }

References libMesh::Elem::_get_bracketing_node_cache(), libMesh::TypeVector< T >::absolute_fuzzy_equals(), libMesh::TypeVector< T >::add_scaled(), libMesh::Elem::as_parent_node(), libMesh::Elem::build(), libMesh::Elem::default_order(), libMesh::Elem::embedding_matrix(), libMesh::Elem::embedding_matrix_version(), libMesh::FIRST, libMesh::invalid_uint, libMesh::Elem::is_mid_infinite_edge_node(), libMesh::Elem::is_vertex_on_child(), libMesh::libmesh_assert(), libMesh::Elem::master_point(), libMesh::Elem::n_children(), libMesh::Elem::n_nodes(), libMesh::Elem::n_nodes_in_child(), libMesh::parent_bracketing_nodes_mutex, libMesh::Elem::second_order_equivalent_type(), and libMesh::Elem::type().

Referenced by libMesh::Elem::bracketing_nodes().

◆ point() [1/2]

Point & libMesh::Elem::point ( const unsigned int i )

inlineinherited

Returns: The Point associated with local Node i as a writable reference.

Definition at line 1967 of file elem.h.

 {
   libmesh_assert_less (i, this->n_nodes());
  
   return *_nodes[i];
 }

References libMesh::Elem::_nodes, and libMesh::Elem::n_nodes().

◆ point() [2/2]

const Point & libMesh::Elem::point ( const unsigned int i ) const

inlineinherited

Returns: The Point associated with local Node i.

Definition at line 1955 of file elem.h.

 {
   libmesh_assert_less (i, this->n_nodes());
   libmesh_assert(_nodes[i]);
   libmesh_assert_not_equal_to (_nodes[i]->id(), Node::invalid_id);
  
   return *_nodes[i];
 }

References libMesh::Elem::_nodes, libMesh::DofObject::invalid_id, libMesh::libmesh_assert(), and libMesh::Elem::n_nodes().

◆ point_test()

bool libMesh::Elem::point_test	(	const Point &	p,
		Real	box_tol,
		Real	map_tol
	)		const

privateinherited

Shared private implementation used by the contains_point() and close_to_point() routines.

The box_tol tolerance is used in the bounding box optimization, the map_tol tolerance is used in the calls to inverse_map() and on_reference_element().

Definition at line 2131 of file elem.C.

 {
   libmesh_assert_greater (box_tol, 0.);
   libmesh_assert_greater (map_tol, 0.);
  
   // This is a great optimization on first order elements, but it
   // could return false negatives on higher orders
   if (this->default_order() == FIRST)
     {
       // Check to make sure the element *could* contain this point, so we
       // can avoid an expensive inverse_map call if it doesn't.
       bool
 #if LIBMESH_DIM > 2
         point_above_min_z = false,
         point_below_max_z = false,
 #endif
 #if LIBMESH_DIM > 1
         point_above_min_y = false,
         point_below_max_y = false,
 #endif
         point_above_min_x = false,
         point_below_max_x = false;
  
       // For relative bounding box checks in physical space
       const Real my_hmax = this->hmax();
  
       for (auto & n : this->node_ref_range())
         {
           point_above_min_x = point_above_min_x || (n(0) - my_hmax*box_tol <= p(0));
           point_below_max_x = point_below_max_x || (n(0) + my_hmax*box_tol >= p(0));
 #if LIBMESH_DIM > 1
           point_above_min_y = point_above_min_y || (n(1) - my_hmax*box_tol <= p(1));
           point_below_max_y = point_below_max_y || (n(1) + my_hmax*box_tol >= p(1));
 #endif
 #if LIBMESH_DIM > 2
           point_above_min_z = point_above_min_z || (n(2) - my_hmax*box_tol <= p(2));
           point_below_max_z = point_below_max_z || (n(2) + my_hmax*box_tol >= p(2));
 #endif
         }
  
       if (
 #if LIBMESH_DIM > 2
           !point_above_min_z ||
           !point_below_max_z ||
 #endif
 #if LIBMESH_DIM > 1
           !point_above_min_y ||
           !point_below_max_y ||
 #endif
           !point_above_min_x ||
           !point_below_max_x)
         return false;
     }
  
   // To be on the safe side, we converge the inverse_map() iteration
   // to a slightly tighter tolerance than that requested by the
   // user...
   const Point mapped_point = FEMap::inverse_map(this->dim(),
                                                 this,
                                                 p,
                                                 0.1*map_tol, // <- this is |dx| tolerance, the Newton residual should be ~ |dx|^2
                                                 /*secure=*/ false);
  
   // Check that the refspace point maps back to p!  This is only necessary
   // for 1D and 2D elements, 3D elements always live in 3D.
   //
   // TODO: The contains_point() function could most likely be implemented
   // more efficiently in the element sub-classes themselves, at least for
   // the linear element types.
   if (this->dim() < 3)
     {
       Point xyz = FEMap::map(this->dim(), this, mapped_point);
  
       // Compute the distance between the original point and the re-mapped point.
       // They should be in the same place.
       Real dist = (xyz - p).norm();
  
  
       // If dist is larger than some fraction of the tolerance, then return false.
       // This can happen when e.g. a 2D element is living in 3D, and
       // FEMap::inverse_map() maps p onto the projection of the element,
       // effectively "tricking" FEInterface::on_reference_element().
       if (dist > this->hmax() * map_tol)
         return false;
     }
  
  
  
   return FEInterface::on_reference_element(mapped_point, this->type(), map_tol);
 }

References libMesh::Elem::default_order(), libMesh::Elem::dim(), libMesh::FIRST, libMesh::Elem::hmax(), libMesh::FEMap::inverse_map(), libMesh::FEMap::map(), libMesh::Elem::node_ref_range(), std::norm(), libMesh::FEInterface::on_reference_element(), libMesh::Real, and libMesh::Elem::type().

Referenced by libMesh::Elem::close_to_point(), and libMesh::Elem::contains_point().

◆ 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::Elem::print_info ( std::ostream & os = libMesh::out ) const

inherited

Prints relevant information about the element.

Definition at line 2225 of file elem.C.

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

References libMesh::Elem::get_info().

Referenced by libMesh::FEMap::compute_single_point_map(), libMesh::FEMap::inverse_map(), and 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(), libMesh::Node::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().

◆ qual_bounds()

virtual std::pair<Real,Real> libMesh::Elem::qual_bounds ( const ElemQuality ) const

inlinevirtualinherited

Returns: The suggested quality bounds for the Elem based on quality measure q.

These are the values suggested by the CUBIT User's Manual. Since this function can have no possible meaning for an abstract Elem, it is an error in the base class.

Reimplemented in libMesh::InfQuad, libMesh::Quad, libMesh::InfHex, libMesh::Tri, libMesh::Hex, and libMesh::Tet.

Definition at line 898 of file elem.h.

899 { libmesh_not_implemented(); return std::make_pair(0.,0.); }

Referenced by main().

◆ quality()

Real libMesh::Elem::quality ( const ElemQuality q ) const

virtualinherited

Returns: A quantitative assessment of element quality based on the quality metric q specified by the user.

I don't know what to do for this metric.

Reimplemented in libMesh::InfQuad, libMesh::Quad, libMesh::InfHex, libMesh::Tri, libMesh::Hex, and libMesh::Tet.

Definition at line 1326 of file elem.C.

 {
   switch (q)
     {
     default:
       {
         libmesh_do_once( libmesh_here();
  
                          libMesh::err << "ERROR:  unknown quality metric: "
                          << Utility::enum_to_string(q)
                          << std::endl
                          << "Cowardly returning 1."
                          << std::endl; );
  
         return 1.;
       }
     }
 }

References libMesh::Utility::enum_to_string(), and libMesh::err.

Referenced by libMesh::Tet::quality(), libMesh::Hex::quality(), libMesh::Tri::quality(), libMesh::InfHex::quality(), and libMesh::Quad::quality().

◆ raw_child_ptr()

const Elem * libMesh::Elem::raw_child_ptr ( unsigned int i ) const

inlineinherited

Returns: A constant pointer to the \( i^{th} \) child for this element. For internal use only - skips assertions about null pointers.

Definition at line 2558 of file elem.h.

 {
   if (!_children)
     return nullptr;
  
   return _children[i];
 }

References libMesh::Elem::_children.

Referenced by libMesh::CheckpointIO::read_remote_elem().

◆ reference_elem()

const Elem * libMesh::Elem::reference_elem ( ) const

inherited

Returns: A pointer to the "reference element" associated with this element. The reference element is the image of this element in reference parametric space. Importantly, it is not an actual element in the mesh, but rather a Singleton-type object, so for example all Quad4 elements share the same reference_elem().

Definition at line 338 of file elem.C.

 {
   return &(ReferenceElem::get(this->type()));
 }

References libMesh::ReferenceElem::get(), and libMesh::Elem::type().

Referenced by libMesh::QComposite< QSubCell >::init().

◆ refine()

void libMesh::Elem::refine ( MeshRefinement & mesh_refinement )

virtualinherited

Refine the element.

Definition at line 87 of file elem_refinement.C.

 {
   libmesh_assert_equal_to (this->refinement_flag(), Elem::REFINE);
   libmesh_assert (this->active());
  
   const unsigned int nc = this->n_children();
  
   // Create my children if necessary
   if (!_children)
     {
       _children = new Elem *[nc];
  
       unsigned int parent_p_level = this->p_level();
       const unsigned int nei = this->n_extra_integers();
       for (unsigned int c = 0; c != nc; c++)
         {
           _children[c] = Elem::build(this->type(), this).release();
           Elem * current_child = this->child_ptr(c);
  
           current_child->set_refinement_flag(Elem::JUST_REFINED);
           current_child->set_p_level(parent_p_level);
           current_child->set_p_refinement_flag(this->p_refinement_flag());
  
           for (auto cnode : current_child->node_index_range())
             {
               Node * node =
                 mesh_refinement.add_node(*this, c, cnode,
                                          current_child->processor_id());
               node->set_n_systems (this->n_systems());
               current_child->set_node(cnode) = node;
             }
  
           mesh_refinement.add_elem (current_child);
           current_child->set_n_systems(this->n_systems());
           libmesh_assert_equal_to (current_child->n_extra_integers(),
                                    this->n_extra_integers());
           for (unsigned int i=0; i != nei; ++i)
             current_child->set_extra_integer(i, this->get_extra_integer(i));
         }
     }
   else
     {
       unsigned int parent_p_level = this->p_level();
       for (unsigned int c = 0; c != nc; c++)
         {
           Elem * current_child = this->child_ptr(c);
           if (current_child != remote_elem)
             {
               libmesh_assert(current_child->subactive());
               current_child->set_refinement_flag(Elem::JUST_REFINED);
               current_child->set_p_level(parent_p_level);
               current_child->set_p_refinement_flag(this->p_refinement_flag());
             }
         }
     }
  
   // Un-set my refinement flag now
   this->set_refinement_flag(Elem::INACTIVE);
  
   // Leave the p refinement flag set - we will need that later to get
   // projection operations correct
   // this->set_p_refinement_flag(Elem::INACTIVE);
  
 #ifndef NDEBUG
   for (unsigned int c = 0; c != nc; c++)
     if (this->child_ptr(c) != remote_elem)
       {
         libmesh_assert_equal_to (this->child_ptr(c)->parent(), this);
         libmesh_assert(this->child_ptr(c)->active());
       }
 #endif
   libmesh_assert (this->ancestor());
 }

References libMesh::Elem::_children, libMesh::Elem::active(), libMesh::MeshRefinement::add_elem(), libMesh::MeshRefinement::add_node(), libMesh::Elem::ancestor(), libMesh::Elem::build(), libMesh::Elem::child_ptr(), libMesh::Elem::INACTIVE, libMesh::Elem::JUST_REFINED, libMesh::libmesh_assert(), libMesh::Elem::n_children(), libMesh::DofObject::n_extra_integers(), libMesh::DofObject::n_systems(), libMesh::Elem::node_index_range(), libMesh::Elem::p_level(), libMesh::Elem::p_refinement_flag(), libMesh::Elem::parent(), libMesh::DofObject::processor_id(), libMesh::Elem::REFINE, libMesh::Elem::refinement_flag(), libMesh::remote_elem, libMesh::DofObject::set_extra_integer(), libMesh::DofObject::set_n_systems(), libMesh::Elem::set_node(), libMesh::Elem::set_p_level(), libMesh::Elem::set_p_refinement_flag(), libMesh::Elem::set_refinement_flag(), libMesh::Elem::subactive(), and libMesh::Elem::type().

◆ refinement_flag()

Elem::RefinementState libMesh::Elem::refinement_flag ( ) const

inlineinherited

Returns: The value of the refinement flag for the element.

Definition at line 2614 of file elem.h.

 {
   return static_cast<RefinementState>(_rflag);
 }

References libMesh::Elem::_rflag.

Referenced by libMesh::Elem::active(), libMesh::OldSolutionBase< Output, point_output >::check_old_context(), libMesh::Elem::coarsen(), libMesh::Elem::contract(), libMesh::MeshRefinement::enforce_mismatch_limit_prior_to_refinement(), 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::Elem::get_info(), libMesh::DistributedMesh::libmesh_assert_valid_parallel_flags(), libMesh::MeshRefinement::make_coarsening_compatible(), libMesh::MeshRefinement::make_flags_parallel_consistent(), libMesh::Elem::make_links_to_me_local(), libMesh::MeshRefinement::make_refinement_compatible(), libMesh::DofMap::old_dof_indices(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectEdges::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectSides::operator()(), libMesh::Parallel::Packing< const Elem * >::pack(), libMesh::Elem::refine(), EquationSystemsTest::testRefineThenReinitPreserveFlags(), libMesh::MeshRefinement::uniformly_coarsen(), and libMesh::Parallel::Packing< Elem * >::unpack().

◆ remove_links_to_me()

void libMesh::Elem::remove_links_to_me ( )

inherited

Resets this element's neighbors' appropriate neighbor pointers and its parent's and children's appropriate pointers to point to null instead of to this.

Used by the library before an element is deleted from a mesh.

Definition at line 1191 of file elem.C.

 {
   libmesh_assert_not_equal_to (this, remote_elem);
  
   // We need to have handled any children first
 #ifdef LIBMESH_ENABLE_AMR
   libmesh_assert (!this->has_children());
 #endif
  
   // Nullify any neighbor links
   for (auto neigh : this->neighbor_ptr_range())
     {
       if (neigh && neigh != remote_elem)
         {
           // My neighbor should never be more refined than me; my real
           // neighbor would have been its parent in that case.
           libmesh_assert_greater_equal (this->level(), neigh->level());
  
           if (this->level() == neigh->level() &&
               neigh->has_neighbor(this))
             {
 #ifdef LIBMESH_ENABLE_AMR
               // My neighbor may have descendants which also consider me a
               // neighbor
               std::vector<Elem *> family;
               neigh->total_family_tree_by_neighbor (family, this);
  
               for (auto & n : family)
                 {
                   libmesh_assert (n);
                   if (n->is_remote())
                     continue;
                   unsigned int my_s = n->which_neighbor_am_i(this);
                   libmesh_assert_less (my_s, n->n_neighbors());
                   libmesh_assert_equal_to (n->neighbor_ptr(my_s), this);
                   n->set_neighbor(my_s, nullptr);
                 }
 #else
               unsigned int my_s = neigh->which_neighbor_am_i(this);
               libmesh_assert_less (my_s, neigh->n_neighbors());
               libmesh_assert_equal_to (neigh->neighbor_ptr(my_s), this);
               neigh->set_neighbor(my_s, nullptr);
 #endif
             }
 #ifdef LIBMESH_ENABLE_AMR
           // Even if my neighbor doesn't link back to me, it might
           // have subactive descendants which do
           else if (neigh->has_children())
             {
               // If my neighbor at the same level doesn't have me as a
               // neighbor, I must be subactive
               libmesh_assert(this->level() > neigh->level() ||
                              this->subactive());
  
               // My neighbor must have some ancestor of mine as a
               // neighbor
               Elem * my_ancestor = this->parent();
               libmesh_assert(my_ancestor);
               while (!neigh->has_neighbor(my_ancestor))
                 {
                   my_ancestor = my_ancestor->parent();
                   libmesh_assert(my_ancestor);
                 }
  
               // My neighbor may have descendants which consider me a
               // neighbor
               std::vector<Elem *> family;
               neigh->total_family_tree_by_subneighbor (family, my_ancestor, this);
  
               for (auto & n : family)
                 {
                   libmesh_assert (n);
                   if (n->is_remote())
                     continue;
                   unsigned int my_s = n->which_neighbor_am_i(this);
                   libmesh_assert_less (my_s, n->n_neighbors());
                   libmesh_assert_equal_to (n->neighbor_ptr(my_s), this);
                   n->set_neighbor(my_s, nullptr);
                 }
             }
 #endif
         }
     }
  
 #ifdef LIBMESH_ENABLE_AMR
   // We can't currently delete a child with a parent!
   libmesh_assert (!this->parent());
 #endif
 }

References libMesh::Elem::has_children(), libMesh::Elem::level(), libMesh::libmesh_assert(), libMesh::Elem::neighbor_ptr_range(), libMesh::Elem::parent(), libMesh::remote_elem, and libMesh::Elem::subactive().

◆ replace_child()

void libMesh::Elem::replace_child	(	Elem *	elem,
		unsigned int	c
	)

inherited

Replaces the child pointer at the specified index in the child array.

Definition at line 1430 of file elem.C.

 {
   libmesh_assert(this->has_children());
  
   libmesh_assert(this->child_ptr(c));
  
   this->set_child(c, elem);
 }

References libMesh::Elem::child_ptr(), libMesh::Elem::has_children(), libMesh::libmesh_assert(), and libMesh::Elem::set_child().

Referenced by libMesh::UnstructuredMesh::all_first_order().

◆ second_order_adjacent_vertex()

unsigned short int libMesh::Elem::second_order_adjacent_vertex	(	const unsigned int	n,
		const unsigned int	v
	)		const

virtualinherited

Returns: The element-local number of the \( v^{th} \) vertex that defines the \( n^{th} \) second-order node, or 0 for linear elements.

Note: The value is always less than this->n_vertices(), while n has to be greater than or equal to this->n_vertices().

Reimplemented in libMesh::Edge4, libMesh::Edge3, libMesh::InfHex18, libMesh::Pyramid14, libMesh::Hex27, libMesh::Prism18, libMesh::InfHex16, libMesh::Hex20, libMesh::Prism15, libMesh::Tet10, libMesh::Pyramid13, libMesh::Quad9, libMesh::Tri6, libMesh::InfPrism12, libMesh::Quad8, and libMesh::InfQuad6.

Definition at line 2351 of file elem.C.

 {
   // for linear elements, always return 0
   return 0;
 }

Referenced by libMesh::UnstructuredMesh::all_second_order(), and libMesh::MeshTools::Modification::smooth().

◆ second_order_child_vertex()

std::pair< unsigned short int, unsigned short int > libMesh::Elem::second_order_child_vertex ( const unsigned int n ) const

virtualinherited

Returns: A pair (c,v), where c == child index, and v == element-local index of the \( n^{th} \) second-order node on the parent element. For linear elements, (0,0) is returned.

Note: The return values are always less than this->n_children() and this->child_ptr(c)->n_vertices().; n has to be greater than or equal to this->n_vertices().; On refined second-order elements, the return value will satisfy this->node_ptr(n) == this->child_ptr(c)->node_ptr(v).

Reimplemented in libMesh::InfHex18, libMesh::Hex27, libMesh::Prism18, libMesh::InfHex16, libMesh::Hex20, libMesh::Prism15, libMesh::Tet10, libMesh::Quad9, libMesh::Tri6, libMesh::InfPrism12, libMesh::Quad8, libMesh::InfQuad6, and libMesh::Edge3.

Definition at line 2361 of file elem.C.

 {
   // for linear elements, always return 0
   return std::pair<unsigned short int, unsigned short int>(0,0);
 }

◆ second_order_equivalent_type()

ElemType libMesh::Elem::second_order_equivalent_type	(	const ElemType	et,
		const bool	full_ordered = `true`
	)

staticinherited

Returns: The element type of the associated second-order element, or INVALID_ELEM for second-order or other elements that cannot be converted into higher order equivalents.

For example, when this is a TET4, then TET10 is returned.

For some elements, there exist two second-order equivalents, e.g. for Quad4 there is Quad8 and Quad9. When the optional full_ordered is true, then QUAD9 is returned. When full_ordered is false, then QUAD8 is returned.

Definition at line 2432 of file elem.C.

 {
   switch (et)
     {
     case NODEELEM:
       return NODEELEM;
     case EDGE2:
     case EDGE3:
       {
         // full_ordered not relevant
         return EDGE3;
       }
  
     case EDGE4:
       {
         // full_ordered not relevant
         return EDGE4;
       }
  
     case TRI3:
     case TRI6:
       {
         // full_ordered not relevant
         return TRI6;
       }
  
       // Currently there is no TRISHELL6, so similarly to other types
       // where this is the case, we just return the input.
     case TRISHELL3:
       return TRISHELL3;
  
     case QUAD4:
     case QUAD8:
       {
         if (full_ordered)
           return QUAD9;
         else
           return QUAD8;
       }
  
     case QUADSHELL4:
     case QUADSHELL8:
       {
         // There is no QUADSHELL9, so in that sense QUADSHELL8 is the
         // "full ordered" element.
         return QUADSHELL8;
       }
  
     case QUAD9:
       {
         // full_ordered not relevant
         return QUAD9;
       }
  
     case TET4:
     case TET10:
       {
         // full_ordered not relevant
         return TET10;
       }
  
     case HEX8:
     case HEX20:
       {
         // see below how this correlates with INFHEX8
         if (full_ordered)
           return HEX27;
         else
           return HEX20;
       }
  
     case HEX27:
       {
         // full_ordered not relevant
         return HEX27;
       }
  
     case PRISM6:
     case PRISM15:
       {
         if (full_ordered)
           return PRISM18;
         else
           return PRISM15;
       }
  
     case PRISM18:
       {
         // full_ordered not relevant
         return PRISM18;
       }
  
     case PYRAMID5:
     case PYRAMID13:
       {
         if (full_ordered)
           return PYRAMID14;
         else
           return PYRAMID13;
       }
  
     case PYRAMID14:
       {
         // full_ordered not relevant
         return PYRAMID14;
       }
  
  
  
 #ifdef LIBMESH_ENABLE_INFINITE_ELEMENTS
  
       // infinite elements
     case INFEDGE2:
       {
         return INFEDGE2;
       }
  
     case INFQUAD4:
     case INFQUAD6:
       {
         // full_ordered not relevant
         return INFQUAD6;
       }
  
     case INFHEX8:
     case INFHEX16:
       {
         /*
          * Note that this matches with \p Hex8:
          * For full-ordered, \p InfHex18 and \p Hex27
          * belong together, and for not full-ordered,
          * \p InfHex16 and \p Hex20 belong together.
          */
         if (full_ordered)
           return INFHEX18;
         else
           return INFHEX16;
       }
  
     case INFHEX18:
       {
         // full_ordered not relevant
         return INFHEX18;
       }
  
     case INFPRISM6:
     case INFPRISM12:
       {
         // full_ordered not relevant
         return INFPRISM12;
       }
  
 #endif
  
  
     default:
       {
         // what did we miss?
         libmesh_error_msg("No second order equivalent element type for et =  "
                           << Utility::enum_to_string(et));
       }
     }
 }

References libMesh::EDGE2, libMesh::EDGE3, libMesh::EDGE4, libMesh::Utility::enum_to_string(), libMesh::HEX20, libMesh::HEX27, libMesh::HEX8, libMesh::INFEDGE2, libMesh::INFHEX16, libMesh::INFHEX18, libMesh::INFHEX8, libMesh::INFPRISM12, libMesh::INFPRISM6, libMesh::INFQUAD4, libMesh::INFQUAD6, libMesh::NODEELEM, libMesh::PRISM15, libMesh::PRISM18, libMesh::PRISM6, libMesh::PYRAMID13, libMesh::PYRAMID14, libMesh::PYRAMID5, libMesh::QUAD4, libMesh::QUAD8, libMesh::QUAD9, libMesh::QUADSHELL4, libMesh::QUADSHELL8, libMesh::TET10, libMesh::TET4, libMesh::TRI3, libMesh::TRI6, and libMesh::TRISHELL3.

Referenced by libMesh::UnstructuredMesh::all_second_order(), libMesh::Elem::bracketing_nodes(), and libMesh::Elem::parent_bracketing_nodes().

◆ 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_child()

void libMesh::Elem::set_child	(	unsigned int	c,
		Elem *	elem
	)

inlineprivateinherited

Sets the pointer to the \( i^{th} \) child for this element.

Do not call if this element has no children, i.e. is active.

Definition at line 2586 of file elem.h.

 {
   libmesh_assert (this->has_children());
  
   _children[c] = elem;
 }

References libMesh::Elem::_children, libMesh::Elem::has_children(), and libMesh::libmesh_assert().

Referenced by libMesh::Elem::add_child(), libMesh::Elem::make_links_to_me_remote(), and libMesh::Elem::replace_child().

◆ 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(), libMesh::Node::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(), 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_interior_parent()

void libMesh::Elem::set_interior_parent ( Elem * p )

inherited

Sets the pointer to the element's interior_parent.

Dangerous! Only use this if you know what you are doing!

Definition at line 801 of file elem.C.

 {
   // interior parents make no sense for full-dimensional elements.
   libmesh_assert_less (this->dim(), LIBMESH_DIM);
  
   // If we have an interior_parent, we USED TO assume it was a
   // one-higher-dimensional interior element, but we now allow e.g.
   // edge elements to have a 3D interior_parent with no
   // intermediate 2D element.
   // libmesh_assert (!p ||
   //                 p->dim() == (this->dim()+1));
   libmesh_assert (!p ||
                   (p == remote_elem) ||
                   (p->dim() > this->dim()));
  
   _elemlinks[1+this->n_sides()] = p;
 }

References libMesh::Elem::_elemlinks, libMesh::Elem::dim(), libMesh::libmesh_assert(), libMesh::Elem::n_sides(), and libMesh::remote_elem.

Referenced by libMesh::BoundaryInfo::add_elements(), libMesh::Edge::Edge(), libMesh::UnstructuredMesh::find_neighbors(), libMesh::Hex::Hex(), libMesh::InfHex::InfHex(), libMesh::InfQuad::InfQuad(), libMesh::NodeElem::NodeElem(), libMesh::Prism::Prism(), libMesh::Pyramid::Pyramid(), libMesh::Quad::Quad(), libMesh::Tet::Tet(), libMesh::Tri::Tri(), and libMesh::Parallel::Packing< Elem * >::unpack().

◆ set_mapping_data()

void libMesh::Elem::set_mapping_data ( const unsigned char data )

inlineinherited

Sets the value of the mapping data for the element.

Definition at line 2548 of file elem.h.

 {
   _map_data = data;
 }

References libMesh::Elem::_map_data, and data.

Referenced by libMesh::ReplicatedMesh::add_elem(), libMesh::DistributedMesh::add_elem(), libMesh::ReplicatedMesh::insert_elem(), and libMesh::DistributedMesh::insert_elem().

◆ set_mapping_type()

void libMesh::Elem::set_mapping_type ( const ElemMappingType type )

inlineinherited

Sets the value of the mapping type for the element.

Definition at line 2532 of file elem.h.

 {
   _map_type = cast_int<unsigned char>(type);
 }

References libMesh::Elem::_map_type, and libMesh::Elem::type().

Referenced by libMesh::ReplicatedMesh::add_elem(), libMesh::DistributedMesh::add_elem(), libMesh::ReplicatedMesh::insert_elem(), and libMesh::DistributedMesh::insert_elem().

◆ 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_neighbor()

void libMesh::Elem::set_neighbor	(	const unsigned int	i,
		Elem *	n
	)

inlineinherited

Assigns n as the \( i^{th} \) neighbor.

Definition at line 2105 of file elem.h.

 {
   libmesh_assert_less (i, this->n_neighbors());
  
   _elemlinks[i+1] = n;
 }

References libMesh::Elem::_elemlinks, and libMesh::Elem::n_neighbors().

Referenced by libMesh::MeshTools::Subdivision::add_boundary_ghosts(), libMesh::BoundaryInfo::add_elements(), libMesh::UnstructuredMesh::all_first_order(), libMesh::UnstructuredMesh::all_second_order(), libMesh::MeshTools::Generation::build_extrusion(), libMesh::InfElemBuilder::build_inf_elem(), libMesh::UnstructuredMesh::copy_nodes_and_elements(), libMesh::UnstructuredMesh::find_neighbors(), libMesh::MeshTools::Modification::flatten(), libMesh::Elem::nullify_neighbors(), libMesh::CheckpointIO::read_remote_elem(), libMesh::ReplicatedMesh::stitching_helper(), and libMesh::Parallel::Packing< Elem * >::unpack().

◆ set_node()

virtual Node* & libMesh::RemoteElem::set_node ( const unsigned int i )

inlineoverridevirtual

Returns: The pointer to local Node i as a writable reference.

Reimplemented from libMesh::Elem.

Definition at line 86 of file remote_elem.h.

87 { libmesh_not_implemented(); return Elem::set_node(i); }

References libMesh::Elem::set_node().

◆ 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_p_level()

void libMesh::Elem::set_p_level ( const unsigned int p )

inherited

Sets the value of the p-refinement level for the element.

The following functions only apply when AMR is enabled and thus are not present otherwise.

Note: The maximum p-refinement level is currently 255.

Definition at line 41 of file elem_refinement.C.

 {
   // Maintain the parent's p level as the minimum of it's children
   if (this->parent() != nullptr)
     {
       unsigned int parent_p_level = this->parent()->p_level();
  
       // If our new p level is less than our parents, our parents drops
       if (parent_p_level > p)
         {
           this->parent()->set_p_level(p);
  
           // And we should keep track of the drop, in case we need to
           // do a projection later.
           this->parent()->set_p_refinement_flag(Elem::JUST_COARSENED);
         }
       // If we are the lowest p level and it increases, so might
       // our parent's, but we have to check every other child to see
       else if (parent_p_level == _p_level && _p_level < p)
         {
           _p_level = cast_int<unsigned char>(p);
           parent_p_level = cast_int<unsigned char>(p);
           for (auto & c : this->parent()->child_ref_range())
             parent_p_level = std::min(parent_p_level,
                                       c.p_level());
  
           // When its children all have a higher p level, the parent's
           // should rise
           if (parent_p_level > this->parent()->p_level())
             {
               this->parent()->set_p_level(parent_p_level);
  
               // And we should keep track of the rise, in case we need to
               // do a projection later.
               this->parent()->set_p_refinement_flag(Elem::JUST_REFINED);
             }
  
           return;
         }
     }
  
   _p_level = cast_int<unsigned char>(p);
 }

References libMesh::Elem::_p_level, libMesh::Elem::child_ref_range(), libMesh::Elem::JUST_COARSENED, libMesh::Elem::JUST_REFINED, libMesh::Elem::p_level(), libMesh::Elem::parent(), libMesh::Elem::set_p_level(), and libMesh::Elem::set_p_refinement_flag().

Referenced by libMesh::UnstructuredMesh::all_first_order(), libMesh::Elem::coarsen(), libMesh::Elem::Elem(), libMesh::Elem::refine(), libMesh::Elem::set_p_level(), and libMesh::Parallel::Packing< Elem * >::unpack().

◆ set_p_refinement_flag()

void libMesh::Elem::set_p_refinement_flag ( const RefinementState pflag )

inlineinherited

Sets the value of the p-refinement flag for the element.

Definition at line 2638 of file elem.h.

 {
   if (this->p_level() == 0)
     libmesh_assert_not_equal_to
       (pflag, Elem::JUST_REFINED);
  
   _pflag = cast_int<unsigned char>(pflag);
 }

References libMesh::Elem::_pflag, libMesh::Elem::JUST_REFINED, and libMesh::Elem::p_level().

Referenced by libMesh::UnstructuredMesh::all_first_order(), libMesh::MeshRefinement::enforce_mismatch_limit_prior_to_refinement(), libMesh::MeshRefinement::make_coarsening_compatible(), libMesh::MeshRefinement::make_flags_parallel_consistent(), libMesh::MeshRefinement::make_refinement_compatible(), libMesh::CheckpointIO::read_connectivity(), libMesh::Elem::refine(), libMesh::Elem::set_p_level(), and libMesh::Parallel::Packing< Elem * >::unpack().

◆ set_parent()

void libMesh::Elem::set_parent ( Elem * p )

inlineinherited

Sets the pointer to the element's parent.

Dangerous! Only use this if you know what you are doing!

Definition at line 2450 of file elem.h.

 {
   // We no longer support using parent() as interior_parent()
   libmesh_assert_equal_to(this->dim(), p ? p->dim() : this->dim());
   _elemlinks[0] = p;
 }

References libMesh::Elem::_elemlinks, and libMesh::Elem::dim().

Referenced by libMesh::BoundaryInfo::add_elements(), and libMesh::UnstructuredMesh::all_first_order().

◆ set_refinement_flag()

void libMesh::Elem::set_refinement_flag ( const RefinementState rflag )

inlineinherited

Sets the value of the refinement flag for the element.

Definition at line 2622 of file elem.h.

 {
   _rflag = cast_int<unsigned char>(rflag);
 }

References libMesh::Elem::_rflag.

Referenced by libMesh::UnstructuredMesh::all_first_order(), MixedDimensionNonUniformRefinement::build_mesh(), MixedDimensionNonUniformRefinementTriangle::build_mesh(), MixedDimensionNonUniformRefinement3D::build_mesh(), libMesh::Elem::coarsen(), libMesh::Elem::contract(), libMesh::MeshRefinement::enforce_mismatch_limit_prior_to_refinement(), libMesh::MeshRefinement::flag_elements_by_elem_fraction(), libMesh::MeshRefinement::flag_elements_by_nelem_target(), main(), libMesh::MeshRefinement::make_coarsening_compatible(), libMesh::MeshRefinement::make_flags_parallel_consistent(), libMesh::MeshRefinement::make_refinement_compatible(), libMesh::CheckpointIO::read_connectivity(), libMesh::XdrIO::read_serialized_connectivity(), libMesh::Elem::refine(), EquationSystemsTest::testRefineThenReinitPreserveFlags(), libMesh::MeshRefinement::uniformly_coarsen(), and libMesh::Parallel::Packing< Elem * >::unpack().

◆ 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_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().

◆ setup()

void libMesh::Singleton::setup ( )

staticinherited

Setup function.

Initializes any derived Singleton::Setup objects. objects.

Definition at line 81 of file libmesh_singleton.C.

 {
   SingletonMutex::scoped_lock lock(setup_mtx);
  
   SetupList & setup_cache = get_setup_cache();
  
   for (auto & item : setup_cache)
     {
       libmesh_assert (item);
       item->setup();
     }
 }

References libMesh::libmesh_assert().

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

◆ side_index_range()

IntRange< unsigned short > libMesh::Elem::side_index_range ( ) const

inlineinherited

Returns: An integer range from 0 up to (but not including) the number of sides this element has.

Definition at line 2188 of file elem.h.

 {
   return {0, cast_int<unsigned short>(this->n_sides())};
 }

References libMesh::Elem::n_sides().

Referenced by libMesh::BoundaryInfo::_find_id_maps(), libMesh::MeshTools::Subdivision::add_boundary_ghosts(), libMesh::BoundaryInfo::add_elements(), libMesh::UnstructuredMesh::all_second_order(), libMesh::MeshTools::Modification::all_tri(), libMesh::InfElemBuilder::build_inf_elem(), libMesh::FEGenericBase< FEOutputType< T >::type >::coarsened_dof_values(), libMesh::FEAbstract::compute_node_constraints(), libMesh::FEAbstract::compute_periodic_node_constraints(), libMesh::FEGenericBase< FEOutputType< T >::type >::compute_proj_constraints(), libMesh::BoundaryInfo::copy_boundary_ids(), libMesh::BoundaryInfo::edge_boundary_ids(), libMesh::JumpErrorEstimator::estimate_error(), libMesh::MeshTools::Modification::flatten(), libMesh::ReplicatedMesh::get_boundary_points(), libMesh::ReplicatedMesh::get_disconnected_subdomains(), libMesh::Elem::get_info(), libMesh::BoundaryInfo::get_side_and_node_maps(), libMesh::Elem::has_topological_neighbor(), libMesh::Elem::libmesh_assert_valid_neighbors(), libMesh::Elem::nullify_neighbors(), libMesh::Parallel::Packing< const Elem * >::pack(), libMesh::PostscriptIO::plot_quadratic_elem(), libMesh::MeshTools::Modification::smooth(), libMesh::ReplicatedMesh::stitching_helper(), and libMesh::Parallel::Packing< Elem * >::unpack().

◆ side_ptr() [1/4]

virtual std::unique_ptr<Elem> libMesh::RemoteElem::side_ptr ( const unsigned int i )

inlineoverridevirtual

Returns: A proxy element coincident with side i.

Note: This method returns the minimum element necessary to uniquely identify the side. For example, the side of a hexahedron is always returned as a 4-noded quadrilateral, regardless of what type of hex you are dealing with. If you want the full-ordered face (i.e. a 9-noded quad face for a 27-noded hexahedron) use the build_side method.; The const version of this function is non-virtual; it simply calls the virtual non-const version and const_casts the return type.

Implements libMesh::Elem.

Definition at line 167 of file remote_elem.h.

168 { libmesh_not_implemented(); return std::unique_ptr<Elem>(); }

◆ side_ptr() [2/4]

void libMesh::Elem::side_ptr	(	std::unique_ptr< const Elem > &	side,
		const unsigned int	i
	)		const

inlineinherited

Definition at line 2210 of file elem.h.

 {
   // Hand off to the non-const version of this function
   Elem * me = const_cast<Elem *>(this);
   std::unique_ptr<Elem> e {const_cast<Elem *>(elem.release())};
   me->side_ptr(e, i);
   elem.reset(e.release());
 }

References libMesh::Elem::side_ptr().

◆ side_ptr() [3/4]

virtual void libMesh::RemoteElem::side_ptr	(	std::unique_ptr< Elem > &	side,
		const unsigned int	i
	)

inlineoverridevirtual

Resets the loose element side, which may currently point to a different side than i or even a different element than this, to point to side i on this.

If side is currently an element of the wrong type, it will be freed and a new element allocated; otherwise no memory allocation will occur.

This should not be called with proxy Side elements. This will cause side to be a minimum-ordered element, even if it is handed a higher-ordered element that must be replaced.

The const version of this function is non-virtual; it simply calls the virtual non-const version and const_casts the return type.

Implements libMesh::Elem.

Definition at line 170 of file remote_elem.h.

172 { libmesh_not_implemented(); }

◆ side_ptr() [4/4]

std::unique_ptr< const Elem > libMesh::Elem::side_ptr ( unsigned int i ) const

inlineinherited

Definition at line 2197 of file elem.h.

 {
   // Call the non-const version of this function, return the result as
   // a std::unique_ptr<const Elem>.
   Elem * me = const_cast<Elem *>(this);
   const Elem * s = const_cast<const Elem *>(me->side_ptr(i).release());
   return std::unique_ptr<const Elem>(s);
 }

References libMesh::Elem::side_ptr().

◆ simple_build_side_ptr()

template<typename Subclass >

void libMesh::Elem::simple_build_side_ptr	(	std::unique_ptr< Elem > &	side,
		const unsigned int	i,
		ElemType	sidetype
	)

inlineprotectedinherited

An implementation for simple (all sides equal) elements.

Definition at line 2252 of file elem.h.

 {
   libmesh_assert_less (i, this->n_sides());
  
   if (!side.get() || side->type() != sidetype)
     {
       Subclass & real_me = cast_ref<Subclass&>(*this);
       side = real_me.Subclass::build_side_ptr(i, false);
     }
   else
     {
       side->subdomain_id() = this->subdomain_id();
  
       for (auto n : side->node_index_range())
         side->set_node(n) = this->node_ptr(Subclass::side_nodes_map[i][n]);
     }
 }

References libMesh::Elem::n_sides(), libMesh::Elem::node_ptr(), and libMesh::Elem::subdomain_id().

◆ simple_side_ptr()

template<typename Subclass , typename Mapclass >

void libMesh::Elem::simple_side_ptr	(	std::unique_ptr< Elem > &	side,
		const unsigned int	i,
		ElemType	sidetype
	)

inlineprotectedinherited

An implementation for simple (all sides equal) elements.

Definition at line 2277 of file elem.h.

 {
   libmesh_assert_less (i, this->n_sides());
  
   if (!side.get() || side->type() != sidetype)
     {
       Subclass & real_me = cast_ref<Subclass&>(*this);
       side = real_me.Subclass::side_ptr(i);
     }
   else
     {
       side->subdomain_id() = this->subdomain_id();
  
       for (auto n : side->node_index_range())
         side->set_node(n) = this->node_ptr(Mapclass::side_nodes_map[i][n]);
     }
 }

References libMesh::Elem::n_sides(), libMesh::Elem::node_ptr(), and libMesh::Elem::subdomain_id().

◆ 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().

◆ subactive()

bool libMesh::Elem::subactive ( ) const

inlineinherited

Returns: true if the element is subactive (i.e. has no active descendants), false otherwise or if AMR is disabled.

Definition at line 2363 of file elem.h.

 {
 #ifdef LIBMESH_ENABLE_AMR
   if (this->active())
     return false;
   if (!this->has_children())
     return true;
   for (const Elem * my_ancestor = this->parent();
        my_ancestor != nullptr;
        my_ancestor = my_ancestor->parent())
     if (my_ancestor->active())
       return true;
 #endif
  
   return false;
 }

References libMesh::Elem::active(), libMesh::Elem::has_children(), and libMesh::Elem::parent().

Referenced by libMesh::HPCoarsenTest::add_projection(), libMesh::Elem::ancestor(), libMesh::FEAbstract::compute_node_constraints(), libMesh::UnstructuredMesh::contract(), libMesh::MeshCommunication::delete_remote_elements(), libMesh::UnstructuredMesh::find_neighbors(), libMesh::Elem::get_info(), libMesh::Elem::libmesh_assert_valid_neighbors(), libMesh::Elem::make_links_to_me_local(), libMesh::Elem::make_links_to_me_remote(), libMesh::Elem::max_descendant_p_level(), libMesh::Elem::min_new_p_level_by_neighbor(), libMesh::Elem::min_p_level_by_neighbor(), libMesh::Elem::refine(), libMesh::Elem::remove_links_to_me(), libMesh::ReplicatedMesh::stitching_helper(), and libMesh::Parallel::Packing< Elem * >::unpack().

◆ subdomain_id() [1/2]

subdomain_id_type & libMesh::Elem::subdomain_id ( )

inlineinherited

Returns: The subdomain that this element belongs to as a writable reference.

Definition at line 2077 of file elem.h.

 {
   return _sbd_id;
 }

References libMesh::Elem::_sbd_id.

◆ subdomain_id() [2/2]

subdomain_id_type libMesh::Elem::subdomain_id ( ) const

inlineinherited

Returns: The subdomain that this element belongs to.

Definition at line 2069 of file elem.h.

 {
   return _sbd_id;
 }

References libMesh::Elem::_sbd_id.

◆ 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().

◆ top_parent()

const Elem * libMesh::Elem::top_parent ( ) const

inlineinherited

Returns: A pointer to the element's top-most (i.e. level-0) parent.

That is, this if this is a level-0 element, this element's parent if this is a level-1 element, this element's grandparent if this is a level-2 element, etc...

Definition at line 2460 of file elem.h.

 {
   const Elem * tp = this;
  
   // Keep getting the element's parent
   // until that parent is at level-0
   while (tp->parent() != nullptr)
     tp = tp->parent();
  
   libmesh_assert(tp);
   libmesh_assert_equal_to (tp->level(), 0);
  
   return tp;
 }

References libMesh::Elem::level(), libMesh::libmesh_assert(), and libMesh::Elem::parent().

Referenced by libMesh::BoundaryInfo::_find_id_maps(), libMesh::BoundaryInfo::add_elements(), libMesh::BoundaryInfo::boundary_ids(), libMesh::BoundaryInfo::edge_boundary_ids(), libMesh::MeshTools::libmesh_assert_valid_amr_interior_parents(), libMesh::ExodusII_IO::read_elemental_variable(), libMesh::BoundaryInfo::side_with_boundary_id(), and ExtraIntegersTest::test_final_integers().

◆ topological_neighbor() [1/2]

const Elem * libMesh::Elem::topological_neighbor	(	const unsigned int	i,
		const MeshBase &	mesh,
		const PointLocatorBase &	point_locator,
		const PeriodicBoundaries *	pb
	)		const

inherited

Returns: A pointer to the \( i^{th} \) neighbor of this element for interior elements. If an element is on a periodic boundary, it will return a corresponding element on the opposite side.

Definition at line 865 of file elem.C.

 {
   libmesh_assert_less (i, this->n_neighbors());
  
   const Elem * neighbor_i = this->neighbor_ptr(i);
   if (neighbor_i != nullptr)
     return neighbor_i;
  
   if (pb)
     {
       // Since the neighbor is nullptr it must be on a boundary. We need
       // see if this is a periodic boundary in which case it will have a
       // topological neighbor
       std::vector<boundary_id_type> bc_ids;
       mesh.get_boundary_info().boundary_ids(this, cast_int<unsigned short>(i), bc_ids);
       for (const auto & id : bc_ids)
         if (pb->boundary(id))
           {
             neighbor_i = pb->neighbor(id, point_locator, this, i);
  
             // Since coarse elements do not have more refined
             // neighbors we need to make sure that we don't return one
             // of these types of neighbors.
             if (neighbor_i)
               while (level() < neighbor_i->level())
                 neighbor_i = neighbor_i->parent();
             return neighbor_i;
           }
     }
  
   return nullptr;
 }

References libMesh::PeriodicBoundaries::boundary(), libMesh::Elem::level(), mesh, libMesh::Elem::n_neighbors(), libMesh::PeriodicBoundaries::neighbor(), libMesh::Elem::neighbor_ptr(), and libMesh::Elem::parent().

Referenced by libMesh::Elem::has_topological_neighbor(), libMesh::DefaultCoupling::operator()(), and libMesh::MeshRefinement::topological_neighbor().

◆ topological_neighbor() [2/2]

Elem * libMesh::Elem::topological_neighbor	(	const unsigned int	i,
		MeshBase &	mesh,
		const PointLocatorBase &	point_locator,
		const PeriodicBoundaries *	pb
	)

inherited

Returns: A writable pointer to the \( i^{th} \) neighbor of this element for interior elements. If an element is on a periodic boundary, it will return a corresponding element on the opposite side.

Definition at line 823 of file elem.C.

 {
   libmesh_assert_less (i, this->n_neighbors());
  
   Elem * neighbor_i = this->neighbor_ptr(i);
   if (neighbor_i != nullptr)
     return neighbor_i;
  
   if (pb)
     {
       // Since the neighbor is nullptr it must be on a boundary. We need
       // see if this is a periodic boundary in which case it will have a
       // topological neighbor
       std::vector<boundary_id_type> bc_ids;
       mesh.get_boundary_info().boundary_ids(this, cast_int<unsigned short>(i), bc_ids);
       for (const auto & id : bc_ids)
         if (pb->boundary(id))
           {
             // Since the point locator inside of periodic boundaries
             // returns a const pointer we will retrieve the proper
             // pointer directly from the mesh object.
             const Elem * const cn = pb->neighbor(id, point_locator, this, i);
             neighbor_i = const_cast<Elem *>(cn);
  
             // Since coarse elements do not have more refined
             // neighbors we need to make sure that we don't return one
             // of these types of neighbors.
             if (neighbor_i)
               while (level() < neighbor_i->level())
                 neighbor_i = neighbor_i->parent();
             return neighbor_i;
           }
     }
  
   return nullptr;
 }

References libMesh::PeriodicBoundaries::boundary(), libMesh::Elem::level(), mesh, libMesh::Elem::n_neighbors(), libMesh::PeriodicBoundaries::neighbor(), libMesh::Elem::neighbor_ptr(), and libMesh::Elem::parent().

◆ total_family_tree() [1/2]

void libMesh::Elem::total_family_tree	(	std::vector< const Elem * > &	family,
		bool	reset = `true`
	)		const

inherited

Same as the family_tree() member, but also adds any subactive descendants.

Definition at line 1457 of file elem.C.

 {
   ElemInternal::total_family_tree(this, family, reset);
 }

References libMesh::ElemInternal::total_family_tree().

Referenced by libMesh::connect_families(), and libMesh::Partitioner::set_parent_processor_ids().

◆ total_family_tree() [2/2]

void libMesh::Elem::total_family_tree	(	std::vector< Elem * > &	family,
		bool	reset = `true`
	)

inherited

Non-const version of function above; fills a vector of non-const pointers.

Definition at line 1465 of file elem.C.

 {
   ElemInternal::total_family_tree(this, family, reset);
 }

References libMesh::ElemInternal::total_family_tree().

◆ total_family_tree_by_neighbor() [1/2]

void libMesh::Elem::total_family_tree_by_neighbor	(	std::vector< const Elem * > &	family,
		const Elem *	neighbor,
		bool	reset = `true`
	)		const

inherited

Same as the family_tree_by_neighbor() member, but also adds any subactive descendants.

Definition at line 1543 of file elem.C.

 {
   ElemInternal::total_family_tree_by_neighbor(this, family, neighbor, reset);
 }

References libMesh::ElemInternal::total_family_tree_by_neighbor().

◆ total_family_tree_by_neighbor() [2/2]

void libMesh::Elem::total_family_tree_by_neighbor	(	std::vector< Elem * > &	family,
		Elem *	neighbor,
		bool	reset = `true`
	)

inherited

Non-const version of function above; fills a vector of non-const pointers.

Definition at line 1552 of file elem.C.

 {
   ElemInternal::total_family_tree_by_neighbor(this, family, neighbor, reset);
 }

References libMesh::ElemInternal::total_family_tree_by_neighbor().

◆ total_family_tree_by_subneighbor() [1/2]

void libMesh::Elem::total_family_tree_by_subneighbor	(	std::vector< const Elem * > &	family,
		const Elem *	neighbor,
		const Elem *	subneighbor,
		bool	reset = `true`
	)		const

inherited

Same as the family_tree_by_subneighbor() member, but also adds any subactive descendants.

Definition at line 1581 of file elem.C.

 {
   ElemInternal::total_family_tree_by_subneighbor(this, family, neighbor, subneighbor, reset);
 }

References libMesh::ElemInternal::total_family_tree_by_subneighbor().

◆ total_family_tree_by_subneighbor() [2/2]

void libMesh::Elem::total_family_tree_by_subneighbor	(	std::vector< Elem * > &	family,
		Elem *	neighbor,
		Elem *	subneighbor,
		bool	reset = `true`
	)

inherited

Non-const version of function above; fills a vector of non-const pointers.

Definition at line 1591 of file elem.C.

 {
   ElemInternal::total_family_tree_by_subneighbor(this, family, neighbor, subneighbor, reset);
 }

References libMesh::ElemInternal::total_family_tree_by_subneighbor().

◆ type()

virtual ElemType libMesh::RemoteElem::type ( ) const

inlineoverridevirtual

Returns: The type of element that has been derived from this base class.

Implements libMesh::Elem.

Definition at line 109 of file remote_elem.h.

110 { return REMOTEELEM; }

References libMesh::REMOTEELEM.

◆ 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().

◆ 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().

◆ 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(), libMesh::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().

◆ volume()

Real libMesh::Elem::volume ( ) const

virtualinherited

Returns: The (length/area/volume) of the geometric element.

Reimplemented in libMesh::Hex27, libMesh::Prism18, libMesh::Pyramid14, libMesh::Hex20, libMesh::Prism15, libMesh::Tet10, libMesh::Pyramid13, libMesh::Quad9, libMesh::Tri6, libMesh::Quad8, libMesh::Tet4, libMesh::Hex8, libMesh::Edge4, libMesh::Prism6, libMesh::Pyramid5, libMesh::Tri3, libMesh::Edge3, libMesh::Quad4, and libMesh::Edge2.

Definition at line 2617 of file elem.C.

 {
   // The default implementation builds a finite element of the correct
   // order and sums up the JxW contributions.  This can be expensive,
   // so the various element types can overload this method and compute
   // the volume more efficiently.
   const FEFamily mapping_family = FEMap::map_fe_type(*this);
   const FEType fe_type(this->default_order(), mapping_family);
  
   std::unique_ptr<FEBase> fe (FEBase::build(this->dim(),
                                             fe_type));
  
   const std::vector<Real> & JxW = fe->get_JxW();
  
   // The default quadrature rule should integrate the mass matrix,
   // thus it should be plenty to compute the area
   QGauss qrule (this->dim(), fe_type.default_quadrature_order());
  
   fe->attach_quadrature_rule(&qrule);
  
   fe->reinit(this);
  
   Real vol=0.;
   for (auto jxw : JxW)
     vol += jxw;
  
   return vol;
  
 }

References libMesh::FEGenericBase< OutputType >::build(), libMesh::Elem::default_order(), libMesh::FEType::default_quadrature_order(), libMesh::Elem::dim(), libMesh::FEMap::map_fe_type(), and libMesh::Real.

Referenced by libMesh::Elem::get_info(), libMesh::Quad8::volume(), libMesh::Tri6::volume(), libMesh::Quad9::volume(), libMesh::Pyramid13::volume(), libMesh::Tet10::volume(), libMesh::Prism15::volume(), libMesh::Hex20::volume(), libMesh::Pyramid14::volume(), libMesh::Hex27::volume(), and libMesh::Prism18::volume().

◆ which_child_am_i()

unsigned int libMesh::Elem::which_child_am_i ( const Elem * e ) const

inlineinherited

Returns: The child index which e corresponds to.

I.e. if c = a->which_child_am_i(e); then a->child_ptr(c) will be e.

Definition at line 2596 of file elem.h.

 {
   libmesh_assert(e);
   libmesh_assert (this->has_children());
  
   unsigned int nc = this->n_children();
   for (unsigned int c=0; c != nc; c++)
     if (this->child_ptr(c) == e)
       return c;
  
   libmesh_error_msg("ERROR:  which_child_am_i() was called with a non-child!");
  
   return libMesh::invalid_uint;
 }

References libMesh::Elem::child_ptr(), libMesh::Elem::has_children(), libMesh::invalid_uint, libMesh::libmesh_assert(), and libMesh::Elem::n_children().

Referenced by libMesh::BoundaryInfo::boundary_ids(), libMesh::BoundaryInfo::edge_boundary_ids(), libMesh::UnstructuredMesh::find_neighbors(), libMesh::Elem::make_links_to_me_remote(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectVertices::operator()(), libMesh::Parallel::Packing< const Elem * >::pack(), libMesh::BoundaryInfo::side_with_boundary_id(), libMesh::MeshTools::Modification::smooth(), and libMesh::Parallel::sync_element_data_by_parent_id().

◆ which_neighbor_am_i()

unsigned int libMesh::Elem::which_neighbor_am_i ( const Elem * e ) const

inlineinherited

This function tells you which neighbor e is.

I.e. if s = a->which_neighbor_am_i(e); then a->neighbor(s) will be an ancestor of e.

Definition at line 2323 of file elem.h.

 {
   libmesh_assert(e);
  
   const Elem * eparent = e;
  
   while (eparent->level() > this->level())
     {
       eparent = eparent->parent();
       libmesh_assert(eparent);
     }
  
   for (auto s : IntRange<unsigned int>(0, this->n_sides()))
     if (this->neighbor_ptr(s) == eparent)
       return s;
  
   return libMesh::invalid_uint;
 }

References libMesh::invalid_uint, libMesh::Elem::level(), libMesh::libmesh_assert(), libMesh::Elem::n_sides(), libMesh::Elem::neighbor_ptr(), and libMesh::Elem::parent().

Referenced by assemble_ellipticdg(), libMesh::FEGenericBase< FEOutputType< T >::type >::compute_proj_constraints(), libMesh::MeshTools::find_hanging_nodes_and_parents(), libMesh::Elem::libmesh_assert_valid_neighbors(), and libMesh::Elem::nullify_neighbors().

◆ which_node_am_i()

virtual unsigned int libMesh::RemoteElem::which_node_am_i	(	unsigned int	side,
		unsigned int	side_node
	)		const

inlineoverridevirtual

Returns: The local node id for node side_node on side side of this Elem. Simply relies on the side_nodes_map for each of the derived types. For example, Tri3::which_node_am_i(0, 0) -> 0 Tri3::which_node_am_i(0, 1) -> 1 Tri3::which_node_am_i(1, 0) -> 1 Tri3::which_node_am_i(1, 1) -> 2 etc...

Implements libMesh::Elem.

Definition at line 97 of file remote_elem.h.

99 { libmesh_not_implemented(); return 0; }

◆ which_side_am_i()

unsigned int libMesh::Elem::which_side_am_i ( const Elem * e ) const

inherited

This function tells you which side the boundary element e is.

I.e. if e = a->build_side_ptr(s) or e = a->side_ptr(s); then a->which_side_am_i(e) will be s.

Note: An exact floating point comparison of the nodal positions of e is made with the nodal positions of this in order to perform this test. The idea is that the test will return a valid side id if e either directly shares Node pointers with this, or was created by exactly copying some of the nodes of this (e.g. through BoundaryMesh::sync()). In these circumstances, non-fuzzy floating point equality is expected.

Returns: The side of this the element which e is, otherwise invalid_uint.

Definition at line 475 of file elem.C.

 {
   libmesh_assert(e);
  
   const unsigned int ns = this->n_sides();
   const unsigned int nn = this->n_nodes();
  
   const unsigned int en = e->n_nodes();
  
   // e might be on any side until proven otherwise
   std::vector<bool> might_be_side(ns, true);
  
   for (unsigned int i=0; i != en; ++i)
     {
       Point side_point = e->point(i);
       unsigned int local_node_id = libMesh::invalid_uint;
  
       // Look for a node of this that's contiguous with node i of
       // e. Note that the exact floating point comparison of Point
       // positions is intentional, see the class documentation for
       // this function.
       for (unsigned int j=0; j != nn; ++j)
         if (this->point(j) == side_point)
           local_node_id = j;
  
       // If a node of e isn't contiguous with some node of this, then
       // e isn't a side of this.
       if (local_node_id == libMesh::invalid_uint)
         return libMesh::invalid_uint;
  
       // If a node of e isn't contiguous with some node on side s of
       // this, then e isn't on side s.
       for (unsigned int s=0; s != ns; ++s)
         if (!this->is_node_on_side(local_node_id, s))
           might_be_side[s] = false;
     }
  
   for (unsigned int s=0; s != ns; ++s)
     if (might_be_side[s])
       {
 #ifdef DEBUG
         for (unsigned int s2=s+1; s2 < ns; ++s2)
           libmesh_assert (!might_be_side[s2]);
 #endif
         return s;
       }
  
   // Didn't find any matching side
   return libMesh::invalid_uint;
 }

References libMesh::invalid_uint, libMesh::Elem::is_node_on_side(), libMesh::libmesh_assert(), libMesh::Elem::n_nodes(), libMesh::Elem::n_sides(), and libMesh::Elem::point().

◆ write_connectivity()

void libMesh::Elem::write_connectivity	(	std::ostream &	out,
		const IOPackage	iop
	)		const

inherited

Writes the element connectivity for various IO packages to the passed ostream "out".

Not virtual, since it is implemented in the base class.

Definition at line 1283 of file elem.C.

 {
   libmesh_assert (out_stream.good());
   libmesh_assert(_nodes);
   libmesh_assert_not_equal_to (iop, INVALID_IO_PACKAGE);
  
   switch (iop)
     {
     case TECPLOT:
       {
         // This connectivity vector will be used repeatedly instead
         // of being reconstructed inside the loop.
         std::vector<dof_id_type> conn;
         for (auto sc : IntRange<unsigned int>(0, this->n_sub_elem()))
           {
             this->connectivity(sc, TECPLOT, conn);
  
             std::copy(conn.begin(),
                       conn.end(),
                       std::ostream_iterator<dof_id_type>(out_stream, " "));
  
             out_stream << '\n';
           }
         return;
       }
  
     case UCD:
       {
         for (auto i : this->node_index_range())
           out_stream << this->node_id(i)+1 << "\t";
  
         out_stream << '\n';
         return;
       }
  
     default:
       libmesh_error_msg("Unsupported IO package " << iop);
     }
 }

References libMesh::Elem::_nodes, libMesh::Elem::connectivity(), libMesh::INVALID_IO_PACKAGE, libMesh::libmesh_assert(), libMesh::Elem::n_sub_elem(), libMesh::Elem::node_id(), libMesh::Elem::node_index_range(), libMesh::TECPLOT, and libMesh::UCD.

Member Data Documentation

◆ _children

Elem** libMesh::Elem::_children

protectedinherited

Pointers to this element's children.

Definition at line 1755 of file elem.h.

Referenced by libMesh::Elem::add_child(), libMesh::Elem::child_ptr(), libMesh::Elem::child_ref_range(), libMesh::Elem::contract(), libMesh::Elem::has_ancestor_children(), libMesh::Elem::has_children(), libMesh::Elem::raw_child_ptr(), libMesh::Elem::refine(), libMesh::Elem::set_child(), and libMesh::Elem::~Elem().

◆ _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().

◆ _elemlinks

Elem** libMesh::Elem::_elemlinks

protectedinherited

Pointers to this element's parent and neighbors, and for lower-dimensional elements' interior_parent.

Definition at line 1749 of file elem.h.

Referenced by libMesh::Elem::Elem(), libMesh::Elem::interior_parent(), libMesh::Elem::neighbor_ptr(), libMesh::Elem::neighbor_ptr_range(), libMesh::Elem::parent(), libMesh::Elem::set_interior_parent(), libMesh::Elem::set_neighbor(), and libMesh::Elem::set_parent().

◆ _elemlinks_data

Elem* libMesh::RemoteElem::_elemlinks_data[1]

protected

Data for link to (nullptr!) parent.

Definition at line 216 of file remote_elem.h.

◆ _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.

◆ _map_data

unsigned char libMesh::Elem::_map_data

protectedinherited

Mapping function data; currently used when needed to store the RATIONAL_BERNSTEIN nodal weight data index.

Definition at line 1797 of file elem.h.

Referenced by libMesh::Elem::Elem(), libMesh::Elem::mapping_data(), and libMesh::Elem::set_mapping_data().

◆ _map_type

unsigned char libMesh::Elem::_map_type

protectedinherited

Mapping function type; currently either 0 (LAGRANGE) or 1 (RATIONAL_BERNSTEIN).

Definition at line 1791 of file elem.h.

Referenced by libMesh::Elem::Elem(), libMesh::Elem::mapping_type(), and libMesh::Elem::set_mapping_type().

◆ _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().

◆ _nodes

Node** libMesh::Elem::_nodes

protectedinherited

Pointers to the nodes we are connected to.

Definition at line 1743 of file elem.h.

◆ _p_level

unsigned char libMesh::Elem::_p_level

protectedinherited

p refinement level - the difference between the polynomial degree on this element and the minimum polynomial degree on the mesh.

This is stored as an unsigned char to save space. In theory, these last four bytes might have been padding anyway.

Definition at line 1784 of file elem.h.

Referenced by libMesh::Elem::hack_p_level(), libMesh::Elem::max_descendant_p_level(), libMesh::Elem::p_level(), and libMesh::Elem::set_p_level().

◆ _pflag

unsigned char libMesh::Elem::_pflag

protectedinherited

p refinement flag.

This is stored as an unsigned char to save space.

Definition at line 1774 of file elem.h.

Referenced by libMesh::Elem::p_refinement_flag(), and libMesh::Elem::set_p_refinement_flag().

◆ _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().

◆ _rflag

unsigned char libMesh::Elem::_rflag

protectedinherited

h refinement flag.

This is stored as an unsigned char to save space.

Definition at line 1768 of file elem.h.

Referenced by libMesh::Elem::refinement_flag(), and libMesh::Elem::set_refinement_flag().

◆ _sbd_id

subdomain_id_type libMesh::Elem::_sbd_id

protectedinherited

The subdomain to which this element belongs.

Definition at line 1761 of file elem.h.

Referenced by libMesh::Elem::subdomain_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().

◆ ConstNeighborPtrIter

const typedef Elem* const * libMesh::Elem::ConstNeighborPtrIter

inherited

Definition at line 299 of file elem.h.

◆ 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(), libMesh::Node::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_subdomain_id

const subdomain_id_type libMesh::Elem::invalid_subdomain_id = std::numeric_limits<subdomain_id_type>::max()

staticinherited

A static integral constant representing an invalid subdomain id.

See also DofObject::{invalid_id, invalid_unique_id, invalid_processor_id}.

Note: We don't use the static_cast(-1) trick here since subdomain_id_type is sometimes a signed integer for compatibility reasons (see libmesh/id_types.h).; Normally you can declare static const integral types directly in the header file (C++ standard, 9.4.2/4) but std::numeric_limits<T>::max() is not considered a "constant expression". This one is therefore defined in elem.C. http://stackoverflow.com/questions/2738435/using-numeric-limitsmax-in-constant-expressions

Definition at line 244 of file elem.h.

Referenced by libMesh::BoundaryInfo::_find_id_maps(), libMesh::BoundaryInfo::add_elements(), libMesh::ReplicatedMesh::get_disconnected_subdomains(), and libMesh::BoundaryInfo::sync().

◆ 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().

◆ LIBMESH_ENABLE_TOPOLOGY_CACHES

libMesh::RemoteElem::LIBMESH_ENABLE_TOPOLOGY_CACHES

Definition at line 206 of file remote_elem.h.

◆ max_n_nodes

const unsigned int libMesh::Elem::max_n_nodes = 27

staticinherited

The maximum number of nodes any element can contain.

This is useful for replacing heap vectors with stack arrays.

Definition at line 587 of file elem.h.

Referenced by libMesh::Elem::Elem().

◆ 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().

◆ remote_elem_id

const dof_id_type libMesh::RemoteElem::remote_elem_id = static_cast<dof_id_type>(-2)

static

A unique id to distinguish remote element links.

Definition at line 52 of file remote_elem.h.

◆ type_to_n_edges_map

const unsigned int libMesh::Elem::type_to_n_edges_map

staticinherited

This array maps the integer representation of the ElemType enum to the number of edges on the element.

Definition at line 656 of file elem.h.

Referenced by libMesh::Parallel::Packing< const Elem * >::packed_size().

◆ type_to_n_nodes_map

const unsigned int libMesh::Elem::type_to_n_nodes_map

staticinherited

This array maps the integer representation of the ElemType enum to the number of nodes in the element.

Definition at line 576 of file elem.h.

Referenced by libMesh::DynaIO::ElementDefinition::ElementDefinition(), libMesh::XdrIO::pack_element(), libMesh::Parallel::Packing< const Elem * >::packed_size(), libMesh::CheckpointIO::read_connectivity(), libMesh::XdrIO::read_serialized_connectivity(), and libMesh::Parallel::Packing< Elem * >::unpack().

◆ type_to_n_sides_map

const unsigned int libMesh::Elem::type_to_n_sides_map

staticinherited

This array maps the integer representation of the ElemType enum to the number of sides on the element.

Definition at line 607 of file elem.h.

Referenced by libMesh::Parallel::Packing< const Elem * >::packed_size().

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

include/geom/remote_elem.h
src/geom/remote_elem.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ Counts [1/2]

◆ Counts [2/2]

◆ index_buffer_t

◆ index_t

◆ NeighborPtrIter

◆ Predicate

Member Enumeration Documentation

◆ RefinementState

Constructor & Destructor Documentation

◆ RemoteElem() [1/3]

◆ RemoteElem() [2/3]

◆ RemoteElem() [3/3]

◆ ~RemoteElem()

Member Function Documentation

◆ _first_side()

◆ _get_bracketing_node_cache()

◆ _get_parent_indices_cache()

◆ _last_side()

◆ active()

◆ active_family_tree() [1/2]

◆ active_family_tree() [2/2]

◆ active_family_tree_by_neighbor() [1/2]

◆ active_family_tree_by_neighbor() [2/2]

◆ active_family_tree_by_side() [1/2]

◆ active_family_tree_by_side() [2/2]

◆ active_family_tree_by_topological_neighbor() [1/2]

◆ active_family_tree_by_topological_neighbor() [2/2]

◆ add_child() [1/2]

◆ add_child() [2/2]

◆ add_extra_integers()

◆ add_system()

◆ ancestor()

◆ as_parent_node()

◆ boundary_sides_begin()

◆ boundary_sides_end()

◆ bracketing_nodes()

◆ build()

◆ build_edge_ptr() [1/2]

◆ build_edge_ptr() [2/2]

◆ build_side_ptr() [1/4]

◆ build_side_ptr() [2/4]

◆ build_side_ptr() [3/4]

◆ build_side_ptr() [4/4]

◆ centroid()

◆ child_neighbor() [1/2]

◆ child_neighbor() [2/2]

◆ child_ptr() [1/2]

◆ child_ptr() [2/2]

◆ child_ref_range() [1/2]

◆ child_ref_range() [2/2]

◆ cleanup()

◆ clear_dofs()

◆ clear_old_dof_object()

◆ close_to_point()

◆ coarsen()

◆ compute_key() [1/4]

◆ compute_key() [2/4]

◆ compute_key() [3/4]

◆ compute_key() [4/4]

◆ connectivity()

◆ contains_edge_of()

◆ contains_point()

◆ contains_vertex_of()

◆ contract()