FEAT::Geometry::AdaptiveNeighbors< AdaptiveMeshType_ > Class Template Reference

Gives access to neighbor information on a mesh layer. More...

#include <adaptive_mesh_layer.hpp>

Classes
class	AdaptiveNeighborsAdjactor
	Adjactor for AdaptiveIndexSet. More...

Public Types
using	ImageIterator = AdaptiveNeighborsAdjactor
	Adjactor type. More...

Public Member Functions
	AdaptiveNeighbors (AdaptiveNeighbors &&other)=default
	AdaptiveNeighbors (const AdaptiveNeighbors &other)=default
	AdaptiveNeighbors (std::shared_ptr< AdaptiveMeshType > mesh, Layer layer)
	Constructor. More...
std::size_t	bytes () const
	Returns the size of dynamically allocated memory in bytes. More...
AdaptiveNeighbors	clone () const
	Returns a clone of this index set. More...
Index	get_index_bound () const
	Returns the maximum index of any face returned by this index set. More...
Index	get_num_entities () const
	Returns the number of entities. More...
int	get_num_indices () const
	Returns the number of indices per entity. More...
Index	get_num_nodes_domain () const
Index	get_num_nodes_image () const
AdaptiveNeighborsAdjactor	image_begin (Index domain_node) const
AdaptiveNeighborsAdjactor	image_end (Index domain_node) const
Index	operator() (Index i, int j)
	access operator More...
Index	operator() (Index i, int j) const
	access operator More...
AdaptiveNeighbors &	operator= (AdaptiveNeighbors &&other)=default
AdaptiveNeighbors &	operator= (const AdaptiveNeighbors &other)=default
void	permute (const Adjacency::Permutation &perm, const Adjacency::Permutation &inv_perm_face)

Static Public Member Functions
static String	name ()

Static Public Attributes
static constexpr int	num_indices
	Number of indices per entry. More...

Protected Types
using	AdaptiveMeshType = AdaptiveMeshType_

Protected Attributes
Layer	_layer
std::shared_ptr< AdaptiveMeshType >	_mesh

Private Attributes
std::optional< Adjacency::Permutation >	_inverse_face_permutation
std::optional< Adjacency::Permutation >	_permutation

Detailed Description

template<typename AdaptiveMeshType_>
class FEAT::Geometry::AdaptiveNeighbors< AdaptiveMeshType_ >

Gives access to neighbor information on a mesh layer.

Definition at line 860 of file adaptive_mesh_layer.hpp.

Member Typedef Documentation

AdaptiveMeshType

template<typename AdaptiveMeshType_ >

using FEAT::Geometry::AdaptiveNeighbors< AdaptiveMeshType_ >::AdaptiveMeshType = AdaptiveMeshType_

protected

Definition at line 863 of file adaptive_mesh_layer.hpp.

ImageIterator

template<typename AdaptiveMeshType_ >

using FEAT::Geometry::AdaptiveNeighbors< AdaptiveMeshType_ >::ImageIterator = AdaptiveNeighborsAdjactor

Adjactor type.

Definition at line 938 of file adaptive_mesh_layer.hpp.

Constructor & Destructor Documentation

AdaptiveNeighbors()

template<typename AdaptiveMeshType_ >

FEAT::Geometry::AdaptiveNeighbors< AdaptiveMeshType_ >::AdaptiveNeighbors ( std::shared_ptr< AdaptiveMeshType >  mesh, Layer  layer  )

inline

Constructor.

Parameters

[in]	mesh	Underlying mesh
[in]	Layer	Layer this index set refers to

Definition at line 952 of file adaptive_mesh_layer.hpp.

Member Function Documentation

bytes()

template<typename AdaptiveMeshType_ >

std::size_t FEAT::Geometry::AdaptiveNeighbors< AdaptiveMeshType_ >::bytes ( ) const

inline

Returns the size of dynamically allocated memory in bytes.

Definition at line 977 of file adaptive_mesh_layer.hpp.

clone()

template<typename AdaptiveMeshType_ >

AdaptiveNeighbors FEAT::Geometry::AdaptiveNeighbors< AdaptiveMeshType_ >::clone ( ) const

inline

Returns a clone of this index set.

Warning

A AdaptiveIndexSet is a view into a underlying AdaptiveMesh. The returned clone will thus not be independent of this AdaptiveIndexSet.

Definition at line 969 of file adaptive_mesh_layer.hpp.

get_index_bound()

template<typename AdaptiveMeshType_ >

Index FEAT::Geometry::AdaptiveNeighbors< AdaptiveMeshType_ >::get_index_bound ( ) const

inline

Returns the maximum index of any face returned by this index set.

Definition at line 1029 of file adaptive_mesh_layer.hpp.

get_num_entities()

template<typename AdaptiveMeshType_ >

Index FEAT::Geometry::AdaptiveNeighbors< AdaptiveMeshType_ >::get_num_entities ( ) const

inline

Returns the number of entities.

Definition at line 1013 of file adaptive_mesh_layer.hpp.

get_num_indices()

template<typename AdaptiveMeshType_ >

int FEAT::Geometry::AdaptiveNeighbors< AdaptiveMeshType_ >::get_num_indices ( ) const

inline

Returns the number of indices per entity.

Definition at line 1021 of file adaptive_mesh_layer.hpp.

References FEAT::Geometry::AdaptiveNeighbors< AdaptiveMeshType_ >::num_indices.

get_num_nodes_domain()

template<typename AdaptiveMeshType_ >

Index FEAT::Geometry::AdaptiveNeighbors< AdaptiveMeshType_ >::get_num_nodes_domain ( ) const

inline

Definition at line 1070 of file adaptive_mesh_layer.hpp.

get_num_nodes_image()

template<typename AdaptiveMeshType_ >

Index FEAT::Geometry::AdaptiveNeighbors< AdaptiveMeshType_ >::get_num_nodes_image ( ) const

inline

Definition at line 1075 of file adaptive_mesh_layer.hpp.

image_begin()

template<typename AdaptiveMeshType_ >

AdaptiveNeighborsAdjactor FEAT::Geometry::AdaptiveNeighbors< AdaptiveMeshType_ >::image_begin ( Index  domain_node ) const

inline

Definition at line 1080 of file adaptive_mesh_layer.hpp.

image_end()

template<typename AdaptiveMeshType_ >

AdaptiveNeighborsAdjactor FEAT::Geometry::AdaptiveNeighbors< AdaptiveMeshType_ >::image_end ( Index  domain_node ) const

inline

Definition at line 1089 of file adaptive_mesh_layer.hpp.

name()

template<typename AdaptiveMeshType_ >

static String FEAT::Geometry::AdaptiveNeighbors< AdaptiveMeshType_ >::name ( )

inlinestatic

Definition at line 1063 of file adaptive_mesh_layer.hpp.

operator()() [1/2]

template<typename AdaptiveMeshType_ >

Index FEAT::Geometry::AdaptiveNeighbors< AdaptiveMeshType_ >::operator() ( Index  i, int  j  )

inline

access operator

Definition at line 983 of file adaptive_mesh_layer.hpp.

operator()() [2/2]

template<typename AdaptiveMeshType_ >

Index FEAT::Geometry::AdaptiveNeighbors< AdaptiveMeshType_ >::operator() ( Index  i, int  j  ) const

inline

access operator

Definition at line 997 of file adaptive_mesh_layer.hpp.

permute()

template<typename AdaptiveMeshType_ >

void FEAT::Geometry::AdaptiveNeighbors< AdaptiveMeshType_ >::permute ( const Adjacency::Permutation &  perm, const Adjacency::Permutation &  inv_perm_face  )

inline

Definition at line 1040 of file adaptive_mesh_layer.hpp.

Member Data Documentation

_inverse_face_permutation

template<typename AdaptiveMeshType_ >

std::optional<Adjacency::Permutation> FEAT::Geometry::AdaptiveNeighbors< AdaptiveMeshType_ >::_inverse_face_permutation

private

Definition at line 943 of file adaptive_mesh_layer.hpp.

_layer

template<typename AdaptiveMeshType_ >

Layer FEAT::Geometry::AdaptiveNeighbors< AdaptiveMeshType_ >::_layer

protected

Definition at line 866 of file adaptive_mesh_layer.hpp.

_mesh

template<typename AdaptiveMeshType_ >

std::shared_ptr<AdaptiveMeshType> FEAT::Geometry::AdaptiveNeighbors< AdaptiveMeshType_ >::_mesh

protected

Definition at line 865 of file adaptive_mesh_layer.hpp.

_permutation

template<typename AdaptiveMeshType_ >

std::optional<Adjacency::Permutation> FEAT::Geometry::AdaptiveNeighbors< AdaptiveMeshType_ >::_permutation

private

Definition at line 942 of file adaptive_mesh_layer.hpp.

num_indices

template<typename AdaptiveMeshType_ >

constexpr int FEAT::Geometry::AdaptiveNeighbors< AdaptiveMeshType_ >::num_indices

staticconstexpr

Initial value:

=
      Shape::FaceTraits<typename AdaptiveMeshType::ShapeType, AdaptiveMeshType_::shape_dim>::count

Number of indices per entry.

Definition at line 871 of file adaptive_mesh_layer.hpp.

Referenced by FEAT::Geometry::AdaptiveNeighbors< AdaptiveMeshType_ >::get_num_indices().

---

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

• kernel/geometry/adaptive_mesh_layer.hpp