The Pyramid5 is an element in 3D composed of 5 nodes. More...

#include <cell_pyramid5.h>

Inheritance diagram for libMesh::Pyramid5:

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 const Elem const	ConstNeighborPtrIter

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

Public Member Functions
	Pyramid5 (Elem *p=nullptr)
	Constructor. More...

	Pyramid5 (Pyramid5 &&)=delete

	Pyramid5 (const Pyramid5 &)=delete

Pyramid5 &	operator= (const Pyramid5 &)=delete

Pyramid5 &	operator= (Pyramid5 &&)=delete

virtual	~Pyramid5 ()=default

virtual ElemType	type () const override

virtual unsigned int	n_sub_elem () const override

virtual bool	is_vertex (const unsigned int i) const override

virtual bool	is_edge (const unsigned int i) const override

virtual bool	is_face (const unsigned int i) const override

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

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

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

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

virtual bool	has_affine_map () const override

virtual Order	default_order () const override

virtual std::unique_ptr< Elem >	build_side_ptr (const unsigned int i) override
	Builds a `QUAD4` or `TRI3` built coincident with face i. More...

virtual void	build_side_ptr (std::unique_ptr< Elem > &elem, const unsigned int i) override
	Rebuilds a `QUAD4` or `TRI3` built coincident with face i. More...

virtual std::unique_ptr< Elem >	build_edge_ptr (const unsigned int i) override
	Builds a `EDGE2` built coincident with edge i. More...

virtual void	build_edge_ptr (std::unique_ptr< Elem > &edge, const unsigned int i) override
	Rebuilds a `EDGE2` coincident with edge i. More...

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

virtual Point	true_centroid () const override
	We compute the centroid of the Pyramid by treating it as a degenerate Hex8 element. More...

virtual Real	volume () const override
	Specialization for computing the volume of a pyramid. More...

virtual BoundingBox	loose_bounding_box () const override
	Builds a bounding box out of the nodal positions. More...

virtual void	permute (unsigned int perm_num) override final
	Permutes the element (by swapping node and neighbor pointers) according to the specified index. More...

virtual void	flip (BoundaryInfo *) override final
	Flips the element (by swapping node and neighbor pointers) to have a mapping Jacobian of opposite sign. More...

ElemType	side_type (const unsigned int s) const override final

virtual std::unique_ptr< Elem >	build_side_ptr (const unsigned int i)=0

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

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

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

virtual void	build_side_ptr (std::unique_ptr< Elem > &side, const unsigned int i)=0
	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...

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

virtual Point	master_point (const unsigned int i) 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_child_on_side (const unsigned int c, const unsigned int s) const override

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

virtual dof_id_type	key (const unsigned int s) const override

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

virtual dof_id_type	key () const

virtual dof_id_type	low_order_key (const unsigned int s) const override

virtual unsigned int	local_side_node (unsigned int side, unsigned int side_node) const override

virtual unsigned int	local_edge_node (unsigned int edge, unsigned int edge_node) const override

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

virtual void	side_ptr (std::unique_ptr< Elem > &side, const unsigned int i) override
	Rebuilds a primitive triangle or quad for face i. More...

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

virtual std::vector< unsigned int >	sides_on_edge (const unsigned int e) const override final

unsigned int	local_singular_node (const Point &p, const Real tol=TOLERANCE *TOLERANCE) const override final

virtual bool	is_singular_node (unsigned int node_idx) const override final

virtual unsigned int	n_permutations () const override final
	One quad side, four orientations. More...

virtual bool	is_flipped () const override final

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

virtual bool	on_reference_element (const Point &p, const Real eps=TOLERANCE) const override final

virtual unsigned short	dim () const override

virtual bool	infinite () const override

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)

virtual Node *&	set_node (const unsigned int i)

virtual void	set_node (const unsigned int i, Node *node)
	Sets local `Node` `i` to refer to `node`. More...

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

virtual bool	runtime_topology () const

const Elem *	reference_elem () const

bool	operator== (const Elem &rhs) const

bool	topologically_equal (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...

unsigned int	which_node_am_i (unsigned int side, unsigned int side_node) const
	This function is deprecated, call local_side_node(side, side_node) instead. More...

bool	contains_vertex_of (const Elem *e, bool mesh_connection=false) 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...

virtual bool	is_remote () const

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

IntRange< unsigned short >	face_index_range () const

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

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

bool	is_internal (const unsigned int i) 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 >	build_side_ptr (const unsigned int i) const

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

std::unique_ptr< const Elem >	build_side_ptr (const unsigned int i, bool proxy) 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

void	build_edge_ptr (std::unique_ptr< const Elem > &edge, const unsigned int i) const

virtual Order	supported_nodal_order () const

virtual Order	default_side_order () const

virtual Point	centroid () const
	Calls Elem::vertex_average() for backwards compatibility. More...

Point	vertex_average () const

virtual Point	quasicircumcenter () const

virtual Real	hmin () const

virtual Real	hmax () 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

bool	positive_edge_orientation (const unsigned int i) const

bool	positive_face_orientation (const unsigned int i) const

void	inherit_data_from (const Elem &src)
	A helper function for copying generic element data (mapping, subdomain, processor) from an element to a derived (child, side, edge) element. More...

virtual bool	has_invertible_map (Real tol=TOLERANCE *TOLERANCE) 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...

void	hack_p_level_and_refinement_flag (const unsigned int p, RefinementState pflag)
	Sets the value of the p-refinement level for the element without altering the p-level of its ancestors; also sets the p_refinement_flag, simultaneously so that they can be safely checked for mutual consistency. 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...

virtual unsigned int	center_node_on_side (const unsigned short side) const

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 std::unique_ptr< Elem >	disconnected_clone () const

void	orient (BoundaryInfo *boundary_info)
	Flips the element (by swapping node and neighbor pointers) to have a mapping Jacobian of opposite sign, iff we find a negative orientation. More...

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

DofObject *	get_old_dof_object ()
	Pointer accessor for previously public old_dof_object. More...

const DofObject *	get_old_dof_object () const

DofObject &	get_old_dof_object_ref ()
	As above, but do not use in situations where the old_dof_object may be nullptr, since this function asserts that the old_dof_object is valid before returning a reference to it. More...

const DofObject &	get_old_dof_object_ref () const

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

void	set_unique_id (unique_id_type new_id)
	Sets the `unique_id` for this `DofObject`. More...

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

void	add_extra_integers (const unsigned int n_integers, const std::vector< dof_id_type > &default_values)
	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 constexpr bool	infinite ()

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

static void	print_info (std::ostream &out_stream=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 ElemType	complete_order_equivalent_type (const ElemType et)

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

static std::unique_ptr< Elem >	build_with_id (const ElemType type, dof_id_type id)
	Calls the build() method above with a nullptr parent, and additionally sets the newly-created Elem's id. More...

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 Public Attributes
static const int	num_nodes = 5
	Geometric constants for Pyramid5. More...

static const int	nodes_per_side = 4

static const int	nodes_per_edge = 2

static const unsigned int	side_nodes_map [num_sides][nodes_per_side]
	This maps the \( j^{th} \) node of the \( i^{th} \) side to element node numbers. More...

static const unsigned int	edge_nodes_map [num_edges][nodes_per_edge]
	This maps the \( j^{th} \) node of the \( i^{th} \) edge to element node numbers. More...

static const int	num_sides = 5
	Geometric constants for all Pyramids. More...

static const int	num_edges = 8

static const int	num_children = 0

static const unsigned int	edge_sides_map [8][2]
	This maps each edge to the sides that contain said edge. 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_dim_map [INVALID_ELEM]
	This array maps the integer representation of the `ElemType` enum to the geometric dimension of the element. 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 Order	type_to_default_order_map [INVALID_ELEM]
	This array maps the integer representation of the `ElemType` enum to the default approximation order of elements of that type. 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
virtual Real	embedding_matrix (const unsigned int, const unsigned int, const unsigned int) const override
	Matrix used to create the elements children. More...

unsigned int	side_children_matrix (const unsigned int, const unsigned int) const
	Matrix that allows children to inherit boundary conditions. More...

void	swap2nodes (unsigned int n1, unsigned int n2)
	Swaps two node_ptrs. More...

void	swap2neighbors (unsigned int n1, unsigned int n2)
	Swaps two neighbor_ptrs. More...

void	swap2boundarysides (unsigned short s1, unsigned short s2, BoundaryInfo *boundary_info) const
	Swaps two sides in `boundary_info`, if it is non-null. More...

void	swap2boundaryedges (unsigned short e1, unsigned short e2, BoundaryInfo *boundary_info) const
	Swaps two edges in `boundary_info`, if it is non-null. More...

void	swap3nodes (unsigned int n1, unsigned int n2, unsigned int n3)
	Swaps three node_ptrs, "rotating" them. More...

void	swap3neighbors (unsigned int n1, unsigned int n2, unsigned int n3)
	Swaps three neighbor_ptrs, "rotating" them. More...

void	swap4nodes (unsigned int n1, unsigned int n2, unsigned int n3, unsigned int n4)
	Swaps four node_ptrs, "rotating" them. More...

void	swap4neighbors (unsigned int n1, unsigned int n2, unsigned int n3, unsigned int n4)
	Swaps four neighbor_ptrs, "rotating" them. More...

template<typename Sideclass , typename Subclass >
std::unique_ptr< Elem >	simple_build_side_ptr (const unsigned int i)
	An implementation for simple (all sides equal) elements. More...

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

template<typename Edgeclass , typename Subclass >
std::unique_ptr< Elem >	simple_build_edge_ptr (const unsigned int i)
	An implementation for simple (all edges equal) elements. More...

template<typename Subclass >
void	simple_build_edge_ptr (std::unique_ptr< Elem > &edge, const unsigned int i, ElemType edgetype)
	An implementation for simple (all edges 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) noexcept
	Increments the construction counter. More...

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

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

void	increment_destructor_count (const std::string &name) noexcept
	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
Node *	_nodelinks_data [num_nodes]
	Data for links to nodes. More...

	LIBMESH_ENABLE_TOPOLOGY_CACHES

Elem *	_elemlinks_data [6+(LIBMESH_DIM >3)]
	Data for links to parent/neighbor/interior_parent elements. 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...

std::unique_ptr< Elem *[]>	_children
	unique_ptr to array of 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...

std::unique_ptr< DofObject >	old_dof_object
	This object on the last mesh. More...

Static Protected Attributes
static const Real	_master_points [14][3]
	Master element node locations. More...

static const unsigned int	adjacent_edges_map [5][4]
	This maps the \( j^{th} \) node to the 3 or 4 edge ids adjacent to the node. More...

static constexpr Real	affine_tol = TOLERANCE*TOLERANCE
	Default tolerance to use in has_affine_map(). More...

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

Detailed Description

The Pyramid5 is an element in 3D composed of 5 nodes.

It is numbered with a counter-clockwise base like this:

*   PYRAMID5:
*             o 4
*           //|\
*          // | \          zeta
*         //  |  \          ^   eta (into page)
*      3 o/...|...o 2       | /
*       ./    |  /          |/
*      ./     | /           o---> xi
*     ./      |/
*    o--------o
*    0        1
*

(xi, eta, zeta): { zeta-1 <= xi <= 1-zeta { zeta-1 <= eta <= 1-zeta { 0 <= zeta <= 1 are the reference element coordinates associated with the given numbering.

Author: Benjamin S. Kirk

Date: 2002 A 3D pyramid element with 5 nodes.

Definition at line 57 of file cell_pyramid5.h.

Member Typedef Documentation

◆ ConstNeighborPtrIter

typedef const Elem* const* libMesh::Elem::ConstNeighborPtrIter

inherited

Definition at line 334 of file elem.h.

◆ 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 119 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 119 of file reference_counter.h.

◆ NeighborPtrIter

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

inherited

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

Definition at line 333 of file elem.h.

◆ Predicate

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

inherited

Useful iterator typedefs.

Definition at line 1860 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 1452 of file elem.h.

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

Constructor & Destructor Documentation

◆ Pyramid5() [1/3]

libMesh::Pyramid5::Pyramid5 ( Elem * p = nullptr )

inlineexplicit

Constructor.

By default this element has no parent.

Definition at line 65 of file cell_pyramid5.h.

                               :
     Pyramid(num_nodes, p, _nodelinks_data)
   {}

◆ Pyramid5() [2/3]

libMesh::Pyramid5::Pyramid5 ( Pyramid5 && )

delete

◆ Pyramid5() [3/3]

libMesh::Pyramid5::Pyramid5 ( const Pyramid5 & )

delete

◆ ~Pyramid5()

virtual libMesh::Pyramid5::~Pyramid5 ( )

virtualdefault

Member Function Documentation

◆ _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 2209 of file elem.h.

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

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

◆ _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 2223 of file elem.h.

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

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

◆ 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 2941 of file elem.h.

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::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::DofMap::merge_ghost_functor_outputs(), libMesh::Elem::min_new_p_level_by_neighbor(), libMesh::Elem::min_p_level_by_neighbor(), libMesh::PointLocatorTree::operator()(), libMesh::EquationSystems::redundant_added_side(), libMesh::Elem::refine(), libMesh::Elem::subactive(), libMesh::Parallel::sync_element_data_by_parent_id(), libMesh::MeshRefinement::test_level_one(), EquationSystemsTest::testRefineThenReinitPreserveFlags(), and libMesh::BoundaryInfo::transfer_boundary_ids_from_children().

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

◆ 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 2133 of file elem.C.

References libMesh::ElemInternal::active_family_tree().

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

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

◆ 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 2141 of file elem.C.

References libMesh::ElemInternal::active_family_tree().

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

◆ 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 2261 of file elem.C.

References libMesh::ElemInternal::active_family_tree_by_neighbor().

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

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

◆ 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 2270 of file elem.C.

References libMesh::ElemInternal::active_family_tree_by_neighbor().

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

◆ 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 2167 of file elem.C.

References libMesh::ElemInternal::active_family_tree_by_side().

Referenced by libMesh::BoundaryInfo::build_node_list_from_side_list(), libMesh::Nemesis_IO_Helper::write_sidesets(), and libMesh::ExodusII_IO_Helper::write_sidesets().

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

◆ 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 2176 of file elem.C.

References libMesh::ElemInternal::active_family_tree_by_side().

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

◆ 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 2279 of file elem.C.

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

Referenced by libMesh::GhostPointNeighbors::operator()(), and libMesh::DefaultCoupling::operator()().

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

◆ 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 2293 of file elem.C.

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

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

◆ 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 2044 of file elem.C.

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

Referenced by libMesh::BoundaryInfo::add_elements(), libMesh::UnstructuredMesh::all_first_order(), libMesh::UnstructuredMesh::copy_nodes_and_elements(), libMesh::CheckpointIO::read_connectivity(), and libMesh::CheckpointIO::read_remote_elem().

 {
   const unsigned int nc = this->n_children();
 
   if (!_children)
     {
       _children = std::make_unique<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");
 }

◆ 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 2071 of file elem.C.

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

 {
   if (!this->has_children())
     {
       const unsigned int nc = this->n_children();
       _children = std::make_unique<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);
 }

◆ add_extra_integers() [1/2]

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.

Any newly-added values will initially be DofObject::invalid_id

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 490 of file dof_object.C.

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::DofObject::add_extra_integers(), libMesh::ReplicatedMesh::add_node(), libMesh::DistributedMesh::add_node(), libMesh::ReplicatedMesh::add_point(), libMesh::UnstructuredMesh::all_first_order(), 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().

 {
   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);
         }
     }
 }

◆ add_extra_integers() [2/2]

void libMesh::DofObject::add_extra_integers	(	const unsigned int	n_integers,
		const std::vector< dof_id_type > &	default_values
	)

inherited

Assigns a set of extra integers to this DofObject.

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

Any newly-added values will be copied from default_values.

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, and its data should be expressed in default_values as per memcpy.

Definition at line 542 of file dof_object.C.

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

 {
   libmesh_assert_equal_to(n_integers, default_values.size());
 
   const unsigned int n_old_integers = this->n_extra_integers();
   this->add_extra_integers(n_integers);
   if (n_integers > n_old_integers)
     {
       const unsigned int n_more_integers = n_integers - n_old_integers;
       std::copy(default_values.begin()+n_old_integers,
                 default_values.end(),
                 _idx_buf.end()-n_more_integers);
     }
 }

◆ add_system()

void libMesh::DofObject::add_system ( )

inherited

Adds an additional system to the DofObject.

Definition at line 195 of file dof_object.C.

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

 {
   // 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);
 }

◆ 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 2010 of file elem.C.

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::find_neighbors(), libMesh::Elem::get_info(), and libMesh::Elem::refine().

 {
 #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
 }

◆ 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 2386 of file elem.C.

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(), libMesh::parent_indices_mutex, and libMesh::Real.

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

 {
   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 Real 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];
 }

◆ boundary_sides_begin()

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

inherited

Iterator accessor functions.

Definition at line 3417 of file elem.C.

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

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

◆ boundary_sides_end()

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

inherited

Definition at line 3426 of file elem.C.

References libMesh::Elem::_last_side().

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

◆ 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 2657 of file elem.C.

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

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

 {
   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.emplace_back(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)
             {
               libmesh_assert(this->child_ptr(c));
               if (this->child_ptr(c) == remote_elem)
                 continue;
 
               for (auto n : make_range(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.emplace_back(pt1, pt2);
         }
     }
 
   return returnval;
 }

◆ 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 444 of file elem.C.

References libMesh::C0POLYGON, libMesh::C0POLYHEDRON, 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::PRISM20, libMesh::PRISM21, libMesh::PRISM6, libMesh::PYRAMID13, libMesh::PYRAMID14, libMesh::PYRAMID18, libMesh::PYRAMID5, libMesh::QUAD4, libMesh::QUAD8, libMesh::QUAD9, libMesh::QUADSHELL4, libMesh::QUADSHELL8, libMesh::QUADSHELL9, libMesh::TET10, libMesh::TET14, libMesh::TET4, libMesh::TRI3, libMesh::TRI3SUBDIVISION, libMesh::TRI6, libMesh::TRI7, libMesh::TRISHELL3, and libMesh::Elem::type().

Referenced by libMesh::GMVIO::_read_one_cell(), libMesh::MeshTools::Subdivision::add_boundary_ghosts(), add_cube_convex_hull_to_mesh(), libMesh::UnstructuredMesh::all_first_order(), libMesh::MeshTools::Modification::all_tri(), AllSecondOrderTest::allCompleteOrderMixed(), AllSecondOrderTest::allCompleteOrderRange(), AllSecondOrderTest::allSecondOrderMixed(), AllSecondOrderTest::allSecondOrderRange(), libMesh::Elem::bracketing_nodes(), libMesh::MeshTools::Generation::build_cube(), libMesh::Nemesis_IO_Helper::build_element_and_node_maps(), libMesh::MeshTools::Generation::build_extrusion(), libMesh::InfElemBuilder::build_inf_elem(), MixedDimensionMeshTest::build_mesh(), ExtraIntegersTest::build_mesh(), MeshfunctionDFEM::build_mesh(), MixedDimensionNonUniformRefinement::build_mesh(), MixedDimensionNonUniformRefinementTriangle::build_mesh(), MixedDimensionNonUniformRefinement3D::build_mesh(), libMesh::Elem::build_with_id(), VolumeTest::construct_elem(), ContainsPointTest::containsPointTri3Helper(), libMesh::MeshBase::copy_constraint_rows(), libMesh::TriangleWrapper::copy_tri_to_mesh(), libMesh::Elem::disconnected_clone(), libMesh::UNVIO::elements_in(), libMesh::MeshTools::Modification::flatten(), libMesh::VariationalSmootherSystem::get_target_elem(), libMesh::ExodusII_IO_Helper::init_conversion_map(), main(), libMesh::Elem::parent_bracketing_nodes(), libMesh::TetGenMeshInterface::pointset_convexhull(), 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::XdrIO::read_serialized_connectivity(), libMesh::OFFIO::read_stream(), libMesh::Elem::refine(), libMesh::SimplexRefiner::refine_via_edges(), libMesh::C0Polyhedron::retriangulate(), PerElemTest< elem_type >::setUp(), RationalMapTest< elem_type >::setUp(), libMesh::MeshTools::Generation::surface_octahedron(), ContainsPointTest::testContainsPointNodeElem(), ContainsPointTest::testContainsPointTet4(), DefaultCouplingTest::testCoupling(), PointNeighborCouplingTest::testCoupling(), SystemsTest::testDofCouplingWithVarGroups(), DofMapTest::testDofOwner(), MeshTriangulationTest::testEdge3Mesh(), MeshTriangulationTest::testEdgesMesh(), MeshTriangulationTest::testHalfDomain(), QuadratureTest::testNodalQuadrature(), MeshTriangulationTest::testPoly2TriBad1DMultiBoundary(), MeshTriangulationTest::testPoly2TriBad2DMultiBoundary(), MeshTriangulationTest::testPoly2TriBadEdges(), QuadratureTest::testPolynomials(), EquationSystemsTest::testReinitWithNodeElem(), SystemsTest::testSetSystemParameterOverEquationSystem(), BoundaryInfoTest::testShellFaceConstraints(), MeshTetTest::testTetsToTets(), MeshSubdomainIDTest::testUnpartitioned(), libMesh::TetGenMeshInterface::triangulate_conformingDelaunayMesh_carvehole(), libMesh::TetGenMeshInterface::triangulate_pointset(), and libMesh::GMVIO::write_ascii_old_impl().

 {
   switch (type)
     {
       // 0D elements
     case NODEELEM:
       return std::make_unique<NodeElem>(p);
 
       // 1D elements
     case EDGE2:
       return std::make_unique<Edge2>(p);
     case EDGE3:
       return std::make_unique<Edge3>(p);
     case EDGE4:
       return std::make_unique<Edge4>(p);
 
       // 2D elements
     case TRI3:
       return std::make_unique<Tri3>(p);
     case TRISHELL3:
       return std::make_unique<TriShell3>(p);
     case TRI3SUBDIVISION:
       return std::make_unique<Tri3Subdivision>(p);
     case TRI6:
       return std::make_unique<Tri6>(p);
     case TRI7:
       return std::make_unique<Tri7>(p);
     case QUAD4:
       return std::make_unique<Quad4>(p);
     case QUADSHELL4:
       return std::make_unique<QuadShell4>(p);
     case QUAD8:
       return std::make_unique<Quad8>(p);
     case QUADSHELL8:
       return std::make_unique<QuadShell8>(p);
     case QUAD9:
       return std::make_unique<Quad9>(p);
     case QUADSHELL9:
       return std::make_unique<QuadShell9>(p);
 
     // Well, a hexagon is *a* polygon...
     case C0POLYGON:
       return std::make_unique<C0Polygon>(6, p);
 
     // Building a polyhedron can't currently be done without creating
     // its nodes first
     case C0POLYHEDRON:
       libmesh_not_implemented_msg
         ("Polyhedra cannot be built via Elem::build()");
 
       // 3D elements
     case TET4:
       return std::make_unique<Tet4>(p);
     case TET10:
       return std::make_unique<Tet10>(p);
     case TET14:
       return std::make_unique<Tet14>(p);
     case HEX8:
       return std::make_unique<Hex8>(p);
     case HEX20:
       return std::make_unique<Hex20>(p);
     case HEX27:
       return std::make_unique<Hex27>(p);
     case PRISM6:
       return std::make_unique<Prism6>(p);
     case PRISM15:
       return std::make_unique<Prism15>(p);
     case PRISM18:
       return std::make_unique<Prism18>(p);
     case PRISM20:
       return std::make_unique<Prism20>(p);
     case PRISM21:
       return std::make_unique<Prism21>(p);
     case PYRAMID5:
       return std::make_unique<Pyramid5>(p);
     case PYRAMID13:
       return std::make_unique<Pyramid13>(p);
     case PYRAMID14:
       return std::make_unique<Pyramid14>(p);
     case PYRAMID18:
       return std::make_unique<Pyramid18>(p);
 
 #ifdef LIBMESH_ENABLE_INFINITE_ELEMENTS
       // 1D infinite elements
     case INFEDGE2:
       return std::make_unique<InfEdge2>(p);
 
       // 2D infinite elements
     case INFQUAD4:
       return std::make_unique<InfQuad4>(p);
     case INFQUAD6:
       return std::make_unique<InfQuad6>(p);
 
       // 3D infinite elements
     case INFHEX8:
       return std::make_unique<InfHex8>(p);
     case INFHEX16:
       return std::make_unique<InfHex16>(p);
     case INFHEX18:
       return std::make_unique<InfHex18>(p);
     case INFPRISM6:
       return std::make_unique<InfPrism6>(p);
     case INFPRISM12:
       return std::make_unique<InfPrism12>(p);
 #endif
 
     default:
       libmesh_error_msg("ERROR: Undefined element type == " << Utility::enum_to_string(type));
     }
 }

◆ build_edge_ptr() [1/4]

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

overridevirtual

Builds a EDGE2 built coincident with edge i.

The std::unique_ptr<Elem> handles the memory aspect.

Implements libMesh::Elem.

Definition at line 178 of file cell_pyramid5.C.

 {
   return this->simple_build_edge_ptr<Edge2,Pyramid5>(i);
 }

◆ build_edge_ptr() [2/4]

void libMesh::Pyramid5::build_edge_ptr	(	std::unique_ptr< Elem > &	edge,
		const unsigned int	i
	)

overridevirtual

Rebuilds a EDGE2 coincident with edge i.

Implements libMesh::Elem.

Definition at line 185 of file cell_pyramid5.C.

References libMesh::EDGE2.

 {
   this->simple_build_edge_ptr<Pyramid5>(edge, i, EDGE2);
 }

◆ build_edge_ptr() [3/4]

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

inlineinherited

Definition at line 2840 of file elem.h.

References libMesh::Elem::build_edge_ptr().

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

◆ build_edge_ptr() [4/4]

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

inlineinherited

Definition at line 2852 of file elem.h.

References libMesh::Elem::build_edge_ptr().

 {
   // 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_edge_ptr(e, i);
   elem = std::move(e);
 }

◆ build_side_ptr() [1/12]

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

overridevirtual

Builds a QUAD4 or TRI3 built coincident with face i.

The std::unique_ptr<Elem> handles the memory aspect.

Implements libMesh::Elem.

Definition at line 131 of file cell_pyramid5.C.

References libMesh::Pyramid::n_sides(), and side_nodes_map.

 {
   libmesh_assert_less (i, this->n_sides());
 
   std::unique_ptr<Elem> face;
 
   switch (i)
     {
     case 0: // triangular face 1
     case 1: // triangular face 2
     case 2: // triangular face 3
     case 3: // triangular face 4
       {
         face = std::make_unique<Tri3>();
         break;
       }
     case 4: // the quad face at z=0
       {
         face = std::make_unique<Quad4>();
         break;
       }
     default:
       libmesh_error_msg("Invalid side i = " << i);
     }
 
   // Set the nodes
   for (auto n : face->node_index_range())
     face->set_node(n, this->node_ptr(Pyramid5::side_nodes_map[i][n]));
 
   face->set_interior_parent(this);
   face->inherit_data_from(*this);
 
   return face;
 }

◆ build_side_ptr() [2/12]

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

overridevirtual

Rebuilds a QUAD4 or TRI3 built coincident with face i.

Implements libMesh::Elem.

Definition at line 168 of file cell_pyramid5.C.

References libMesh::Pyramid::side_ptr().

 {
   this->side_ptr(side, i);
   side->set_interior_parent(this);
   side->inherit_data_from(*this);
 }

◆ build_side_ptr() [3/12]

virtual std::unique_ptr<Elem> libMesh::Elem::build_side_ptr

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

The element returned is full-ordered and full-featured, in contrast to the side method. For example, calling build_side_ptr(0) on a 20-noded hex in subdomain 5 will build a 8-noded quadrilateral coincident with face 0, assign it subdomain id 5, and pass back the pointer.

The side element's id() is undefined; it is a temporary element not added to any mesh.

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.

◆ build_side_ptr() [4/12]

std::unique_ptr< const Elem > libMesh::Elem::build_side_ptr

inline

Definition at line 2745 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);
   return me->build_side_ptr(i);
 }

◆ build_side_ptr() [5/12]

virtual std::unique_ptr<Elem> libMesh::Elem::build_side_ptr

inline

Definition at line 927 of file elem.h.

928 { if (proxy) libmesh_error(); libmesh_deprecated(); return this->build_side_ptr(i); }

libMesh::Pyramid5::build_side_ptr

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

Builds a QUAD4 or TRI3 built coincident with face i.

Definition: cell_pyramid5.C:131

◆ build_side_ptr() [6/12]

std::unique_ptr<const Elem> libMesh::Elem::build_side_ptr

inline

Definition at line 930 of file elem.h.

931 { if (proxy) libmesh_error(); libmesh_deprecated(); return this->build_side_ptr(i); }

libMesh::Pyramid5::build_side_ptr

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

Builds a QUAD4 or TRI3 built coincident with face i.

Definition: cell_pyramid5.C:131

◆ build_side_ptr() [7/12]

virtual void libMesh::Elem::build_side_ptr

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

◆ build_side_ptr() [8/12]

void libMesh::Elem::build_side_ptr

inline

Definition at line 2757 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 = std::move(e);
 }

◆ build_side_ptr() [9/12]

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

inlineinherited

Definition at line 2745 of file elem.h.

References libMesh::Elem::build_side_ptr().

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

◆ build_side_ptr() [10/12]

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

inlinevirtualinherited

Definition at line 927 of file elem.h.

References libMesh::Elem::build_side_ptr().

928 { if (proxy) libmesh_error(); libmesh_deprecated(); return this->build_side_ptr(i); }

libMesh::Elem::build_side_ptr

virtual std::unique_ptr< Elem > build_side_ptr(const unsigned int i)=0

◆ build_side_ptr() [11/12]

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

inlineinherited

Definition at line 930 of file elem.h.

References libMesh::Elem::build_side_ptr().

931 { if (proxy) libmesh_error(); libmesh_deprecated(); return this->build_side_ptr(i); }

libMesh::Elem::build_side_ptr

virtual std::unique_ptr< Elem > build_side_ptr(const unsigned int i)=0

◆ build_side_ptr() [12/12]

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

inlineinherited

Definition at line 2757 of file elem.h.

References libMesh::Elem::build_side_ptr().

 {
   // 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 = std::move(e);
 }

◆ build_with_id()

std::unique_ptr< Elem > libMesh::Elem::build_with_id	(	const ElemType	type,
		dof_id_type	id
	)

staticinherited

Calls the build() method above with a nullptr parent, and additionally sets the newly-created Elem's id.

This can be useful when adding pre-numbered Elems to a Mesh via add_elem() calls.

Definition at line 558 of file elem.C.

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

Referenced by libMesh::MeshTools::Subdivision::all_subdivision(), libMesh::MeshTools::Generation::build_cube(), GetBoundaryPointsTest::build_mesh(), SlitMeshTest::build_mesh(), OverlappingTestBase::build_quad_mesh(), libMesh::TetGenIO::element_in(), libMesh::Poly2TriTriangulator::insert_refinement_points(), libMesh::GmshIO::read_mesh(), libMesh::MatlabIO::read_stream(), NodalNeighborsTest::testOrientation(), EquationSystemsTest::testPostInitAddElem(), SystemsTest::testProjectMatrix3D(), InfFERadialTest::testRefinement(), libMesh::NetGenMeshInterface::triangulate(), and libMesh::Poly2TriTriangulator::triangulate_current_points().

 {
   // Call the other build() method with nullptr parent, then set the
   // required id.
   auto temp = Elem::build(type, nullptr);
   temp->set_id(id);
   return temp;
 }

◆ center_node_on_side()

unsigned int libMesh::Elem::center_node_on_side ( const unsigned short side ) const

virtualinherited

Returns: The local index of the center node on the side side.

A center node is a node that is located at the centroid of the given side. If the given side does not have a center node, this will return invalid_uint.

Reimplemented in libMesh::Prism20, libMesh::Prism21, libMesh::Prism18, libMesh::RemoteElem, libMesh::Hex27, libMesh::Pyramid18, libMesh::Pyramid14, libMesh::Edge, libMesh::Tri7, libMesh::Tri6, libMesh::Quad9, and libMesh::Quad8.

Definition at line 3533 of file elem.C.

References libMesh::invalid_uint, and libMesh::Elem::n_sides().

 {
   libmesh_assert_less (side, this->n_sides());
   return invalid_uint;
 }

◆ centroid()

Point libMesh::Elem::centroid ( ) const

virtualinherited

Calls Elem::vertex_average() for backwards compatibility.

Deprecated:: This method has now been deprecated, so it will be removed at some point in the future. Calls to Elem::centroid() in user code should be updated to either call Elem::vertex_average() or Elem::true_centroid() on a case by case basis.

Definition at line 578 of file elem.C.

References libMesh::err, and libMesh::Elem::vertex_average().

 {
   libmesh_do_once(libMesh::err
                   << "Elem::centroid() has been deprecated. Replace with either "
                   << "Elem::vertex_average() to maintain existing behavior, or "
                   << "the more expensive Elem::true_centroid() "
                   << "in cases where the true 'geometric' centroid is required."
                   << std::endl);
   libmesh_deprecated();
 
   return Elem::vertex_average();
 }

◆ child_neighbor() [1/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 2640 of file elem.h.

References libMesh::Elem::neighbor_ptr_range().

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

◆ child_neighbor() [2/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 2652 of file elem.h.

References libMesh::Elem::neighbor_ptr_range().

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

◆ child_ptr() [1/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 3163 of file elem.h.

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

Referenced by libMesh::Elem::add_child(), libMesh::BoundaryInfo::add_elements(), 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_child_on_edge(), 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(), InfFERadialTest::testRefinement(), EquationSystemsTest::testRefineThenReinitPreserveFlags(), libMesh::BoundaryInfo::transfer_boundary_ids_from_children(), libMesh::Elem::which_child_am_i(), and libMesh::CheckpointIO::write_remote_elem().

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

◆ child_ptr() [2/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 3172 of file elem.h.

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

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

◆ 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 2346 of file elem.h.

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 >(), main(), 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().

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

◆ child_ref_range() [2/2]

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

inlineinherited

Definition at line 2354 of file elem.h.

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

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

◆ 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 798 of file dof_object.h.

References libMesh::DofObject::set_n_systems().

 {
   this->set_n_systems(0);
 }

◆ clear_old_dof_object()

void libMesh::DofObject::clear_old_dof_object ( )

inherited

Sets the old_dof_object to nullptr.

Definition at line 128 of file dof_object.C.

References libMesh::DofObject::old_dof_object.

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

 {
   this->old_dof_object.reset(nullptr);
 }

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

Reimplemented in libMesh::NodeElem.

Definition at line 2782 of file elem.C.

References libMesh::Elem::point_test().

Referenced by assemble_SchroedingerEquation(), libMesh::PointLocatorNanoflann::operator()(), and libMesh::PointLocatorTree::operator()().

 {
   // 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);
 }

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

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::Real, libMesh::Elem::refinement_flag(), libMesh::remote_elem, libMesh::Elem::set_p_level(), and libMesh::Elem::set_refinement_flag().

 {
   libmesh_assert_equal_to (this->refinement_flag(), Elem::COARSEN_INACTIVE);
   libmesh_assert (!this->active());
 
   // We no longer delete children until MeshRefinement::contract()
 
   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 Real 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());
 }

◆ complete_order_equivalent_type()

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

staticinherited

Returns: The ElemType of the associated "complete" order element (which will be the same as the input if the input is already a complete-order ElemType), or INVALID_ELEM for elements that cannot be converted into complete-order equivalents.

The "complete" version of an element is an element which can represent the same geometry but which has nodes available to restore degrees of freedom on any vertex, edge, or face.

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

Definition at line 3325 of file elem.C.

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::PRISM20, libMesh::PRISM21, libMesh::PRISM6, libMesh::PYRAMID13, libMesh::PYRAMID14, libMesh::PYRAMID18, libMesh::PYRAMID5, libMesh::QUAD4, libMesh::QUAD8, libMesh::QUAD9, libMesh::QUADSHELL4, libMesh::QUADSHELL8, libMesh::QUADSHELL9, libMesh::TET10, libMesh::TET14, libMesh::TET4, libMesh::TRI3, libMesh::TRI6, libMesh::TRI7, and libMesh::TRISHELL3.

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

 {
   switch (et)
     {
     case NODEELEM:
       return NODEELEM;
     case EDGE2:
     case EDGE3:
       return EDGE3;
 
     case EDGE4:
       return EDGE4;
 
     case TRI3:
     case TRI6:
     case TRI7:
       return TRI7;
 
       // 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:
     case QUAD9:
       return QUAD9;
 
     case QUADSHELL4:
     case QUADSHELL8:
     case QUADSHELL9:
       return QUADSHELL9;
 
     case TET4:
     case TET10:
     case TET14:
       return TET14;
 
     case HEX8:
     case HEX20:
     case HEX27:
       return HEX27;
 
     // We don't strictly need the 21st node for DoFs, but some code
     // depends on it for e.g. refinement patterns
     case PRISM6:
     case PRISM15:
     case PRISM18:
     case PRISM20:
     case PRISM21:
       return PRISM21;
 
     case PYRAMID5:
     case PYRAMID13:
     case PYRAMID14:
     case PYRAMID18:
       return PYRAMID18;
 
 
 
 #ifdef LIBMESH_ENABLE_INFINITE_ELEMENTS
     case INFEDGE2:
       return INFEDGE2;
 
     case INFQUAD4:
     case INFQUAD6:
       return INFQUAD6;
 
     case INFHEX8:
     case INFHEX16:
     case INFHEX18:
       return INFHEX18;
 
     // Probably ought to implement INFPRISM13 and/or 14; until then
     // we'll just return the not-complete-order ElemType, in
     // accordance which what seems like bad precedent...
     case INFPRISM6:
     case INFPRISM12:
       return INFPRISM12;
 #endif // LIBMESH_ENABLE_INFINITE_ELEMENTS
 
     default:
       {
         // what did we miss?
         libmesh_error_msg("No complete order equivalent element type for et =  "
                           << Utility::enum_to_string(et));
       }
     }
 }

◆ 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 3294 of file elem.h.

 {
   return n0;
 }

◆ 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 3302 of file elem.h.

References libMesh::Utility::hashword2().

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

◆ 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 3314 of file elem.h.

References libMesh::Utility::hashword().

 {
   std::array<dof_id_type, 3> array = {{n0, n1, n2}};
   std::sort(array.begin(), array.end());
   return Utility::hashword(array);
 }

◆ 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 3326 of file elem.h.

References libMesh::Utility::hashword().

 {
   std::array<dof_id_type, 4> array = {{n0, n1, n2, n3}};
   std::sort(array.begin(), array.end());
   return Utility::hashword(array);
 }

◆ connectivity()

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

overridevirtual

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

Implements libMesh::Elem.

Definition at line 192 of file cell_pyramid5.C.

References libMesh::Elem::_nodes, libMesh::INVALID_IO_PACKAGE, libMesh::libmesh_assert(), n_sub_elem(), libMesh::Elem::node_id(), libMesh::TECPLOT, and libMesh::VTK.

 {
   libmesh_assert(_nodes);
   libmesh_assert_less (sc, this->n_sub_elem());
   libmesh_assert_not_equal_to (iop, INVALID_IO_PACKAGE);
 
   switch (iop)
     {
     case TECPLOT:
       {
         conn.resize(8);
         conn[0] = this->node_id(0)+1;
         conn[1] = this->node_id(1)+1;
         conn[2] = this->node_id(2)+1;
         conn[3] = this->node_id(3)+1;
         conn[4] = this->node_id(4)+1;
         conn[5] = this->node_id(4)+1;
         conn[6] = this->node_id(4)+1;
         conn[7] = this->node_id(4)+1;
         return;
       }
 
     case VTK:
       {
         conn.resize(5);
         conn[0] = this->node_id(3);
         conn[1] = this->node_id(2);
         conn[2] = this->node_id(1);
         conn[3] = this->node_id(0);
         conn[4] = this->node_id(4);
         return;
       }
 
     default:
       libmesh_error_msg("Unsupported IO package " << iop);
     }
 }

◆ 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 972 of file elem.C.

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

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

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

◆ contains_point()

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

virtualinherited

Returns: true if the physical 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::NodeElem, libMesh::Tet4, libMesh::InfHex, libMesh::InfPrism, libMesh::Tri3, and libMesh::InfQuad4.

Definition at line 2757 of file elem.C.

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::InfFE< Dim, T_radial, T_map >::inf_compute_constraints(), libMesh::PointLocatorNanoflann::operator()(), libMesh::PointLocatorTree::operator()(), libMesh::System::point_gradient(), libMesh::System::point_hessian(), libMesh::System::point_value(), NavierSystem::side_constraint(), RationalMapTest< elem_type >::testContainsPoint(), PointLocatorTest::testLocator(), and PointLocatorTest::testPlanar().

 {
   // 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);
 }

◆ contains_vertex_of()

bool libMesh::Elem::contains_vertex_of	(	const Elem *	e,
		bool	mesh_connection = `false`
	)		const

inherited

Returns: true if a vertex of e is contained in this element. If mesh_connection is true, looks specifically for containment possibilities of an element e that is connected to this via membership in the same manifold of the same mesh.

Definition at line 934 of file elem.C.

References libMesh::Elem::contains_point(), libMesh::Elem::level(), libMesh::make_range(), libMesh::Elem::n_vertices(), libMesh::Elem::node_ptr(), libMesh::Elem::node_ref(), and libMesh::Elem::point().

 {
   // Our vertices are the first numbered nodes
   const unsigned int nv = e->n_vertices();
   const unsigned int my_nv = this->n_vertices();
 
   // Check for vertex-to-vertex containment first; contains_point() is
   // expensive
   for (auto n : make_range(nv))
     {
       const Node * vertex = e->node_ptr(n);
       for (auto my_n : make_range(my_nv))
         if (&this->node_ref(my_n) == vertex)
           return true;
     }
 
   // If e is in our mesh, then we might be done testing
   if (mesh_connection)
     {
       const unsigned int l = this->level();
       const unsigned int el = e->level();
 
       if (l >= el)
         return false;
 
       // We could also return false for l==el-1 iff we knew we had no
       // triangular faces, but we don't have an API to check that.
     }
 
   // Our vertices are the first numbered nodes
   for (auto n : make_range(nv))
     if (this->contains_point(e->point(n)))
       return true;
   return false;
 }

◆ 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 228 of file elem_refinement.C.

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

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

◆ debug_buffer()

void libMesh::DofObject::debug_buffer ( ) const

inherited

Print our buffer for debugging.

Definition at line 660 of file dof_object.C.

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

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

◆ default_order()

Order libMesh::Pyramid5::default_order ( ) const

overridevirtual

Returns: FIRST.

Implements libMesh::Elem.

Definition at line 124 of file cell_pyramid5.C.

References libMesh::FIRST.

 {
   return FIRST;
 }

◆ default_side_order()

virtual Order libMesh::Elem::default_side_order ( ) const

inlinevirtualinherited

Returns: The default approximation order for side elements of this element type. This may be lower for elements with 'bubble functions' in the Lagrange basis.

Reimplemented in libMesh::Tri7.

Definition at line 1012 of file elem.h.

References libMesh::Elem::default_order().

Referenced by libMesh::FEAbstract::compute_node_constraints(), and libMesh::FEAbstract::compute_periodic_node_constraints().

1012 { return default_order(); }

libMesh::Elem::default_order

virtual Order default_order() const =0

◆ dim()

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

inlineoverridevirtualinherited

Returns: 3, the dimensionality of the object.

Implements libMesh::Elem.

Definition at line 61 of file cell.h.

61 { return 3; }

◆ disable_print_counter_info() [1/2]

void libMesh::ReferenceCounter::disable_print_counter_info ( )

staticinherited

Definition at line 100 of file reference_counter.C.

References libMesh::ReferenceCounter::_enable_print_counter.

 {
   _enable_print_counter = false;
   return;
 }

◆ disable_print_counter_info() [2/2]

void libMesh::ReferenceCounter::disable_print_counter_info ( )

staticinherited

Definition at line 100 of file reference_counter.C.

References libMesh::ReferenceCounter::_enable_print_counter.

 {
   _enable_print_counter = false;
   return;
 }

◆ disconnected_clone()

std::unique_ptr< Elem > libMesh::Elem::disconnected_clone ( ) const

virtualinherited

Returns: An Elem of the same type as this, wrapped in a smart pointer.

This is not a complete clone() method (since e.g. it does not set node pointers; the standard use case reassigns node pointers from a different mesh), but it is necessary to use this instead of build() for runtime-polymorphic elements like Polygon subtypes whose "type" depends on more than their type(), and it is useful to use this for elements whose id, unique_id, extra integers, etc. should be preserved in the near-clone.

Reimplemented in libMesh::C0Polyhedron.

Definition at line 412 of file elem.C.

References libMesh::Elem::build(), libMesh::C0POLYGON, libMesh::DofObject::id(), libMesh::DofObject::n_extra_integers(), libMesh::Elem::n_sides(), libMesh::Elem::type(), libMesh::DofObject::unique_id(), and libMesh::DofObject::valid_unique_id().

Referenced by libMesh::UnstructuredMesh::copy_nodes_and_elements(), libMesh::Polyhedron::side_clones(), libMesh::Polyhedron::side_ptr(), and libMesh::Elem::true_centroid().

 {
   std::unique_ptr<Elem> returnval;
 
   switch (this->type())
     {
     case C0POLYGON:
       returnval = std::make_unique<C0Polygon>(this->n_sides());
       break;
 
     default:
       returnval = Elem::build(this->type());
     }
 
   returnval->set_id() = this->id();
 #ifdef LIBMESH_ENABLE_UNIQUE_ID
   if (this->valid_unique_id())
     returnval->set_unique_id(this->unique_id());
 #endif
 
   const auto n_elem_ints = this->n_extra_integers();
   returnval->add_extra_integers(n_elem_ints);
   for (unsigned int i = 0; i != n_elem_ints; ++i)
     returnval->set_extra_integer(i, this->get_extra_integer(i));
 
   returnval->inherit_data_from(*this);
 
   return returnval;
 }

◆ 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 1032 of file dof_object.h.

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

 {
   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);
 }

◆ 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 1053 of file dof_object.h.

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

 {
   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);
 }

◆ 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 2692 of file elem.h.

References libMesh::Elem::n_edges().

Referenced by libMesh::FE< Dim, LAGRANGE_VEC >::cache(), libMesh::FEGenericBase< FEOutputType< T >::type >::coarsened_dof_values(), libMesh::BoundaryInfo::copy_boundary_ids(), libMesh::ElemCutter::find_intersection_points(), and libMesh::Elem::quality().

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

◆ edges_adjacent_to_node()

std::vector< unsigned int > libMesh::Pyramid::edges_adjacent_to_node ( const unsigned int int ) const

overridevirtualinherited

Returns: the (local) edge numbers that touch the specified node

Implements libMesh::Elem.

Definition at line 278 of file cell_pyramid.C.

References libMesh::Pyramid::adjacent_edges_map, libMesh::Elem::is_edge(), libMesh::Elem::is_face(), libMesh::Elem::is_vertex(), libMesh::libmesh_assert(), libMesh::Pyramid::n_nodes(), and libMesh::Pyramid::n_vertices().

 {
   libmesh_assert_less(n, this->n_nodes());
   if (this->is_vertex(n))
     {
       auto trim = (n < 4) ? 1 : 0;
       return {std::begin(adjacent_edges_map[n]), std::end(adjacent_edges_map[n]) - trim};
     }
   else if (this->is_edge(n))
     return {n - this->n_vertices()};
 
   // Not a vertex or edge node, so must be one of the face nodes.
   libmesh_assert(this->is_face(n));
   return {};
 }

◆ embedding_matrix()

virtual Real libMesh::Pyramid5::embedding_matrix	(	const unsigned int	,
		const unsigned int	,
		const unsigned int
	)		const

inlineoverrideprotectedvirtual

Matrix used to create the elements children.

Implements libMesh::Elem.

Definition at line 214 of file cell_pyramid5.h.

217 { 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 2051 of file elem.h.

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

2051 { return 0; }

◆ 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 94 of file reference_counter.C.

References libMesh::ReferenceCounter::_enable_print_counter.

 {
   _enable_print_counter = true;
   return;
 }

◆ 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 94 of file reference_counter.C.

References libMesh::ReferenceCounter::_enable_print_counter.

 {
   _enable_print_counter = true;
   return;
 }

◆ face_index_range()

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

inlineinherited

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

Definition at line 2701 of file elem.h.

References libMesh::Elem::n_faces().

Referenced by libMesh::FE< Dim, LAGRANGE_VEC >::cache().

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

◆ 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 2101 of file elem.C.

References libMesh::ElemInternal::family_tree().

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

◆ 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 2109 of file elem.C.

References libMesh::ElemInternal::family_tree().

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

◆ 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 2185 of file elem.C.

References libMesh::ElemInternal::family_tree_by_neighbor().

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

◆ 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 2194 of file elem.C.

References libMesh::ElemInternal::family_tree_by_neighbor().

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

◆ 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 2149 of file elem.C.

References libMesh::ElemInternal::family_tree_by_side().

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

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

◆ 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 2158 of file elem.C.

References libMesh::ElemInternal::family_tree_by_side().

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

◆ 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 2221 of file elem.C.

References libMesh::ElemInternal::family_tree_by_subneighbor().

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

◆ 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 2231 of file elem.C.

References libMesh::ElemInternal::family_tree_by_subneighbor().

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

◆ 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 1083 of file elem.C.

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

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

 {
   // 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;
     }
 }

◆ 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 1110 of file elem.C.

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

 {
   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();
     }
 }

◆ 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 1172 of file elem.C.

References libMesh::ElemInternal::find_interior_neighbors().

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

◆ 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 1179 of file elem.C.

References libMesh::ElemInternal::find_interior_neighbors().

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

◆ 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 993 of file elem.C.

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

Referenced by libMesh::MeshFunction::check_found_elem(), libMesh::MeshRefinement::enforce_mismatch_limit_prior_to_refinement(), libMesh::Elem::find_edge_neighbors(), libMesh::Elem::find_point_neighbors(), libMesh::ReplicatedMesh::get_boundary_points(), libMesh::Elem::is_semilocal(), libMesh::GhostPointNeighbors::operator()(), and InfFERadialTest::testRefinement().

 {
   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);
 
 #ifdef LIBMESH_ENABLE_AMR
   std::vector<const Elem *> active_neighbor_children;
 #endif // #ifdef LIBMESH_ENABLE_AMR
 
   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
                     {
                       auto it = neighbor_set.lower_bound(current_neighbor);
                       if ((it == neighbor_set.end() || *it != current_neighbor) &&
                           current_neighbor->contains_point(p))   // ... don't have and touches p
                         {
                           // Add it and test it
                           next_untested_set.insert(current_neighbor);
                           neighbor_set.emplace_hint(it, current_neighbor);
                         }
                     }
 #ifdef LIBMESH_ENABLE_AMR
                   else                                 // ... the neighbor is *not* active,
                     {                                  // ... so add *all* neighboring
                                                        // active children that touch p
                       active_neighbor_children.clear();
                       current_neighbor->active_family_tree_by_neighbor
                         (active_neighbor_children, elem);
 
                       for (const auto & current_child : active_neighbor_children)
                         {
                           auto it = neighbor_set.lower_bound(current_child);
                           if ((it == neighbor_set.end() || *it != current_child) &&
                               current_child->contains_point(p))
                             {
                               // Add it and test it
                               next_untested_set.insert(current_child);
                               neighbor_set.emplace_hint(it, current_child);
                             }
                         }
                     }
 #endif // #ifdef LIBMESH_ENABLE_AMR
                 }
             }
       untested_set.swap(next_untested_set);
       next_untested_set.clear();
     }
 }

◆ 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 1060 of file elem.C.

References libMesh::Elem::find_point_neighbors().

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

◆ 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 1067 of file elem.C.

References libMesh::ElemInternal::find_point_neighbors().

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

◆ 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 1075 of file elem.C.

References libMesh::ElemInternal::find_point_neighbors().

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

◆ 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 3072 of file elem.C.

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::PRISM20, libMesh::PRISM21, libMesh::PRISM6, libMesh::PYRAMID13, libMesh::PYRAMID14, libMesh::PYRAMID18, libMesh::PYRAMID5, libMesh::QUAD4, libMesh::QUAD8, libMesh::QUAD9, libMesh::QUADSHELL4, libMesh::QUADSHELL8, libMesh::QUADSHELL9, libMesh::TET10, libMesh::TET14, libMesh::TET4, libMesh::TRI3, libMesh::TRI6, libMesh::TRI7, and libMesh::TRISHELL3.

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

 {
   switch (et)
     {
     case NODEELEM:
       return NODEELEM;
     case EDGE2:
     case EDGE3:
     case EDGE4:
       return EDGE2;
     case TRI3:
     case TRI6:
     case TRI7:
       return TRI3;
     case TRISHELL3:
       return TRISHELL3;
     case QUAD4:
     case QUAD8:
     case QUAD9:
       return QUAD4;
     case QUADSHELL4:
     case QUADSHELL8:
     case QUADSHELL9:
       return QUADSHELL4;
     case TET4:
     case TET10:
     case TET14:
       return TET4;
     case HEX8:
     case HEX27:
     case HEX20:
       return HEX8;
     case PRISM6:
     case PRISM15:
     case PRISM18:
     case PRISM20:
     case PRISM21:
       return PRISM6;
     case PYRAMID5:
     case PYRAMID13:
     case PYRAMID14:
     case PYRAMID18:
       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;
     }
 }

◆ flip()

void libMesh::Pyramid5::flip ( BoundaryInfo * boundary_info )

finaloverridevirtual

Flips the element (by swapping node and neighbor pointers) to have a mapping Jacobian of opposite sign.

This is useful for automatically fixing up elements that have been newly created (e.g. from extrusions) with a negative Jacobian.

If boundary_info is not null, swap boundary side/edge ids consistently.

Implements libMesh::Elem.

Definition at line 286 of file cell_pyramid5.C.

References libMesh::libmesh_assert(), libMesh::Elem::swap2boundaryedges(), libMesh::Elem::swap2boundarysides(), libMesh::Elem::swap2neighbors(), and libMesh::Elem::swap2nodes().

 {
   libmesh_assert(boundary_info);
 
   swap2nodes(0,1);
   swap2nodes(2,3);
   swap2neighbors(1,3);
   swap2boundarysides(1,3,boundary_info);
   swap2boundaryedges(1,3,boundary_info);
   swap2boundaryedges(4,5,boundary_info);
   swap2boundaryedges(6,7,boundary_info);
 }

◆ 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 1146 of file dof_object.h.

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

Referenced by libMesh::Elem::get_info(), libMesh::VTKIO::nodes_to_vtk(), libMesh::rational_fe_shape(), libMesh::rational_fe_shape_deriv(), libMesh::rational_fe_shape_second_deriv(), libMesh::rational_fe_weighted_shapes(), libMesh::rational_fe_weighted_shapes_derivs(), libMesh::ExodusII_IO::read(), and DofObjectTest< Node >::testAddExtraData().

 {
 #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;
 }

◆ 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 1102 of file dof_object.h.

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

Referenced by libMesh::MeshTools::Modification::all_tri(), WriteElemsetData::checkByCentroid(), libMesh::MeshTools::Modification::flatten(), libMesh::SyncElementIntegers::gather_data(), libMesh::XdrIO::pack_element(), libMesh::CheckpointIO::read_connectivity(), libMesh::SimplexRefiner::refine_via_edges(), libMesh::DofObject::set_n_vars_per_group(), DofObjectTest< Node >::testAddExtraData(), DofObjectTest< Node >::testAddSystemExtraInts(), ExtraIntegersTest::testExtraIntegersExodusReading(), DofObjectTest< Node >::testSetNSystemsExtraInts(), DofObjectTest< Node >::testSetNVariableGroupsExtraInts(), and libMesh::XdrIO::write_serialized_nodes().

 {
   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];
 }

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

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

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

 {
 #if defined(LIBMESH_ENABLE_REFERENCE_COUNTING) && defined(DEBUG)
 
   std::ostringstream oss;
 
   oss << '\n'
       << " ---------------------------------------------------------------------------- \n"
       << "| Reference count information                                                |\n"
       << " ---------------------------------------------------------------------------- \n";
 
   for (const auto & [name, cd] : _counts)
     oss << "| " << name << " reference count information:\n"
         << "|  Creations:    " << cd.first    << '\n'
         << "|  Destructions: " << cd.second << '\n';
 
   oss << " ---------------------------------------------------------------------------- \n";
 
   return oss.str();
 
 #else
 
   return "";
 
 #endif
 }

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

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

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

 {
 #if defined(LIBMESH_ENABLE_REFERENCE_COUNTING) && defined(DEBUG)
 
   std::ostringstream oss;
 
   oss << '\n'
       << " ---------------------------------------------------------------------------- \n"
       << "| Reference count information                                                |\n"
       << " ---------------------------------------------------------------------------- \n";
 
   for (const auto & [name, cd] : _counts)
     oss << "| " << name << " reference count information:\n"
         << "|  Creations:    " << cd.first    << '\n'
         << "|  Destructions: " << cd.second << '\n';
 
   oss << " ---------------------------------------------------------------------------- \n";
 
   return oss.str();
 
 #else
 
   return "";
 
 #endif
 }

◆ get_info() [3/3]

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

inherited

Prints relevant information about the element to a string.

Definition at line 2929 of file elem.C.

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

 {
   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 << ", subdomain_id()=" << this->subdomain_id();
   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';
 
   oss << "   mapping=" << Utility::enum_to_string(this->mapping_type()) << '\n';
 
   for (auto n : this->node_index_range())
     {
       oss << "    " << n << this->node_ref(n);
       if (this->mapping_type() == RATIONAL_BERNSTEIN_MAP)
         {
           const unsigned char datum_index = this->mapping_data();
           oss << "    weight=" <<
             this->node_ref(n).get_extra_datum<Real>(datum_index) << '\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";
     }
 
   if (!this->infinite())
     {
     oss << "   hmin()=" << this->hmin()
         << ", hmax()=" << this->hmax()                             << '\n'
         << "   volume()=" << this->volume()                        << '\n';
     }
   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 : make_range(this->n_systems()))
     for (auto v : make_range(this->n_vars(s)))
       for (auto c : make_range(this->n_comp(s,v)))
         oss << '(' << s << '/' << v << '/' << this->dof_number(s,v,c) << ") ";
 
 
   return oss.str();
 }

◆ 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_uint if node_ptr is not a local node.

Definition at line 2545 of file elem.h.

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

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

 {
   for (auto n : make_range(this->n_nodes()))
     if (this->_nodes[n] == node_ptr)
       return n;
 
   return libMesh::invalid_uint;
 }

◆ get_nodes()

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

inlineinherited

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

Definition at line 2499 of file elem.h.

References libMesh::Elem::_nodes.

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

 {
   return _nodes;
 }

◆ get_old_dof_object() [1/2]

DofObject* libMesh::DofObject::get_old_dof_object ( )

inlineinherited

Pointer accessor for previously public old_dof_object.

If you want to assert that the old_dof_object pointer is valid as well, consider using the get_old_dof_object_ref() accessor instead.

Definition at line 96 of file dof_object.h.

References libMesh::DofObject::old_dof_object.

Referenced by libMesh::OldSolutionBase< Output, point_output >::check_old_context(), libMesh::OldSolutionCoefs< Output, point_output >::eval_at_node(), libMesh::OldSolutionValue< Output, point_output >::eval_at_node(), libMesh::OldSolutionCoefs< Output, point_output >::eval_mixed_derivatives(), libMesh::OldSolutionValue< Output, point_output >::eval_mixed_derivatives(), libMesh::DofMap::old_dof_indices(), libMesh::BuildProjectionList::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::SortAndCopy::operator()(), and libMesh::DofObject::operator=().

96 { return old_dof_object.get(); }

libMesh::DofObject::old_dof_object

std::unique_ptr< DofObject > old_dof_object

This object on the last mesh.

Definition: dof_object.h:88

◆ get_old_dof_object() [2/2]

const DofObject* libMesh::DofObject::get_old_dof_object ( ) const

inlineinherited

Definition at line 97 of file dof_object.h.

References libMesh::DofObject::old_dof_object.

97 { return old_dof_object.get(); }

libMesh::DofObject::old_dof_object

std::unique_ptr< DofObject > old_dof_object

This object on the last mesh.

Definition: dof_object.h:88

◆ get_old_dof_object_ref() [1/2]

DofObject& libMesh::DofObject::get_old_dof_object_ref ( )

inlineinherited

As above, but do not use in situations where the old_dof_object may be nullptr, since this function asserts that the old_dof_object is valid before returning a reference to it.

Definition at line 104 of file dof_object.h.

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

Referenced by libMesh::OldSolutionCoefs< Output, point_output >::eval_old_dofs(), libMesh::OldSolutionValue< Output, point_output >::eval_old_dofs(), and libMesh::DofMap::old_dof_indices().

   {
     libmesh_assert(old_dof_object);
     return *old_dof_object;
   }

◆ get_old_dof_object_ref() [2/2]

const DofObject& libMesh::DofObject::get_old_dof_object_ref ( ) const

inlineinherited

Definition at line 110 of file dof_object.h.

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

   {
     libmesh_assert(old_dof_object);
     return *old_dof_object;
   }

◆ 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 3264 of file elem.h.

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

Referenced by libMesh::Elem::hack_p_level_and_refinement_flag(), libMesh::HPCoarsenTest::select_refinement(), and libMesh::Elem::set_p_level().

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

◆ hack_p_level_and_refinement_flag()

void libMesh::Elem::hack_p_level_and_refinement_flag	(	const unsigned int	p,
		RefinementState	pflag
	)

inlineinherited

Sets the value of the p-refinement level for the element without altering the p-level of its ancestors; also sets the p_refinement_flag, simultaneously so that they can be safely checked for mutual consistency.

Definition at line 3275 of file elem.h.

References libMesh::Elem::_pflag, and libMesh::Elem::hack_p_level().

 {
   _pflag = cast_int<unsigned char>(pflag);
   this->hack_p_level(p);
 }

◆ has_affine_map()

bool libMesh::Pyramid5::has_affine_map ( ) const

overridevirtual

Returns: true if the element map is definitely affine within numerical tolerances.

Reimplemented from libMesh::Elem.

Definition at line 115 of file cell_pyramid5.C.

 {
   //  Point v = this->point(3) - this->point(0);
   //  return (v.relative_fuzzy_equals(this->point(2) - this->point(1)));
   return false;
 }

◆ 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 2993 of file elem.h.

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

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

◆ 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 2979 of file elem.h.

References libMesh::Elem::_children.

Referenced by libMesh::Elem::add_child(), libMesh::BoundaryInfo::add_elements(), libMesh::Elem::ancestor(), libMesh::connect_children(), libMesh::UnstructuredMesh::find_neighbors(), libMesh::MeshRefinement::flag_elements_by_nelem_target(), libMesh::Elem::get_info(), libMesh::MeshTools::libmesh_assert_topology_consistent_procids< Elem >(), main(), 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::Elem::remove_links_to_me(), libMesh::Elem::replace_child(), libMesh::Elem::set_child(), libMesh::Elem::subactive(), libMesh::Parallel::sync_element_data_by_parent_id(), and libMesh::Elem::which_child_am_i().

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

◆ 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 1226 of file dof_object.h.

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

Referenced by libMesh::DofMap::old_dof_indices().

 {
   if (sys == libMesh::invalid_uint)
     {
       for (auto s : make_range(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;
 }

◆ has_extra_integers()

bool libMesh::DofObject::has_extra_integers ( ) const

inlineinherited

Returns whether extra integers are associated to the DofObject.

Definition at line 1188 of file dof_object.h.

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

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

◆ has_invertible_map()

bool libMesh::Elem::has_invertible_map ( Real tol = TOLERANCE*TOLERANCE ) const

virtualinherited

Returns: true if the element map is invertible everywhere on the element, to within a user-specified tolerance. The tolerance is generally used in comparisons against zero, so it should be an absolute rather than a relative tolerance. Throws a libmesh_not_implemented() error unless specialized by derived classes.

Reimplemented in libMesh::NodeElem, libMesh::Tet4, libMesh::Tri3, libMesh::Edge4, libMesh::Edge3, libMesh::Quad4, and libMesh::Edge2.

Definition at line 2887 of file elem.C.

References libMesh::FEMap::compute_map(), libMesh::Elem::dim(), libMesh::FEMap::get_jacobian(), libMesh::index_range(), libMesh::FEMap::init_reference_to_physical_map(), libMesh::Elem::is_singular_node(), and libMesh::Elem::n_nodes().

Referenced by VolumeTest::testEdge4Invertible().

 {
   QNodal qnodal {this->dim()};
   FEMap fe_map;
   auto & jac = fe_map.get_jacobian();
 
   // We have a separate check for is_singular_node() below, so in this
   // case its "OK" to do nodal quadrature on pyramids.
   qnodal.allow_nodal_pyramid_quadrature = true;
   qnodal.init(*this);
   auto & qp = qnodal.get_points();
   libmesh_assert_equal_to(qp.size(), this->n_nodes());
 
   std::vector<Point> one_point(1);
   std::vector<Real> one_weight(1,1);
   for (auto i : index_range(qp))
     {
       if (this->is_singular_node(i))
         continue;
 
       one_point[0] = qp[i];
 
       fe_map.init_reference_to_physical_map(this->dim(), one_point, this);
       fe_map.compute_map(this->dim(), one_weight, this, false);
 
       if (jac[0] <= 0)
         return false;
     }
 
   return true;
 }

◆ 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 2628 of file elem.h.

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

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

◆ 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 1350 of file elem.C.

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

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

 {
   // 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;
 }

◆ hmax()

Real libMesh::Elem::hmax ( ) const

virtualinherited

Returns: The maximum vertex separation for the element.

Definition at line 722 of file elem.C.

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

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

 {
   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);
 }

◆ hmin()

Real libMesh::Elem::hmin ( ) const

virtualinherited

Returns: The minimum vertex separation for the element.

Definition at line 702 of file elem.C.

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

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

 {
   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);
 }

◆ id()

dof_id_type libMesh::DofObject::id ( ) const

inlineinherited

Returns: The id for this DofObject

Definition at line 828 of file dof_object.h.

References libMesh::DofObject::_id.

 {
   return _id;
 }

◆ increment_constructor_count() [1/2]

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

inlineprotectednoexceptinherited

Increments the construction counter.

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

Definition at line 183 of file reference_counter.h.

References libMesh::err, libMesh::BasicOStreamProxy< charT, traits >::get(), libMesh::Quality::name(), and libMesh::Threads::spin_mtx.

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

 {
   libmesh_try
   {
     Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
     std::pair<unsigned int, unsigned int> & p = _counts[name];
     p.first++;
   }
   libmesh_catch (...)
   {
     auto stream = libMesh::err.get();
     stream->exceptions(stream->goodbit); // stream must not throw
     libMesh::err << "Encountered unrecoverable error while calling "
                  << "ReferenceCounter::increment_constructor_count() "
                  << "for a(n) " << name << " object." << std::endl;
     std::terminate();
   }
 }

◆ increment_constructor_count() [2/2]

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

inlineprotectednoexceptinherited

Increments the construction counter.

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

Definition at line 183 of file reference_counter.h.

References libMesh::err, libMesh::BasicOStreamProxy< charT, traits >::get(), libMesh::Quality::name(), and libMesh::Threads::spin_mtx.

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

 {
   libmesh_try
   {
     Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
     std::pair<unsigned int, unsigned int> & p = _counts[name];
     p.first++;
   }
   libmesh_catch (...)
   {
     auto stream = libMesh::err.get();
     stream->exceptions(stream->goodbit); // stream must not throw
     libMesh::err << "Encountered unrecoverable error while calling "
                  << "ReferenceCounter::increment_constructor_count() "
                  << "for a(n) " << name << " object." << std::endl;
     std::terminate();
   }
 }

◆ increment_destructor_count() [1/2]

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

inlineprotectednoexceptinherited

Increments the destruction counter.

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

Definition at line 207 of file reference_counter.h.

References libMesh::err, libMesh::BasicOStreamProxy< charT, traits >::get(), libMesh::Quality::name(), and libMesh::Threads::spin_mtx.

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

 {
   libmesh_try
   {
     Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
     std::pair<unsigned int, unsigned int> & p = _counts[name];
     p.second++;
   }
   libmesh_catch (...)
   {
     auto stream = libMesh::err.get();
     stream->exceptions(stream->goodbit); // stream must not throw
     libMesh::err << "Encountered unrecoverable error while calling "
                  << "ReferenceCounter::increment_destructor_count() "
                  << "for a(n) " << name << " object." << std::endl;
     std::terminate();
   }
 }

◆ increment_destructor_count() [2/2]

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

inlineprotectednoexceptinherited

Increments the destruction counter.

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

Definition at line 207 of file reference_counter.h.

References libMesh::err, libMesh::BasicOStreamProxy< charT, traits >::get(), libMesh::Quality::name(), and libMesh::Threads::spin_mtx.

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

 {
   libmesh_try
   {
     Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
     std::pair<unsigned int, unsigned int> & p = _counts[name];
     p.second++;
   }
   libmesh_catch (...)
   {
     auto stream = libMesh::err.get();
     stream->exceptions(stream->goodbit); // stream must not throw
     libMesh::err << "Encountered unrecoverable error while calling "
                  << "ReferenceCounter::increment_destructor_count() "
                  << "for a(n) " << name << " object." << std::endl;
     std::terminate();
   }
 }

◆ infinite() [1/2]

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

inlineoverridevirtualinherited

Returns: false. All classes derived from Cell are finite elements.

Implements libMesh::Elem.

Definition at line 75 of file cell.h.

75 { return false; }

◆ infinite() [2/2]

static constexpr bool libMesh::Elem::infinite ( )

inlinestaticinherited

Definition at line 1918 of file elem.h.

1918 { return false; }

◆ inherit_data_from()

void libMesh::Elem::inherit_data_from ( const Elem & src )

inlineinherited

A helper function for copying generic element data (mapping, subdomain, processor) from an element to a derived (child, side, edge) element.

Useful for forwards compatibility when new data is added.

Definition at line 3339 of file elem.h.

References libMesh::Elem::mapping_data(), libMesh::Elem::mapping_type(), libMesh::Elem::p_level(), libMesh::DofObject::processor_id(), libMesh::Elem::set_mapping_data(), libMesh::Elem::set_mapping_type(), libMesh::Elem::set_p_level(), and libMesh::Elem::subdomain_id().

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

 {
   this->set_mapping_type(src.mapping_type());
   this->set_mapping_data(src.mapping_data());
   this->subdomain_id() = src.subdomain_id();
   this->processor_id(src.processor_id());
 #ifdef LIBMESH_ENABLE_AMR
   this->set_p_level(src.p_level());
 #endif
 }

◆ interior_parent() [1/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 returns nullptr if this->dim() == LIBMESH_DIM; in such cases no data storage for an interior parent pointer has been allocated.

Definition at line 1186 of file elem.C.

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

Referenced by libMesh::FEMap::compute_face_map(), libMesh::UnstructuredMesh::find_neighbors(), libMesh::BoundaryInfo::get_side_and_node_maps(), libMesh::InfFE< Dim, T_radial, T_map >::init_face_shape_functions(), libMesh::MeshTools::libmesh_assert_valid_amr_interior_parents(), libMesh::GhostPointNeighbors::operator()(), libMesh::Elem::topologically_equal(), libMesh::BoundaryVolumeSolutionTransfer::transfer_boundary_volume(), and libMesh::BoundaryVolumeSolutionTransfer::transfer_volume_boundary().

 {
   // interior parents make no sense for full-dimensional elements.
   if (this->dim() >= LIBMESH_DIM)
       return nullptr;
 
   // 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()));
 
   // If an element in a multi-dimensional mesh has an interior_parent
   // link, it should be at our level or coarser, just like a neighbor
   // link.  Our collect_families() code relies on this, but it might
   // be tempting for users to manually assign something that breaks
   // it.
   //
   // However, we *also* create temporary side elements, and we don't
   // bother with creating ancestors for those, so they can be at level
   // 0 even when they're sides of non-level-0 elements.
   libmesh_assert (!interior_p ||
                   (interior_p->level() <= this->level()) ||
                   (this->level() == 0 &&
                    this->id() == DofObject::invalid_id));
 
   return interior_p;
 }

◆ interior_parent() [2/2]

Elem * libMesh::Elem::interior_parent ( )

inherited

Definition at line 1231 of file elem.C.

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

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

◆ invalidate()

void libMesh::DofObject::invalidate ( )

inlineinherited

Invalidates all the indices for this DofObject.

Definition at line 788 of file dof_object.h.

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

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

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

◆ 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 751 of file dof_object.h.

References libMesh::DofObject::invalid_id, libMesh::make_range(), 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().

 {
   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 : make_range(n_sys))
         for (auto vg : make_range(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 : make_range(this->n_var_groups(sys_num)))
       if (this->n_comp_group(sys_num,vg))
         this->set_vg_dof_base(sys_num,vg,invalid_id);
 }

◆ invalidate_id()

void libMesh::DofObject::invalidate_id ( )

inlineinherited

Sets the id to invalid_id.

Definition at line 772 of file dof_object.h.

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

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

 {
   this->set_id (invalid_id);
 }

◆ invalidate_processor_id()

void libMesh::DofObject::invalidate_processor_id ( )

inlineinherited

Sets the processor id to invalid_processor_id.

Definition at line 780 of file dof_object.h.

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

 {
   this->processor_id (invalid_processor_id);
 }

◆ 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 3009 of file elem.h.

References libMesh::Elem::parent().

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

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

◆ 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 2306 of file elem.C.

References libMesh::Elem::build_edge_ptr(), libMesh::Elem::child_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()().

 {
   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->child_ptr(c)->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));
 }

◆ is_child_on_side()

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

overridevirtualinherited

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

Implements libMesh::Elem.

Definition at line 237 of file cell_pyramid.C.

References libMesh::Pyramid::n_children(), libMesh::Pyramid::n_sides(), and side_nodes_map.

 {
   libmesh_assert_less (c, this->n_children());
   libmesh_assert_less (s, this->n_sides());
 
   for (unsigned int i = 0; i != 4; ++i)
     if (Pyramid5::side_nodes_map[s][i] == c)
       return true;
   return false;
 }

◆ is_edge()

bool libMesh::Pyramid5::is_edge ( const unsigned int i ) const

overridevirtual

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

Implements libMesh::Elem.

Definition at line 70 of file cell_pyramid5.C.

 {
   return false;
 }

◆ is_edge_on_side()

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

overridevirtualinherited

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

Implements libMesh::Elem.

Definition at line 251 of file cell_pyramid.C.

References libMesh::Pyramid::edge_sides_map, libMesh::Pyramid::n_edges(), and libMesh::Pyramid::n_sides().

 {
   libmesh_assert_less (e, this->n_edges());
   libmesh_assert_less (s, this->n_sides());
 
   return (edge_sides_map[e][0] == s || edge_sides_map[e][1] == s);
 }

◆ is_face()

bool libMesh::Pyramid5::is_face ( const unsigned int i ) const

overridevirtual

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

Implements libMesh::Elem.

Definition at line 75 of file cell_pyramid5.C.

 {
   return false;
 }

◆ is_flipped()

bool libMesh::Pyramid::is_flipped ( ) const

finaloverridevirtualinherited

Returns: Whether the element is flipped compared to standard libMesh (e.g. clockwise for 2D elements) node orientations.

Always returns false if a 2D element is not in the XY plane or a 1D element is not on the X axis; user code designed to work for embedded manifolds should handle any consistent orientation, and determining whether an orientation is consistent is not a local operation.

Implements libMesh::Elem.

Definition at line 270 of file cell_pyramid.C.

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

 {
   return (triple_product(this->point(1)-this->point(0),
                          this->point(3)-this->point(0),
                          this->point(4)-this->point(0)) < 0);
 }

◆ is_internal()

bool libMesh::Elem::is_internal ( const unsigned int i ) const

inherited

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

Definition at line 3572 of file elem.C.

References libMesh::Elem::dim(), libMesh::Elem::is_edge(), libMesh::Elem::is_face(), and libMesh::Elem::is_vertex().

Referenced by libMesh::Prism::edges_adjacent_to_node(), libMesh::Hex::edges_adjacent_to_node(), libMesh::InfPrism::edges_adjacent_to_node(), and libMesh::InfHex::edges_adjacent_to_node().

 {
   switch (this->dim())
   {
     case 0:
       return false;
 
     case 1:
       return !this->is_vertex(i);
 
     case 2:
       return !this->is_vertex(i) && !this->is_edge(i);
 
     case 3:
       return !this->is_vertex(i) && !this->is_edge(i) && !this->is_face(i);
 
     default:
       libmesh_error_msg("impossible element dimension " << std::to_string(this->dim()));
       return 0;
   }
 }

◆ 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 1213 of file elem.h.

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

1213 { return false; }

◆ 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::InfEdge2, libMesh::InfQuad, libMesh::InfPrism, and libMesh::InfHex.

Definition at line 1905 of file elem.h.

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

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

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

libMesh::libmesh_assert

libmesh_assert(ctx)

libMesh::Elem::infinite

virtual bool infinite() const =0

◆ is_node_on_edge()

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

overridevirtual

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

Implements libMesh::Elem.

Definition at line 104 of file cell_pyramid5.C.

References edge_nodes_map, and libMesh::Pyramid::n_edges().

 {
   libmesh_assert_less (e, n_edges());
   return std::find(std::begin(edge_nodes_map[e]),
                    std::end(edge_nodes_map[e]),
                    n) != std::end(edge_nodes_map[e]);
 }

◆ is_node_on_side()

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

overridevirtual

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

Implements libMesh::Elem.

Definition at line 80 of file cell_pyramid5.C.

References libMesh::Pyramid::n_sides(), and side_nodes_map.

 {
   libmesh_assert_less (s, n_sides());
   return std::find(std::begin(side_nodes_map[s]),
                    std::end(side_nodes_map[s]),
                    n) != std::end(side_nodes_map[s]);
 }

◆ is_remote()

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

inlinevirtualinherited

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 in libMesh::RemoteElem.

Definition at line 603 of file elem.h.

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

604 { return false; }

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

This method is discouraged, as it uses the old definition of semilocal (elements which are not local but which are point neighbors of something local) rather than any of the new definitions discussed in ghosting_functor.h

Definition at line 855 of file elem.C.

References libMesh::Elem::find_point_neighbors().

 {
   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;
 }

◆ is_singular_node()

virtual bool libMesh::Pyramid::is_singular_node ( unsigned int node_idx ) const

inlinefinaloverridevirtualinherited

Returns: true iff the node at the given index has a singular mapping; i.e. is the degree-4 node on a Pyramid.

Reimplemented from libMesh::Elem.

Definition at line 185 of file cell_pyramid.h.

185 { return (node_idx == 4); }

◆ is_vertex()

bool libMesh::Pyramid5::is_vertex ( const unsigned int i ) const

overridevirtual

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

Implements libMesh::Elem.

Definition at line 64 of file cell_pyramid5.C.

References libMesh::invalid_uint.

 {
   libmesh_assert_not_equal_to (n, invalid_uint);
   return true;
 }

◆ is_vertex_on_child()

virtual bool 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 774 of file elem.h.

References libMesh::Elem::is_vertex().

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

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

libMesh::Elem::is_vertex

virtual bool is_vertex(const unsigned int i) const =0

◆ 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 3493 of file elem.C.

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

 {
 #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
 }

◆ key() [1/4]

virtual dof_id_type libMesh::Elem::key

inherited

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

◆ key() [2/4]

dof_id_type libMesh::Elem::key

inherited

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

Definition at line 753 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() [3/4]

dof_id_type libMesh::Pyramid::key ( const unsigned int s ) const

overridevirtualinherited

Returns: An id associated with the s side of this element. The id is not necessarily unique, but should be close.

Implements libMesh::Elem.

Reimplemented in libMesh::Pyramid18, and libMesh::Pyramid14.

Definition at line 77 of file cell_pyramid.C.

References libMesh::Elem::compute_key(), libMesh::Pyramid::n_sides(), libMesh::Elem::node_id(), and side_nodes_map.

 {
   libmesh_assert_less (s, this->n_sides());
 
   switch (s)
     {
     case 0: // triangular face 1
     case 1: // triangular face 2
     case 2: // triangular face 3
     case 3: // triangular face 4
       return this->compute_key (this->node_id(Pyramid5::side_nodes_map[s][0]),
                                 this->node_id(Pyramid5::side_nodes_map[s][1]),
                                 this->node_id(Pyramid5::side_nodes_map[s][2]));
 
     case 4:  // the quad face at z=0
       return this->compute_key (this->node_id(Pyramid5::side_nodes_map[s][0]),
                                 this->node_id(Pyramid5::side_nodes_map[s][1]),
                                 this->node_id(Pyramid5::side_nodes_map[s][2]),
                                 this->node_id(Pyramid5::side_nodes_map[s][3]));
 
     default:
       libmesh_error_msg("Invalid side s = " << s);
     }
 }

◆ key() [4/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::Tet4, libMesh::Edge3, libMesh::Edge4, libMesh::Edge2, libMesh::Quad9, libMesh::Quad, libMesh::Polyhedron, libMesh::Polygon, and libMesh::Tri.

Definition at line 753 of file elem.C.

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

 {
   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);
 }

◆ 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 742 of file elem.C.

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

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

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

◆ 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 3074 of file elem.h.

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

 {
 #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
 }

◆ libmesh_assert_valid_neighbors()

void libMesh::Elem::libmesh_assert_valid_neighbors ( ) const

inherited

Checks for consistent neighbor links on this element.

Definition at line 1383 of file elem.C.

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

 {
   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));
         }
     }
 }

◆ 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 1371 of file elem.C.

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

 {
   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());
     }
 }

◆ local_edge_node()

unsigned int libMesh::Pyramid::local_edge_node	(	unsigned int	edge,
		unsigned int	edge_node
	)		const

overridevirtualinherited

Returns: Pyramid5::edge_nodes_map[edge][edge_node] after doing some range checking.

Implements libMesh::Elem.

Reimplemented in libMesh::Pyramid18, libMesh::Pyramid14, and libMesh::Pyramid13.

Definition at line 147 of file cell_pyramid.C.

References edge_nodes_map, libMesh::Pyramid::n_edges(), and nodes_per_edge.

 {
   libmesh_assert_less(edge, this->n_edges());
   libmesh_assert_less(edge_node, Pyramid5::nodes_per_edge);
 
   return Pyramid5::edge_nodes_map[edge][edge_node];
 }

◆ 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 2487 of file elem.h.

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

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

 {
   for (auto n : make_range(this->n_nodes()))
     if (this->node_id(n) == i)
       return n;
 
   return libMesh::invalid_uint;
 }

◆ local_side_node()

unsigned int libMesh::Pyramid::local_side_node	(	unsigned int	side,
		unsigned int	side_node
	)		const

overridevirtualinherited

Returns: Pyramid5::side_nodes_map[side][side_node] after doing some range checking.

Implements libMesh::Elem.

Reimplemented in libMesh::Pyramid18, libMesh::Pyramid14, and libMesh::Pyramid13.

Definition at line 131 of file cell_pyramid.C.

References libMesh::libmesh_assert(), libMesh::Pyramid::n_sides(), nodes_per_side, and side_nodes_map.

 {
   libmesh_assert_less (side, this->n_sides());
 
   // Never more than 4 nodes per side.
   libmesh_assert_less(side_node, Pyramid5::nodes_per_side);
 
   // Some sides have 3 nodes.
   libmesh_assert(side == 4 || side_node < 3);
 
   return Pyramid5::side_nodes_map[side][side_node];
 }

◆ local_singular_node()

unsigned int libMesh::Pyramid::local_singular_node	(	const Point &	p,
		const Real	tol = `TOLERANCE*TOLERANCE`
	)		const

finaloverridevirtualinherited

Returns: Node 4 (the apex) if is at the apex within the tolerance tol. If is not at the apex within the tolerance tol, will return invalid_uint.

The Jacobian at the apex is singular because directional derivatives are defined in four directions, independently (four edges meet). Therefore, we can check for this in a caught, failed inverse mapping and return the correct point without failure if it is the apex. This behavior does require exceptions to be enabled.

Reimplemented from libMesh::Elem.

Definition at line 294 of file cell_pyramid.C.

References libMesh::TypeVector< T >::absolute_fuzzy_equals(), libMesh::invalid_uint, and libMesh::Elem::node_ref().

 {
   return this->node_ref(4).absolute_fuzzy_equals(p, tol) ? 4 : invalid_uint;
 }

◆ loose_bounding_box()

BoundingBox libMesh::Pyramid5::loose_bounding_box ( ) const

overridevirtual

Builds a bounding box out of the nodal positions.

Reimplemented from libMesh::Cell.

Definition at line 269 of file cell_pyramid5.C.

References libMesh::Elem::loose_bounding_box().

 {
   return Elem::loose_bounding_box();
 }

◆ low_order_key()

dof_id_type libMesh::Pyramid::low_order_key ( const unsigned int s ) const

overridevirtualinherited

Returns: An id associated with the s side of this element, as defined solely by element vertices. 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 104 of file cell_pyramid.C.

References libMesh::Elem::compute_key(), libMesh::Pyramid::n_sides(), libMesh::Elem::node_id(), and side_nodes_map.

 {
   libmesh_assert_less (s, this->n_sides());
 
   switch (s)
     {
     case 0: // triangular face 1
     case 1: // triangular face 2
     case 2: // triangular face 3
     case 3: // triangular face 4
       return this->compute_key (this->node_id(Pyramid5::side_nodes_map[s][0]),
                                 this->node_id(Pyramid5::side_nodes_map[s][1]),
                                 this->node_id(Pyramid5::side_nodes_map[s][2]));
 
     case 4:  // the quad face at z=0
       return this->compute_key (this->node_id(Pyramid5::side_nodes_map[s][0]),
                                 this->node_id(Pyramid5::side_nodes_map[s][1]),
                                 this->node_id(Pyramid5::side_nodes_map[s][2]),
                                 this->node_id(Pyramid5::side_nodes_map[s][3]));
 
     default:
       libmesh_error_msg("Invalid side s = " << s);
     }
 }

◆ 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 1455 of file elem.C.

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

 {
   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);
     }
 }

◆ 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 1533 of file elem.C.

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

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

◆ mapping_data()

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

inlineinherited

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

Definition at line 3136 of file elem.h.

References libMesh::Elem::_map_data.

Referenced by libMesh::MeshTools::Modification::all_tri(), libMesh::MeshTools::Modification::flatten(), libMesh::Elem::get_info(), libMesh::Elem::inherit_data_from(), libMesh::Polygon::Polygon(), libMesh::Polyhedron::Polyhedron(), libMesh::rational_fe_shape(), libMesh::rational_fe_shape_deriv(), libMesh::rational_fe_shape_second_deriv(), libMesh::rational_fe_weighted_shapes(), and libMesh::rational_fe_weighted_shapes_derivs().

 {
   return _map_data;
 }

◆ mapping_type()

ElemMappingType libMesh::Elem::mapping_type ( ) const

inlineinherited

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

Definition at line 3120 of file elem.h.

References libMesh::Elem::_map_type.

 {
   return static_cast<ElemMappingType>(_map_type);
 }

◆ master_point()

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

inlineoverridevirtualinherited

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

Implements libMesh::Elem.

Definition at line 66 of file cell_pyramid.h.

References libMesh::Pyramid::_master_points, and libMesh::Pyramid::n_nodes().

   {
     libmesh_assert_less(i, this->n_nodes());
     return Point(_master_points[i][0],
                  _master_points[i][1],
                  _master_points[i][2]);
   }

◆ 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 3246 of file elem.h.

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

 {
   // 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;
 }

◆ 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 2352 of file elem.C.

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

 {
   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;
 }

◆ 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 2323 of file elem.C.

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

 {
   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;
 }

◆ n_children()

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

inlineoverridevirtualinherited

Returns: 10.

Implements libMesh::Elem.

Definition at line 110 of file cell_pyramid.h.

Referenced by libMesh::Pyramid::is_child_on_side().

110 { return 10; }

◆ 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 1002 of file dof_object.h.

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::Nemesis_IO::copy_elemental_solution(), libMesh::ExodusII_IO::copy_nodal_solution(), libMesh::Nemesis_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::OldSolutionCoefs< Output, point_output >::eval_mixed_derivatives(), libMesh::OldSolutionValue< Output, point_output >::eval_mixed_derivatives(), 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::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectSides::operator()(), libMesh::DofObject::operator=(), libMesh::DofObject::print_dof_info(), libMesh::DofObject::set_dof_number(), libMesh::DofObject::set_n_vars_per_group(), libMesh::DofMap::set_nonlocal_dof_objects(), and libMesh::Nemesis_IO_Helper::write_nodal_solution().

 {
   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));
 }

◆ 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 1015 of file dof_object.h.

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

 {
   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);
 }

◆ 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 directly stored on this object. Optionally only degrees of freedom for variable number var are counted. Does not count degrees of freedom only indirectly associated with this object, such as those stored on an element's nodes when n_dofs() is called on the element itself.

Definition at line 806 of file dof_object.h.

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

Referenced by libMesh::PetscDMWrapper::add_dofs_helper(), and libMesh::EquationSystems::build_parallel_solution_vector().

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

◆ n_edges()

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

inlineoverridevirtualinherited

Returns: 8. All pyramids have 8 edges.

Implements libMesh::Elem.

Definition at line 100 of file cell_pyramid.h.

100 { return 8; }

◆ 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 1170 of file dof_object.h.

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

Referenced by libMesh::DofObject::add_extra_integers(), libMesh::MeshTools::Modification::all_tri(), libMesh::C0Polyhedron::disconnected_clone(), libMesh::Elem::disconnected_clone(), libMesh::MeshTools::Modification::flatten(), libMesh::DofObject::get_extra_datum(), libMesh::DofObject::get_extra_integer(), libMesh::CheckpointIO::read_connectivity(), libMesh::CheckpointIO::read_nodes(), libMesh::XdrIO::read_serialized_connectivity(), libMesh::Elem::refine(), libMesh::SimplexRefiner::refine_via_edges(), 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().

 {
   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;
 }

◆ n_faces()

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

inlineoverridevirtualinherited

Returns: 5. All pyramids have 5 faces.

Implements libMesh::Elem.

Definition at line 105 of file cell_pyramid.h.

105 { return 5; }

◆ 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 714 of file elem.h.

References libMesh::Elem::n_sides().

Referenced by libMesh::Elem::_last_side(), 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(), libMesh::Elem::topological_neighbor(), and libMesh::Elem::topologically_equal().

715 { return this->n_sides(); }

libMesh::Elem::n_sides

virtual unsigned int n_sides() const =0

◆ n_nodes()

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

inlineoverridevirtualinherited

Returns: 5. All pyramid-derivatives are guaranteed to have at least 5 nodes.

Implements libMesh::Elem.

Reimplemented in libMesh::Pyramid18, libMesh::Pyramid14, and libMesh::Pyramid13.

Definition at line 85 of file cell_pyramid.h.

Referenced by libMesh::Pyramid::edges_adjacent_to_node(), and libMesh::Pyramid::master_point().

85 { return 5; }

◆ 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 674 of file elem.h.

References libMesh::Elem::n_nodes().

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

675 { return this->n_nodes(); }

libMesh::Elem::n_nodes

virtual unsigned int n_nodes() const =0

◆ 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 85 of file reference_counter.h.

References libMesh::ReferenceCounter::_n_objects.

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

86 { return _n_objects; }

libMesh::ReferenceCounter::_n_objects

static Threads::atomic< unsigned int > _n_objects

The number of objects.

Definition: reference_counter.h:132

◆ 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 85 of file reference_counter.h.

References libMesh::ReferenceCounter::_n_objects.

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

86 { return _n_objects; }

libMesh::ReferenceCounter::_n_objects

static Threads::atomic< unsigned int > _n_objects

The number of objects.

Definition: reference_counter.h:132

◆ n_permutations()

virtual unsigned int libMesh::Pyramid::n_permutations ( ) const

inlinefinaloverridevirtualinherited

One quad side, four orientations.

Implements libMesh::Elem.

Definition at line 190 of file cell_pyramid.h.

190 { return 4; }

◆ 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 947 of file dof_object.h.

References libMesh::DofObject::_idx_buf.

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

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

◆ 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::Prism21, libMesh::Pyramid18, libMesh::Prism20, libMesh::Pyramid14, libMesh::Prism18, libMesh::Hex27, libMesh::Tet14, libMesh::Prism15, libMesh::Pyramid13, libMesh::InfHex18, libMesh::Tet10, libMesh::Hex20, libMesh::Tri7, libMesh::InfHex16, libMesh::Tri6, libMesh::Quad9, libMesh::InfPrism12, libMesh::C0Polygon, libMesh::Quad8, libMesh::InfQuad6, libMesh::Edge4, and libMesh::Edge3.

Definition at line 3046 of file elem.C.

Referenced by libMesh::MeshTools::Modification::smooth().

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

◆ n_sides()

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

inlineoverridevirtualinherited

Returns: 5

Implements libMesh::Elem.

Definition at line 90 of file cell_pyramid.h.

90 { return 5; }

◆ n_sub_elem()

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

inlineoverridevirtual

Returns: 1.

Implements libMesh::Elem.

Definition at line 83 of file cell_pyramid5.h.

Referenced by connectivity().

83 { return 1; }

◆ n_systems()

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

inlineinherited

Returns: The number of systems associated with this DofObject

Definition at line 937 of file dof_object.h.

References libMesh::DofObject::_idx_buf.

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

◆ 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 957 of file dof_object.h.

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

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

◆ n_vars() [1/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 967 of file dof_object.h.

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

 {
   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);
 }

◆ n_vars() [2/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 984 of file dof_object.h.

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

 {
   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;
 }

◆ n_vertices()

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

inlineoverridevirtualinherited

Returns: 5. All pyramids have 5 vertices.

Implements libMesh::Elem.

Definition at line 95 of file cell_pyramid.h.

Referenced by libMesh::Pyramid::edges_adjacent_to_node(), libMesh::Pyramid13::second_order_adjacent_vertex(), libMesh::Pyramid14::second_order_adjacent_vertex(), and libMesh::Pyramid18::second_order_adjacent_vertex().

95 { return 5; }

◆ neighbor_ptr() [1/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 2598 of file elem.h.

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::MeshTools::Modification::all_tri(), libMesh::ClawSystem::assemble_avg_coupling_matrices(), assemble_ellipticdg(), libMesh::ClawSystem::assemble_jump_coupling_matrix(), assemble_SchroedingerEquation(), assembly_with_dg_fem_context(), libMesh::BoundaryInfo::boundary_ids(), libMesh::EquationSystems::build_discontinuous_solution_vector(), libMesh::InfElemBuilder::build_inf_elem(), libMesh::BoundaryInfo::clear_stitched_boundary_side_ids(), compute_enriched_soln(), 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_disconnected_subdomains(), libMesh::Elem::get_info(), libMesh::VariationalSmootherConstraint::get_neighbors_for_subdomain_constraint(), libMesh::InfFE< Dim, T_radial, T_map >::inf_compute_constraints(), libMesh::InfFE< Dim, T_radial, T_map >::inf_compute_node_constraints(), libMesh::RBEIMConstruction::initialize_qp_data(), libMesh::Poly2TriTriangulator::insert_refinement_points(), libMesh::Poly2TriTriangulator::is_refine_boundary_allowed(), libMesh::HDGProblem::jacobian(), 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::C0Polygon::permute(), libMesh::CheckpointIO::read_remote_elem(), libMesh::EquationSystems::redundant_added_side(), libMesh::SimplexRefiner::refine_via_edges(), libMesh::InfFE< Dim, T_radial, T_map >::reinit(), libMesh::FE< Dim, LAGRANGE_VEC >::reinit(), libMesh::FEXYZ< Dim >::reinit(), libMesh::HDGProblem::residual(), libMesh::C0Polyhedron::retriangulate(), libMesh::FE< Dim, LAGRANGE_VEC >::side_map(), libMesh::Elem::SideIter::side_on_boundary(), libMesh::BoundaryInfo::side_with_boundary_id(), libMesh::BoundaryInfo::sides_with_boundary_id(), libMesh::MeshTools::Modification::smooth(), libMesh::UnstructuredMesh::stitching_helper(), libMesh::Elem::swap2neighbors(), ElemTest< elem_type >::test_orient_elements(), DefaultCouplingTest::testCoupling(), PointNeighborCouplingTest::testCoupling(), MeshBaseTest::testMeshBaseVerifyIsPrepared(), InfFERadialTest::testSides(), libMesh::Elem::topological_neighbor(), libMesh::MeshRefinement::topological_neighbor(), libMesh::Elem::topologically_equal(), libMesh::MeshTetInterface::volume_to_surface_mesh(), libMesh::Elem::which_neighbor_am_i(), and libMesh::CheckpointIO::write_remote_elem().

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

◆ neighbor_ptr() [2/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 2608 of file elem.h.

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

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

◆ 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 3503 of file elem.h.

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

Referenced by ContrivedPartitioner::_do_partition(), libMesh::MeshTetInterface::check_hull_integrity(), libMesh::Elem::child_neighbor(), libMesh::UnstructuredMesh::find_neighbors(), libMesh::Elem::has_neighbor(), libMesh::InfFE< Dim, T_radial, T_map >::inf_compute_constraints(), libMesh::Elem::make_links_to_me_remote(), libMesh::Elem::remove_links_to_me(), and DistributedMeshTest::testRemoteElemError().

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

◆ neighbor_ptr_range() [2/2]

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

inlineinherited

Definition at line 3510 of file elem.h.

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

 {
   return {_elemlinks+1, _elemlinks + 1 + this->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 2475 of file elem.h.

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

 {
   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();
 }

◆ 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 2683 of file elem.h.

References libMesh::Elem::n_nodes().

Referenced by libMesh::BoundaryInfo::_find_id_maps(), libMesh::MeshRefinement::add_node(), assemble_stokes(), libMesh::TetGenMeshInterface::assign_nodes_to_elem(), libMesh::BoundaryInfo::build_node_list_from_side_list(), libMesh::FE< Dim, LAGRANGE_VEC >::cache(), libMesh::Elem::coarsen(), libMesh::FEMap::compute_map(), libMesh::FEGenericBase< FEOutputType< T >::type >::compute_periodic_constraints(), libMesh::MeshTools::Modification::flatten(), libMesh::Elem::get_info(), libMesh::MeshTools::libmesh_assert_equal_connectivity(), libMesh::Elem::libmesh_assert_valid_node_pointers(), libMesh::XdrIO::pack_element(), libMesh::Elem::quality(), libMesh::Polyhedron::side_ptr(), libMesh::MeshTools::Modification::smooth(), libMesh::Elem::true_centroid(), and libMesh::Elem::write_connectivity().

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

◆ node_ptr() [1/2]

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

inlineinherited

Returns: A const pointer to local Node i.

Definition at line 2507 of file elem.h.

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

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

◆ node_ptr() [2/2]

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

inlineinherited

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

Definition at line 2518 of file elem.h.

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

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

◆ node_ref() [1/2]

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

inlineinherited

Returns: A const reference to local Node i.

Definition at line 2529 of file elem.h.

References libMesh::Elem::node_ptr().

Referenced by libMesh::BoundaryInfo::_find_id_maps(), libMesh::DofMap::allgather_recursive_constraints(), libMesh::FEGenericBase< FEOutputType< T >::type >::compute_periodic_constraints(), libMesh::DofMap::constrain_p_dofs(), libMesh::Elem::contains_vertex_of(), libMesh::DofMap::dof_indices(), libMesh::TopologyMap::fill(), libMesh::Elem::get_info(), libMesh::VariationalSmootherSystem::get_target_to_reference_jacobian(), libMesh::Pyramid::local_singular_node(), libMesh::MeshCommunication::make_new_node_proc_ids_parallel_consistent(), libMesh::DofMap::old_dof_indices(), libMesh::DofMap::process_mesh_constraint_rows(), libMesh::rational_fe_shape(), libMesh::rational_fe_shape_deriv(), libMesh::rational_fe_shape_second_deriv(), libMesh::rational_fe_weighted_shapes(), libMesh::rational_fe_weighted_shapes_derivs(), ParsedFEMFunctionTest::setUp(), libMesh::MeshTools::Modification::smooth(), libMesh::Parallel::sync_node_data_by_element_id_once(), VolumeTest::testEdge3Volume(), and SlitMeshRefinedSystemTest::testRestart().

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

◆ node_ref() [2/2]

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

inlineinherited

Returns: A writable reference to local Node i.

Definition at line 2537 of file elem.h.

References libMesh::Elem::node_ptr().

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

◆ 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 2665 of file elem.h.

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

Referenced by libMesh::BoundaryInfo::build_side_list_from_node_list(), libMesh::Polyhedron::convex(), libMesh::MeshTools::Modification::distort(), libMesh::MeshBase::get_info(), libMesh::Polygon::key(), libMesh::Polyhedron::key(), libMesh::MeshCommunication::make_new_node_proc_ids_parallel_consistent(), ExodusTest< elem_type >::meshes_equal_enough(), libMesh::Elem::point_test(), libMesh::Polyhedron::Polyhedron(), libMesh::ReplicatedMesh::renumber_nodes_and_elements(), libMesh::FE< Dim, LAGRANGE_VEC >::shape_deriv(), libMesh::FE< Dim, LAGRANGE_VEC >::shape_second_deriv(), libMesh::BoundaryVolumeSolutionTransfer::transfer_boundary_volume(), libMesh::BoundaryVolumeSolutionTransfer::transfer_volume_boundary(), and libMesh::MeshTetInterface::volume_to_surface_mesh().

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

◆ node_ref_range() [2/2]

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

inlineinherited

Definition at line 2674 of file elem.h.

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

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

◆ nodes_on_edge()

std::vector< unsigned > libMesh::Pyramid5::nodes_on_edge ( const unsigned int int ) const

overridevirtual

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

Implements libMesh::Elem.

Definition at line 98 of file cell_pyramid5.C.

References edge_nodes_map, and libMesh::Pyramid::n_edges().

 {
   libmesh_assert_less(e, n_edges());
   return {std::begin(edge_nodes_map[e]), std::end(edge_nodes_map[e])};
 }

◆ nodes_on_side()

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

overridevirtual

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

Implements libMesh::Elem.

Definition at line 90 of file cell_pyramid5.C.

References libMesh::Pyramid::n_sides(), and side_nodes_map.

 {
   libmesh_assert_less(s, n_sides());
   auto trim = (s == 4) ? 0 : 1;
   return {std::begin(side_nodes_map[s]), std::end(side_nodes_map[s]) - trim};
 }

◆ 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 3020 of file elem.C.

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

 {
   // 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);
             }
         }
     }
 }

◆ 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 2909 of file elem.h.

References libMesh::Elem::has_neighbor().

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

◆ on_reference_element()

bool libMesh::Pyramid::on_reference_element	(	const Point &	p,
		const Real	eps = `TOLERANCE`
	)		const

finaloverridevirtualinherited

Returns: true if the master-space point p is contained in the reference element corresponding to this element, false otherwise.

Since we are doing floating point comparisons here the parameter eps can be specified to indicate a tolerance. For example, \( x \le 1 \) becomes \( x \le 1 + \epsilon \).

Implements libMesh::Elem.

Definition at line 300 of file cell_pyramid.C.

References libMesh::Real.

 {
   const Real & xi = p(0);
   const Real & eta = p(1);
   const Real & zeta = p(2);
 
   // Check that the point is on the same side of all the faces
   // by testing whether:
   //
   // n_i.(x - x_i) <= 0
   //
   // for each i, where:
   //   n_i is the outward normal of face i,
   //   x_i is a point on face i.
   return ((-eta - 1. + zeta <= 0.+eps) &&
           (  xi - 1. + zeta <= 0.+eps) &&
           ( eta - 1. + zeta <= 0.+eps) &&
           ( -xi - 1. + zeta <= 0.+eps) &&
           (            zeta >= 0.-eps));
 }

◆ operator=() [1/2]

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

delete

◆ operator=() [2/2]

Pyramid5& libMesh::Pyramid5::operator= ( Pyramid5 && )

delete

◆ operator==()

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

inherited

Returns: true if two elements are equivalent, 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 771 of file elem.C.

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

 {
   // 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;
 }

◆ 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, libMesh::Polyhedron, libMesh::Hex, and libMesh::C0Polygon.

Definition at line 3525 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::Prism, libMesh::Polyhedron, libMesh::Edge, libMesh::Polygon, and libMesh::Hex.

Definition at line 3517 of file elem.C.

Referenced by VolumeTest::testC0PolygonMethods().

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

◆ orient()

void libMesh::Elem::orient ( BoundaryInfo * boundary_info )

inlineinherited

Flips the element (by swapping node and neighbor pointers) to have a mapping Jacobian of opposite sign, iff we find a negative orientation.

This only fixes flipped elements; for tangled elements the only fixes possible are non-local.

Definition at line 3286 of file elem.h.

References libMesh::Elem::flip(), and libMesh::Elem::is_flipped().

Referenced by libMesh::MeshTools::Modification::orient_elements().

 {
   if (this->is_flipped())
     this->flip(boundary_info);
 }

◆ 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 1914 of file elem.h.

Referenced by InfFERadialTest::base_point(), libMesh::InfFE< Dim, T_radial, T_map >::compute_data(), libMesh::InfFE< Dim, T_radial, T_map >::compute_shape_functions(), libMesh::Elem::get_info(), libMesh::InfFEMap::inverse_map(), libMesh::InfFEMap::map(), InfFERadialTest::testInfQuants(), and InfFERadialTest::testInfQuants_numericDeriv().

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

◆ 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 3108 of file elem.h.

References libMesh::Elem::_p_level.

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

◆ 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 3226 of file elem.h.

References libMesh::Elem::_pflag.

Referenced by libMesh::BoundaryInfo::add_elements(), 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()(), and libMesh::Elem::refine().

 {
   return static_cast<RefinementState>(_pflag);
 }

◆ 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 642 of file dof_object.C.

References libMesh::DofObject::_idx_buf, and libMesh::DofObject::old_dof_object.

 {
 #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
 }

◆ 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 560 of file dof_object.C.

References libMesh::DofObject::_idx_buf, and libMesh::DofObject::old_dof_object.

Referenced by libMesh::Node::packed_size().

 {
   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());
 }

◆ parent() [1/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 3030 of file elem.h.

References libMesh::Elem::_elemlinks.

 {
   return _elemlinks[0];
 }

◆ parent() [2/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 3038 of file elem.h.

References libMesh::Elem::_elemlinks.

 {
   return _elemlinks[0];
 }

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

Reimplemented in libMesh::Prism21, libMesh::Prism20, libMesh::Tet14, and libMesh::Tri7.

Definition at line 2454 of file elem.C.

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::Real, libMesh::Elem::second_order_equivalent_type(), and libMesh::Elem::type().

Referenced by libMesh::Elem::bracketing_nodes(), and main().

 {
   // 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 Real 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].emplace_back(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 Real 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].emplace_back(n1, n2);
                               break;
                             }
                           else
                             libmesh_assert(!pmid.absolute_fuzzy_equals(bracketed_pt));
                         }
                     }
                 }
             }
         }
     }
 
   return cached_bracketing_nodes[em_vers][child][child_node];
 }

◆ permute()

void libMesh::Pyramid5::permute ( unsigned int perm_num )

finaloverridevirtual

Permutes the element (by swapping node and neighbor pointers) according to the specified index.

This is useful for regression testing, by making it easy to make a structured mesh behave more like an arbitrarily unstructured mesh.

This is so far only used for regression testing, so we do not currently provide a way to permute any boundary side/edge ids along with the element permutation.

Implements libMesh::Elem.

Definition at line 274 of file cell_pyramid5.C.

References libMesh::Elem::swap4neighbors(), and libMesh::Elem::swap4nodes().

 {
   libmesh_assert_less (perm_num, 4);
 
   for (unsigned int i = 0; i != perm_num; ++i)
     {
       swap4nodes(0,1,2,3);
       swap4neighbors(0,1,2,3);
     }
 }

◆ point() [1/2]

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

inlineinherited

Returns: The Point associated with local Node i.

Definition at line 2453 of file elem.h.

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

 {
   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];
 }

◆ point() [2/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 2465 of file elem.h.

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

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

◆ positive_edge_orientation()

bool libMesh::Elem::positive_edge_orientation ( const unsigned int i ) const

inherited

Returns: true if edge i is positively oriented. An edge is positively oriented iff its first vertex (i.e. zeroth node) is lexicographically greater than its second vertex (i.e. first node).

Definition at line 3595 of file elem.C.

References libMesh::Elem::local_edge_node(), libMesh::Elem::n_edges(), and libMesh::Elem::point().

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

 {
   libmesh_assert_less (i, this->n_edges());
 
   return this->point(this->local_edge_node(i, 0)) >
          this->point(this->local_edge_node(i, 1));
 }

◆ positive_face_orientation()

bool libMesh::Elem::positive_face_orientation ( const unsigned int i ) const

inherited

Returns: true if face i is positively oriented. A face is positively oriented iff the triangle defined by the lexicographically least vertex and its two adjacent vertices on the same face is positively oriented. Said triangle is positively oriented iff its vertices are an odd permutation of their lexicographic ordering.

Definition at line 3604 of file elem.C.

References distance(), libMesh::Elem::n_faces(), libMesh::Elem::nodes_on_side(), libMesh::Elem::point(), and libMesh::Elem::side_ptr().

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

 {
   libmesh_assert_less (i, this->n_faces());
 
   // Get the number of vertices N of face i. Note that for 3d elements, i.e.
   // elements for which this->n_faces() > 0, the number of vertices on any of
   // its sides (or faces) is just the number of that face's sides (or edges).
   auto side_i = this->side_ptr(i);
   const unsigned int N = side_i->n_sides();
 
   const std::vector<unsigned int> nodes = this->nodes_on_side(i);
 
   auto cmp = [&](const unsigned int & m, const unsigned int & n) -> bool
              { return this->point(m) < this->point(n); };
 
   const unsigned int V = std::distance(nodes.begin(),
                          std::min_element(nodes.begin(), nodes.begin() + N, cmp));
 
   return cmp(nodes[(V + N - 1) % N], nodes[(V + 1) % N]);
 }

◆ print_dof_info()

void libMesh::DofObject::print_dof_info ( ) const

inherited

Print out info for debugging.

Definition at line 670 of file dof_object.C.

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

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

◆ print_info() [1/3]

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

staticinherited

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

Definition at line 81 of file reference_counter.C.

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

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

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

◆ print_info() [2/3]

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

staticinherited

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

Definition at line 81 of file reference_counter.C.

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

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

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

◆ print_info() [3/3]

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

inherited

Prints relevant information about the element.

Definition at line 2921 of file elem.C.

References libMesh::Elem::get_info().

Referenced by libMesh::FEMap::compute_single_point_map(), libMesh::FEMap::inverse_map(), and libMesh::operator<<().

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

◆ processor_id() [1/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 905 of file dof_object.h.

References libMesh::DofObject::_processor_id.

Referenced by NonManifoldTestPartitioner::_do_partition(), libMesh::BoundaryInfo::_find_id_maps(), libMesh::DistributedMesh::add_elem(), libMesh::BoundaryInfo::add_elements(), libMesh::DistributedMesh::add_node(), libMesh::MeshRefinement::add_node(), libMesh::ReplicatedMesh::add_point(), libMesh::DistributedMesh::add_point(), libMesh::RBConstruction::add_scaled_matrix_and_vector(), libMesh::MeshTools::Modification::all_tri(), libMesh::DofMap::allgather_recursive_constraints(), libMesh::Patch::build_around_element(), libMesh::Partitioner::build_graph(), libMesh::InfElemBuilder::build_inf_elem(), libMesh::BoundaryInfo::build_node_list_from_side_list(), libMesh::MeshFunction::check_found_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::MeshBase::copy_constraint_rows(), libMesh::ExodusII_IO::copy_nodal_solution(), libMesh::DistributedMesh::delete_elem(), libMesh::MeshCommunication::delete_remote_elements(), 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::UnstructuredMesh::find_neighbors(), libMesh::MeshTools::Modification::flatten(), libMesh::Node::get_info(), libMesh::Elem::get_info(), libMesh::Elem::inherit_data_from(), libMesh::RBEIMConstruction::initialize_qp_data(), libMesh::DistributedMesh::insert_elem(), libMesh::DofObject::invalidate_processor_id(), 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(), ExodusTest< elem_type >::meshes_equal_enough(), libMesh::PeriodicBoundaries::neighbor(), libMesh::RBEIMEvaluation::node_distribute_bfs(), OverlappingCouplingFunctor::operator()(), AugmentSparsityOnInterface::operator()(), AugmentSparsityOnNodes::operator()(), libMesh::GhostPointNeighbors::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::CompareDofObjectsByPIDAndThenID::operator()(), libMesh::DistributedMesh::own_node(), 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::Polygon::Polygon(), libMesh::Polyhedron::Polyhedron(), libMesh::DofMap::process_mesh_constraint_rows(), libMesh::DofObject::processor_id(), libMesh::CheckpointIO::read_connectivity(), libMesh::SimplexRefiner::refine_via_edges(), libMesh::DistributedMesh::renumber_nodes_and_elements(), libMesh::DofMap::scatter_constraints(), libMesh::Partitioner::set_interface_node_processor_ids_BFS(), libMesh::Partitioner::set_interface_node_processor_ids_linear(), libMesh::Partitioner::set_interface_node_processor_ids_petscpartitioner(), libMesh::Partitioner::set_node_processor_ids(), libMesh::DofMap::set_nonlocal_dof_objects(), libMesh::Partitioner::set_parent_processor_ids(), ParsedFEMFunctionTest::setUp(), libMesh::Partitioner::single_partition_range(), 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::DTKAdapter::update_variable_values(), NonManifoldGhostingFunctorTest::verify_send_list_entries_helper(), libMesh::GmshIO::write_mesh(), and libMesh::Nemesis_IO_Helper::write_sidesets().

 {
   return _processor_id;
 }

◆ processor_id() [2/3]

processor_id_type & libMesh::DofObject::processor_id ( )

inlineinherited

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

Definition at line 913 of file dof_object.h.

References libMesh::DofObject::_processor_id.

 {
   return _processor_id;
 }

◆ 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 921 of file dof_object.h.

References libMesh::DofObject::processor_id().

 {
   this->processor_id() = pid;
 }

◆ 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::Polyhedron, libMesh::InfHex, libMesh::Quad, libMesh::Tri, libMesh::Polygon, libMesh::Hex, and libMesh::Tet.

Definition at line 1120 of file elem.h.

Referenced by main().

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

◆ 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. Not all ElemQuality metrics are supported for all Elem types; consult the Elem::quality() overrides for specific Elem types to determine which quality metrics are supported. The ElemQuality metrics with generic support for all Elems with dimension > 1 are: .) EDGE_LENGTH_RATIO - ratio of maximum to minimum edge (in 2D, side) length, where the min/max is taken over all Elem edges. .) MIN,MAX_ANGLE - The minimum (respectively maximum) angle between all pairs of adjacent Elem edges, in degrees. Note that, in 3D, these are not the dihedral angles (angle between adjacent planar faces of the element), which we plan to add support for in the future. In 2D, we compute the angle between adjacent sides for this metric.

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

Definition at line 1774 of file elem.C.

References libMesh::cross_norm(), libMesh::Elem::dim(), libMesh::Elem::edge_index_range(), libMesh::EDGE_LENGTH_RATIO, libMesh::Elem::edges_adjacent_to_node(), libMesh::Utility::enum_to_string(), libMesh::err, libMesh::index_range(), libMesh::JACOBIAN, libMesh::Elem::local_edge_node(), libMesh::make_range(), libMesh::MAX_ANGLE, libMesh::MAX_DIHEDRAL_ANGLE, libMesh::MIN_ANGLE, libMesh::MIN_DIHEDRAL_ANGLE, libMesh::Elem::n_edges(), libMesh::Elem::node_index_range(), libMesh::Elem::nodes_on_side(), libMesh::TensorTools::norm(), libMesh::pi, libMesh::Elem::point(), libMesh::Real, libMesh::SCALED_JACOBIAN, libMesh::Elem::sides_on_edge(), libMesh::triple_product(), libMesh::Elem::type(), and libMesh::TypeVector< T >::unit().

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

 {
   switch (q)
     {
       // Return the maximum ratio of edge lengths, or zero if that
       // maximum would otherwise be infinity.
     case EDGE_LENGTH_RATIO:
       {
         if (this->dim() < 2)
           return 1;
 
         std::vector<Real> edge_lengths(this->n_edges());
         for (auto e : index_range(edge_lengths))
           edge_lengths[e] = (this->point(this->local_edge_node(e,1)) -
                              this->point(this->local_edge_node(e,0))).norm();
 
         auto [min, max] =
           std::minmax_element(edge_lengths.begin(), edge_lengths.end());
 
         if (*min == 0.)
           return 0.;
         else
           return *max / *min;
       }
 
     case MIN_ANGLE:
     case MAX_ANGLE:
       {
         // 1D elements don't have interior angles, so just return some
         // dummy value in that case.
         if (this->dim() < 2)
           return 0.;
 
         // Initialize return values
         Real min_angle = std::numeric_limits<Real>::max();
         Real max_angle = -std::numeric_limits<Real>::max();
 
         for (auto n : this->node_index_range())
           {
             // Get list of edge ids adjacent to this node.
             const auto adjacent_edge_ids = this->edges_adjacent_to_node(n);
 
             // Skip any nodes with fewer than 2 adjacent edges. You
             // need at least two adjacent edges to form an interior
             // element angle.
             auto N = adjacent_edge_ids.size();
             if (N < 2)
               continue;
 
             // Consider all possible pairs of edges adjacent to node n
             for (unsigned int first = 0; first < N-1; ++first)
               for (unsigned int second = first+1; second < N; ++second)
                 {
                   // Get ids of first and second edges
                   auto first_edge = adjacent_edge_ids[first];
                   auto second_edge = adjacent_edge_ids[second];
 
                   // Get node ids of first and second edge
                   auto first_edge_node_0 = this->local_edge_node(first_edge, 0);
                   auto first_edge_node_1 = this->local_edge_node(first_edge, 1);
                   auto second_edge_node_0 = this->local_edge_node(second_edge, 0);
                   auto second_edge_node_1 = this->local_edge_node(second_edge, 1);
 
                   // Orient both edges so that edge node 0 == n
                   if (first_edge_node_0 != n)
                     std::swap(first_edge_node_0, first_edge_node_1);
                   if (second_edge_node_0 != n)
                     std::swap(second_edge_node_0, second_edge_node_1);
 
                   libmesh_assert_equal_to(first_edge_node_0, n);
                   libmesh_assert_equal_to(second_edge_node_0, n);
 
                   // Locally oriented edge vectors
                   Point
                     first_ev = this->point(first_edge_node_1) - this->point(first_edge_node_0),
                     second_ev = this->point(second_edge_node_1) - this->point(second_edge_node_0);
 
                   // Angle between them in the range [0, pi]
                   Real theta = std::acos(first_ev.unit() * second_ev.unit());
 
                   // Track min and max angles seen
                   min_angle = std::min(theta, min_angle);
                   max_angle = std::max(theta, max_angle);
                 }
           }
 
         // Return requested extreme value (in degrees)
         return Real(180)/libMesh::pi * ((q == MIN_ANGLE) ? min_angle : max_angle);
       }
 
     case MIN_DIHEDRAL_ANGLE:
     case MAX_DIHEDRAL_ANGLE:
       {
         // For 1D and 2D elements, just call this function with MIN,MAX_ANGLE instead.
         if (this->dim() < 3)
           return this->quality((q == MIN_DIHEDRAL_ANGLE) ? MIN_ANGLE : MAX_ANGLE);
 
         // Initialize return values
         Real min_angle = std::numeric_limits<Real>::max();
         Real max_angle = -std::numeric_limits<Real>::max();
 
         // Algorithm for computing dihedral angles:
         // .) Loop over the edges, use the edge_sides_map to get the
         //    two sides adjacent to the edge.
         // .) For each adjacent side, use the side_nodes_map to get the
         //    list of three (or more) node ids on that side.
         // .) Use the node ids to compute the (approximate) inward
         //    normal for the side.  Note: this is approximate since 3D
         //    elements with four-sided faces and quadratic tetrahedra
         //    do not necessarily have planar faces.
         // .) Compute the dihedral angle for the current edge, compare
         //    it to the current min and max dihedral angles.
         for (auto e : this->edge_index_range())
           {
             // Get list of edge ids adjacent to this node.
             const auto adjacent_side_ids = this->sides_on_edge(e);
 
             // All 3D elements should have exactly two sides adjacent to each edge.
             libmesh_assert_equal_to(adjacent_side_ids.size(), 2);
 
             // Get lists of node ids on each side
             const auto side_0_node_ids = this->nodes_on_side(adjacent_side_ids[0]);
             const auto side_1_node_ids = this->nodes_on_side(adjacent_side_ids[1]);
 
             // All 3D elements have at least three nodes on each side
             libmesh_assert_greater_equal(side_0_node_ids.size(), 3);
             libmesh_assert_greater_equal(side_1_node_ids.size(), 3);
 
             // Construct (approximate) inward normal on each adjacent side
             const auto side_0_normal =
               (this->point(side_0_node_ids[2]) - this->point(side_0_node_ids[0])).cross
               (this->point(side_0_node_ids[1]) - this->point(side_0_node_ids[0])).unit();
             const auto side_1_normal =
               (this->point(side_1_node_ids[2]) - this->point(side_1_node_ids[0])).cross
               (this->point(side_1_node_ids[1]) - this->point(side_1_node_ids[0])).unit();
 
             // Compute dihedral angle between the planes.
             // Using the absolute value ensures that we get the same result
             // even if the orientation of one of the planes is flipped, i.e.
             // it always gives us a value in the range [0, pi/2].
             // https://en.wikipedia.org/wiki/Dihedral_angle
             Real theta = std::acos(std::abs(side_0_normal * side_1_normal));
 
             // Track min and max angles seen
             min_angle = std::min(theta, min_angle);
             max_angle = std::max(theta, max_angle);
           }
 
         // Return requested extreme value (in degrees)
         return Real(180)/libMesh::pi * ((q == MIN_DIHEDRAL_ANGLE) ? min_angle : max_angle);
       }
 
     case JACOBIAN:
     case SCALED_JACOBIAN:
       {
         // 1D elements don't have interior corners, so this metric
         // does not really apply to them.
         const auto N = this->dim();
         if (N < 2)
           return 1.;
 
         // Initialize return value
         Real min_node_area = std::numeric_limits<Real>::max();
 
         for (auto n : this->node_index_range())
           {
             // Get list of edge ids adjacent to this node.
             auto adjacent_edge_ids = this->edges_adjacent_to_node(n);
 
             // Skip any nodes that don't have dim() adjacent edges. In 2D,
             // you need at least two adjacent edges to compute the cross
             // product, and in 3D, you need at least three adjacent edges
             // to compute the scalar triple product. The only element
             // type which has an unusual topology in this regard is the
             // Pyramid element in 3D, where 4 edges meet at the apex node.
             // For now, we just skip this node when computing the JACOBIAN
             // metric for Pyramids.
             if (adjacent_edge_ids.size() != N)
               continue;
 
             // Construct oriented edges
             std::vector<Point> oriented_edges(N);
             for (auto i : make_range(N))
               {
                 auto node_0 = this->local_edge_node(adjacent_edge_ids[i], 0);
                 auto node_1 = this->local_edge_node(adjacent_edge_ids[i], 1);
                 if (node_0 != n)
                   std::swap(node_0, node_1);
                 oriented_edges[i] = this->point(node_1) - this->point(node_0);
               }
 
             // Compute unscaled area (2D) or volume (3D) using the
             // cross product (2D) or scalar triple product (3D) of the
             // oriented edges. We take the absolute value so that we
             // don't have to worry about the sign of the area.
             Real node_area = (N == 2) ?
               cross_norm(oriented_edges[0], oriented_edges[1]) :
               std::abs(triple_product(oriented_edges[0], oriented_edges[1], oriented_edges[2]));
 
             // Divide by (non-zero) edge lengths if computing scaled Jacobian.
             // If any length is zero, then set node_area to zero. This means that
             // e.g. degenerate quadrilaterals will have a zero SCALED_JACOBIAN metric.
             if (q == SCALED_JACOBIAN)
               for (auto i : make_range(N))
                 {
                   Real len_i = oriented_edges[i].norm();
                   node_area = (len_i == 0.) ? 0. : (node_area / len_i);
                 }
 
             // Update minimum
             min_node_area = std::min(node_area, min_node_area);
           }
 
         return min_node_area;
       }
 
       // Return 1 if we made it here
     default:
       {
         libmesh_do_once( libmesh_here();
 
                          libMesh::err << "ERROR: quality metric "
                          << Utility::enum_to_string(q)
                          << " not implemented on element type "
                          << Utility::enum_to_string(this->type())
                          << std::endl
                          << "Returning 1."
                          << std::endl; );
 
         return 1.;
       }
     }
 }

◆ quasicircumcenter()

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

inlinevirtualinherited

Returns: The "circumcenter of mass" (area-weighted average of triangulation circumcenters) of the element.

Not implemented for infinite elements, not currently implemented for 3D elements, currently ignores curvature of element edges.

Reimplemented in libMesh::NodeElem, libMesh::Edge, and libMesh::Face.

Definition at line 1060 of file elem.h.

Referenced by libMesh::Poly2TriTriangulator::insert_refinement_points().

1061 { libmesh_not_implemented(); }

◆ 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 3154 of file elem.h.

References libMesh::Elem::_children.

Referenced by libMesh::BoundaryInfo::add_elements(), and libMesh::CheckpointIO::read_remote_elem().

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

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

If the element is of a type that can admit multiple topologies, such as a Polygon subtype, then there is no reference element; for such types this method should not be used.

Definition at line 570 of file elem.C.

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

Referenced by libMesh::RBEIMConstruction::enrich_eim_approximation_on_interiors(), libMesh::VariationalSmootherSystem::get_target_to_reference_jacobian(), libMesh::QComposite< QSubCell >::init(), and libMesh::RBParametrizedFunction::preevaluate_parametrized_function_on_mesh().

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

◆ refine()

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

virtualinherited

Refine the element.

Definition at line 87 of file elem_refinement.C.

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::p_level(), libMesh::Elem::p_refinement_flag(), libMesh::Elem::parent(), libMesh::Elem::REFINE, libMesh::Elem::refinement_flag(), libMesh::remote_elem, libMesh::DofObject::set_extra_integer(), libMesh::DofObject::set_n_systems(), libMesh::Elem::set_p_level(), libMesh::Elem::set_p_refinement_flag(), libMesh::Elem::set_refinement_flag(), libMesh::Elem::subactive(), and libMesh::Elem::type().

 {
   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 = std::make_unique<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++)
         {
           auto current_child = Elem::build(this->type(), this);
           _children[c] = current_child.get();
 
           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);
             }
 
           Elem * added_child = mesh_refinement.add_elem (std::move(current_child));
           added_child->set_n_systems(this->n_systems());
           libmesh_assert_equal_to (added_child->n_extra_integers(),
                                    this->n_extra_integers());
           for (unsigned int i=0; i != nei; ++i)
             added_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());
 }

◆ refinement_flag()

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

inlineinherited

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

Definition at line 3210 of file elem.h.

References libMesh::Elem::_rflag.

Referenced by libMesh::Elem::active(), libMesh::BoundaryInfo::add_elements(), 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::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectVertices::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectEdges::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectSides::operator()(), libMesh::Elem::refine(), EquationSystemsTest::testRefineThenReinitPreserveFlags(), libMesh::BoundaryInfo::transfer_boundary_ids_from_children(), and libMesh::MeshRefinement::uniformly_coarsen().

 {
   return static_cast<RefinementState>(_rflag);
 }

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

To be used before an element is deleted from a mesh.

Definition at line 1639 of file elem.C.

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

Referenced by MeshDeletionsTest::testDeleteElem().

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

◆ 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 2090 of file elem.C.

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

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

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

◆ runtime_topology()

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

inlinevirtualinherited

Returns: true iff this element type can vary in topology (e.g. have different numbers of sides and/or nodes) at runtime. For such general polygons or polyhedra, APIs which assume a fixed topology are not safe to use.

Reimplemented in libMesh::Polyhedron, and libMesh::Polygon.

Definition at line 259 of file elem.h.

Referenced by libMesh::FE< Dim, LAGRANGE_VEC >::edge_map(), libMesh::FE< Dim, LAGRANGE_VEC >::edge_reinit(), libMesh::Elem::Elem(), libMesh::QBase::init(), libMesh::FE< Dim, LAGRANGE_VEC >::reinit(), and libMesh::FE< Dim, LAGRANGE_VEC >::side_map().

259 { return false; }

◆ 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::Prism21, libMesh::Pyramid18, libMesh::Prism20, libMesh::Prism18, libMesh::Pyramid14, libMesh::Hex27, libMesh::Tet14, libMesh::Prism15, libMesh::InfHex18, libMesh::Pyramid13, libMesh::Tet10, libMesh::Hex20, libMesh::Tri7, libMesh::InfHex16, libMesh::Tri6, libMesh::Quad9, libMesh::InfPrism12, libMesh::Quad8, libMesh::InfQuad6, libMesh::Edge4, and libMesh::Edge3.

Definition at line 3054 of file elem.C.

Referenced by libMesh::MeshTools::Modification::smooth().

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

◆ 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::Prism21, libMesh::Prism20, libMesh::Prism18, libMesh::Hex27, libMesh::Tet14, libMesh::Prism15, libMesh::InfHex18, libMesh::Tet10, libMesh::Hex20, libMesh::Tri7, libMesh::InfHex16, libMesh::Tri6, libMesh::Quad9, libMesh::InfPrism12, libMesh::Quad8, libMesh::C0Polygon, libMesh::InfQuad6, libMesh::Edge3, and libMesh::C0Polyhedron.

Definition at line 3064 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 ElemType of the associated second-order element (which will be the same as the input if the input is already a second-order ElemType) or INVALID_ELEM for 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 3141 of file elem.C.

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::PRISM20, libMesh::PRISM21, libMesh::PRISM6, libMesh::PYRAMID13, libMesh::PYRAMID14, libMesh::PYRAMID18, libMesh::PYRAMID5, libMesh::QUAD4, libMesh::QUAD8, libMesh::QUAD9, libMesh::QUADSHELL4, libMesh::QUADSHELL8, libMesh::QUADSHELL9, libMesh::TET10, libMesh::TET14, libMesh::TET4, libMesh::TRI3, libMesh::TRI6, libMesh::TRI7, and libMesh::TRISHELL3.

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

 {
   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;
       }
 
     case TRI7:
       return TRI7;
 
       // 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:
       {
         if (full_ordered)
           return QUADSHELL9;
         else
           return QUADSHELL8;
       }
 
     case QUAD9:
       {
         // full_ordered not relevant
         return QUAD9;
       }
 
     case QUADSHELL9:
       {
         // full_ordered not relevant
         return QUADSHELL9;
       }
 
     case TET4:
     case TET10:
       {
         // full_ordered not relevant
         return TET10;
       }
 
     case TET14:
       return TET14;
 
     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;
       }
 
     // full_ordered not relevant, already fully second order
     case PRISM18:
       return PRISM18;
     case PRISM20:
       return PRISM20;
     case PRISM21:
       return PRISM21;
     case PYRAMID18:
       return PYRAMID18;
 
     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));
       }
     }
 }

◆ set_buffer()

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

inlineinherited

Definition at line 717 of file dof_object.h.

References libMesh::DofObject::_idx_buf.

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

718 { _idx_buf = buf; }

libMesh::DofObject::_idx_buf

index_buffer_t _idx_buf

Definition: dof_object.h:680

◆ 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 454 of file dof_object.C.

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

 {
   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);
 }

◆ 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 1126 of file dof_object.h.

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::ExodusII_IO::read(), libMesh::DynaIO::read_mesh(), and DofObjectTest< Node >::testAddExtraData().

 {
 #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));
 }

◆ 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 1086 of file dof_object.h.

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::SyncElementIntegers::act_on_data(), libMesh::BoundaryInfo::add_elements(), libMesh::UnstructuredMesh::all_first_order(), libMesh::UnstructuredMesh::create_submesh(), libMesh::ExodusII_IO::read(), libMesh::CheckpointIO::read_connectivity(), libMesh::CheckpointIO::read_nodes(), libMesh::XdrIO::read_serialized_connectivity(), libMesh::XdrIO::read_serialized_nodes(), libMesh::Elem::refine(), DofObjectTest< Node >::testAddExtraData(), DofObjectTest< Node >::testAddSystemExtraInts(), DofObjectTest< Node >::testSetNSystemsExtraInts(), and DofObjectTest< Node >::testSetNVariableGroupsExtraInts().

 {
   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;
 }

◆ 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 836 of file dof_object.h.

References libMesh::DofObject::_id.

Referenced by libMesh::ReplicatedMesh::add_elem(), libMesh::DistributedMesh::add_elem(), libMesh::ReplicatedMesh::add_node(), libMesh::DistributedMesh::add_node(), libMesh::UnstructuredMesh::all_first_order(), libMesh::DistributedMesh::fix_broken_node_and_element_numbering(), libMesh::DofObject::invalidate_id(), libMesh::Node::Node(), libMesh::DistributedMesh::own_node(), libMesh::RemoteElem::RemoteElem(), libMesh::ReplicatedMesh::renumber_elem(), libMesh::DistributedMesh::renumber_elem(), libMesh::ReplicatedMesh::renumber_node(), libMesh::DistributedMesh::renumber_node(), libMesh::ReplicatedMesh::renumber_nodes_and_elements(), libMesh::DofObject::set_id(), DofObjectTest< Node >::testInvalidateId(), DofObjectTest< Node >::testSetId(), DofObjectTest< Node >::testValidId(), and libMesh::MeshTetInterface::volume_to_surface_mesh().

 {
   return _id;
 }

◆ set_id() [2/2]

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

inlineinherited

Sets the id for this DofObject.

Definition at line 201 of file dof_object.h.

References libMesh::DofObject::set_id().

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

libMesh::DofObject::set_id

dof_id_type & set_id()

Definition: dof_object.h:836

◆ 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 1248 of file elem.C.

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::UnstructuredMesh::copy_nodes_and_elements(), libMesh::Edge::Edge(), libMesh::UnstructuredMesh::find_neighbors(), libMesh::Hex::Hex(), libMesh::InfHex::InfHex(), libMesh::InfQuad::InfQuad(), libMesh::NodeElem::NodeElem(), libMesh::Polygon::Polygon(), libMesh::Polyhedron::Polyhedron(), libMesh::Prism::Prism(), libMesh::Pyramid::Pyramid(), libMesh::Quad::Quad(), libMesh::Tet::Tet(), libMesh::Tri::Tri(), and libMesh::MeshTetInterface::volume_to_surface_mesh().

 {
   // interior parents make no sense for full-dimensional elements.
   libmesh_assert (!p ||
                   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;
 }

◆ 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 3144 of file elem.h.

References libMesh::Elem::_map_data.

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

 {
   _map_data = data;
 }

◆ 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 3128 of file elem.h.

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

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

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

◆ 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 385 of file dof_object.C.

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

 {
   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);
 }

◆ 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 397 of file dof_object.C.

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

 {
   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));
 }

◆ 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 150 of file dof_object.C.

References libMesh::DofObject::_idx_buf, libMesh::make_range(), 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().

 {
   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 ?
     static_cast<dof_id_type>(-static_cast<std::ptrdiff_t>(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 : make_range(this->n_systems()))
     {
       libmesh_assert_equal_to (this->n_vars(s),       0);
       libmesh_assert_equal_to (this->n_var_groups(s), 0);
     }
 #endif
 }

◆ 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 247 of file dof_object.C.

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

 {
   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 : make_range(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 : make_range(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 : make_range(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 : make_range(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
 }

◆ set_neighbor()

void libMesh::Elem::set_neighbor	(	const unsigned int	i,
		Elem *	n
	)

inlineinherited

Assigns n as the \( i^{th} \) neighbor.

Definition at line 2618 of file elem.h.

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::copy_nodes_and_elements(), libMesh::UnstructuredMesh::find_neighbors(), libMesh::Poly2TriTriangulator::insert_refinement_points(), libMesh::Elem::nullify_neighbors(), libMesh::C0Polygon::permute(), libMesh::CheckpointIO::read_remote_elem(), libMesh::C0Polyhedron::retriangulate(), libMesh::UnstructuredMesh::stitching_helper(), libMesh::Elem::swap2neighbors(), MeshBaseTest::testMeshBaseVerifyIsPrepared(), and libMesh::MeshTetInterface::volume_to_surface_mesh().

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

◆ set_node() [1/2]

Node *& libMesh::Elem::set_node ( const unsigned int i )

inlinevirtualinherited

Returns: The pointer to the Node with local number i as a writable reference.

Deprecated:: This setter cannot update the multiple node pointers used in a general polyhedron; use the set_node overload that takes an argument.

Reimplemented in libMesh::RemoteElem.

Definition at line 2558 of file elem.h.

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

Referenced by LinearElasticityWithContact::add_contact_edge_elements(), add_cube_convex_hull_to_mesh(), libMesh::UnstructuredMesh::all_first_order(), AllSecondOrderTest::allCompleteOrderMixed(), AllSecondOrderTest::allCompleteOrderRange(), AllSecondOrderTest::allSecondOrderMixed(), AllSecondOrderTest::allSecondOrderRange(), libMesh::TetGenMeshInterface::assign_nodes_to_elem(), libMesh::MeshTools::Generation::build_cube(), GetBoundaryPointsTest::build_mesh(), MixedDimensionMeshTest::build_mesh(), MeshfunctionDFEM::build_mesh(), SlitMeshTest::build_mesh(), MixedDimensionNonUniformRefinement::build_mesh(), MixedDimensionNonUniformRefinementTriangle::build_mesh(), MixedDimensionNonUniformRefinement3D::build_mesh(), OverlappingTestBase::build_quad_mesh(), libMesh::TriangleWrapper::copy_tri_to_mesh(), libMesh::UnstructuredMesh::create_submesh(), libMesh::C0Polygon::permute(), libMesh::Nemesis_IO::read(), libMesh::ExodusII_IO::read(), libMesh::AbaqusIO::read_elements(), libMesh::GmshIO::read_mesh(), libMesh::DynaIO::read_mesh(), libMesh::MatlabIO::read_stream(), libMesh::C0Polyhedron::retriangulate(), libMesh::RemoteElem::set_node(), PerElemTest< elem_type >::setUp(), libMesh::FE< Dim, LAGRANGE_VEC >::shape(), libMesh::Polyhedron::side_clones(), libMesh::UnstructuredMesh::stitching_helper(), libMesh::MeshTools::Generation::surface_octahedron(), libMesh::Elem::swap2nodes(), SystemsTest::testDofCouplingWithVarGroups(), MeshTriangulationTest::testEdge3Mesh(), MeshTriangulationTest::testEdgesMesh(), MeshTriangulationTest::testHalfDomain(), NodalNeighborsTest::testOrientation(), MeshTriangulationTest::testPoly2TriBad1DMultiBoundary(), MeshTriangulationTest::testPoly2TriBad2DMultiBoundary(), MeshTriangulationTest::testPoly2TriBadEdges(), EquationSystemsTest::testPostInitAddElem(), SystemsTest::testProjectMatrix3D(), InfFERadialTest::testRefinement(), EquationSystemsTest::testReinitWithNodeElem(), SystemsTest::testSetSystemParameterOverEquationSystem(), BoundaryInfoTest::testShellFaceConstraints(), InfFERadialTest::testSides(), MeshTetTest::testTetsToTets(), MeshSubdomainIDTest::testUnpartitioned(), and libMesh::Poly2TriTriangulator::triangulate_current_points().

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

◆ set_node() [2/2]

void libMesh::Elem::set_node	(	const unsigned int	i,
		Node *	node
	)

inlinevirtualinherited

Sets local Node i to refer to node.

Reimplemented in libMesh::RemoteElem.

Definition at line 2571 of file elem.h.

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

 {
   libmesh_assert_less (i, this->n_nodes());
 
   _nodes[i] = 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 135 of file dof_object.C.

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

 {
   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 = this->construct(this);
 }

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

References libMesh::Elem::_p_level, libMesh::Elem::child_ref_range(), libMesh::Elem::hack_p_level(), 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::inherit_data_from(), libMesh::Polygon::Polygon(), libMesh::Polyhedron::Polyhedron(), libMesh::Elem::refine(), libMesh::Elem::set_p_level(), and VolumeTest::testHex20PLevelTrueCentroid().

 {
   // 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;
         }
     }
 
   this->hack_p_level(p);
 }

◆ 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 3234 of file elem.h.

References libMesh::Elem::_pflag, libMesh::Elem::JUST_REFINED, and libMesh::Elem::p_level().

Referenced by libMesh::BoundaryInfo::add_elements(), 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::Elem::refine(), and libMesh::Elem::set_p_level().

 {
   if (this->p_level() == 0)
     libmesh_assert_not_equal_to
       (pflag, Elem::JUST_REFINED);
 
   _pflag = cast_int<unsigned char>(pflag);
 }

◆ 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 3046 of file elem.h.

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

Referenced by libMesh::BoundaryInfo::add_elements(), and libMesh::UnstructuredMesh::all_first_order().

 {
   // We no longer support using parent() as interior_parent()
   libmesh_assert_equal_to(this->dim(), p ? p->dim() : this->dim());
   _elemlinks[0] = p;
 }

◆ 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 3218 of file elem.h.

References libMesh::Elem::_rflag.

Referenced by libMesh::BoundaryInfo::add_elements(), libMesh::UnstructuredMesh::all_first_order(), 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::Elem::refine(), InfFERadialTest::testRefinement(), EquationSystemsTest::testRefineThenReinitPreserveFlags(), EquationSystemsTest::testSelectivePRefine(), and libMesh::MeshRefinement::uniformly_coarsen().

 {
   _rflag = cast_int<unsigned char>(rflag);
 }

◆ set_unique_id() [1/2]

unique_id_type & libMesh::DofObject::set_unique_id ( )

inlineinherited

Returns: The globally unique_id for this DofObject as a writable reference. Deprecated; use the API taking an input instead.

Definition at line 858 of file dof_object.h.

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::create_submesh(), libMesh::ReplicatedMesh::insert_elem(), libMesh::DistributedMesh::insert_elem(), libMesh::ReplicatedMesh::insert_node(), ExodusTest< elem_type >::meshes_equal_enough(), libMesh::Nemesis_IO::read(), libMesh::CheckpointIO::read_nodes(), libMesh::XdrIO::read_serialized_nodes(), libMesh::SimplexRefiner::refine_via_edges(), and libMesh::MeshTetInterface::volume_to_surface_mesh().

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

◆ set_unique_id() [2/2]

void libMesh::DofObject::set_unique_id ( unique_id_type new_id )

inlineinherited

Sets the unique_id for this DofObject.

Definition at line 872 of file dof_object.h.

References libMesh::DofObject::_unique_id, and libMesh::libmesh_ignore().

 {
 #ifdef LIBMESH_ENABLE_UNIQUE_ID
   _unique_id = new_id;
 #else
   libmesh_ignore(new_id);
   libmesh_not_implemented();
 #endif
 }

◆ 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 1297 of file dof_object.h.

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

 {
   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);
 }

◆ side_children_matrix()

unsigned int libMesh::Pyramid::side_children_matrix	(	const unsigned	int,
		const unsigned	int
	)		const

inlineprotectedinherited

Matrix that allows children to inherit boundary conditions.

Definition at line 221 of file cell_pyramid.h.

223 { libmesh_not_implemented(); return 0; }

◆ 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 2710 of file elem.h.

References libMesh::Elem::n_sides().

Referenced by libMesh::BoundaryInfo::_find_id_maps(), libMesh::MeshTools::Subdivision::add_boundary_ghosts(), libMesh::BoundaryInfo::add_elements(), libMesh::MeshTools::Modification::all_tri(), libMesh::InfElemBuilder::build_inf_elem(), libMesh::FEGenericBase< FEOutputType< T >::type >::coarsened_dof_values(), compute_enriched_soln(), 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_disconnected_subdomains(), libMesh::Elem::get_info(), libMesh::BoundaryInfo::get_side_and_node_maps(), libMesh::Elem::has_topological_neighbor(), libMesh::InfFE< Dim, T_radial, T_map >::inf_compute_constraints(), libMesh::InfFE< Dim, T_radial, T_map >::inf_compute_node_constraints(), libMesh::LaplaceMeshSmoother::init(), libMesh::Elem::libmesh_assert_valid_neighbors(), libMesh::VariationalSmootherConstraint::nodes_share_boundary_id(), libMesh::Elem::nullify_neighbors(), libMesh::PostscriptIO::plot_quadratic_elem(), libMesh::MeshTools::Modification::smooth(), libMesh::UnstructuredMesh::stitching_helper(), MeshBaseTest::testMeshBaseVerifyIsPrepared(), and libMesh::MeshTetInterface::volume_to_surface_mesh().

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

◆ side_ptr() [1/4]

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

overridevirtualinherited

Returns: A primitive triangle or quad for face i.

Implements libMesh::Elem.

Definition at line 158 of file cell_pyramid.C.

References libMesh::Pyramid::n_sides(), and side_nodes_map.

Referenced by build_side_ptr(), and libMesh::Pyramid::side_ptr().

 {
   libmesh_assert_less (i, this->n_sides());
 
   // Return value
   std::unique_ptr<Elem> face;
 
   // Set up the type of element
   switch (i)
     {
     case 0: // triangular face 1
     case 1: // triangular face 2
     case 2: // triangular face 3
     case 3: // triangular face 4
       {
         face = std::make_unique<Tri3>();
         break;
       }
     case 4:  // the quad face at z=0
       {
         face = std::make_unique<Quad4>();
         break;
       }
     default:
       libmesh_error_msg("Invalid side i = " << i);
     }
 
   // Set the nodes
   for (auto n : face->node_index_range())
     face->set_node(n, this->node_ptr(Pyramid5::side_nodes_map[i][n]));
 
   return face;
 }

◆ side_ptr() [2/4]

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

overridevirtualinherited

Rebuilds a primitive triangle or quad for face i.

Implements libMesh::Elem.

Definition at line 194 of file cell_pyramid.C.

References libMesh::Pyramid::n_sides(), libMesh::QUAD4, side_nodes_map, libMesh::Pyramid::side_ptr(), libMesh::Elem::subdomain_id(), and libMesh::TRI3.

 {
   libmesh_assert_less (i, this->n_sides());
 
   switch (i)
     {
     case 0: // triangular face 1
     case 1: // triangular face 2
     case 2: // triangular face 3
     case 3: // triangular face 4
       {
         if (!side.get() || side->type() != TRI3)
           {
             side = this->side_ptr(i);
             return;
           }
         break;
       }
 
     case 4:  // the quad face at z=0
       {
         if (!side.get() || side->type() != QUAD4)
           {
             side = this->side_ptr(i);
             return;
           }
         break;
       }
 
     default:
       libmesh_error_msg("Invalid side i = " << i);
     }
 
   side->subdomain_id() = this->subdomain_id();
 
   // Set the nodes
   for (auto n : side->node_index_range())
     side->set_node(n, this->node_ptr(Pyramid5::side_nodes_map[i][n]));
 }

◆ side_ptr() [3/4]

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

inlineinherited

Definition at line 2719 of file elem.h.

References libMesh::Elem::side_ptr().

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

◆ side_ptr() [4/4]

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

inlineinherited

Definition at line 2731 of file elem.h.

References libMesh::Elem::side_ptr().

 {
   // 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 = std::move(e);
 }

◆ side_type()

ElemType libMesh::Pyramid5::side_type ( const unsigned int s ) const

finaloverridevirtual

Returns: The type of element for side s.

Implements libMesh::Elem.

Definition at line 300 of file cell_pyramid5.C.

References libMesh::QUAD4, and libMesh::TRI3.

 {
   libmesh_assert_less (s, 5);
   if (s < 4)
     return TRI3;
   return QUAD4;
 }

◆ sides_on_edge()

std::vector< unsigned int > libMesh::Pyramid::sides_on_edge ( const unsigned int int ) const

finaloverridevirtualinherited

Returns: the (local) side numbers that touch the specified edge

Implements libMesh::Elem.

Definition at line 262 of file cell_pyramid.C.

References libMesh::Pyramid::edge_sides_map, and libMesh::Pyramid::n_edges().

 {
   libmesh_assert_less (e, this->n_edges());
   return {edge_sides_map[e][0], edge_sides_map[e][1]};
 }

◆ simple_build_edge_ptr() [1/2]

template<typename Edgeclass , typename Subclass >

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

inlineprotectedinherited

An implementation for simple (all edges equal) elements.

Definition at line 2866 of file elem.h.

References libMesh::Elem::n_edges().

 {
   libmesh_assert_less (i, this->n_edges());
 
   std::unique_ptr<Elem> edge = std::make_unique<Edgeclass>();
 
   for (auto n : edge->node_index_range())
     edge->set_node(n, this->node_ptr(Subclass::edge_nodes_map[i][n]));
 
   edge->set_interior_parent(this);
   edge->inherit_data_from(*this);
 
   return edge;
 }

◆ simple_build_edge_ptr() [2/2]

template<typename Subclass >

void libMesh::Elem::simple_build_edge_ptr	(	std::unique_ptr< Elem > &	edge,
		const unsigned int	i,
		ElemType	edgetype
	)

inlineprotectedinherited

An implementation for simple (all edges equal) elements.

Definition at line 2887 of file elem.h.

References libMesh::Elem::n_edges().

 {
   libmesh_assert_less (i, this->n_edges());
 
   if (!edge.get() || edge->type() != edgetype)
     {
       Subclass & real_me = cast_ref<Subclass&>(*this);
       edge = real_me.Subclass::build_edge_ptr(i);
     }
   else
     {
       edge->inherit_data_from(*this);
       for (auto n : edge->node_index_range())
         edge->set_node(n, this->node_ptr(Subclass::edge_nodes_map[i][n]));
     }
 }

◆ simple_build_side_ptr() [1/2]

template<typename Sideclass , typename Subclass >

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

inlineprotectedinherited

An implementation for simple (all sides equal) elements.

Definition at line 2772 of file elem.h.

References libMesh::Elem::n_sides().

 {
   libmesh_assert_less (i, this->n_sides());
 
   std::unique_ptr<Elem> face = std::make_unique<Sideclass>();
   for (auto n : face->node_index_range())
     face->set_node(n, this->node_ptr(Subclass::side_nodes_map[i][n]));
 
   face->set_interior_parent(this);
   face->inherit_data_from(*this);
 
   return face;
 }

◆ simple_build_side_ptr() [2/2]

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 2791 of file elem.h.

References libMesh::Elem::n_sides().

 {
   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);
     }
   else
     {
       side->set_interior_parent(this);
       side->inherit_data_from(*this);
       for (auto n : side->node_index_range())
         side->set_node(n, this->node_ptr(Subclass::side_nodes_map[i][n]));
     }
 }

◆ 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 2816 of file elem.h.

References libMesh::Elem::n_sides(), and libMesh::Elem::subdomain_id().

 {
   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]));
     }
 }

◆ 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 2959 of file elem.h.

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::MeshCommunication::delete_remote_elements(), libMesh::UnstructuredMesh::find_neighbors(), libMesh::Elem::get_info(), libMesh::InfFE< Dim, T_radial, T_map >::inf_compute_constraints(), libMesh::InfFE< Dim, T_radial, T_map >::inf_compute_node_constraints(), 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(), and libMesh::UnstructuredMesh::stitching_helper().

 {
 #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;
 }

◆ subdomain_id() [1/2]

subdomain_id_type libMesh::Elem::subdomain_id ( ) const

inlineinherited

Returns: The subdomain that this element belongs to.

Definition at line 2582 of file elem.h.

References libMesh::Elem::_sbd_id.

Referenced by libMesh::DofMap::_dof_indices(), libMesh::BoundaryInfo::_find_id_maps(), libMesh::SyncSubdomainIds::act_on_data(), LinearElasticityWithContact::add_contact_edge_elements(), libMesh::MeshTools::Modification::all_tri(), AllSecondOrderTest::allCompleteOrderRange(), AllSecondOrderTest::allSecondOrderRange(), libMesh::AbaqusIO::assign_subdomain_ids(), libMesh::EquationSystems::build_discontinuous_solution_vector(), MixedDimensionMeshTest::build_mesh(), MixedDimensionNonUniformRefinement::build_mesh(), MixedDimensionNonUniformRefinementTriangle::build_mesh(), MixedDimensionNonUniformRefinement3D::build_mesh(), OverlappingTestBase::build_quad_mesh(), libMesh::InfQuad6::build_side_ptr(), libMesh::MeshTools::Modification::change_subdomain_id(), libMesh::FEGenericBase< FEOutputType< T >::type >::compute_proj_constraints(), libMesh::TriangleWrapper::copy_tri_to_mesh(), libMesh::DofMap::dof_indices(), libMesh::Elem::Elem(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::SubFunctor::find_dofs_to_send(), libMesh::MeshTools::Modification::flatten(), libMesh::SyncSubdomainIds::gather_data(), libMesh::Elem::get_info(), libMesh::VariationalSmootherConstraint::get_neighbors_for_subdomain_constraint(), MeshExtruderTest::QueryElemSubdomainID::get_subdomain_for_layer(), libMesh::UNVIO::groups_in(), libMesh::Elem::inherit_data_from(), libMesh::DofMap::old_dof_indices(), libMesh::PointLocatorNanoflann::operator()(), libMesh::XdrIO::pack_element(), libMesh::Polygon::Polygon(), libMesh::Polyhedron::Polyhedron(), libMesh::CheckpointIO::read_connectivity(), libMesh::GmshIO::read_mesh(), libMesh::DynaIO::read_mesh(), libMesh::Pyramid::side_ptr(), libMesh::Prism::side_ptr(), libMesh::Polygon::side_ptr(), libMesh::InfPrism::side_ptr(), libMesh::InfHex::side_ptr(), libMesh::InfQuad::side_ptr(), libMesh::Elem::simple_side_ptr(), SystemsTest::testDofCouplingWithVarGroups(), MeshExtruderTest::testExtruder(), SystemsTest::testSetSystemParameterOverEquationSystem(), and SystemsTest::tripleValueTest().

 {
   return _sbd_id;
 }

◆ subdomain_id() [2/2]

subdomain_id_type & libMesh::Elem::subdomain_id ( )

inlineinherited

Returns: The subdomain that this element belongs to as a writable reference.

Definition at line 2590 of file elem.h.

References libMesh::Elem::_sbd_id.

 {
   return _sbd_id;
 }

◆ supported_nodal_order()

virtual Order libMesh::Elem::supported_nodal_order ( ) const

inlinevirtualinherited

Returns: The maximum supported approximation order for nodal (Lagrange or Rational Bezier-Bernstein) variables on this element type. This is usually the same as the default order.

Reimplemented in libMesh::NodeElem.

Definition at line 1005 of file elem.h.

References libMesh::Elem::default_order().

Referenced by libMesh::MeshBase::copy_constraint_rows().

1005 { return default_order(); }

libMesh::Elem::default_order

virtual Order default_order() const =0

◆ swap2boundaryedges()

void libMesh::Elem::swap2boundaryedges	(	unsigned short	e1,
		unsigned short	e2,
		BoundaryInfo *	boundary_info
	)		const

protectedinherited

Swaps two edges in boundary_info, if it is non-null.

Definition at line 3556 of file elem.C.

References libMesh::BoundaryInfo::add_edge(), libMesh::BoundaryInfo::edge_boundary_ids(), and libMesh::BoundaryInfo::remove_edge().

Referenced by libMesh::InfQuad4::flip(), libMesh::InfPrism6::flip(), libMesh::InfHex8::flip(), libMesh::Quad4::flip(), libMesh::InfQuad6::flip(), libMesh::C0Polygon::flip(), flip(), libMesh::Tri3::flip(), libMesh::Prism6::flip(), libMesh::InfPrism12::flip(), libMesh::Quad8::flip(), libMesh::Hex8::flip(), libMesh::Quad9::flip(), libMesh::InfHex16::flip(), libMesh::Tri7::flip(), libMesh::Tri6::flip(), libMesh::Pyramid13::flip(), libMesh::InfHex18::flip(), libMesh::Hex20::flip(), libMesh::Tet10::flip(), libMesh::Tet14::flip(), libMesh::Prism15::flip(), libMesh::Tet4::flip(), libMesh::Pyramid14::flip(), libMesh::Pyramid18::flip(), libMesh::Hex27::flip(), libMesh::Prism18::flip(), libMesh::Prism20::flip(), and libMesh::Prism21::flip().

 {
   std::vector<boundary_id_type> ids1, ids2;
   boundary_info->edge_boundary_ids(this, e1, ids1);
   boundary_info->edge_boundary_ids(this, e2, ids2);
   boundary_info->remove_edge(this, e1);
   boundary_info->remove_edge(this, e2);
   if (!ids1.empty())
     boundary_info->add_edge(this, e2, ids1);
   if (!ids2.empty())
     boundary_info->add_edge(this, e1, ids2);
 }

◆ swap2boundarysides()

void libMesh::Elem::swap2boundarysides	(	unsigned short	s1,
		unsigned short	s2,
		BoundaryInfo *	boundary_info
	)		const

protectedinherited

Swaps two sides in boundary_info, if it is non-null.

Definition at line 3540 of file elem.C.

References libMesh::BoundaryInfo::add_side(), libMesh::BoundaryInfo::boundary_ids(), and libMesh::BoundaryInfo::remove_side().

Referenced by libMesh::InfQuad4::flip(), libMesh::InfPrism6::flip(), libMesh::InfHex8::flip(), libMesh::Edge2::flip(), libMesh::Quad4::flip(), libMesh::InfQuad6::flip(), libMesh::C0Polygon::flip(), flip(), libMesh::Edge4::flip(), libMesh::Edge3::flip(), libMesh::Tri3::flip(), libMesh::Prism6::flip(), libMesh::InfPrism12::flip(), libMesh::Quad8::flip(), libMesh::Hex8::flip(), libMesh::Quad9::flip(), libMesh::InfHex16::flip(), libMesh::Tri7::flip(), libMesh::Tri6::flip(), libMesh::Pyramid13::flip(), libMesh::InfHex18::flip(), libMesh::Hex20::flip(), libMesh::Tet10::flip(), libMesh::Tet14::flip(), libMesh::Prism15::flip(), libMesh::Tet4::flip(), libMesh::Pyramid14::flip(), libMesh::Pyramid18::flip(), libMesh::Hex27::flip(), libMesh::Prism18::flip(), libMesh::Prism20::flip(), and libMesh::Prism21::flip().

 {
   std::vector<boundary_id_type> ids1, ids2;
   boundary_info->boundary_ids(this, s1, ids1);
   boundary_info->boundary_ids(this, s2, ids2);
   boundary_info->remove_side(this, s1);
   boundary_info->remove_side(this, s2);
   if (!ids1.empty())
     boundary_info->add_side(this, s2, ids1);
   if (!ids2.empty())
     boundary_info->add_side(this, s1, ids2);
 }

◆ swap2neighbors()

void libMesh::Elem::swap2neighbors	(	unsigned int	n1,
		unsigned int	n2
	)

inlineprotectedinherited

Swaps two neighbor_ptrs.

Definition at line 2102 of file elem.h.

References libMesh::Elem::neighbor_ptr(), and libMesh::Elem::set_neighbor().

Referenced by libMesh::InfQuad4::flip(), libMesh::InfPrism6::flip(), libMesh::InfHex8::flip(), libMesh::Edge2::flip(), libMesh::Quad4::flip(), libMesh::InfQuad6::flip(), libMesh::C0Polygon::flip(), libMesh::Edge4::flip(), flip(), libMesh::Edge3::flip(), libMesh::Tri3::flip(), libMesh::Prism6::flip(), libMesh::InfPrism12::flip(), libMesh::Quad8::flip(), libMesh::Hex8::flip(), libMesh::Quad9::flip(), libMesh::Tri7::flip(), libMesh::InfHex16::flip(), libMesh::Tri6::flip(), libMesh::Pyramid13::flip(), libMesh::InfHex18::flip(), libMesh::Hex20::flip(), libMesh::Tet14::flip(), libMesh::Tet10::flip(), libMesh::Prism15::flip(), libMesh::Tet4::flip(), libMesh::Pyramid14::flip(), libMesh::Pyramid18::flip(), libMesh::Hex27::flip(), libMesh::Prism18::flip(), libMesh::Prism20::flip(), libMesh::Prism21::flip(), libMesh::Prism6::permute(), libMesh::Hex8::permute(), libMesh::Hex20::permute(), libMesh::Prism15::permute(), libMesh::Hex27::permute(), libMesh::Prism20::permute(), libMesh::Prism18::permute(), libMesh::Prism21::permute(), libMesh::Elem::swap3neighbors(), and libMesh::Elem::swap4neighbors().

   {
     Elem * temp = this->neighbor_ptr(n1);
     this->set_neighbor(n1, this->neighbor_ptr(n2));
     this->set_neighbor(n2, temp);
   }

◆ swap2nodes()

void libMesh::Elem::swap2nodes	(	unsigned int	n1,
		unsigned int	n2
	)

inlineprotectedinherited

Swaps two node_ptrs.

Definition at line 2092 of file elem.h.

References libMesh::Elem::node_ptr(), and libMesh::Elem::set_node().

Referenced by libMesh::InfQuad4::flip(), libMesh::InfPrism6::flip(), libMesh::InfHex8::flip(), libMesh::Edge2::flip(), libMesh::Quad4::flip(), libMesh::InfQuad6::flip(), libMesh::C0Polygon::flip(), libMesh::Edge4::flip(), flip(), libMesh::Edge3::flip(), libMesh::Tri3::flip(), libMesh::Prism6::flip(), libMesh::InfPrism12::flip(), libMesh::Quad8::flip(), libMesh::Hex8::flip(), libMesh::Quad9::flip(), libMesh::Tri7::flip(), libMesh::InfHex16::flip(), libMesh::Tri6::flip(), libMesh::Pyramid13::flip(), libMesh::InfHex18::flip(), libMesh::Hex20::flip(), libMesh::Tet14::flip(), libMesh::Tet10::flip(), libMesh::Prism15::flip(), libMesh::Tet4::flip(), libMesh::Pyramid14::flip(), libMesh::Pyramid18::flip(), libMesh::Hex27::flip(), libMesh::Prism18::flip(), libMesh::Prism20::flip(), libMesh::Prism21::flip(), libMesh::Prism6::permute(), libMesh::Hex8::permute(), libMesh::Hex20::permute(), libMesh::Prism15::permute(), libMesh::Hex27::permute(), libMesh::Prism20::permute(), libMesh::Prism18::permute(), libMesh::Prism21::permute(), libMesh::Elem::swap3nodes(), and libMesh::Elem::swap4nodes().

   {
     Node * temp = this->node_ptr(n1);
     this->set_node(n1, this->node_ptr(n2));
     this->set_node(n2, temp);
   }

◆ swap3neighbors()

void libMesh::Elem::swap3neighbors	(	unsigned int	n1,
		unsigned int	n2,
		unsigned int	n3
	)

inlineprotectedinherited

Swaps three neighbor_ptrs, "rotating" them.

Definition at line 2133 of file elem.h.

References libMesh::Elem::swap2neighbors().

Referenced by libMesh::InfPrism6::permute(), libMesh::Tri3::permute(), libMesh::Prism6::permute(), libMesh::InfPrism12::permute(), libMesh::Tri7::permute(), libMesh::Tri6::permute(), libMesh::Tet10::permute(), libMesh::Tet14::permute(), libMesh::Prism15::permute(), libMesh::Tet4::permute(), libMesh::Prism20::permute(), libMesh::Prism18::permute(), libMesh::Prism21::permute(), and libMesh::Elem::swap4neighbors().

   {
     swap2neighbors(n1, n2);
     swap2neighbors(n2, n3);
   }

◆ swap3nodes()

void libMesh::Elem::swap3nodes	(	unsigned int	n1,
		unsigned int	n2,
		unsigned int	n3
	)

inlineprotectedinherited

Swaps three node_ptrs, "rotating" them.

Definition at line 2124 of file elem.h.

References libMesh::Elem::swap2nodes().

Referenced by libMesh::InfPrism6::permute(), libMesh::Tri3::permute(), libMesh::Prism6::permute(), libMesh::InfPrism12::permute(), libMesh::Tri7::permute(), libMesh::Tri6::permute(), libMesh::Tet10::permute(), libMesh::Tet14::permute(), libMesh::Prism15::permute(), libMesh::Tet4::permute(), libMesh::Prism20::permute(), libMesh::Prism18::permute(), libMesh::Prism21::permute(), and libMesh::Elem::swap4nodes().

   {
     swap2nodes(n1, n2);
     swap2nodes(n2, n3);
   }

◆ swap4neighbors()

void libMesh::Elem::swap4neighbors	(	unsigned int	n1,
		unsigned int	n2,
		unsigned int	n3,
		unsigned int	n4
	)

inlineprotectedinherited

Swaps four neighbor_ptrs, "rotating" them.

Definition at line 2153 of file elem.h.

References libMesh::Elem::swap2neighbors(), and libMesh::Elem::swap3neighbors().

Referenced by libMesh::InfHex8::permute(), libMesh::Quad4::permute(), permute(), libMesh::Hex8::permute(), libMesh::Quad8::permute(), libMesh::Quad9::permute(), libMesh::InfHex16::permute(), libMesh::Pyramid13::permute(), libMesh::InfHex18::permute(), libMesh::Hex20::permute(), libMesh::Pyramid14::permute(), libMesh::Pyramid18::permute(), and libMesh::Hex27::permute().

   {
     swap3neighbors(n1, n2, n3);
     swap2neighbors(n3, n4);
   }

◆ swap4nodes()

void libMesh::Elem::swap4nodes	(	unsigned int	n1,
		unsigned int	n2,
		unsigned int	n3,
		unsigned int	n4
	)

inlineprotectedinherited

Swaps four node_ptrs, "rotating" them.

Definition at line 2143 of file elem.h.

References libMesh::Elem::swap2nodes(), and libMesh::Elem::swap3nodes().

Referenced by libMesh::InfHex8::permute(), libMesh::Quad4::permute(), permute(), libMesh::Hex8::permute(), libMesh::Quad8::permute(), libMesh::Quad9::permute(), libMesh::InfHex16::permute(), libMesh::Pyramid13::permute(), libMesh::InfHex18::permute(), libMesh::Hex20::permute(), libMesh::Pyramid14::permute(), libMesh::Pyramid18::permute(), and libMesh::Hex27::permute().

   {
     swap3nodes(n1, n2, n3);
     swap2nodes(n3, n4);
   }

◆ 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 3056 of file elem.h.

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

Referenced by 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(), libMesh::BoundaryInfo::sides_with_boundary_id(), and ExtraIntegersTest::test_final_integers().

 {
   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;
 }

◆ 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 1313 of file elem.C.

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::GhostPointNeighbors::operator()(), libMesh::DefaultCoupling::operator()(), and libMesh::MeshRefinement::topological_neighbor().

 {
   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;
 }

◆ 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 1271 of file elem.C.

References libMesh::PeriodicBoundaries::boundary(), libMesh::Elem::level(), mesh, libMesh::Elem::n_neighbors(), libMesh::PeriodicBoundaries::neighbor(), libMesh::Elem::neighbor_ptr(), and libMesh::Elem::parent().

 {
   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;
 }

◆ topologically_equal()

bool libMesh::Elem::topologically_equal ( const Elem & rhs ) const

inherited

Returns: true if two elements have equal topologies, false otherwise. This is true if the elements connect to nodes of the same id in the same order, and neighbors of the same id on each side, the same id on any parent and/or interior_parent link, etc.

Definition at line 803 of file elem.C.

References libMesh::DofObject::id(), libMesh::Elem::interior_parent(), libMesh::make_range(), libMesh::Elem::n_neighbors(), libMesh::Elem::n_nodes(), libMesh::Elem::neighbor_ptr(), libMesh::Elem::node_id(), libMesh::Elem::parent(), and libMesh::Elem::type().

 {
   // If the elements aren't the same type, they aren't equal
   if (this->type() != rhs.type())
     return false;
 
   libmesh_assert_equal_to(this->n_nodes(), rhs.n_nodes());
 
   for (auto n : make_range(this->n_nodes()))
     if (this->node_id(n) != rhs.node_id(n))
       return false;
 
   for (auto neigh : make_range(this->n_neighbors()))
     {
       if (!this->neighbor_ptr(neigh))
         {
           if (rhs.neighbor_ptr(neigh))
             return false;
           continue;
         }
       if (!rhs.neighbor_ptr(neigh) ||
           this->neighbor_ptr(neigh)->id() !=
           rhs.neighbor_ptr(neigh)->id())
         return false;
     }
 
   if (this->parent())
     {
       if (!rhs.parent())
         return false;
       if (this->parent()->id() != rhs.parent()->id())
         return false;
     }
   else if (rhs.parent())
     return false;
 
   if (this->interior_parent())
     {
       if (!rhs.interior_parent())
         return false;
       if (this->interior_parent()->id() !=
           rhs.interior_parent()->id())
         return false;
     }
   else if (rhs.interior_parent())
     return false;
 
   return true;
 }

◆ 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 2117 of file elem.C.

References libMesh::ElemInternal::total_family_tree().

Referenced by libMesh::Partitioner::set_parent_processor_ids().

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

◆ 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 2125 of file elem.C.

References libMesh::ElemInternal::total_family_tree().

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

◆ 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 2203 of file elem.C.

References libMesh::ElemInternal::total_family_tree_by_neighbor().

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

◆ 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 2212 of file elem.C.

References libMesh::ElemInternal::total_family_tree_by_neighbor().

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

◆ 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 2241 of file elem.C.

References libMesh::ElemInternal::total_family_tree_by_subneighbor().

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

◆ 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 2251 of file elem.C.

References libMesh::ElemInternal::total_family_tree_by_subneighbor().

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

◆ true_centroid()

Point libMesh::Pyramid5::true_centroid ( ) const

overridevirtual

We compute the centroid of the Pyramid by treating it as a degenerate Hex8 element.

Reimplemented from libMesh::Elem.

Definition at line 233 of file cell_pyramid5.C.

References libMesh::Hex8::centroid_from_points(), and libMesh::Elem::point().

 {
   // Call Hex8 static helper function, passing 4 copies of the final
   // vertex point, effectively treating the Pyramid as a degenerate
   // hexahedron.  In my testing, this still seems to give correct
   // results.
   return Hex8::centroid_from_points(
     point(0), point(1), point(2), point(3),
     point(4), point(4), point(4), point(4));
 }

◆ type()

virtual ElemType libMesh::Pyramid5::type ( ) const

inlineoverridevirtual

Returns: PYRAMID.

Implements libMesh::Elem.

Definition at line 78 of file cell_pyramid5.h.

References libMesh::PYRAMID5.

78 { return PYRAMID5; }

libMesh::PYRAMID5

Definition: enum_elem_type.h:53

◆ unique_id()

unique_id_type libMesh::DofObject::unique_id ( ) const

inlineinherited

Returns: The globally unique_id for this DofObject

Definition at line 844 of file dof_object.h.

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::DistributedMesh::add_elem(), libMesh::ReplicatedMesh::add_node(), libMesh::DistributedMesh::add_node(), libMesh::ReplicatedMesh::add_point(), libMesh::MeshTools::Modification::all_tri(), libMesh::C0Polyhedron::disconnected_clone(), libMesh::Elem::disconnected_clone(), libMesh::MeshTools::Modification::flatten(), libMesh::Elem::get_info(), libMesh::ReplicatedMesh::insert_elem(), libMesh::DistributedMesh::insert_elem(), libMesh::ReplicatedMesh::insert_node(), libMesh::XdrIO::pack_element(), libMesh::ExodusII_IO::read_elemental_variable(), SlitMeshRefinedSystemTest::testRestart(), and libMesh::XdrIO::write_serialized_nodes().

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

◆ unpack_indexing()

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

inherited

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

Definition at line 595 of file dof_object.C.

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

 {
   _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)
         {
           if (hdr > 0 || i > 1)
             libmesh_assert_greater_equal (_idx_buf[i], _idx_buf[i-1]);
           else
             libmesh_assert_greater_equal (_idx_buf[i], ns);
           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_less_equal(_idx_buf[ns], _idx_buf.size());
     }
 #endif
 
 #ifdef LIBMESH_ENABLE_AMR
   if (has_old_dof_object)
     {
       this->old_dof_object = this->construct();
       this->old_dof_object->unpack_indexing(begin+size);
     }
 #endif
 }

◆ 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 575 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));
 }

◆ valid_id()

bool libMesh::DofObject::valid_id ( ) const

inlineinherited

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

Definition at line 885 of file dof_object.h.

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::ReplicatedMesh::insert_node(), libMesh::Poly2TriTriangulator::insert_refinement_points(), libMesh::Elem::libmesh_assert_valid_node_pointers(), DofObjectTest< Node >::testInvalidateId(), and DofObjectTest< Node >::testValidId().

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

◆ 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 929 of file dof_object.h.

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

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

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

◆ 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 893 of file dof_object.h.

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::C0Polyhedron::disconnected_clone(), libMesh::Elem::disconnected_clone(), libMesh::Elem::get_info(), libMesh::ReplicatedMesh::insert_elem(), libMesh::DistributedMesh::insert_elem(), libMesh::ReplicatedMesh::insert_node(), and libMesh::DofObject::unique_id().

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

◆ 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 1200 of file dof_object.h.

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

 {
   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;
     }
 }

◆ vertex_average()

Point libMesh::Elem::vertex_average ( ) const

inherited

Returns: A Point at the average of the elment's vertices.

Note: This used to be the base class centroid() implementation, but the centroid is only equal to the vertex average in some special cases. The centroid() implementation now returns the "true" centroid of the element (up to quadrature error).

Definition at line 688 of file elem.C.

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

Referenced by libMesh::Elem::centroid(), libMesh::RBEIMConstruction::enrich_eim_approximation_on_interiors(), libMesh::UnstructuredMesh::find_neighbors(), libMesh::BoundaryInfo::get_side_and_node_maps(), libMesh::Poly2TriTriangulator::insert_refinement_points(), A0::interior_assembly(), A1::interior_assembly(), OutputAssembly::interior_assembly(), SlitFunc::operator()(), libMesh::LocationMap< T >::point_of(), libMesh::RBParametrizedFunction::preevaluate_parametrized_function_on_mesh(), libMesh::SimplexRefiner::refine_via_edges(), libMesh::C0Polygon::retriangulate(), libMesh::FE< Dim, LAGRANGE_VEC >::shape_deriv(), libMesh::FE< Dim, LAGRANGE_VEC >::shape_second_deriv(), DefaultCouplingTest::testCoupling(), PointNeighborCouplingTest::testCoupling(), libMesh::Tri3::true_centroid(), and libMesh::Tet4::true_centroid().

 {
   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));
 }

◆ 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 1317 of file dof_object.h.

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

 {
   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];
 }

◆ volume()

Real libMesh::Pyramid5::volume ( ) const

overridevirtual

Specialization for computing the volume of a pyramid.

Reimplemented from libMesh::Elem.

Definition at line 246 of file cell_pyramid5.C.

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

 {
   // The pyramid with a bilinear base has volume given by the
   // formula in: "Calculation of the Volume of a General Hexahedron
   // for Flow Predictions", AIAA Journal v.23, no.6, 1984, p.954-
   Point
     x0 = point(0), x1 = point(1), x2 = point(2),
     x3 = point(3), x4 = point(4);
 
   // Construct various edge and diagonal vectors.
   Point v40 = x0 - x4;
   Point v13 = x3 - x1;
   Point v02 = x2 - x0;
   Point v03 = x3 - x0;
   Point v01 = x1 - x0;
 
   // Finally, ready to return the volume!
   return
     triple_product(v40, v13, v02) / 6. +
     triple_product(v02, v01, v03) / 12.;
 }

◆ 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 3192 of file elem.h.

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::BoundaryInfo::side_with_boundary_id(), libMesh::BoundaryInfo::sides_with_boundary_id(), libMesh::MeshTools::Modification::smooth(), and libMesh::Parallel::sync_element_data_by_parent_id().

 {
   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;
 }

◆ 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 2919 of file elem.h.

References libMesh::invalid_uint, libMesh::Elem::level(), libMesh::libmesh_assert(), libMesh::make_range(), libMesh::Elem::n_sides(), libMesh::Elem::neighbor_ptr(), and libMesh::Elem::parent().

Referenced by assemble_ellipticdg(), libMesh::EquationSystems::build_discontinuous_solution_vector(), libMesh::BoundaryInfo::clear_stitched_boundary_side_ids(), libMesh::FEGenericBase< FEOutputType< T >::type >::compute_proj_constraints(), libMesh::MeshTools::find_hanging_nodes_and_parents(), libMesh::Poly2TriTriangulator::insert_refinement_points(), libMesh::Elem::libmesh_assert_valid_neighbors(), libMesh::Elem::nullify_neighbors(), libMesh::C0Polyhedron::retriangulate(), and MeshBaseTest::testMeshBaseVerifyIsPrepared().

 {
   libmesh_assert(e);
 
   const Elem * eparent = e;
 
   while (eparent->level() > this->level())
     {
       eparent = eparent->parent();
       libmesh_assert(eparent);
     }
 
   for (auto s : make_range(this->n_sides()))
     if (this->neighbor_ptr(s) == eparent)
       return s;
 
   return libMesh::invalid_uint;
 }

◆ which_node_am_i()

unsigned int libMesh::Elem::which_node_am_i	(	unsigned int	side,
		unsigned int	side_node
	)		const

inherited

This function is deprecated, call local_side_node(side, side_node) instead.

Definition at line 924 of file elem.C.

References libMesh::Elem::local_side_node().

 {
   libmesh_deprecated();
   return local_side_node(side, side_node);
 }

◆ 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 870 of file elem.C.

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

 {
   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;
 }

◆ 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 1731 of file elem.C.

References libMesh::Elem::_nodes, libMesh::Elem::connectivity(), libMesh::INVALID_IO_PACKAGE, libMesh::libmesh_assert(), libMesh::make_range(), libMesh::Elem::n_sub_elem(), libMesh::Elem::node_id(), libMesh::Elem::node_index_range(), libMesh::TECPLOT, and libMesh::UCD.

 {
   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 : make_range(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);
     }
 }

Member Data Documentation

◆ _children

std::unique_ptr<Elem *[]> libMesh::Elem::_children

protectedinherited

unique_ptr to array of this element's children.

A Mesh ultimately owns the child Elems so we are not responsible for deleting them, but we are responsible for cleaning up the array allocated to hold those Elems, hence the unique_ptr.

Definition at line 2261 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(), and libMesh::Elem::set_child().

◆ _counts [1/2]

ReferenceCounter::Counts libMesh::ReferenceCounter::_counts

staticprotectedinherited

Actually holds the data.

Definition at line 124 of file reference_counter.h.

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

◆ _counts [2/2]

ReferenceCounter::Counts libMesh::ReferenceCounter::_counts

staticprotectedinherited

Actually holds the data.

Definition at line 124 of file reference_counter.h.

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

◆ _elemlinks

Elem** libMesh::Elem::_elemlinks

protectedinherited

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

Definition at line 2251 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::Polygon::Polygon(), libMesh::Polyhedron::Polyhedron(), libMesh::Elem::set_interior_parent(), libMesh::Elem::set_neighbor(), and libMesh::Elem::set_parent().

◆ _elemlinks_data

Elem* libMesh::Pyramid::_elemlinks_data[6+(LIBMESH_DIM >3)]

protectedinherited

Data for links to parent/neighbor/interior_parent elements.

Definition at line 209 of file cell_pyramid.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 143 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 143 of file reference_counter.h.

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

◆ _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 2303 of file elem.h.

Referenced by libMesh::Elem::Elem(), libMesh::Elem::mapping_data(), libMesh::Polygon::Polygon(), libMesh::Polyhedron::Polyhedron(), 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 2297 of file elem.h.

Referenced by libMesh::Elem::Elem(), libMesh::Elem::mapping_type(), libMesh::Polygon::Polygon(), libMesh::Polyhedron::Polyhedron(), and libMesh::Elem::set_mapping_type().

◆ _master_points

const Real libMesh::Pyramid::_master_points

staticprotectedinherited

Initial value:

=
  {
    {-1, -1, 0},
    {1, -1, 0},
    {1, 1, 0},
    {-1, 1, 0},
    {0, 0, 1},
    {0, -1, 0},
    {1, 0, 0},
    {0, 1, 0},
    {-1, 0, 0},
    {0, -0.5, 0.5},
    {0.5, 0, 0.5},
    {0, 0.5, 0.5},
    {-0.5, 0, 0.5},
    {0, 0, 0}
  }

Master element node locations.

Definition at line 214 of file cell_pyramid.h.

Referenced by libMesh::Pyramid::master_point().

◆ _mutex [1/2]

Threads::spin_mutex libMesh::ReferenceCounter::_mutex

staticprotectedinherited

Mutual exclusion object to enable thread-safe reference counting.

Definition at line 137 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 137 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 132 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 132 of file reference_counter.h.

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

◆ _nodelinks_data

Node* libMesh::Pyramid5::_nodelinks_data[num_nodes]

protected

Data for links to nodes.

Definition at line 205 of file cell_pyramid5.h.

◆ _nodes

Node** libMesh::Elem::_nodes

protectedinherited

Pointers to the nodes we are connected to.

Definition at line 2245 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 2290 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 2280 of file elem.h.

Referenced by libMesh::Elem::hack_p_level_and_refinement_flag(), libMesh::Elem::p_refinement_flag(), and libMesh::Elem::set_p_refinement_flag().

◆ _rflag

unsigned char libMesh::Elem::_rflag

protectedinherited

h refinement flag.

This is stored as an unsigned char to save space.

Definition at line 2274 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 2267 of file elem.h.

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

◆ adjacent_edges_map

const unsigned int libMesh::Pyramid::adjacent_edges_map

staticprotectedinherited

Initial value:

=
  {
    {0, 3, 4, 99},  
    {0, 1, 5, 99},  
    {1, 2, 6, 99},  
    {2, 3, 7, 99},  
    {4, 5, 6,  7}   
  }

This maps the \( j^{th} \) node to the 3 or 4 edge ids adjacent to the node.

The edge numbering matches the ones used in the derived classes' edge_nodes_map. An edge index of 99 is used to indicate that there is no adjacent edge. This data structure is used in the Pyramid::edges_adjacent_to_node() override and is shared by all the derived Hex types.

Definition at line 235 of file cell_pyramid.h.

Referenced by libMesh::Pyramid::edges_adjacent_to_node().

◆ affine_tol

constexpr Real libMesh::Elem::affine_tol = TOLERANCE*TOLERANCE

staticprotectedinherited

Default tolerance to use in has_affine_map().

Definition at line 2061 of file elem.h.

◆ edge_nodes_map

const unsigned int libMesh::Pyramid5::edge_nodes_map

static

Initial value:

=
  {
    {0, 1}, 
    {1, 2}, 
    {2, 3}, 
    {0, 3}, 
    {0, 4}, 
    {1, 4}, 
    {2, 4}, 
    {3, 4}  
  }

This maps the \( j^{th} \) node of the \( i^{th} \) edge to element node numbers.

Definition at line 176 of file cell_pyramid5.h.

Referenced by is_node_on_edge(), libMesh::Pyramid::local_edge_node(), and nodes_on_edge().

◆ edge_sides_map

const unsigned int libMesh::Pyramid::edge_sides_map

staticinherited

Initial value:

=
  {
    {0, 4}, 
    {1, 4}, 
    {2, 4}, 
    {3, 4}, 
    {0, 3}, 
    {0, 1}, 
    {1, 2}, 
    {2, 3}  
  }

This maps each edge to the sides that contain said edge.

Definition at line 199 of file cell_pyramid.h.

Referenced by libMesh::Pyramid::is_edge_on_side(), and libMesh::Pyramid::sides_on_edge().

◆ 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 482 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 493 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::MeshCommunication::allgather(), libMesh::Node::choose_processor_id(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::SubProjector::construct_projection(), libMesh::MeshTools::correct_node_proc_ids(), libMesh::MeshTools::create_bounding_box(), libMesh::MeshTools::create_nodal_bounding_box(), 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::MeshBase::get_info(), libMesh::DistributedMesh::insert_elem(), 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_constraint_rows(), libMesh::MeshBase::n_elem_on_proc(), libMesh::MeshBase::n_nodes_on_proc(), libMesh::MeshBase::n_unpartitioned_elem(), libMesh::MeshBase::n_unpartitioned_nodes(), libMesh::SparsityPattern::Build::operator()(), libMesh::Partitioner::processor_pairs_to_interface_nodes(), libMesh::Nemesis_IO_Helper::read_var_names_impl(), libMesh::DistributedMesh::renumber_dof_objects(), libMesh::DistributedMesh::renumber_nodes_and_elements(), 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::LaplaceMeshSmoother::smooth(), 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::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 251 of file elem.h.

Referenced by libMesh::BoundaryInfo::_find_id_maps(), libMesh::BoundaryInfo::add_elements(), libMesh::ReplicatedMesh::get_disconnected_subdomains(), libMesh::MeshBase::get_id_by_name(), libMesh::BoundaryInfo::sync(), and MeshSubdomainIDTest::testMultiple().

◆ 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 487 of file dof_object.h.

Referenced by libMesh::DistributedMesh::renumber_dof_objects(), libMesh::DofObject::unique_id(), and libMesh::DofObject::valid_unique_id().

◆ LIBMESH_ENABLE_TOPOLOGY_CACHES

libMesh::Pyramid5::LIBMESH_ENABLE_TOPOLOGY_CACHES

protected

Definition at line 219 of file cell_pyramid5.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 661 of file elem.h.

Referenced by libMesh::Elem::Elem(), and ElemTest< elem_type >::test_static_data().

◆ nodes_per_edge

const int libMesh::Pyramid5::nodes_per_edge = 2

static

Definition at line 164 of file cell_pyramid5.h.

Referenced by libMesh::Pyramid::local_edge_node().

◆ nodes_per_side

const int libMesh::Pyramid5::nodes_per_side = 4

static

Definition at line 163 of file cell_pyramid5.h.

Referenced by libMesh::Pyramid::local_side_node().

◆ num_children

const int libMesh::Pyramid::num_children = 0

staticinherited

Definition at line 79 of file cell_pyramid.h.

◆ num_edges

const int libMesh::Pyramid::num_edges = 8

staticinherited

Definition at line 78 of file cell_pyramid.h.

◆ num_nodes

const int libMesh::Pyramid5::num_nodes = 5

static

Geometric constants for Pyramid5.

Definition at line 162 of file cell_pyramid5.h.

◆ num_sides

const int libMesh::Pyramid::num_sides = 5

staticinherited

Geometric constants for all Pyramids.

Definition at line 77 of file cell_pyramid.h.

Referenced by libMesh::Pyramid14::center_node_on_side(), and libMesh::Pyramid18::center_node_on_side().

◆ old_dof_object

std::unique_ptr<DofObject> libMesh::DofObject::old_dof_object

protectedinherited

This object on the last mesh.

Useful for projecting solutions from one mesh to another.

Public access to old_dof_object is now officially deprecated and will be removed in future libMesh versions. Use the get_old_dof_object() accessor instead.

Definition at line 88 of file dof_object.h.

Referenced by libMesh::DofObject::clear_old_dof_object(), libMesh::DofObject::get_old_dof_object(), libMesh::DofObject::get_old_dof_object_ref(), libMesh::DofObject::operator=(), libMesh::DofObject::pack_indexing(), libMesh::DofObject::packed_indexing_size(), libMesh::DofObject::set_old_dof_object(), and libMesh::DofObject::unpack_indexing().

◆ side_nodes_map

const unsigned int libMesh::Pyramid5::side_nodes_map

static

Initial value:

=
  {
    {0, 1, 4, 99}, 
    {1, 2, 4, 99}, 
    {2, 3, 4, 99}, 
    {3, 0, 4, 99}, 
    {0, 3, 2,  1}  
  }

This maps the \( j^{th} \) node of the \( i^{th} \) side to element node numbers.

Definition at line 170 of file cell_pyramid5.h.

Referenced by build_side_ptr(), libMesh::Pyramid::is_child_on_side(), is_node_on_side(), libMesh::Pyramid::key(), libMesh::Pyramid::local_side_node(), libMesh::Pyramid::low_order_key(), nodes_on_side(), and libMesh::Pyramid::side_ptr().

◆ type_to_default_order_map

const Order libMesh::Elem::type_to_default_order_map

staticinherited

This array maps the integer representation of the ElemType enum to the default approximation order of elements of that type.

This is currently usable even for complicated subclasses with runtime-varying topology.

Definition at line 991 of file elem.h.

Referenced by SystemsTest::test2DProjectVectorFE(), SystemsTest::test3DProjectVectorFE(), ElemTest< elem_type >::test_static_data(), and MeshSmootherTest::testVariationalSmoother().

◆ type_to_dim_map

const unsigned int libMesh::Elem::type_to_dim_map

staticinherited

This array maps the integer representation of the ElemType enum to the geometric dimension of the element.

This is currently usable even for complicated subclasses with runtime-varying topology.

Definition at line 635 of file elem.h.

Referenced by FETestBase< order, family, elem_type, 1 >::setUp(), SystemsTest::test2DProjectVectorFE(), SystemsTest::test3DProjectVectorFE(), ElemTest< elem_type >::test_static_data(), and PointLocatorTest::testLocator().

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

This is only usable for simple types for which the node number is fixed; for more general types like Polygon subclasses an actual instantiated Elem must be queried.

Definition at line 743 of file elem.h.

Referenced by ElemTest< elem_type >::test_static_data().

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

This is only usable for simple types for which the node number is fixed; for more general types like Polygon subclasses an actual instantiated Elem must be queried.

Definition at line 650 of file elem.h.

Referenced by libMesh::DynaIO::ElementDefinition::ElementDefinition(), libMesh::FEAbstract::get_refspace_nodes(), libMesh::XdrIO::pack_element(), libMesh::CheckpointIO::read_connectivity(), libMesh::XdrIO::read_serialized_connectivity(), ElemTest< elem_type >::test_static_data(), MeshGenerationTest::testBuildCube(), MeshGenerationTest::testBuildLine(), and libMesh::ExodusII_IO_Helper::write_elements().

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

This is only usable for simple types for which the node number is fixed; for more general types like Polygon subclasses an actual instantiated Elem must be queried.

Definition at line 685 of file elem.h.

Referenced by ElemTest< elem_type >::test_static_data(), MeshGenerationTest::testBuildCube(), and MeshGenerationTest::testBuildSquare().

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

include/geom/cell_pyramid5.h
src/geom/cell_pyramid5.C

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Typedef Documentation

◆ ConstNeighborPtrIter

◆ Counts [1/2]

◆ Counts [2/2]

◆ NeighborPtrIter

◆ Predicate

Member Enumeration Documentation

◆ RefinementState

Constructor & Destructor Documentation

◆ Pyramid5() [1/3]

◆ Pyramid5() [2/3]

◆ Pyramid5() [3/3]

◆ ~Pyramid5()

Member Function Documentation

◆ _get_bracketing_node_cache()

◆ _get_parent_indices_cache()

◆ 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() [1/2]

◆ add_extra_integers() [2/2]

◆ add_system()

◆ ancestor()

◆ as_parent_node()

◆ boundary_sides_begin()

◆ boundary_sides_end()

◆ bracketing_nodes()

◆ build()

◆ build_edge_ptr() [1/4]

◆ build_edge_ptr() [2/4]

◆ build_edge_ptr() [3/4]

◆ build_edge_ptr() [4/4]

◆ build_side_ptr() [1/12]

◆ build_side_ptr() [2/12]

◆ build_side_ptr() [3/12]

◆ build_side_ptr() [4/12]

◆ build_side_ptr() [5/12]

◆ build_side_ptr() [6/12]

◆ build_side_ptr() [7/12]

◆ build_side_ptr() [8/12]

◆ build_side_ptr() [9/12]

◆ build_side_ptr() [10/12]

◆ build_side_ptr() [11/12]

◆ build_side_ptr() [12/12]

◆ build_with_id()

◆ center_node_on_side()

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

◆ clear_dofs()

◆ clear_old_dof_object()

◆ close_to_point()

◆ coarsen()

◆ complete_order_equivalent_type()

◆ compute_key() [1/4]

◆ compute_key() [2/4]

◆ compute_key() [3/4]

◆ compute_key() [4/4]