Class that represents DG element collector. More...

#include <acaobserverdatacollector.h>

Inheritance diagram for maia::acoustic_analogy::observer_collector::ObserverDataCollector< nDim >:

Collaboration diagram for maia::acoustic_analogy::observer_collector::ObserverDataCollector< nDim >:

Public Types
template<class T >
using	Invalid = typename maia::acoustic_analogy::observer_collector::Invalid< T >

Public Member Functions
constexpr	ObserverDataCollector ()=default
	Default c'tor does nothing. More...

MFloat &	observerCoordinates (const MInt id)
	Accessor for surface element coordinates. More...

MFloat	observerCoordinates (const MInt id) const
	Accessor for surface element coordinates (const version). More...

MFloat	observerCoordinates (const MInt id, const MInt component) const
	Accessor for surface element coordinates (const version). More...

MFloat &	variables (const MInt id, const MInt var)
	Accessor for variables (return a reference to the start of the given variable in memory). More...

MFloat &	variables (const MInt id)

MFloat &	variables (const MInt id, const MInt var, const MInt sample)

MFloat	variables (const MInt id, const MInt var, const MInt sample) const
	Accessor for variables (const version). More...

MFloat &	complexVariables (const MInt id, const MInt var)
	Accessor for complex variables. More...

MFloat &	complexVariables (const MInt id)

MFloat &	complexVariables (const MInt id, const MInt var, const MInt sample, const MInt component)

MFloat	complexVariables (const MInt id, const MInt var, const MInt sample, const MInt component) const
	Accessor for complex variables (const version). More...

MInt	noVars ()
	Return number of variables. More...

void	setNoVars (const MInt noVars_)
	Set number of variables. More...

MInt	noComplexVars ()
	Return number of complex variables. More...

void	setNoComplexVars (const MInt noComplexVars_)
	Set number of complex variables. More...

MInt	noSamples ()
	Return number of samples (i.e. number of time steps) More...

void	setNoSamples (const MInt noSamples_)
	Set number of samples. More...

Public Member Functions inherited from maia::container::Container< ObserverDataCollector< nDim >, Invalid >
constexpr	Container ()=default
	Default c'tor does nothing. More...

constexpr MInt	capacity () const
	Return capacity (i.e., maximum number of nodes) More...

void	reset (const MInt capacity)
	Reset tree, re-create data structures with given capacity, and set size to zero. More...

void	resize (const MInt capacity)
	Resize the container capacity. More...

constexpr MInt	size () const
	Return size (i.e., currently used number of nodes) More...

void	size (const MInt size_)
	Resize tree WITHOUT CONSIDERING ANY NODE CONSISTENCY! Use at own risk and remove ASAP... More...

void	append (const MInt count)
	Append nodes to end of tree. More...

void	append ()

void	shrink (const MInt count)
	Remove nodes from end of tree. More...

void	shrink ()

void	copy (const T &source, const MInt begin, const MInt end, const MInt to)
	Copy nodes to another location without changing any parent/child/neighbor information. More...

void	copy (const T &source, const MInt from, const MInt to)

void	copy (const MInt begin, const MInt end, const MInt to)

void	copy (const MInt from, const MInt to)

void	move (const MInt begin, const MInt end, const MInt to)
	Move nodes to another location and update parent/child/neighbor information accordingly. More...

void	move (const MInt from, const MInt to)

void	swap (const MInt a, const MInt b)
	Swap two nodes and update parent/child/neighbor information accordingly. More...

void	insert (const MInt begin, const MInt count)

void	insert (const MInt id)

void	erase (const MInt begin, const MInt end)
	Erase nodes in range [begin, end) and update parent/child/neighbor information. More...

void	erase (const MInt id)

void	removeAndShift (const MInt begin, const MInt end)

void	removeAndShift (const MInt id)

void	removeAndFill (const MInt begin, const MInt end)

void	removeAndFill (const MInt id)

void	clear ()
	Clear tree by invalidating all nodes and setting size to zero. More...

ObserverDataCollector< nDim > &	derived ()

const ObserverDataCollector< nDim > &	derived () const

void	rawCopy (const T &source, const MInt begin, const MInt end, const MInt to)
	Copy range of nodes [begin, end) to range starting at 'to'. More...

void	rawCopy (const T &source, const MInt from, const MInt to)

void	deleteConnectivity (const MInt NotUsed(begin), const MInt NotUsed(end))

void	moveConnectivity (const MInt NotUsed(begin), const MInt NotUsed(end), const MInt NotUsed(to))

void	moveConnectivity (const MInt from, const MInt to)

constexpr MInt	dummy () const

Private Types
using	Base = maia::container::Container< ObserverDataCollector< nDim >, Invalid >

template<class T >
using	Storage = typename Base::template Storage< T >

Private Member Functions
void	reset ()
	Reset, re-create data structures with given capacity, and set size to zero. More...

void	invalidate (const MInt begin, const MInt end)
	Erase range of nodes such that they contain no sensible values anymore. More...

template<class Functor , class T >
void	rawCopyGeneric (Functor &&c, const T &source, const MInt begin, const MInt end, const MInt destination)
	Helper function for rawCopy(). Destination may refer to beginning or end of target range. More...

Private Attributes
MInt	m_noVars = -1

MInt	m_noComplexVars = -1

MInt	m_noSamples = -1

Storage< MFloat >	m_observerCoordinates {}

Storage< MFloat >	m_variables {}

Storage< MFloat >	m_complexVariables {}

Static Private Attributes
static constexpr MInt	s_maxNoVars = 10
	Maximum number of variables (in the time domain) More...

static constexpr MInt	s_maxNoComplexVars = 5
	Maximum number of complex variables (in the frequency domain) More...

static constexpr MInt	s_maxNoSamples = 1048576
	Maximum number of samples. More...

Friends
class	maia::container::Container< ObserverDataCollector< nDim >, Invalid >

Additional Inherited Members
Protected Types inherited from maia::container::Container< ObserverDataCollector< nDim >, Invalid >
using	Storage = std::vector< T >

Protected Member Functions inherited from maia::container::Container< ObserverDataCollector< nDim >, Invalid >
virtual void	resize ()

void	resetStorage (const MInt n, Storage< T > &c)
	Create new container with given size and replace original one. More...

void	resizeStorage (const MInt n, Storage< T > &c)
	Resize container with given size. More...

void	fill_invalid (Container_ &c, const MInt begin, const MInt end, const MInt solverSize=1, const T value=Invalid< T >::value())

void	copyData (const Container_ &source, Container_ &target, Functor &&f, const MInt begin, const MInt end, const MInt dest, const MInt solverSize=1)
	Copy [begin, end) range with given solver size from source to dest position of target. More...

MBool	isValidId (const MInt id) const
	Return whether given id refers to a valid node (auxiliary method). More...

Detailed Description

template<MInt nDim>
class maia::acoustic_analogy::observer_collector::ObserverDataCollector< nDim >

Definition at line 111 of file acaobserverdatacollector.h.

Member Typedef Documentation

◆ Base

template<MInt nDim>

using maia::acoustic_analogy::observer_collector::ObserverDataCollector< nDim >::Base = maia::container::Container<ObserverDataCollector<nDim>, Invalid>

private

Definition at line 116 of file acaobserverdatacollector.h.

◆ Invalid

template<MInt nDim>

template<class T >

using maia::acoustic_analogy::observer_collector::ObserverDataCollector< nDim >::Invalid = typename maia::acoustic_analogy::observer_collector::Invalid<T>

Definition at line 124 of file acaobserverdatacollector.h.

◆ Storage

template<MInt nDim>

template<class T >

using maia::acoustic_analogy::observer_collector::ObserverDataCollector< nDim >::Storage = typename Base::template Storage<T>

private

Definition at line 119 of file acaobserverdatacollector.h.

Constructor & Destructor Documentation

◆ ObserverDataCollector()

template<MInt nDim>

constexpr maia::acoustic_analogy::observer_collector::ObserverDataCollector< nDim >::ObserverDataCollector ( )

constexprdefault

Member Function Documentation

◆ complexVariables() [1/4]

template<MInt nDim>

MFloat & maia::acoustic_analogy::observer_collector::ObserverDataCollector< nDim >::complexVariables ( const MInt id )

inline

Definition at line 147 of file acaobserverdatacollector.h.

147{ return complexVariables(id, 0); };

maia::acoustic_analogy::observer_collector::ObserverDataCollector::complexVariables

MFloat & complexVariables(const MInt id, const MInt var)

Accessor for complex variables.

Definition: acaobserverdatacollector.h:302

◆ complexVariables() [2/4]

template<MInt nDim>

MFloat & maia::acoustic_analogy::observer_collector::ObserverDataCollector< nDim >::complexVariables	(	const MInt	id,
		const MInt	var
	)

Definition at line 302 of file acaobserverdatacollector.h.

                                                                                   {
// Prevent accidental compilation without support for SoA layout
#ifdef ACACOLLECTOR_SOA_MEMORY_LAYOUT
#error Missing implementation for structure-of-arrays memory layout.
#endif
  ENSURE_VALID_ID_ACCESSOR(id);
  ENSURE_VALID_VARIABLE_ID_ACCESSOR(var);
  return m_complexVariables[id * 2 * noComplexVars() * noSamples() + var * 2 * noSamples()];
}

◆ complexVariables() [3/4]

template<MInt nDim>

MFloat & maia::acoustic_analogy::observer_collector::ObserverDataCollector< nDim >::complexVariables	(	const MInt	id,
		const MInt	var,
		const MInt	sample,
		const MInt	component
	)

NOTE: the following complexariables accessors might be very inefficient to use in a loop e.g. over all samples and should only be used during the development of the method. Accessor for complex variables.

Definition at line 317 of file acaobserverdatacollector.h.

                                                                            {
// Prevent accidental compilation without support for SoA layout
#ifdef ACACOLLECTOR_SOA_MEMORY_LAYOUT
#error Missing implementation for structure-of-arrays memory layout.
#endif
  ENSURE_VALID_ID_ACCESSOR(id);
  ENSURE_VALID_VARIABLE_ID_ACCESSOR(var);
  ENSURE_VALID_SAMPLE_ID_ACCESSOR(sample);
  return m_complexVariables[id * 2 * noComplexVars() * noSamples() + var * 2 * noSamples() + 2 * sample + component];
}

◆ complexVariables() [4/4]

template<MInt nDim>

MFloat maia::acoustic_analogy::observer_collector::ObserverDataCollector< nDim >::complexVariables	(	const MInt	id,
		const MInt	var,
		const MInt	sample,
		const MInt	component
	)		const

Definition at line 330 of file acaobserverdatacollector.h.

                                                                                 {
// Prevent accidental compilation without support for SoA layout
#ifdef ACACOLLECTOR_SOA_MEMORY_LAYOUT
#error Missing implementation for structure-of-arrays memory layout.
#endif
  ENSURE_VALID_ID_ACCESSOR(id);
  ENSURE_VALID_VARIABLE_ID_ACCESSOR(var);
  ENSURE_VALID_SAMPLE_ID_ACCESSOR(sample);
  return m_complexVariables[id * 2 * noComplexVars() * noSamples() + var * 2 * noSamples() + 2 * sample + component];
}

◆ invalidate()

template<MInt nDim>

void maia::acoustic_analogy::observer_collector::ObserverDataCollector< nDim >::invalidate	(	const MInt	begin,
		const MInt	end
	)

private

Definition at line 345 of file acaobserverdatacollector.h.

                                                                             {
// Prevent accidental compilation without support for SoA layout
#ifdef ACACOLLECTOR_SOA_MEMORY_LAYOUT
#error Missing implementation for structure-of-arrays memory layout.
#endif
 
  const MInt varSize = noVars() * noSamples();
  const MInt complexVarSize = 2 * noComplexVars() * noSamples();
 
  // Observer coordinates
  fill_invalid(m_observerCoordinates, begin, end, nDim);
 
  // Variables
  fill_invalid(m_variables, begin, end, varSize);
 
  // Complex variables
  fill_invalid(m_complexVariables, begin, end, complexVarSize);
}

◆ noComplexVars()

template<MInt nDim>

MInt maia::acoustic_analogy::observer_collector::ObserverDataCollector< nDim >::noComplexVars ( )

inline

Definition at line 163 of file acaobserverdatacollector.h.

163{ return m_noComplexVars; }

maia::acoustic_analogy::observer_collector::ObserverDataCollector::m_noComplexVars

MInt m_noComplexVars

Definition: acaobserverdatacollector.h:196

◆ noSamples()

template<MInt nDim>

MInt maia::acoustic_analogy::observer_collector::ObserverDataCollector< nDim >::noSamples ( )

inline

Definition at line 172 of file acaobserverdatacollector.h.

172{ return m_noSamples; }

maia::acoustic_analogy::observer_collector::ObserverDataCollector::m_noSamples

MInt m_noSamples

Definition: acaobserverdatacollector.h:199

◆ noVars()

template<MInt nDim>

MInt maia::acoustic_analogy::observer_collector::ObserverDataCollector< nDim >::noVars ( )

inline

Definition at line 155 of file acaobserverdatacollector.h.

155{ return m_noVars; }

maia::acoustic_analogy::observer_collector::ObserverDataCollector::m_noVars

MInt m_noVars

Definition: acaobserverdatacollector.h:193

◆ observerCoordinates() [1/3]

template<MInt nDim>

MFloat & maia::acoustic_analogy::observer_collector::ObserverDataCollector< nDim >::observerCoordinates ( const MInt id )

Definition at line 229 of file acaobserverdatacollector.h.

                                                                      {
// Prevent accidental compilation without support for SoA layout
#ifdef ACACOLLECTOR_SOA_MEMORY_LAYOUT
#error Missing implementation for structure-of-arrays memory layout.
#endif
  ENSURE_VALID_ID_ACCESSOR(id);
  return m_observerCoordinates[id * nDim];
}

◆ observerCoordinates() [2/3]

template<MInt nDim>

MFloat maia::acoustic_analogy::observer_collector::ObserverDataCollector< nDim >::observerCoordinates ( const MInt id ) const

Definition at line 239 of file acaobserverdatacollector.h.

                                                                           {
// Prevent accidental compilation without support for SoA layout
#ifdef ACACOLLECTOR_SOA_MEMORY_LAYOUT
#error Missing implementation for structure-of-arrays memory layout.
#endif
  ENSURE_VALID_ID_ACCESSOR(id);
  return m_observerCoordinates[id * nDim];
}

◆ observerCoordinates() [3/3]

template<MInt nDim>

MFloat maia::acoustic_analogy::observer_collector::ObserverDataCollector< nDim >::observerCoordinates	(	const MInt	id,
		const MInt	component
	)		const

Definition at line 249 of file acaobserverdatacollector.h.

                                                                                                 {
// Prevent accidental compilation without support for SoA layout
#ifdef ACACOLLECTOR_SOA_MEMORY_LAYOUT
#error Missing implementation for structure-of-arrays memory layout.
#endif
  ENSURE_VALID_ID_ACCESSOR(id);
  return m_observerCoordinates[id * nDim + component];
}

◆ rawCopyGeneric()

template<MInt nDim>

template<class Functor , class T >

void maia::acoustic_analogy::observer_collector::ObserverDataCollector< nDim >::rawCopyGeneric	(	Functor &&	c,
		const T &	source,
		const MInt	begin,
		const MInt	end,
		const MInt	destination
	)

private

Definition at line 368 of file acaobserverdatacollector.h.

                                                                         {
// Prevent accidental compilation without support for SoA layout
#ifdef ACACOLLECTOR_SOA_MEMORY_LAYOUT
#error Missing implementation for structure-of-arrays memory layout.
#endif
 
  const MInt varSize = noVars() * noSamples();
  const MInt complexVarSize = 2 * noComplexVars() * noSamples();
 
  // Observer coordinates
  copyData(source.m_observerCoordinates, m_observerCoordinates, c, begin, end, destination, nDim);
 
  // Variables
  copyData(source.m_variables, m_variables, c, begin, end, destination, varSize);
 
  // Variables
  copyData(source.m_complexVariables, m_complexVariables, c, begin, end, destination, complexVarSize);
}

◆ reset()

template<MInt nDim>

void maia::acoustic_analogy::observer_collector::ObserverDataCollector< nDim >::reset

private

Definition at line 217 of file acaobserverdatacollector.h.

                                        {
  const MInt varSize = noVars() * noSamples();
  const MInt complexVarSize = 2 * noComplexVars() * noSamples();
 
  resetStorage(nDim, m_observerCoordinates);
  resetStorage(varSize, m_variables);
  resetStorage(complexVarSize, m_complexVariables);
}

◆ setNoComplexVars()

template<MInt nDim>

void maia::acoustic_analogy::observer_collector::ObserverDataCollector< nDim >::setNoComplexVars ( const MInt noComplexVars_ )

inline

Definition at line 165 of file acaobserverdatacollector.h.

                                                   {
    ENSURE_CONDITION(noComplexVars_ > 0 && noComplexVars_ <= s_maxNoComplexVars,
                     "Invalid number of complex variables.");
    m_noComplexVars = noComplexVars_;
  };

◆ setNoSamples()

template<MInt nDim>

void maia::acoustic_analogy::observer_collector::ObserverDataCollector< nDim >::setNoSamples ( const MInt noSamples_ )

inline

Definition at line 174 of file acaobserverdatacollector.h.

                                           {
    ENSURE_CONDITION(noSamples_ > 0 && noSamples_ <= s_maxNoSamples, "Invalid number of samples.");
    m_noSamples = noSamples_;
  };

◆ setNoVars()

template<MInt nDim>

void maia::acoustic_analogy::observer_collector::ObserverDataCollector< nDim >::setNoVars ( const MInt noVars_ )

inline

Definition at line 157 of file acaobserverdatacollector.h.

                                     {
    ENSURE_CONDITION(noVars_ > 0 && noVars_ <= s_maxNoVars, "Invalid number of variables.");
    m_noVars = noVars_;
  };

◆ variables() [1/4]

template<MInt nDim>

MFloat & maia::acoustic_analogy::observer_collector::ObserverDataCollector< nDim >::variables ( const MInt id )

inline

Definition at line 141 of file acaobserverdatacollector.h.

141{ return variables(id, 0); };

maia::acoustic_analogy::observer_collector::ObserverDataCollector::variables

MFloat & variables(const MInt id, const MInt var)

Accessor for variables (return a reference to the start of the given variable in memory).

Definition: acaobserverdatacollector.h:261

◆ variables() [2/4]

template<MInt nDim>

MFloat & maia::acoustic_analogy::observer_collector::ObserverDataCollector< nDim >::variables	(	const MInt	id,
		const MInt	var
	)

Definition at line 261 of file acaobserverdatacollector.h.

                                                                            {
// Prevent accidental compilation without support for SoA layout
#ifdef ACACOLLECTOR_SOA_MEMORY_LAYOUT
#error Missing implementation for structure-of-arrays memory layout.
#endif
  ENSURE_VALID_ID_ACCESSOR(id);
  ENSURE_VALID_VARIABLE_ID_ACCESSOR(var);
  return m_variables[id * noVars() * noSamples() + var * noSamples()];
}

◆ variables() [3/4]

template<MInt nDim>

MFloat & maia::acoustic_analogy::observer_collector::ObserverDataCollector< nDim >::variables	(	const MInt	id,
		const MInt	var,
		const MInt	sample
	)

NOTE: the following variables accessors might be very inefficient to use in a loop e.g. over all samples and should only be used during the development of the method. Accessor for variables.

Definition at line 276 of file acaobserverdatacollector.h.

                                                                                               {
// Prevent accidental compilation without support for SoA layout
#ifdef ACACOLLECTOR_SOA_MEMORY_LAYOUT
#error Missing implementation for structure-of-arrays memory layout.
#endif
  ENSURE_VALID_ID_ACCESSOR(id);
  ENSURE_VALID_VARIABLE_ID_ACCESSOR(var);
  ENSURE_VALID_SAMPLE_ID_ACCESSOR(sample);
  return m_variables[id * noVars() * noSamples() + var * noSamples() + sample];
}

◆ variables() [4/4]

template<MInt nDim>

MFloat maia::acoustic_analogy::observer_collector::ObserverDataCollector< nDim >::variables	(	const MInt	id,
		const MInt	var,
		const MInt	sample
	)		const

Definition at line 288 of file acaobserverdatacollector.h.

                                                                                                    {
// Prevent accidental compilation without support for SoA layout
#ifdef ACACOLLECTOR_SOA_MEMORY_LAYOUT
#error Missing implementation for structure-of-arrays memory layout.
#endif
  ENSURE_VALID_ID_ACCESSOR(id);
  ENSURE_VALID_VARIABLE_ID_ACCESSOR(var);
  ENSURE_VALID_SAMPLE_ID_ACCESSOR(sample);
  return m_variables[id * noVars() * noSamples() + var * noSamples() + sample];
}