Comfort class. Provides getter functions to access the mesh member variables more comfortably. More...

#include <SF_fem_utils.h>

Collaboration diagram for SF::element_view< T, S >:

Public Member Functions
	element_view (const meshdata< T, S > &mesh, const SF_nbr nbr)
	Constructor. Initializes to element index 0. More...

void	set_elem (size_t eidx)
	Set the view to a new element. More...

bool	next ()
	Select next element if possible. More...

T	num_nodes () const
	Getter function for the number of nodes. More...

elem_t	type () const
	Getter function for the element type. More...

T	tag () const
	Getter function for the element tag. More...

const T &	node (short nidx) const
	Access the connectivity information. More...

const T &	global_node (short nidx) const
	Access the connectivity information. More...

const T &	global_node (short nidx, SF_nbr nbr) const
	Access the connectivity information. More...

const T *	nodes () const
	Access the connectivity information. More...

Point	coord (short nidx) const
	Access vertex coordinates. More...

Point	fiber () const
	Get element fiber direction. More...

Point	sheet () const
	Get element sheet direction. More...

bool	has_sheet () const
	Check if a sheet direction is present. More...

size_t	element_index () const
	Get currently selected element index. More...

size_t	global_element_index () const
	Get currently selected element index. More...

size_t	global_element_index (SF_nbr nbr) const
	Get currently selected element index. More...

short	num_dof (short order) const

void	integration_points (const short order, Point ip, double w, int &nint) const

short	dimension () const

Detailed Description

template<class T, class S>
class SF::element_view< T, S >

Comfort class. Provides getter functions to access the mesh member variables more comfortably.

Template Parameters

T	Integer type.
S	Floating point type.

Definition at line 704 of file SF_fem_utils.h.

Constructor & Destructor Documentation

◆ element_view()

template<class T, class S>

SF::element_view< T, S >::element_view	(	const meshdata< T, S > &	mesh,
		const SF_nbr	nbr
	)

inline

Constructor. Initializes to element index 0.

Parameters

[in] mesh The mesh which should be linked to the element view.

Definition at line 720 of file SF_fem_utils.h.

Member Function Documentation

◆ coord()

template<class T, class S>

Point SF::element_view< T, S >::coord ( short nidx ) const

inline

Access vertex coordinates.

Parameters

[in] nidx Connectivity index w.r.t. the current element (e.g. 0-3 for a Tetra).

Returns: Vertex coordinate.

Definition at line 840 of file SF_fem_utils.h.

Here is the caller graph for this function:

◆ dimension()

template<class T, class S>

short SF::element_view< T, S >::dimension ( ) const

inline

Definition at line 920 of file SF_fem_utils.h.

Here is the caller graph for this function:

◆ element_index()

template<class T, class S>

size_t SF::element_view< T, S >::element_index ( ) const

inline

Get currently selected element index.

Returns: Element index.

Definition at line 883 of file SF_fem_utils.h.

Here is the caller graph for this function:

◆ fiber()

template<class T, class S>

Point SF::element_view< T, S >::fiber ( ) const

inline

Get element fiber direction.

Returns: Fiber direction.

Definition at line 851 of file SF_fem_utils.h.

Here is the caller graph for this function:

◆ global_element_index() [1/2]

template<class T, class S>

size_t SF::element_view< T, S >::global_element_index ( ) const

inline

Get currently selected element index.

Returns: Element index.

Definition at line 893 of file SF_fem_utils.h.

Here is the caller graph for this function:

◆ global_element_index() [2/2]

template<class T, class S>

size_t SF::element_view< T, S >::global_element_index ( SF_nbr nbr ) const

inline

Get currently selected element index.

Parameters

[in] nbr Numbering to use.

Returns: Element index.

Definition at line 903 of file SF_fem_utils.h.

◆ global_node() [1/2]

template<class T, class S>

const T& SF::element_view< T, S >::global_node ( short nidx ) const

inline

Access the connectivity information.

Parameters

[in] nidx Connectivity index w.r.t. the current element (e.g. 0-3 for a Tetra).

Returns: Local index w.r.t. to the local domain. Use the mesh numberings to access global indices.

Definition at line 806 of file SF_fem_utils.h.

Here is the caller graph for this function:

◆ global_node() [2/2]

template<class T, class S>

const T& SF::element_view< T, S >::global_node	(	short	nidx,
		SF_nbr	nbr
	)		const

inline

Access the connectivity information.

Parameters

[in]	nidx	Connectivity index w.r.t. the current element (e.g. 0-3 for a Tetra).
[in]	nbr	Numbering to use.

Returns: Local index w.r.t. to the local domain. Use the mesh numberings to access global indices.

Definition at line 818 of file SF_fem_utils.h.

◆ has_sheet()

template<class T, class S>

bool SF::element_view< T, S >::has_sheet ( ) const

inline

Check if a sheet direction is present.

Returns: Whether sheet direction is present.

Definition at line 873 of file SF_fem_utils.h.

Here is the caller graph for this function:

◆ integration_points()

template<class T, class S>

void SF::element_view< T, S >::integration_points	(	const short	order,
		Point *	ip,
		double *	w,
		int &	nint
	)		const

inline

Definition at line 915 of file SF_fem_utils.h.

Here is the caller graph for this function:

◆ next()

template<class T, class S>

bool SF::element_view< T, S >::next ( )

inline

Select next element if possible.

Returns: Whether there was a next element.

Definition at line 746 of file SF_fem_utils.h.

◆ node()

template<class T, class S>

const T& SF::element_view< T, S >::node ( short nidx ) const

inline

Access the connectivity information.

Parameters

[in] nidx Connectivity index w.r.t. the current element (e.g. 0-3 for a Tetra).

Returns: Local index w.r.t. to the local domain. Use the mesh numberings to access global indices.

Definition at line 794 of file SF_fem_utils.h.

Here is the caller graph for this function:

◆ nodes()

template<class T, class S>

const T* SF::element_view< T, S >::nodes ( ) const

inline

Access the connectivity information.

Returns: Local connectivity indices.

Definition at line 829 of file SF_fem_utils.h.

Here is the caller graph for this function:

◆ num_dof()

template<class T, class S>

short SF::element_view< T, S >::num_dof ( short order ) const

inline

Definition at line 910 of file SF_fem_utils.h.

◆ num_nodes()

template<class T, class S>

T SF::element_view< T, S >::num_nodes ( ) const

inline

Getter function for the number of nodes.

Returns: The number of nodes.

Definition at line 762 of file SF_fem_utils.h.

Here is the caller graph for this function:

◆ set_elem()

template<class T, class S>

void SF::element_view< T, S >::set_elem ( size_t eidx )

inline

Set the view to a new element.

Parameters

[in] eidx An element index.

Definition at line 732 of file SF_fem_utils.h.

Here is the caller graph for this function:

◆ sheet()

template<class T, class S>

Point SF::element_view< T, S >::sheet ( ) const

inline

Get element sheet direction.

Returns: Sheet direction.

Definition at line 860 of file SF_fem_utils.h.

Here is the caller graph for this function:

◆ tag()

template<class T, class S>

T SF::element_view< T, S >::tag ( ) const

inline

Getter function for the element tag.

Returns: The element tag.

Definition at line 782 of file SF_fem_utils.h.

◆ type()

template<class T, class S>

elem_t SF::element_view< T, S >::type ( ) const

inline

Getter function for the element type.

Returns: The element type.

Definition at line 772 of file SF_fem_utils.h.

Here is the caller graph for this function:

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

fem/slimfem/src/SF_fem_utils.h

Public Member Functions

Detailed Description

template<class T, class S> class SF::element_view< T, S >

Constructor & Destructor Documentation

◆ element_view()

Member Function Documentation

◆ coord()

◆ dimension()

◆ element_index()

◆ fiber()

◆ global_element_index() [1/2]

◆ global_element_index() [2/2]

◆ global_node() [1/2]

◆ global_node() [2/2]

◆ has_sheet()

◆ integration_points()

◆ next()

◆ node()

◆ nodes()

◆ num_dof()

◆ num_nodes()

◆ set_elem()

◆ sheet()

◆ tag()

◆ type()

template<class T, class S>
class SF::element_view< T, S >