Describes a general quadrilateral cell for a 2D hybrid mesh. More...

#include <lf/mesh/hybrid2d/quad.h>

Inheritance diagram for lf::mesh::hybrid2d::Quadrilateral:

Public Member Functions
	Quadrilateral ()=default
	default constructors, needed by std::vector

	~Quadrilateral () override=default

Default and disabled constructors
	Quadrilateral (const Quadrilateral &)=delete

	Quadrilateral (Quadrilateral &&) noexcept=default

Quadrilateral &	operator= (const Quadrilateral &)=delete

Quadrilateral &	operator= (Quadrilateral &&) noexcept=default

	Quadrilateral (size_type index, std::unique_ptr< geometry::Geometry > &&geometry, const Point corner0, const Point corner1, const Point corner2, const Point corner3, const Segment edge0, const Segment edge1, const Segment edge2, const Segment edge3)
	constructor, is called from MeshFactory

unsigned	Codim () const override
	an edge is an entity of co-dimension 1

std::span< const Entity *const >	SubEntities (unsigned rel_codim) const override
	Access to all subentities selected by relative co-dimension.

std::span< const lf::mesh::Orientation >	RelativeOrientations () const override
	Access to relative orientations of edges.

size_type	index () const
	access to index of an entity

Standard methods inherited from Entity object
See also mesh::Entity
const geometry::Geometry *	Geometry () const override
	Describes the geometry of this entity.

base::RefEl	RefEl () const override
	Describes the reference element type of this entity.

bool	operator== (const mesh::Entity &rhs) const override
	Check if two entities are the same.

Public Member Functions inherited from lf::mesh::Entity
bool	operator!= (const Entity &rhs) const
	Check if two entities are different.

virtual	~Entity ()=default
	Virtual Destructor.

Private Types
using	size_type = mesh::Mesh::size_type

Private Attributes
size_type	index_ = -1

std::unique_ptr< geometry::Geometry >	geometry_

std::array< const Point *, 4 >	nodes_ {}

std::array< const Segment *, 4 >	edges_ {}

std::array< lf::mesh::Orientation, 4 >	edge_ori_ {}

Entity *	this_ = nullptr

Additional Inherited Members
Protected Member Functions inherited from lf::mesh::Entity
	Entity ()=default

	Entity (const Entity &)=default

	Entity (Entity &&)=default

Entity &	operator= (const Entity &)=default

Entity &	operator= (Entity &&)=default

Related Symbols inherited from lf::mesh::Entity
void	PrintInfo (std::ostream &stream, const lf::mesh::Entity &e, int output_ctrl=0)
	Prints info about an entity.

Detailed Description

Describes a general quadrilateral cell for a 2D hybrid mesh.

A quadrilateral cell stores and ordered list of four nodes and of four edges, which have to be compatible.

Note: Every Segment object owns a smart pointer to an associated geometry object.

Definition at line 28 of file quad.h.

Member Typedef Documentation

◆ size_type

using lf::mesh::hybrid2d::Quadrilateral::size_type = mesh::Mesh::size_type

private

Definition at line 29 of file quad.h.

Constructor & Destructor Documentation

◆ Quadrilateral() [1/4]

lf::mesh::hybrid2d::Quadrilateral::Quadrilateral ( )

default

default constructors, needed by std::vector

Referenced by operator=(), operator=(), Quadrilateral(), and Quadrilateral().

◆ Quadrilateral() [2/4]

lf::mesh::hybrid2d::Quadrilateral::Quadrilateral ( const Quadrilateral & )

delete

References Quadrilateral().

◆ Quadrilateral() [3/4]

lf::mesh::hybrid2d::Quadrilateral::Quadrilateral ( Quadrilateral && )

defaultnoexcept

References Quadrilateral().

◆ Quadrilateral() [4/4]

lf::mesh::hybrid2d::Quadrilateral::Quadrilateral	(	size_type	index,
		std::unique_ptr< geometry::Geometry > &&	geometry,
		const Point *	corner0,
		const Point *	corner1,
		const Point *	corner2,
		const Point *	corner3,
		const Segment *	edge0,
		const Segment *	edge1,
		const Segment *	edge2,
		const Segment *	edge3 )

explicit

constructor, is called from MeshFactory

Parameters

index	index of the entity to be created; will usually be retrieved via the `Index()` method of `Mesh`
geometry	pointer to a geometry object providing the shape of the cell
corner0	pointer to first node
corner1	pointer to second node
corner2	pointer to third node
corner3	pointer to fourth node
edge0	pointer to first edge
edge1	pointer to second edge
edge2	pointer to third edge
edge3	pointer to fourth edge

The sub-entities have to be consistent according to the conventions fixed for a reference element of type kTria.

Note: Note that you need to create a suitable geometry object for the entity before you can initialize the entity object itseld.

Definition at line 15 of file quad.cc.

References geometry_, index(), index_, and nodes_.

◆ ~Quadrilateral()

lf::mesh::hybrid2d::Quadrilateral::~Quadrilateral ( )

overridedefault

Member Function Documentation

◆ Codim()

unsigned lf::mesh::hybrid2d::Quadrilateral::Codim ( ) const

inlinenodiscardoverridevirtual

an edge is an entity of co-dimension 1

Implements lf::mesh::Entity.

Definition at line 73 of file quad.h.

References Codim().

Referenced by Codim().

◆ Geometry()

const geometry::Geometry * lf::mesh::hybrid2d::Quadrilateral::Geometry ( ) const

inlinenodiscardoverridevirtual

Describes the geometry of this entity.

Returns: A pointer to a Geometry object that will remain valid for as long as the Mesh remains valid.

Why does this member function return a pointer instead of a reference? One reason is that entities without a geometric shape are conceivable as building block of a "mesh graph", where only topological information matters. Another reason is that during the construction of a mesh, it turns out to be convenient to build entities "without geometry" first and then endow them with geometric information. A nullptr is a good way to indicate missing geometric information.

Implements lf::mesh::Entity.

Definition at line 103 of file quad.h.

References geometry_.

Referenced by operator=().

◆ index()

size_type lf::mesh::hybrid2d::Quadrilateral::index ( ) const

inlinenodiscard

access to index of an entity

Definition at line 96 of file quad.h.

References index_.

Referenced by operator=(), and Quadrilateral().

◆ operator=() [1/2]

Quadrilateral & lf::mesh::hybrid2d::Quadrilateral::operator= ( const Quadrilateral & )

delete

References Quadrilateral().

◆ operator=() [2/2]

Quadrilateral & lf::mesh::hybrid2d::Quadrilateral::operator= ( Quadrilateral && )

defaultnoexcept

References Geometry(), index(), and Quadrilateral().

◆ operator==()

bool lf::mesh::hybrid2d::Quadrilateral::operator== ( const mesh::Entity & rhs ) const

inlinenodiscardoverridevirtual

Check if two entities are the same.

Parameters

rhs	Check if this entity is the same as the rhs entity.

Note: The behavior of this method is undefined if the rhs entity belongs to a different Mesh.

Implements lf::mesh::Entity.

Definition at line 109 of file quad.h.

◆ RefEl()

base::RefEl lf::mesh::hybrid2d::Quadrilateral::RefEl ( ) const

inlinenodiscardoverridevirtual

Describes the reference element type of this entity.

Returns: An object of type lf::base::RefEl.

Implements lf::mesh::Entity.

Definition at line 106 of file quad.h.

References lf::base::RefEl::kQuad().

◆ RelativeOrientations()

std::span< const lf::mesh::Orientation > lf::mesh::hybrid2d::Quadrilateral::RelativeOrientations ( ) const

inlinenodiscardoverridevirtual

Access to relative orientations of edges.

See also: mesh::Orientation

Implements lf::mesh::Entity.

Definition at line 90 of file quad.h.

References edge_ori_.

◆ SubEntities()

std::span< const mesh::Entity *const > lf::mesh::hybrid2d::Quadrilateral::SubEntities ( unsigned rel_codim ) const

nodiscardoverridevirtual

Access to all subentities selected by relative co-dimension.

Parameters

rel_codim if 1 select edges, if 2 select nodes, if 0 select cell itself

Returns

for rel_codim == 1: return range with quadrilateral itself as only element
for rel_codim == 1: return 4-range covering corners
for rel_codim == 2: return 4-range containing the edges

Implements lf::mesh::Entity.

Definition at line 84 of file quad.cc.

References edges_, lf::mesh::Entity::Entity(), nodes_, and this_.

Member Data Documentation

◆ edge_ori_

std::array<lf::mesh::Orientation, 4> lf::mesh::hybrid2d::Quadrilateral::edge_ori_ {}

private

Definition at line 122 of file quad.h.

Referenced by RelativeOrientations().

◆ edges_

std::array<const Segment*, 4> lf::mesh::hybrid2d::Quadrilateral::edges_ {}

private

Definition at line 120 of file quad.h.

Referenced by SubEntities().

◆ geometry_

std::unique_ptr<geometry::Geometry> lf::mesh::hybrid2d::Quadrilateral::geometry_

private

Definition at line 118 of file quad.h.

Referenced by Geometry(), and Quadrilateral().

◆ index_

size_type lf::mesh::hybrid2d::Quadrilateral::index_ = -1

private

Definition at line 117 of file quad.h.

Referenced by index(), and Quadrilateral().

◆ nodes_

std::array<const Point*, 4> lf::mesh::hybrid2d::Quadrilateral::nodes_ {}

private

Definition at line 119 of file quad.h.

Referenced by Quadrilateral(), and SubEntities().

◆ this_

Entity* lf::mesh::hybrid2d::Quadrilateral::this_ = nullptr

private

Definition at line 123 of file quad.h.

Referenced by SubEntities().

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

/home/runner/work/lehrfempp/lehrfempp/lib/lf/mesh/hybrid2d/quad.h
/home/runner/work/lehrfempp/lehrfempp/lib/lf/mesh/hybrid2d/quad.cc

Public Member Functions

Private Types

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ size_type

Constructor & Destructor Documentation

◆ Quadrilateral() [1/4]

◆ Quadrilateral() [2/4]

◆ Quadrilateral() [3/4]

◆ Quadrilateral() [4/4]

◆ ~Quadrilateral()

Member Function Documentation

◆ Codim()

◆ Geometry()

◆ index()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ RefEl()

◆ RelativeOrientations()

◆ SubEntities()

Member Data Documentation

◆ edge_ori_

◆ edges_

◆ geometry_

◆ index_

◆ nodes_

◆ this_