NeoFOAM::SegmentedField< ValueType, IndexType > Class Template Reference

Data structure that stores a segmented fields or a vector of vectors. More...

#include <segmentedField.hpp>

Public Member Functions
	SegmentedField (const Executor &exec, size_t size, size_t numSegments)
	Create a segmented field with a given size and number of segments.
	SegmentedField (const Field< IndexType > &intervals)
	SegmentedField (const Field< ValueType > &values, const Field< IndexType > &segments)
	Constructor to create a segmentedField from values and the segments.
const Executor &	exec () const
	Get the executor associated with the segmented field.
size_t	size () const
	Get the size of the segmented field.
size_t	numSegments () const
	Get the number of segments in the segmented field.
SegmentedFieldView< ValueType, IndexType >	view () &
	get a view of the segmented field
SegmentedFieldView< ValueType, IndexType >	view () &&=delete
std::pair< std::span< ValueType >, std::span< IndexType > >	spans () &
	get the combined value and range spans of the segmented field
std::pair< std::span< ValueType >, std::span< IndexType > >	spans () &&=delete
const Field< ValueType > &	values () const
const Field< IndexType > &	segments () const

Detailed Description

template<typename ValueType, typename IndexType>
class NeoFOAM::SegmentedField< ValueType, IndexType >

Data structure that stores a segmented fields or a vector of vectors.

Definition at line 123 of file segmentedField.hpp.

Constructor & Destructor Documentation

SegmentedField() [1/3]

template<typename ValueType , typename IndexType >

NeoFOAM::SegmentedField< ValueType, IndexType >::SegmentedField ( const Executor &  exec, size_t  size, size_t  numSegments  )

inline

Create a segmented field with a given size and number of segments.

Parameters

exec	Executor associated to the matrix
size	size of the matrix
numSegments	number of segments

Definition at line 134 of file segmentedField.hpp.

SegmentedField() [2/3]

template<typename ValueType , typename IndexType >

NeoFOAM::SegmentedField< ValueType, IndexType >::SegmentedField ( const Field< IndexType > &  intervals )

inline

Definition at line 143 of file segmentedField.hpp.

SegmentedField() [3/3]

template<typename ValueType , typename IndexType >

NeoFOAM::SegmentedField< ValueType, IndexType >::SegmentedField ( const Field< ValueType > &  values, const Field< IndexType > &  segments  )

inline

Constructor to create a segmentedField from values and the segments.

Parameters

values	The values of the segmented field.
segments	The segments of the segmented field.

Definition at line 157 of file segmentedField.hpp.

Member Function Documentation

exec()

template<typename ValueType , typename IndexType >

const Executor & NeoFOAM::SegmentedField< ValueType, IndexType >::exec ( ) const

inline

Get the executor associated with the segmented field.

Returns

Reference to the executor.

Definition at line 168 of file segmentedField.hpp.

numSegments()

template<typename ValueType , typename IndexType >

size_t NeoFOAM::SegmentedField< ValueType, IndexType >::numSegments ( ) const

inline

Get the number of segments in the segmented field.

Returns

The number of segments.

Definition at line 180 of file segmentedField.hpp.

segments()

template<typename ValueType , typename IndexType >

const Field< IndexType > & NeoFOAM::SegmentedField< ValueType, IndexType >::segments ( ) const

inline

Definition at line 209 of file segmentedField.hpp.

size()

template<typename ValueType , typename IndexType >

size_t NeoFOAM::SegmentedField< ValueType, IndexType >::size ( ) const

inline

Get the size of the segmented field.

Returns

The size of the segmented field.

Definition at line 174 of file segmentedField.hpp.

spans() [1/2]

template<typename ValueType , typename IndexType >

std::pair< std::span< ValueType >, std::span< IndexType > > NeoFOAM::SegmentedField< ValueType, IndexType >::spans ( ) &

inline

get the combined value and range spans of the segmented field

Returns

Combined value and range spans of the fields

Definition at line 199 of file segmentedField.hpp.

spans() [2/2]

template<typename ValueType , typename IndexType >

std::pair< std::span< ValueType >, std::span< IndexType > > NeoFOAM::SegmentedField< ValueType, IndexType >::spans ( ) &&

delete

values()

template<typename ValueType , typename IndexType >

const Field< ValueType > & NeoFOAM::SegmentedField< ValueType, IndexType >::values ( ) const

inline

Definition at line 207 of file segmentedField.hpp.

view() [1/2]

template<typename ValueType , typename IndexType >

SegmentedFieldView< ValueType, IndexType > NeoFOAM::SegmentedField< ValueType, IndexType >::view ( ) &

inline

get a view of the segmented field

Returns

Span of the fields

Definition at line 187 of file segmentedField.hpp.

view() [2/2]

template<typename ValueType , typename IndexType >

SegmentedFieldView< ValueType, IndexType > NeoFOAM::SegmentedField< ValueType, IndexType >::view ( ) &&

delete

---

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

• /home/runner/work/NeoFOAM/NeoFOAM/include/NeoFOAM/fields/segmentedField.hpp