MoReFEM: MoReFEM::GeometricElt Class Reference

MoReFEM::GeometricElt::GeometricElt ( MeshNS::unique_id mesh_unique_id )

explicit

Minimal constructor: only the Mesh for which the current geometric element is created is provided.

Parameters

[in] mesh_unique_id Unique identifier of the mesh (which is what is returned by Mesh::GetUniqueId() method).

MoReFEM::GeometricElt::GeometricElt	(	MeshNS::unique_id	mesh_unique_id,
		const Coords::vector_shared_ptr &	mesh_coords_list,
		GeomEltNS::index_type	index,
		std::vector< CoordsNS::index_from_mesh_file > &&	coords_indexes )

explicit

Constructor from vector.

Minimal constructor: only the Mesh for which the current geometric element is created is provided.

Parameters

[in]	mesh_unique_id	Unique identifier of the mesh (which is what is returned by Mesh::GetUniqueId() method).
[in]	index	Index associated to the geometric element in the mesh.

Parameters

[in] coords_indexes Indexes of the Coords to pick from mesh_coords_list.

Parameters

[in] mesh_coords_list List of ALL Coords list built from the mesh.

MoReFEM::GeometricElt::GeometricElt	(	MeshNS::unique_id	mesh_unique_id,
		const Coords::vector_shared_ptr &	mesh_coords_list,
		std::vector< CoordsNS::index_from_mesh_file > &&	coords_indexes )

explicit

Constructor from vector; index is left undefined.

Minimal constructor: only the Mesh for which the current geometric element is created is provided.

Parameters

[in] mesh_unique_id Unique identifier of the mesh (which is what is returned by Mesh::GetUniqueId() method).

Parameters

[in] coords_indexes Indexes of the Coords to pick from mesh_coords_list.

Parameters

[in] mesh_coords_list List of ALL Coords list built from the mesh.

Index should be specified through dedicated method SetIndex

MoReFEM::GeometricElt::GeometricElt ( const GeometricElt & rhs )

explicitdelete

The copy constructor.

Parameters

[in] rhs The object from which the construction occurs.

MoReFEM::GeometricElt::GeometricElt ( GeometricElt && rhs )

explicitdelete

The move constructor.

Parameters

[in] rhs The object from which the construction occurs.

GeometricElt & MoReFEM::GeometricElt::operator= ( const GeometricElt & rhs )

delete

The (copy) operator=.

Parameters

[in] rhs The object from which the affectation occurs.

Returns: Reference to the object (to enable chained affectation).

GeometricElt & MoReFEM::GeometricElt::operator= ( GeometricElt && rhs )

delete

The (move) operator=.

Parameters

[in] rhs The object from which the affectation occurs.

Returns: Reference to the object (to enable chained affectation).

virtual std::size_t MoReFEM::GeometricElt::Ncoords ( ) const

pure virtual

Get the number of Coords object required to characterize completely a GeometricElt of this type.

For instance 27 for an Hexahedron27.

Returns: Number of Coords object required to characterize completely a GeometricElt of this type.

virtual std::size_t MoReFEM::GeometricElt::Nvertex ( ) const

pure virtual

Get the number of vertice.

virtual std::size_t MoReFEM::GeometricElt::Nedge ( ) const

pure virtual

Get the number of edges.

virtual std::size_t MoReFEM::GeometricElt::Nface ( ) const

pure virtual

Get the number of faces.

virtual std::size_t MoReFEM::GeometricElt::GetDimension ( ) const

pure virtual

Get the dimension of the geometric element.

virtual Advanced::GeometricEltEnum MoReFEM::GeometricElt::GetIdentifier ( ) const

pure virtual

Get the identifier of the geometric element.

virtual const RefGeomElt & MoReFEM::GeometricElt::GetRefGeomElt ( ) const

pure virtual

Get a reference to the reference geometric element.

virtual const Advanced::GeomEltNS::GenericName & MoReFEM::GeometricElt::GetName ( ) const

pure virtual

Get the string name of the geometric element (e.g. 'Triangle3', 'Segment2', etc...).

void MoReFEM::GeometricElt::SetIndex ( GeomEltNS::index_type index )

noexcept

Mutator to the GeometricElt index.

Parameters

[in] index New index to set.

GeomEltNS::index_type MoReFEM::GeometricElt::GetIndex ( ) const

inline

Accessor to the GeometricElt index.

This index is assumed to be unique for a given Mesh: no other geometric element should bear the same index (Mesh enforces that when the mesh is read).

This uniqueness is important: indexes are used to compare elements, and also to define a hash function when GeometricElt are put in an unordered_map.

However, a check upon the mesh is also required: same index might be used by two different meshes for two unrelated geometric elements.

MeshNS::unique_id MoReFEM::GeometricElt::GetMeshIdentifier ( ) const

noexcept

Get the identifier of the mesh.

You shouldn't have to use this: it is used mostly to implement the comparison operators.

Returns: Index that tags the mesh.

void MoReFEM::GeometricElt::SetMeshLabel ( const MeshLabel::const_shared_ptr & mesh_label )

noexcept

Set the label.

Parameters

[in] mesh_label MeshLabel associated to the current GeometricElt.

const Coords & MoReFEM::GeometricElt::GetCoord ( std::size_t i ) const

Get the ith coords index.

Parameters

i	Index of the sought Coords object used to define the geometric element.

const Vertex::vector_shared_ptr & MoReFEM::GeometricElt::GetVertexList ( ) const

noexcept

Return the list of vertice.

Returns: The list of vertice (as smart pointers).

const OrientedEdge::vector_shared_ptr & MoReFEM::GeometricElt::GetOrientedEdgeList ( ) const

Return the list of edges.

This method assumes the edges were already built by the mesh; if not an exception is thrown.

Returns: The list of edges (as smart pointers).

const OrientedFace::vector_shared_ptr & MoReFEM::GeometricElt::GetOrientedFaceList ( ) const

Return the list of faces.

This method assumes the faces were already built by the mesh; if not an exception is thrown.

Returns: The list of faces (as smart pointers).

Volume::shared_ptr MoReFEM::GeometricElt::GetVolumePtr ( ) const

Return the volume (as an interface).

This method assumes the volume were already built by the mesh; if not an exception is thrown.

Returns: The volume interface. Might be nullptr!

void MoReFEM::GeometricElt::SetVertexList ( Vertex::vector_shared_ptr && vertex_list )

Set the list of vertice.

Parameters

[in] vertex_list List of Vertex related to the geometric element.

void MoReFEM::GeometricElt::SetOrientedEdgeList ( OrientedEdge::vector_shared_ptr && edge_list )

Set the list of edges (with their orientation).

Parameters

[in] edge_list List of OrientedEdge related to the geometric element.

void MoReFEM::GeometricElt::SetOrientedFaceList ( OrientedFace::vector_shared_ptr && face_list )

Set the list of faces (with their orientation).

Parameters

[in] face_list List of OrientedFace related to the geometric element.

void MoReFEM::GeometricElt::SetVolume ( const Volume::shared_ptr & volume )

Set the volume interface.

Parameters

[in] volume New value to set.

template<class InterfaceT >

void MoReFEM::GeometricElt::BuildInterface	(	const GeometricElt *	geom_elt_ptr,
		typename InterfaceT::InterfaceMap &	interface_list )

Build a new interface, regardless of the orientation.

Template Parameters

InterfaceT Interface type, which derives from Interface base class. Choices are among { Vertex, Edge, Face, Volume }.

Parameters

[in]	geom_elt_ptr	Pointer to current GeometricElt; must point to same object as this. This is rather clumsy, but I lack the time currently to fix something that is clumsy but ultimately not broken.
[in,out]	interface_list	List of InterfaceT under construction when current method is called. If interface is not yet there it is added at the end of the method call.

virtual double MoReFEM::GeometricElt::ShapeFunction	(	LocalNodeNS::index_type	local_node_index,
		const LocalCoords &	local_coords ) const

pure virtual

Shape function call.

Parameters

[in]	local_node_index	Index of the local node considered.
[in]	local_coords	Local coordinates at which the shape function is applied.

Returns: Shape function value at the local node considered.

virtual double MoReFEM::GeometricElt::FirstDerivateShapeFunction	(	LocalNodeNS::index_type	local_node_index,
		Advanced::ComponentNS::index_type	component,
		const LocalCoords &	local_coords ) const

pure virtual

First derivate of the shape function call.

Parameters

[in]	local_node_index	Index of the local node considered.
[in]	local_coords	Local coordinates at which the shape function is applied.
[in]	component	Component of the derivate considered.

Returns: Derivate of the shape function wrt to component at the local node considered.

virtual double MoReFEM::GeometricElt::SecondDerivateShapeFunction	(	LocalNodeNS::index_type	local_node_index,
		Advanced::ComponentNS::index_type	component1,
		Advanced::ComponentNS::index_type	component2,
		const LocalCoords &	local_coords ) const

pure virtual

Second derivate of the shape function call.

Parameters

[in]	local_node_index	Index of the local node considered.
[in]	local_coords	Local coordinates at which the shape function is applied.
[in]	component1	Component of the first derivate considered.
[in]	component2	Component of the second derivate considered.

Returns: Derivate of the shape function wrt to component1 and component2 at the local node considered.

virtual void MoReFEM::GeometricElt::BuildVertexList	(	const GeometricElt *	geom_elt_ptr,
		Vertex::InterfaceMap &	existing_list )

privatepure virtual

Build the list of all vertices that belongs to the geometric element.

Parameters

[in,out] existing_list List of all vertice that have been built so far for the enclosing geometric mesh. If a vertex already exists, point to the already existing object instead of recreating one. If not, create a new object from scratch and add it in the existing_list.

Parameters

[in] geom_elt_ptr Pointer to current GeometricElt; must point to same object as this. This is rather clumsy, but I lack the time currently to fix something that is clumsy but ultimately not broken.

virtual void MoReFEM::GeometricElt::BuildEdgeList	(	const GeometricElt *	geom_elt_ptr,
		Edge::InterfaceMap &	existing_list )

privatepure virtual

Build the list of all edges that belongs to the geometric element.

Parameters

[in]	geom_elt_ptr	Pointer to current GeometricElt; must point to same object as this. This is rather clumsy, but I lack the time currently to fix something that is clumsy but ultimately not broken.
[in,out]	existing_list	List of all edges that have been built so far for the enclosing geometric mesh. If an edge already exists, point to the already existing object instead of recreating one. If not, create a new object from scratch and add it in the existing_list.

virtual void MoReFEM::GeometricElt::BuildFaceList	(	const GeometricElt *	geom_elt_ptr,
		Face::InterfaceMap &	existing_list )

privatepure virtual

Build the list of all faces that belongs to the geometric element.

Parameters

[in]	geom_elt_ptr	Pointer to current GeometricElt; must point to same object as this. This is rather clumsy, but I lack the time currently to fix something that is clumsy but ultimately not broken.
[in,out]	existing_list	List of all faces that have been built so far for the enclosing geometric mesh. If a face already exists, point to the already existing object instead of recreating one. If not, create a new object from scratch and add it in the existing_list.

virtual void MoReFEM::GeometricElt::BuildVolumeList	(	const GeometricElt *	geom_elt_ptr,
		Volume::InterfaceMap &	existing_list )

privatepure virtual

Build the list of all faces that belongs to the geometric element.

Parameters

[in]	geom_elt_ptr	Pointer to current GeometricElt; must point to same object as this. This is rather clumsy, but I lack the time currently to fix something that is clumsy but ultimately not broken.
[in,out]	existing_list	List of all faces that have been built so far for the enclosing geometric mesh. If a face already exists, point to the already existing object instead of recreating one. If not, create a new object from scratch and add it in the existing_list.

[internal] As there is at most one volume by GeometricElt, and this volume can't therefore be shared with others geometric elements, we could have handled it differently from other interfaces. But the little efficiency we could have gained would have to be paid with maintenance cost; hence the choice to use a same mechanism for all the interfaces.

const Advanced::GeomEltNS::EnsightName & MoReFEM::GeometricElt::GetEnsightName ( ) const

Ensight-related methods.

Get the ensight name of the geometric element (e.g. 'tria3', 'bar2', etc...)

An exception is thrown if Medit format is not supported.

Returns: Ensight name (acts as an identifier for Ensight).

virtual void MoReFEM::GeometricElt::WriteEnsightFormat	(	std::ostream &	stream,
		bool	do_print_index ) const

pure virtual

Write the geometric element in Ensight format.

Parameters

[in,out]	stream	Stream upon which object information are written.
[in]	do_print_index	True if the geometric element is preceded by its internal index.

GmfKwdCod MoReFEM::GeometricElt::GetMeditIdentifier ( ) const

Medit-related methods.

Get the identifier Medit use to tag the geometric element.

An exception is thrown if Medit format is not supported.

Returns: Identifier.

virtual void MoReFEM::GeometricElt::WriteMeditFormat	(	libmeshb_int	mesh_index,
		const std::unordered_map< ::MoReFEM::CoordsNS::index_from_mesh_file, int > &	processor_wise_reindexing ) const

pure virtual

Write the geometric elementin Medit format.

Parameters

[in]	mesh_index	Index that was returned by Medit when the output file was opened.
[in]	processor_wise_reindexing	Medit requires the indexes run from 1 to Ncoord on each processor; this container maps the Coords index to the processor-wise one to write in the Medit file.

The method is indeed an underlying call to the Medit API.

virtual void MoReFEM::GeometricElt::ReadMeditFormat	(	const FilesystemNS::File &	medit_file,
		const Coords::vector_shared_ptr &	mesh_coords_list,
		libmeshb_int	libmesh_mesh_index,
		std::size_t	Ncoord_in_mesh,
		int &	reference_index )

pure virtual

Read the geometric element in Medit format.

Parameters

[in]	libmesh_mesh_index	Index that was returned by Medit when the input file was opened.
[in]	Ncoord_in_mesh	Total number of coord in the mesh. Used for a check upon file validity.
[out]	reference_index	Reference of the label, as libmesh int index. The calling function has the responsibility to use (or not) this value and Set the label pointer in GeometricElt object.

Parameters

[in]	mesh_coords_list	List of ALL Coords list built from the mesh.
[in]	medit_file	File being read.

The method is indeed an underlying call to the Medit API.

void MoReFEM::GeometricElt::SetCoordsList	(	const Coords::vector_shared_ptr &	mesh_coords_list,
		std::vector< CoordsNS::index_from_mesh_file > &&	coords_indexes )

protected

Set the coord list from the vector given in input.

Parameters

[in] coords_indexes Indexes of the Coords to pick from mesh_coords_list.

Parameters

[in] mesh_coords_list List of ALL Coords list built from the mesh.

Beware: an error will be raised if the input vector size is not what is expected !

template<InterfaceNS::Nature InterfaceT>

void MoReFEM::GeometricElt::SetInterfaceListBuilt ( )

protected

Tells the object edges or faces have been built.

Template Parameters

InterfaceT Interface type, which derives from Interface base class. Choices are among { Vertex, Edge, Face, Volume }.

GeomEltNS::index_type MoReFEM::GeometricElt::index_ = NumericNS::UninitializedIndex<decltype(index_)>()

private

Index associated to the current geometric element.

This index is assumed to be unique for a given Mesh: no other geometric element should bear the same index (Mesh enforces that when the mesh is read).

This uniqueness is important: indexes are used to compare elements, and also to define a hash function when GeometricElt are put in an unordered_map.

However, a check upon the mesh is also required: same index might be used by two different meshes for two unrelated geometric elements.

Public Types
using	unique_ptr = std::unique_ptr<GeometricElt>
	Alias for unique pointer.

using	shared_ptr = std::shared_ptr<GeometricElt>
	Alias for shared pointer.

using	vector_shared_ptr = std::vector<shared_ptr>
	Alias for vector of pointers.

Friends
class	PostProcessingNS::OutputDeformedMesh
	Friendship to allow call to SetCoordsList().

Public Member Functions
virtual std::size_t	Ncoords () const =0
	Get the number of Coords object required to characterize completely a GeometricElt of this type.

virtual std::size_t	Nvertex () const =0
	Get the number of vertice.

virtual std::size_t	Nedge () const =0
	Get the number of edges.

virtual std::size_t	Nface () const =0
	Get the number of faces.

virtual std::size_t	GetDimension () const =0
	Get the dimension of the geometric element.

virtual Advanced::GeometricEltEnum	GetIdentifier () const =0
	Get the identifier of the geometric element.

virtual const RefGeomElt &	GetRefGeomElt () const =0
	Get a reference to the reference geometric element.

virtual const Advanced::GeomEltNS::GenericName &	GetName () const =0
	Get the string name of the geometric element (e.g. 'Triangle3', 'Segment2', etc...).

void	SetIndex (GeomEltNS::index_type index) noexcept

GeomEltNS::index_type	GetIndex () const

MeshNS::unique_id	GetMeshIdentifier () const noexcept
	Get the identifier of the mesh.

void	SetMeshLabel (const MeshLabel::const_shared_ptr &mesh_label) noexcept

MeshLabel::const_shared_ptr	GetMeshLabelPtr () const noexcept
	Get the label.

const Coords::vector_shared_ptr &	GetCoordsList () const noexcept
	Get the coords as a vector.

const Coords &	GetCoord (std::size_t i) const

const Vertex::vector_shared_ptr &	GetVertexList () const noexcept
	Return the list of vertice.

const OrientedEdge::vector_shared_ptr &	GetOrientedEdgeList () const
	Return the list of edges.

const OrientedFace::vector_shared_ptr &	GetOrientedFaceList () const
	Return the list of faces.

Volume::shared_ptr	GetVolumePtr () const
	Return the volume (as an interface).

void	SetVertexList (Vertex::vector_shared_ptr &&vertex_list)
	Set the list of vertice.

void	SetOrientedEdgeList (OrientedEdge::vector_shared_ptr &&edge_list)
	Set the list of edges (with their orientation).

void	SetOrientedFaceList (OrientedFace::vector_shared_ptr &&face_list)
	Set the list of faces (with their orientation).

void	SetVolume (const Volume::shared_ptr &volume)
	Set the volume interface.

template<class InterfaceT >
void	BuildInterface (const GeometricElt *geom_elt_ptr, typename InterfaceT::InterfaceMap &interface_list)
	Build a new interface, regardless of the orientation.

Special members.
	GeometricElt (MeshNS::unique_id mesh_unique_id)
	Minimal constructor: only the Mesh for which the current geometric element is created is provided.

	GeometricElt (MeshNS::unique_id mesh_unique_id, const Coords::vector_shared_ptr &mesh_coords_list, GeomEltNS::index_type index, std::vector< CoordsNS::index_from_mesh_file > &&coords_indexes)
	Constructor from vector.

	GeometricElt (MeshNS::unique_id mesh_unique_id, const Coords::vector_shared_ptr &mesh_coords_list, std::vector< CoordsNS::index_from_mesh_file > &&coords_indexes)
	Constructor from vector; index is left undefined.

virtual	~GeometricElt ()
	Destructor.

	GeometricElt (const GeometricElt &rhs)=delete
	The copy constructor.

	GeometricElt (GeometricElt &&rhs)=delete
	The move constructor.

GeometricElt &	operator= (const GeometricElt &rhs)=delete
	The (copy) operator=.

GeometricElt &	operator= (GeometricElt &&rhs)=delete
	The (move) operator=.

Shape function methods.
const MeshNS::unique_id	mesh_identifier_
	Identifier of the mesh.

GeomEltNS::index_type	index_ = NumericNS::UninitializedIndex<decltype(index_)>()
	Index associated to the current geometric element.

MeshLabel::const_shared_ptr	mesh_label_ = nullptr
	Surface reference to which the geometric element belongs to.

Coords::vector_shared_ptr	coords_list_
	Coords that belong to the geometric element.

Vertex::vector_shared_ptr	vertex_list_
	List of vertice.

OrientedEdge::vector_shared_ptr	oriented_edge_list_
	List of edges.

OrientedFace::vector_shared_ptr	oriented_face_list_
	List of faces.

Volume::shared_ptr	volume_ = nullptr
	Volume (as an interface).

InterfaceNS::Nature	higher_interface_type_built_ = InterfaceNS::Nature::undefined
	Knows whether a given type of interface has been built or not.

virtual double	ShapeFunction (LocalNodeNS::index_type local_node_index, const LocalCoords &local_coords) const =0
	Shape function call.

virtual double	FirstDerivateShapeFunction (LocalNodeNS::index_type local_node_index, Advanced::ComponentNS::index_type component, const LocalCoords &local_coords) const =0
	First derivate of the shape function call.

virtual double	SecondDerivateShapeFunction (LocalNodeNS::index_type local_node_index, Advanced::ComponentNS::index_type component1, Advanced::ComponentNS::index_type component2, const LocalCoords &local_coords) const =0
	Second derivate of the shape function call.

const Advanced::GeomEltNS::EnsightName &	GetEnsightName () const
	Ensight-related methods.

virtual void	WriteEnsightFormat (std::ostream &stream, bool do_print_index) const =0
	Write the geometric element in Ensight format.

GmfKwdCod	GetMeditIdentifier () const
	Medit-related methods.

virtual void	WriteMeditFormat (libmeshb_int mesh_index, const std::unordered_map< ::MoReFEM::CoordsNS::index_from_mesh_file, int > &processor_wise_reindexing) const =0
	Write the geometric elementin Medit format.

virtual void	ReadMeditFormat (const FilesystemNS::File &medit_file, const Coords::vector_shared_ptr &mesh_coords_list, libmeshb_int libmesh_mesh_index, std::size_t Ncoord_in_mesh, int &reference_index)=0
	Read the geometric element in Medit format.

virtual void	BuildVertexList (const GeometricElt *geom_elt_ptr, Vertex::InterfaceMap &existing_list)=0
	Build the list of all vertices that belongs to the geometric element.

virtual void	BuildEdgeList (const GeometricElt *geom_elt_ptr, Edge::InterfaceMap &existing_list)=0
	Build the list of all edges that belongs to the geometric element.

virtual void	BuildFaceList (const GeometricElt *geom_elt_ptr, Face::InterfaceMap &existing_list)=0
	Build the list of all faces that belongs to the geometric element.

virtual void	BuildVolumeList (const GeometricElt *geom_elt_ptr, Volume::InterfaceMap &existing_list)=0
	Build the list of all faces that belongs to the geometric element.

void	SetCoordsList (const Coords::vector_shared_ptr &mesh_coords_list, std::vector< CoordsNS::index_from_mesh_file > &&coords_indexes)
	Set the coord list from the vector given in input.

template<InterfaceNS::Nature InterfaceT>
void	SetInterfaceListBuilt ()
	Tells the object edges or faces have been built.

Public Types

Public Member Functions

Friends

Shape function methods.

Detailed Description

Constructor & Destructor Documentation

◆ GeometricElt() [1/5]

◆ GeometricElt() [2/5]

◆ GeometricElt() [3/5]

◆ GeometricElt() [4/5]

◆ GeometricElt() [5/5]

Member Function Documentation

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ Ncoords()

◆ Nvertex()

◆ Nedge()

◆ Nface()

◆ GetDimension()

◆ GetIdentifier()

◆ GetRefGeomElt()

◆ GetName()

◆ SetIndex()

◆ GetIndex()

◆ GetMeshIdentifier()

◆ SetMeshLabel()

◆ GetCoord()

◆ GetVertexList()

◆ GetOrientedEdgeList()

◆ GetOrientedFaceList()

◆ GetVolumePtr()

◆ SetVertexList()

◆ SetOrientedEdgeList()

◆ SetOrientedFaceList()

◆ SetVolume()

◆ BuildInterface()

◆ ShapeFunction()

◆ FirstDerivateShapeFunction()

◆ SecondDerivateShapeFunction()

◆ BuildVertexList()

◆ BuildEdgeList()

◆ BuildFaceList()

◆ BuildVolumeList()

◆ GetEnsightName()

◆ WriteEnsightFormat()

◆ GetMeditIdentifier()

◆ WriteMeditFormat()

◆ ReadMeditFormat()

◆ SetCoordsList()

◆ SetInterfaceListBuilt()

Field Documentation

◆ index_