View for element-dominant matsets. More...

#include </home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/develop/src/axom/bump/views/MaterialView.hpp>

Inheritance diagram for axom::bump::views::ElementDominantMaterialView< IndexT, FloatT, MAXMATERIALS >:

[legend]

Classes
class	const_iterator
	An iterator class for iterating over read-only data in a zone. The iterator can access material ids and volume fractions for one material at a time in the associated zone. More...

Public Types
using	MaterialID = IndexT

using	ZoneIndex = IndexT

using	IndexType = IndexT

using	FloatType = FloatT

using	IDList = StaticArray< IndexType, MAXMATERIALS >

using	VFList = StaticArray< FloatType, MAXMATERIALS >

Public Member Functions
void	add (MaterialID matno, const axom::ArrayView< FloatType > &vfs)

AXOM_HOST_DEVICE axom::IndexType	numberOfZones () const

AXOM_HOST_DEVICE axom::IndexType	numberOfMaterials (ZoneIndex zi) const

AXOM_HOST_DEVICE void	zoneMaterials (ZoneIndex zi, IDList &ids, VFList &vfs) const

AXOM_HOST_DEVICE axom::IndexType	zoneMaterials (ZoneIndex zi, axom::ArrayView< IndexType > &ids, axom::ArrayView< FloatType > &vfs) const

AXOM_HOST_DEVICE bool	zoneContainsMaterial (ZoneIndex zi, MaterialID mat) const

AXOM_HOST_DEVICE bool	zoneContainsMaterial (ZoneIndex zi, MaterialID mat, FloatType &vf) const

const_iterator AXOM_HOST_DEVICE	beginZone (ZoneIndex zi) const
	Return the iterator for the beginning of a zone's material data. More...

const_iterator AXOM_HOST_DEVICE	endZone (ZoneIndex zi) const
	Return the iterator for the end of a zone's material data. More...

Static Public Attributes
constexpr static axom::IndexType	MaxMaterials = MAXMATERIALS

constexpr static axom::IndexType	InvalidIndex = -1

Friends
class	const_iterator

Detailed Description

template<typename IndexT, typename FloatT, axom::IndexType MAXMATERIALS = 20>
class axom::bump::views::ElementDominantMaterialView< IndexT, FloatT, MAXMATERIALS >

View for element-dominant matsets.

Template Parameters

IndexT	The integer type used for material data.
FloatT	The floating point type used for material data (volume fractions).
MAXMATERIALS	The maximum number of materials to support.

matsets:
  matset:
    topology: topology
    volume_fractions:
      a: [a0, a1, 0]
      b: [b0, b1, b2]
      c: [0, 0, c2]
    material_map: # (optional)
      a: 0
      b: 1
      c: 2

Member Typedef Documentation

◆ MaterialID

template<typename IndexT , typename FloatT , axom::IndexType MAXMATERIALS = 20>

using axom::bump::views::ElementDominantMaterialView< IndexT, FloatT, MAXMATERIALS >::MaterialID = IndexT

◆ ZoneIndex

template<typename IndexT , typename FloatT , axom::IndexType MAXMATERIALS = 20>

using axom::bump::views::ElementDominantMaterialView< IndexT, FloatT, MAXMATERIALS >::ZoneIndex = IndexT

◆ IndexType

template<typename IndexT , typename FloatT , axom::IndexType MAXMATERIALS = 20>

using axom::bump::views::ElementDominantMaterialView< IndexT, FloatT, MAXMATERIALS >::IndexType = IndexT

◆ FloatType

template<typename IndexT , typename FloatT , axom::IndexType MAXMATERIALS = 20>

using axom::bump::views::ElementDominantMaterialView< IndexT, FloatT, MAXMATERIALS >::FloatType = FloatT

◆ IDList

template<typename IndexT , typename FloatT , axom::IndexType MAXMATERIALS = 20>

using axom::bump::views::ElementDominantMaterialView< IndexT, FloatT, MAXMATERIALS >::IDList = StaticArray<IndexType, MAXMATERIALS>

◆ VFList

template<typename IndexT , typename FloatT , axom::IndexType MAXMATERIALS = 20>

using axom::bump::views::ElementDominantMaterialView< IndexT, FloatT, MAXMATERIALS >::VFList = StaticArray<FloatType, MAXMATERIALS>

Member Function Documentation

◆ add()

template<typename IndexT , typename FloatT , axom::IndexType MAXMATERIALS = 20>

void axom::bump::views::ElementDominantMaterialView< IndexT, FloatT, MAXMATERIALS >::add	(	MaterialID	matno,
		const axom::ArrayView< FloatType > &	vfs
	)

inline

References axom::utilities::annotations::begin(), axom::StaticArray< T, N >::capacity(), axom::StackArray< T, N >::data(), axom::utilities::annotations::end(), axom::StaticArray< T, N >::push_back(), axom::StaticArray< T, N >::size(), SLIC_ERROR, and SLIC_ERROR_IF.

◆ numberOfZones()

template<typename IndexT , typename FloatT , axom::IndexType MAXMATERIALS = 20>

AXOM_HOST_DEVICE axom::IndexType axom::bump::views::ElementDominantMaterialView< IndexT, FloatT, MAXMATERIALS >::numberOfZones ( ) const

inline

References axom::StaticArray< T, N >::size().

◆ numberOfMaterials()

template<typename IndexT , typename FloatT , axom::IndexType MAXMATERIALS = 20>

AXOM_HOST_DEVICE axom::IndexType axom::bump::views::ElementDominantMaterialView< IndexT, FloatT, MAXMATERIALS >::numberOfMaterials ( ZoneIndex zi ) const

inline

References axom::StaticArray< T, N >::size(), and SLIC_ASSERT.

◆ zoneMaterials() [1/2]

template<typename IndexT , typename FloatT , axom::IndexType MAXMATERIALS = 20>

AXOM_HOST_DEVICE void axom::bump::views::ElementDominantMaterialView< IndexT, FloatT, MAXMATERIALS >::zoneMaterials	(	ZoneIndex	zi,
		IDList &	ids,
		VFList &	vfs
	)		const

inline

References axom::StaticArray< T, N >::clear(), axom::StaticArray< T, N >::push_back(), axom::StaticArray< T, N >::size(), and SLIC_ASSERT.

◆ zoneMaterials() [2/2]

template<typename IndexT , typename FloatT , axom::IndexType MAXMATERIALS = 20>

AXOM_HOST_DEVICE axom::IndexType axom::bump::views::ElementDominantMaterialView< IndexT, FloatT, MAXMATERIALS >::zoneMaterials	(	ZoneIndex	zi,
		axom::ArrayView< IndexType > &	ids,
		axom::ArrayView< FloatType > &	vfs
	)		const

inline

References axom::StaticArray< T, N >::size(), and SLIC_ASSERT.

◆ zoneContainsMaterial() [1/2]

template<typename IndexT , typename FloatT , axom::IndexType MAXMATERIALS = 20>

AXOM_HOST_DEVICE bool axom::bump::views::ElementDominantMaterialView< IndexT, FloatT, MAXMATERIALS >::zoneContainsMaterial	(	ZoneIndex	zi,
		MaterialID	mat
	)		const

inline

◆ zoneContainsMaterial() [2/2]

template<typename IndexT , typename FloatT , axom::IndexType MAXMATERIALS = 20>

AXOM_HOST_DEVICE bool axom::bump::views::ElementDominantMaterialView< IndexT, FloatT, MAXMATERIALS >::zoneContainsMaterial	(	ZoneIndex	zi,
		MaterialID	mat,
		FloatType &	vf
	)		const

inline

References axom::bump::views::ElementDominantMaterialView< IndexT, FloatT, MAXMATERIALS >::InvalidIndex, and SLIC_ASSERT.

◆ beginZone()

template<typename IndexT , typename FloatT , axom::IndexType MAXMATERIALS = 20>

const_iterator AXOM_HOST_DEVICE axom::bump::views::ElementDominantMaterialView< IndexT, FloatT, MAXMATERIALS >::beginZone ( ZoneIndex zi ) const

inline

Return the iterator for the beginning of a zone's material data.

Parameters

zi	The zone index being queried.

Returns: The iterator for the beginning of a zone's material data.

References axom::bump::views::ElementDominantMaterialView< IndexT, FloatT, MAXMATERIALS >::const_iterator, axom::bump::views::ElementDominantMaterialView< IndexT, FloatT, MAXMATERIALS >::numberOfZones(), and SLIC_ASSERT.

◆ endZone()

template<typename IndexT , typename FloatT , axom::IndexType MAXMATERIALS = 20>

const_iterator AXOM_HOST_DEVICE axom::bump::views::ElementDominantMaterialView< IndexT, FloatT, MAXMATERIALS >::endZone ( ZoneIndex zi ) const

inline

Return the iterator for the end of a zone's material data.

Parameters

zi	The zone index being queried.

Returns: The iterator for the end of a zone's material data.

References axom::bump::views::ElementDominantMaterialView< IndexT, FloatT, MAXMATERIALS >::const_iterator, axom::bump::views::ElementDominantMaterialView< IndexT, FloatT, MAXMATERIALS >::numberOfZones(), axom::StaticArray< T, N >::size(), and SLIC_ASSERT.

Friends And Related Function Documentation

◆ const_iterator

template<typename IndexT , typename FloatT , axom::IndexType MAXMATERIALS = 20>

friend class const_iterator

friend

Member Data Documentation

◆ MaxMaterials

template<typename IndexT , typename FloatT , axom::IndexType MAXMATERIALS = 20>

constexpr static axom::IndexType axom::bump::views::ElementDominantMaterialView< IndexT, FloatT, MAXMATERIALS >::MaxMaterials = MAXMATERIALS

staticconstexpr

◆ InvalidIndex

template<typename IndexT , typename FloatT , axom::IndexType MAXMATERIALS = 20>

constexpr static axom::IndexType axom::bump::views::ElementDominantMaterialView< IndexT, FloatT, MAXMATERIALS >::InvalidIndex = -1

staticconstexpr

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

/home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/develop/src/axom/bump/views/MaterialView.hpp

Classes

Public Types

Public Member Functions

Static Public Attributes

Friends

Detailed Description

template<typename IndexT, typename FloatT, axom::IndexType MAXMATERIALS = 20> class axom::bump::views::ElementDominantMaterialView< IndexT, FloatT, MAXMATERIALS >

Member Typedef Documentation

◆ MaterialID

◆ ZoneIndex

◆ IndexType

◆ FloatType

◆ IDList

◆ VFList

Member Function Documentation

◆ add()

◆ numberOfZones()

◆ numberOfMaterials()

◆ zoneMaterials() [1/2]

◆ zoneMaterials() [2/2]

◆ zoneContainsMaterial() [1/2]

◆ zoneContainsMaterial() [2/2]

◆ beginZone()

◆ endZone()

Friends And Related Function Documentation

◆ const_iterator

Member Data Documentation

◆ MaxMaterials

◆ InvalidIndex

template<typename IndexT, typename FloatT, axom::IndexType MAXMATERIALS = 20>
class axom::bump::views::ElementDominantMaterialView< IndexT, FloatT, MAXMATERIALS >