#include <Wrapper.hpp>

Inheritance diagram for geosx::dataRepository::Wrapper< T >:

Public Types
using	TYPE = T
	Alias for the wrapped type `T`.

Public Member Functions
virtual HistoryMetadata	getHistoryMetadata (localIndex const packCount=-1) const override final
	Get a description of the wrapped data for time history collection/output. More...

void const *	voidPointer () const override

virtual localIndex	elementByteSize () const override

Constructors, destructor, copy/move assignment
	Wrapper (string const &name, Group &parent)
	Constructor that creates a new instance of wrapped type. More...

	Wrapper (string const &name, Group &parent, std::unique_ptr< T > object)
	Constructor that takes ownership of an existing object. More...

	Wrapper (string const &name, Group &parent, T *object)
	Constructor that does not take ownership of an existing object. More...

virtual	~Wrapper () noexcept override
	Default destructor. More...

Wrapper &	operator= (Wrapper const &source)
	Copy Assignment Operator. More...

Wrapper &	operator= (Wrapper &&source)
	Move Assignment Operator. More...

Packing/unpacking methods.
virtual bool	isPackable (bool onDevice) const override
	Check whether wrapped type is can be packed into a buffer on host or device. More...

virtual localIndex	pack (buffer_unit_type *&buffer, bool withMetadata, bool onDevice, parallelDeviceEvents &events) const override final
	Pack the entire wrapped object into a buffer. More...

virtual localIndex	packByIndex (buffer_unit_type *&buffer, arrayView1d< localIndex const > const &packList, bool withMetadata, bool onDevice, parallelDeviceEvents &events) const override final
	For indexable types, pack selected indices of wrapped object into a buffer. More...

virtual localIndex	packSize (bool withMetadata, bool onDevice, parallelDeviceEvents &events) const override final
	Get the buffer size needed to pack the entire wrapped object. More...

virtual localIndex	packByIndexSize (arrayView1d< localIndex const > const &packList, bool withMetadata, bool onDevice, parallelDeviceEvents &events) const override final
	Get the buffer size needed to pack the selected indices wrapped object. More...

virtual localIndex	unpack (buffer_unit_type const *&buffer, bool withMetadata, bool onDevice, parallelDeviceEvents &events) override final
	Unpack the entire wrapped object from a buffer. More...

virtual localIndex	unpackByIndex (buffer_unit_type const *&buffer, arrayView1d< localIndex const > const &unpackIndices, bool withMetadata, bool onDevice, parallelDeviceEvents &events) override final
	For indexable types, unpack selected indices of wrapped object from a buffer. More...

Methods that delegate to the wrapped type
These functions will call the corresponding method on the wrapped object, if such method is declared in wrapped type.
virtual localIndex	size () const override
	Calls T::size() More...

virtual void	resize (int ndims, localIndex const *const dims) override
	Calls T::resize( num_dims, dims ) More...

virtual void	reserve (localIndex const newCapacity) override
	Calls T::reserve( newCapacity ) if it exists, otherwise a no-op. More...

virtual localIndex	capacity () const override

virtual void	resize (localIndex const newSize) override
	Calls T::resize(newsize) if it exists. More...

virtual void	copy (localIndex const sourceIndex, localIndex const destIndex) override
	Calls T::copy(sourceIndex, destIndex) More...

virtual void	copyData (WrapperBase const &source) override
	Copy the the data contained in another wrapper into this wrapper. More...

virtual void	move (LvArray::MemorySpace const space, bool const touch) const override
	Calls T::move(space, touch) More...

virtual string	typeRegex () const override
	Calls TypeRegex< T >::get(). More...

Methods for wrapped value data access
T &	reference ()
	Accessor for m_data. More...

GEOSX_DECLTYPE_AUTO_RETURN	reference () const
	const Accessor for m_data More...

template<typename _T = T, typename = std::enable_if_t< traits::HasMemberFunction_toView< _T > >>
GEOSX_DECLTYPE_AUTO_RETURN	referenceAsView ()
	Provide access to wrapped object converted to a view, if possible. More...

template<typename _T = T, typename = std::enable_if_t< !traits::HasMemberFunction_toView< _T > >>
T &	referenceAsView ()
	Provide access to wrapped object converted to a view, if possible. More...

template<typename _T = T, typename = std::enable_if_t< traits::HasMemberFunction_toView< _T > >>
GEOSX_DECLTYPE_AUTO_RETURN	referenceAsView () const
	Provide access to wrapped object converted to a view, if possible. More...

template<typename _T = T, typename = std::enable_if_t< !traits::HasMemberFunction_toView< _T > >>
T const &	referenceAsView () const
	Provide access to wrapped object converted to a view, if possible. More...

Methods to manipulate default value for wrapped object
virtual bool	hasDefaultValue () const final override
	Return true iff this wrapper has a valid default value. More...

template<typename U = T>
DefaultValue< T > const &	getDefaultValueStruct () const
	Accessor for m_default. More...

template<typename U = T>
std::enable_if_t< DefaultValue< U >::has_default_value, typename DefaultValue< U >::value_type const &>	getDefaultValue () const
	Accessor for default value. More...

template<typename U = T>
std::enable_if_t< DefaultValue< U >::has_default_value, Wrapper< T > &>	setDefaultValue (typename DefaultValue< U >::value_type const &defaultVal)
	Setter for default value. More...

template<typename U = T>
std::enable_if_t< !traits::is_array< U > &&DefaultValue< U >::has_default_value, Wrapper< T > &>	setApplyDefaultValue (typename DefaultValue< U >::value_type const &defaultVal)
	Set and apply for default value. More...

template<typename U = T>
std::enable_if_t< traits::is_array< U > &&DefaultValue< U >::has_default_value, Wrapper< T > &>	setApplyDefaultValue (typename DefaultValue< U >::value_type const &defaultVal)
	Set and apply for default value. More...

virtual string	getDefaultValueString () const override
	Return a string representing the default value. More...

virtual bool	processInputFile (xmlWrapper::xmlNode const &targetNode) override
	Initialize the wrapper from the input xml node. More...

void	setName ()
	DO_NOT_DOCUMENT. More...

void	addBlueprintField (conduit::Node &fields, string const &name, string const &topology, std::vector< string > const &componentNames={}) const override
	Push the data in the wrapper into a Conduit blueprint field. More...

void	populateMCArray (conduit::Node &node, std::vector< string > const &componentNames={}) const override
	Push the data in the wrapper into a Conduit Blueprint mcarray. More...

std::unique_ptr< WrapperBase >	averageOverSecondDim (string const &name, Group &group) const override
	Create a new Wrapper with values averaged over the second dimension. More...

void	registerToWrite () const override
	Register the wrapper's data for writing with Conduit.

void	finishWriting () const override
	Write the wrapped data into Conduit.

bool	loadFromConduit () override
	Read the wrapped data from Conduit. More...

Overridden setters
Setters that replace (hide) corresponding non-virtual functions in WrapperBase with the goal of returning Wrapper<T> pointers rather than WrapperBase pointers.
Wrapper< T > &	setSizedFromParent (int val)
	Set whether this wrapper is resized when its parent is resized. More...

Wrapper< T > &	setRestartFlags (RestartFlags flags)
	Set the RestartFlags of the wrapper. More...

Wrapper< T > &	setPlotLevel (PlotLevel const flag)
	Set the PlotLevel of the wrapper. More...

Wrapper< T > &	setInputFlag (InputFlags const input)
	Set the InputFlag of the wrapper. More...

Wrapper< T > &	setDescription (string const &description)
	Set the description string of the wrapper. More...

Wrapper< T > &	setRegisteringObjects (string const &objectName)
	Add a new name to the list of groups that register this wrapper. More...

Public Member Functions inherited from geosx::dataRepository::WrapperBase
	WrapperBase (string const &name, Group &parent)
	Constructor. More...

virtual	~WrapperBase ()
	Default destructor.

void	resize ()
	Calls resize(newsize) where newsize is taken from the parent Group.

int	sizedFromParent () const
	Check whether this wrapper is resized when its parent is resized. More...

WrapperBase &	setSizedFromParent (int val)
	Set whether this wrapper is resized when its parent is resized. More...

RestartFlags	getRestartFlags () const
	Get the RestartFlags of the wrapper. More...

WrapperBase &	setRestartFlags (RestartFlags flags)
	Set the RestartFlags of the wrapper. More...

PlotLevel	getPlotLevel () const
	Get PlotLevel for this wrapper. More...

WrapperBase &	setPlotLevel (PlotLevel const flag)
	Set the PlotLevel of the wrapper. More...

string const &	getName () const
	Get name of the wrapper. More...

string	getPath () const
	Return the path to this Wrapper in the data repository. More...

WrapperBase &	setInputFlag (InputFlags const input)
	Set the InputFlag of the wrapper. More...

InputFlags	getInputFlag () const
	Get the InputFlag of the wrapper. More...

bool	getSuccessfulReadFromInput () const
	Returns flag that indicates whether the contents of the wrapper have been successfully read from the input file. More...

WrapperBase &	setDescription (string const &description)
	Set the description string of the wrapper. More...

string const &	getDescription () const
	Get the description string of the wrapper. More...

string	dumpInputOptions (bool const outputHeader) const

std::set< string > const &	getRegisteringObjects () const
	Get the list of names of groups that registered this wrapper. More...

WrapperBase &	setRegisteringObjects (string const &objectName)
	Add a new name to the list of groups that register this wrapper. More...

Miscellaneous
virtual std::unique_ptr< WrapperBase >	clone (string const &name, Group &parent) override
	Creates a clone of `*this` WrapperBase. More...

virtual void	copyWrapper (WrapperBase const &source) override
	Copies the contents of a Wrapper into *this. More...

virtual void	copyWrapperAttributes (WrapperBase const &source) override
	Copy attributes from another wrapper. More...

virtual const std::type_info &	getTypeId () const noexcept override
	Get the typeid of T. More...

virtual int	numArrayDims () const override
	Return the number of dimensions of the array. More...

virtual localIndex	numArrayComp () const override
	Return the number of components in a multidimensional array. More...

virtual Wrapper &	setDimLabels (integer const dim, Span< string const > const labels) override
	Set dimension labels for an array. More...

virtual Span< string const >	getDimLabels (integer const dim) const override
	Get dimension labels of an array. More...

static Wrapper &	cast (WrapperBase &wrapper)
	Downcast base to a typed wrapper. More...

static Wrapper< T > const &	cast (WrapperBase const &wrapper)
	Downcast base to a const typed wrapper. More...

Additional Inherited Members
Protected Attributes inherited from geosx::dataRepository::WrapperBase
string	m_name
	Name of the object that is being wrapped.

Group *	m_parent
	Pointer to Group that holds this WrapperBase.

int	m_sizedFromParent
	Integer to indicate whether or not this wrapped object should be resized when m_parent is resized.

RestartFlags	m_restart_flags
	Flag to determine the restart behavior for this wrapped object.

PlotLevel	m_plotLevel
	Flag to store the plotLevel.

InputFlags	m_inputFlag
	Flag to store if this wrapped object should be read from input.

bool	m_successfulReadFromInput
	Flag to indicate if wrapped object was successfully read from input.

string	m_description
	A string description of the wrapped object.

std::set< string >	m_registeringObjects
	A vector of the names of the objects that created this Wrapper.

conduit::Node &	m_conduitNode
	A reference to the corresponding conduit::Node.

Detailed Description

template<typename T>
class geosx::dataRepository::Wrapper< T >

Templated class to serve as a wrapper to arbitrary objects.

Template Parameters

T	is any type that is to be wrapped by Wrapper

Definition at line 56 of file Wrapper.hpp.

Constructor & Destructor Documentation

◆ Wrapper() [1/3]

template<typename T>

geosx::dataRepository::Wrapper< T >::Wrapper	(	string const &	name,
		Group &	parent
	)

inlineexplicit

Constructor that creates a new instance of wrapped type.

Parameters

name	name of the object
parent	parent group which owns the Wrapper

Definition at line 75 of file Wrapper.hpp.

◆ Wrapper() [2/3]

template<typename T>

geosx::dataRepository::Wrapper< T >::Wrapper	(	string const &	name,
		Group &	parent,
		std::unique_ptr< T >	object
	)

inlineexplicit

Constructor that takes ownership of an existing object.

Parameters

name	name of the object
parent	parent group that owns the Wrapper
object	object that is being wrapped by the Wrapper

Definition at line 96 of file Wrapper.hpp.

◆ Wrapper() [3/3]

template<typename T>

geosx::dataRepository::Wrapper< T >::Wrapper	(	string const &	name,
		Group &	parent,
		T *	object
	)

inlineexplicit

Constructor that does not take ownership of an existing object.

Parameters

name	name of the object
parent	parent group that owns the Wrapper
object	object that is being wrapped by the Wrapper

Definition at line 118 of file Wrapper.hpp.

◆ ~Wrapper()

template<typename T>

virtual geosx::dataRepository::Wrapper< T >::~Wrapper ( )

inlineoverridevirtualnoexcept

Default destructor.

Deletes wrapped object if the wrapper is owning

Definition at line 139 of file Wrapper.hpp.

Member Function Documentation

◆ addBlueprintField()

template<typename T>

void geosx::dataRepository::Wrapper< T >::addBlueprintField	(	conduit::Node &	fields,
		string const &	name,
		string const &	topology,
		std::vector< string > const &	componentNames = `{}`
	)		const

inlineoverridevirtual

Push the data in the wrapper into a Conduit blueprint field.

Parameters

fields	The Conduit Node containg the blueprint fields.
name	The name of the field.
topology	The topology associated with the field.
componentNames	The name of the components, if not specified they are auto generated.

Note: This wrapper must hold an LvArray::Array.

Implements geosx::dataRepository::WrapperBase.

Definition at line 755 of file Wrapper.hpp.

◆ averageOverSecondDim()

template<typename T>

std::unique_ptr< WrapperBase > geosx::dataRepository::Wrapper< T >::averageOverSecondDim	(	string const &	name,
		Group &	group
	)		const

inlineoverridevirtual

Create a new Wrapper with values averaged over the second dimension.

Parameters

name	The name to give the new wrapper.
group	The group to hang the new Wrapper from.

Returns: The newly created wrapper.

Note: This Wrapper must hold an LvArray::Array of dimension 2 or greater.; The new Wrapper is not registered with group.

Implements geosx::dataRepository::WrapperBase.

Definition at line 766 of file Wrapper.hpp.

◆ capacity()

template<typename T>

virtual localIndex geosx::dataRepository::Wrapper< T >::capacity ( ) const

inlineoverridevirtual

Returns: T::capacity() if it exists, other wise calls size().

Implements geosx::dataRepository::WrapperBase.

Definition at line 497 of file Wrapper.hpp.

◆ cast() [1/2]

template<typename T>

static Wrapper& geosx::dataRepository::Wrapper< T >::cast ( WrapperBase & wrapper )

inlinestatic

Downcast base to a typed wrapper.

Parameters

wrapper the base wrapper reference

Precondition: wrapper must be an instance of Wrapper<T>

Returns: reference to wrapper cast to a typed wrapper.

Definition at line 216 of file Wrapper.hpp.

◆ cast() [2/2]

template<typename T>

static Wrapper< T > const& geosx::dataRepository::Wrapper< T >::cast ( WrapperBase const & wrapper )

inlinestatic

Downcast base to a const typed wrapper.

Parameters

wrapper the base wrapper reference

Precondition: wrapper must be an instance of Wrapper<T>

Returns: const reference to wrapper cast to a typed wrapper.

Definition at line 229 of file Wrapper.hpp.

◆ clone()

template<typename T>

virtual std::unique_ptr< WrapperBase > geosx::dataRepository::Wrapper< T >::clone	(	string const &	name,
		Group &	parent
	)

inlineoverridevirtual

Creates a clone of *this WrapperBase.

Parameters

[in]	name	name of the clone
[in]	parent	parent Group that will hold this clone

Returns

The overridden function will create a copy of the derived Wrapper<T> the using the provided values of name and parent to differentiate itself from the source.

Implements geosx::dataRepository::WrapperBase.

Definition at line 179 of file Wrapper.hpp.

◆ copy()

template<typename T>

virtual void geosx::dataRepository::Wrapper< T >::copy	(	localIndex const	sourceIndex,
		localIndex const	destIndex
	)

inlineoverridevirtual

Calls T::copy(sourceIndex, destIndex)

Parameters

[in]	sourceIndex	index to copy from
[in]	destIndex	index to copy to

Implements geosx::dataRepository::WrapperBase.

Definition at line 542 of file Wrapper.hpp.

◆ copyData()

template<typename T>

virtual void geosx::dataRepository::Wrapper< T >::copyData ( WrapperBase const & source )

inlineoverridevirtual

Copy the the data contained in another wrapper into this wrapper.

Parameters

source The wrapper that holds the data to copy.

Implements geosx::dataRepository::WrapperBase.

Definition at line 552 of file Wrapper.hpp.

◆ copyWrapper()

template<typename T>

virtual void geosx::dataRepository::Wrapper< T >::copyWrapper ( WrapperBase const & source )

inlineoverridevirtual

Copies the contents of a Wrapper into *this.

Parameters

[in] source The wrapper to copy

Implements geosx::dataRepository::WrapperBase.

Definition at line 187 of file Wrapper.hpp.

◆ copyWrapperAttributes()

template<typename T>

virtual void geosx::dataRepository::Wrapper< T >::copyWrapperAttributes ( WrapperBase const & source )

inlineoverridevirtual

Copy attributes from another wrapper.

Parameters

[in] source the source wrapper, must wrap the same type T

Reimplemented from geosx::dataRepository::WrapperBase.

Definition at line 195 of file Wrapper.hpp.

◆ elementByteSize()

template<typename T>

virtual localIndex geosx::dataRepository::Wrapper< T >::elementByteSize ( ) const

inlineoverridevirtual

Returns: the number of bytes in an object of unit size. Ie elementByteSize() * size() gives the size of memory pointed to by voidPointer().

Implements geosx::dataRepository::WrapperBase.

Definition at line 467 of file Wrapper.hpp.

◆ getDefaultValue()

template<typename T>

template<typename U = T>

std::enable_if_t< DefaultValue::has_default_value, typename DefaultValue::value_type const & > geosx::dataRepository::Wrapper< T >::getDefaultValue ( ) const

inline

Accessor for default value.

Returns: reference to const T

Definition at line 655 of file Wrapper.hpp.

◆ getDefaultValueString()

template<typename T>

virtual string geosx::dataRepository::Wrapper< T >::getDefaultValueString ( ) const

inlineoverridevirtual

Return a string representing the default value.

Returns: A string representing the default value.

Implements geosx::dataRepository::WrapperBase.

Definition at line 704 of file Wrapper.hpp.

◆ getDefaultValueStruct()

template<typename T>

template<typename U = T>

DefaultValue< T > const& geosx::dataRepository::Wrapper< T >::getDefaultValueStruct ( ) const

inline

Accessor for m_default.

Returns: reference to const m_default member

Definition at line 643 of file Wrapper.hpp.

◆ getDimLabels()

template<typename T>

virtual Span< string const > geosx::dataRepository::Wrapper< T >::getDimLabels ( integer const dim ) const

inlineoverridevirtual

Get dimension labels of an array.

Parameters

dim	dimension index (must be less than number of array dimensions)

Returns: reference to array of labels (empty unless set via setDimLabels)

An error is raised if wrapped type is not LvArray::Array.

Implements geosx::dataRepository::WrapperBase.

Definition at line 254 of file Wrapper.hpp.

◆ getHistoryMetadata()

template<typename T>

virtual HistoryMetadata geosx::dataRepository::Wrapper< T >::getHistoryMetadata ( localIndex const packCount = -1 ) const

inlinefinaloverridevirtual

Get a description of the wrapped data for time history collection/output.

Parameters

packCount The number of indices from the wrapped data to collect,

Returns: HistoryMetadata about the wrapped type

Implements geosx::dataRepository::WrapperBase.

Definition at line 263 of file Wrapper.hpp.

◆ getTypeId()

template<typename T>

virtual const std::type_info& geosx::dataRepository::Wrapper< T >::getTypeId ( ) const

inlineoverridevirtualnoexcept

Get the typeid of T.

Returns: type_info of the wrapped type "typeid(T)"

Implements geosx::dataRepository::WrapperBase.

Definition at line 205 of file Wrapper.hpp.

◆ hasDefaultValue()

template<typename T>

virtual bool geosx::dataRepository::Wrapper< T >::hasDefaultValue ( ) const

inlinefinaloverridevirtual

Return true iff this wrapper has a valid default value.

Returns: True iff this wrapper has a valid default value.

Implements geosx::dataRepository::WrapperBase.

Definition at line 632 of file Wrapper.hpp.

◆ isPackable()

template<typename T>

virtual bool geosx::dataRepository::Wrapper< T >::isPackable ( bool onDevice ) const

inlineoverridevirtual

Check whether wrapped type is can be packed into a buffer on host or device.

Parameters

[in] onDevice determine whether the wrapper is packable on host vs device

Returns: true if T is packable, false otherwise

Implements geosx::dataRepository::WrapperBase.

Definition at line 276 of file Wrapper.hpp.

◆ loadFromConduit()

template<typename T>

bool geosx::dataRepository::Wrapper< T >::loadFromConduit ( )

inlineoverridevirtual

Read the wrapped data from Conduit.

Returns: True iff the Wrapper read in data.

Implements geosx::dataRepository::WrapperBase.

Definition at line 805 of file Wrapper.hpp.

◆ move()

template<typename T>

virtual void geosx::dataRepository::Wrapper< T >::move	(	LvArray::MemorySpace const	space,
		bool const	touch
	)		const

inlineoverridevirtual

Calls T::move(space, touch)

Parameters

[in]	space	A CHAI execution space to move the data into
[in]	touch	whether to register a touch in target space

Implements geosx::dataRepository::WrapperBase.

Definition at line 560 of file Wrapper.hpp.

◆ numArrayComp()

template<typename T>

virtual localIndex geosx::dataRepository::Wrapper< T >::numArrayComp ( ) const

inlineoverridevirtual

Return the number of components in a multidimensional array.

Returns: total size along all dimensions except first if T is an array, and 0 otherwise

Implements geosx::dataRepository::WrapperBase.

Definition at line 243 of file Wrapper.hpp.

◆ numArrayDims()

template<typename T>

virtual int geosx::dataRepository::Wrapper< T >::numArrayDims ( ) const

inlineoverridevirtual

Return the number of dimensions of the array.

Returns: the number of dimensions of the array if T is an array, and 0 otherwise

Implements geosx::dataRepository::WrapperBase.

Definition at line 238 of file Wrapper.hpp.

◆ operator=() [1/2]

template<typename T>

Wrapper& geosx::dataRepository::Wrapper< T >::operator= ( Wrapper< T > const & source )

inline

Copy Assignment Operator.

Parameters

source rhs

Returns: *this

Definition at line 154 of file Wrapper.hpp.

◆ operator=() [2/2]

template<typename T>

Wrapper& geosx::dataRepository::Wrapper< T >::operator= ( Wrapper< T > && source )

inline

Move Assignment Operator.

Parameters

source

Returns: *this

Definition at line 165 of file Wrapper.hpp.

◆ pack()

template<typename T>

virtual localIndex geosx::dataRepository::Wrapper< T >::pack	(	buffer_unit_type *&	buffer,
		bool	withMetadata,
		bool	onDevice,
		parallelDeviceEvents &	events
	)		const

inlinefinaloverridevirtual

Pack the entire wrapped object into a buffer.

Parameters

[in,out]	buffer	the binary buffer pointer, advanced upon completion
[in]	withMetadata	whether to pack string metadata with the underlying data
[in]	onDevice	whether to use device-based packing functions (buffer must be either pinned or a device pointer)
[out]	events	a collection of events to poll for completion of async packing kernels ( device packing is incomplete until all events are finalized )

Returns: the number of buffer_unit_type units packed

Implements geosx::dataRepository::WrapperBase.

Definition at line 292 of file Wrapper.hpp.

◆ packByIndex()

template<typename T>

virtual localIndex geosx::dataRepository::Wrapper< T >::packByIndex	(	buffer_unit_type *&	buffer,
		arrayView1d< localIndex const > const &	packList,
		bool	withMetadata,
		bool	onDevice,
		parallelDeviceEvents &	events
	)		const

inlinefinaloverridevirtual

For indexable types, pack selected indices of wrapped object into a buffer.

Parameters

[in,out]	buffer	the binary buffer pointer, advanced upon completion
[in]	packList	the list of indices to pack
[in]	withMetadata	whether to pack string metadata with the underlying data
[in]	onDevice	whether to use device-based packing functions (buffer must be either pinned or a device pointer)
[out]	events	a collection of events to poll for completion of async packing kernels ( device packing is incomplete until all events are finalized )

Returns: the number of buffer_unit_type units packed

Implements geosx::dataRepository::WrapperBase.

Definition at line 317 of file Wrapper.hpp.

◆ packByIndexSize()

template<typename T>

virtual localIndex geosx::dataRepository::Wrapper< T >::packByIndexSize	(	arrayView1d< localIndex const > const &	packList,
		bool	withMetadata,
		bool	onDevice,
		parallelDeviceEvents &	events
	)		const

inlinefinaloverridevirtual

Get the buffer size needed to pack the selected indices wrapped object.

Parameters

[in]	packList	the list of indices to pack
[in]	withMetadata	whether to pack string metadata with the underlying data
[in]	onDevice	whether to use device-based packing functions (buffer must be either pinned or a device pointer)
[out]	events	a collection of events to poll for completion of async packing kernels ( device packing is incomplete until all events are finalized )

Returns: the number of buffer_unit_type units needed to pack

Implements geosx::dataRepository::WrapperBase.

Definition at line 371 of file Wrapper.hpp.

◆ packSize()

template<typename T>

virtual localIndex geosx::dataRepository::Wrapper< T >::packSize	(	bool	withMetadata,
		bool	onDevice,
		parallelDeviceEvents &	events
	)		const

inlinefinaloverridevirtual

Get the buffer size needed to pack the entire wrapped object.

Parameters

[in]	withMetadata	whether to pack string metadata with the underlying data
[in]	onDevice	whether to use device-based packing functions this matters as the size on device differs from the size on host as we pack less metadata on device
[out]	events	a collection of events to poll for completion of async packing kernels ( device packing is incomplete until all events are finalized )

Returns: the number of buffer_unit_type units needed to pack

Implements geosx::dataRepository::WrapperBase.

Definition at line 345 of file Wrapper.hpp.

◆ populateMCArray()

template<typename T>

void geosx::dataRepository::Wrapper< T >::populateMCArray	(	conduit::Node &	node,
		std::vector< string > const &	componentNames = `{}`
	)		const

inlineoverridevirtual

Push the data in the wrapper into a Conduit Blueprint mcarray.

Parameters

node	The Conduit Node to put the data into.
componentNames	The names of the components, if not specified they are auto generated.

Note: This wrapper must hold an LvArray::Array.

Implements geosx::dataRepository::WrapperBase.

Definition at line 762 of file Wrapper.hpp.

◆ processInputFile()

template<typename T>

virtual bool geosx::dataRepository::Wrapper< T >::processInputFile ( xmlWrapper< T >::xmlNode const & targetNode )

inlineoverridevirtual

Initialize the wrapper from the input xml node.

Parameters

targetNode the xml node to initialize from.

Returns: True iff the wrapper initialized itself from the file.

Implements geosx::dataRepository::WrapperBase.

Definition at line 711 of file Wrapper.hpp.

◆ reference() [1/2]

template<typename T>

T& geosx::dataRepository::Wrapper< T >::reference ( )

inline

Accessor for m_data.

Returns: reference to T

Definition at line 578 of file Wrapper.hpp.

◆ reference() [2/2]

template<typename T>

GEOSX_DECLTYPE_AUTO_RETURN geosx::dataRepository::Wrapper< T >::reference ( ) const

inline

const Accessor for m_data

Returns: reference to T, or in the case of an Array, a reference to an ArrayView<T const> const.

Definition at line 586 of file Wrapper.hpp.

◆ referenceAsView() [1/4]

template<typename T>

template<typename _T = T, typename = std::enable_if_t< traits::HasMemberFunction_toView< _T > >>

GEOSX_DECLTYPE_AUTO_RETURN geosx::dataRepository::Wrapper< T >::referenceAsView ( )

inline

Provide access to wrapped object converted to a view, if possible.

Template Parameters

U	dummy template parameter to enable SFINAE (do not change)

Returns: the view for wrapped object

This is used mainly for LvArray classes (arrays, etc.) that can convert themselves into views. For other types, a regular reference is returned.

Definition at line 598 of file Wrapper.hpp.

◆ referenceAsView() [2/4]

template<typename T>

template<typename _T = T, typename = std::enable_if_t< !traits::HasMemberFunction_toView< _T > >>

T& geosx::dataRepository::Wrapper< T >::referenceAsView ( )

inline

Provide access to wrapped object converted to a view, if possible.

Template Parameters

U	dummy template parameter to enable SFINAE (do not change)

Returns: the view for wrapped object

This is used mainly for LvArray classes (arrays, etc.) that can convert themselves into views. For other types, a regular reference is returned.

Definition at line 605 of file Wrapper.hpp.

◆ referenceAsView() [3/4]

template<typename T>

template<typename _T = T, typename = std::enable_if_t< traits::HasMemberFunction_toView< _T > >>

GEOSX_DECLTYPE_AUTO_RETURN geosx::dataRepository::Wrapper< T >::referenceAsView ( ) const

inline

Provide access to wrapped object converted to a view, if possible.

Template Parameters

U	dummy template parameter to enable SFINAE (do not change)

Returns: the view for wrapped object

This is used mainly for LvArray classes (arrays, etc.) that can convert themselves into views. For other types, a regular reference is returned.

Definition at line 612 of file Wrapper.hpp.

◆ referenceAsView() [4/4]

template<typename T>

template<typename _T = T, typename = std::enable_if_t< !traits::HasMemberFunction_toView< _T > >>

T const& geosx::dataRepository::Wrapper< T >::referenceAsView ( ) const

inline

Provide access to wrapped object converted to a view, if possible.

Template Parameters

U	dummy template parameter to enable SFINAE (do not change)

Returns: the view for wrapped object

This is used mainly for LvArray classes (arrays, etc.) that can convert themselves into views. For other types, a regular reference is returned.

Definition at line 619 of file Wrapper.hpp.

◆ reserve()

template<typename T>

virtual void geosx::dataRepository::Wrapper< T >::reserve ( localIndex const newCapacity )

inlineoverridevirtual

Calls T::reserve( newCapacity ) if it exists, otherwise a no-op.

Parameters

[in] newCapacity the new capacity of the T.

Implements geosx::dataRepository::WrapperBase.

Definition at line 490 of file Wrapper.hpp.

◆ resize() [1/2]

template<typename T>

virtual void geosx::dataRepository::Wrapper< T >::resize	(	int	num_dims,
		localIndex const *const	dims
	)

inlineoverridevirtual

Calls T::resize( num_dims, dims )

Parameters

[in]	num_dims	number of dimensions in T
[in]	dims	pointer to the new dims

Implements geosx::dataRepository::WrapperBase.

Definition at line 483 of file Wrapper.hpp.

◆ resize() [2/2]

template<typename T>

virtual void geosx::dataRepository::Wrapper< T >::resize ( localIndex const newsize )

inlineoverridevirtual

Calls T::resize(newsize) if it exists.

Parameters

[in] newsize parameter to pass to T::resize(newsize)

Implements geosx::dataRepository::WrapperBase.

Definition at line 504 of file Wrapper.hpp.

◆ setApplyDefaultValue() [1/2]

template<typename T>

template<typename U = T>

std::enable_if_t< !traits::is_array && DefaultValue::has_default_value, Wrapper< T > & > geosx::dataRepository::Wrapper< T >::setApplyDefaultValue ( typename DefaultValue::value_type const & defaultVal )

inline

Set and apply for default value.

Parameters

defaultVal the new default value

Returns: pointer to Wrapper<T>

Definition at line 680 of file Wrapper.hpp.

◆ setApplyDefaultValue() [2/2]

template<typename T>

template<typename U = T>

std::enable_if_t< traits::is_array && DefaultValue::has_default_value, Wrapper< T > & > geosx::dataRepository::Wrapper< T >::setApplyDefaultValue ( typename DefaultValue::value_type const & defaultVal )

inline

Set and apply for default value.

Parameters

defaultVal the new default value

Returns: pointer to Wrapper<T>

Definition at line 694 of file Wrapper.hpp.

◆ setDefaultValue()

template<typename T>

template<typename U = T>

std::enable_if_t< DefaultValue::has_default_value, Wrapper< T > & > geosx::dataRepository::Wrapper< T >::setDefaultValue ( typename DefaultValue::value_type const & defaultVal )

inline

Setter for default value.

Parameters

defaultVal the new default value

Returns: pointer to Wrapper<T>

Definition at line 667 of file Wrapper.hpp.

◆ setDescription()

template<typename T>

Wrapper< T >& geosx::dataRepository::Wrapper< T >::setDescription ( string const & description )

inline

Set the description string of the wrapper.

Parameters

description the description

Returns: a pointer to this wrapper

Definition at line 874 of file Wrapper.hpp.

◆ setDimLabels()

template<typename T>

virtual Wrapper& geosx::dataRepository::Wrapper< T >::setDimLabels	(	integer const	dim,
		Span< string const > const	labels
	)

inlineoverridevirtual

Set dimension labels for an array.

Parameters

dim	dimension index (must be less than number of array dimensions)
labels	array of labels

Returns: reference to this (for convenience of call chaining)

Dimension labels are typically used in visualization output to give context to plots of multidimensional data, such as fluid component and phase names. This method provides a way for physics modules (solvers and constitutive models) to communicate meaningful labels to output drivers (such as VTK and Silo).

An error is raised if wrapped type is not LvArray::Array.

Implements geosx::dataRepository::WrapperBase.

Definition at line 248 of file Wrapper.hpp.

◆ setInputFlag()

template<typename T>

Wrapper< T >& geosx::dataRepository::Wrapper< T >::setInputFlag ( InputFlags const input )

inline

Set the InputFlag of the wrapper.

Parameters

input the new InputFlags value

Returns: a pointer to this wrapper

Definition at line 865 of file Wrapper.hpp.

◆ setName()

template<typename T>

void geosx::dataRepository::Wrapper< T >::setName ( )

inline

DO_NOT_DOCUMENT.

Associate the path to this wrapper with the object being held.

Note: This calls T::setName( string ) if it exists and is a no-op if not. LvArray objects implement this method.

Definition at line 750 of file Wrapper.hpp.

◆ setPlotLevel()

template<typename T>

Wrapper< T >& geosx::dataRepository::Wrapper< T >::setPlotLevel ( PlotLevel const flag )

inline

Set the PlotLevel of the wrapper.

Parameters

flag	the new PlotLevel value

Returns: a pointer to this wrapper

Definition at line 856 of file Wrapper.hpp.

◆ setRegisteringObjects()

template<typename T>

Wrapper< T >& geosx::dataRepository::Wrapper< T >::setRegisteringObjects ( string const & objectName )

inline

Add a new name to the list of groups that register this wrapper.

Parameters

objectName name of the registering object

Returns: pointer to this wrapper

Definition at line 883 of file Wrapper.hpp.

◆ setRestartFlags()

template<typename T>

Wrapper< T >& geosx::dataRepository::Wrapper< T >::setRestartFlags ( RestartFlags flags )

inline

Set the RestartFlags of the wrapper.

Parameters

flags the new RestartFlags value

Returns: a pointer to this wrapper

Definition at line 847 of file Wrapper.hpp.

◆ setSizedFromParent()

template<typename T>

Wrapper< T >& geosx::dataRepository::Wrapper< T >::setSizedFromParent ( int val )

inline

Set whether this wrapper is resized when its parent is resized.

Parameters

val	an int that is converted into a bool

Returns: a pointer to this wrapper

Definition at line 838 of file Wrapper.hpp.

◆ size()

template<typename T>

virtual localIndex geosx::dataRepository::Wrapper< T >::size ( ) const

inlineoverridevirtual

Calls T::size()

Returns: result of T::size()

Implements geosx::dataRepository::WrapperBase.

Definition at line 479 of file Wrapper.hpp.

◆ typeRegex()

template<typename T>

virtual string geosx::dataRepository::Wrapper< T >::typeRegex ( ) const

inlineoverridevirtual

Calls TypeRegex< T >::get().

Returns: regex used to validate inputs of wrapped type

Implements geosx::dataRepository::WrapperBase.

Definition at line 564 of file Wrapper.hpp.

◆ unpack()

template<typename T>

virtual localIndex geosx::dataRepository::Wrapper< T >::unpack	(	buffer_unit_type const *&	buffer,
		bool	withMetadata,
		bool	onDevice,
		parallelDeviceEvents &	events
	)

inlinefinaloverridevirtual

Unpack the entire wrapped object from a buffer.

Parameters

[in,out]	buffer	the binary buffer pointer, advanced upon completion
[in]	withMetadata	whether to expect string metadata with the underlying data
[in]	onDevice	whether to use device-based packing functions (buffer must be either pinned or a device pointer)
[out]	events	a collection of events to poll for completion of async packing kernels ( device packing is incomplete until all events are finalized )

Returns: the number of buffer_unit_type units unpacked

Implements geosx::dataRepository::WrapperBase.

Definition at line 400 of file Wrapper.hpp.

◆ unpackByIndex()

template<typename T>

virtual localIndex geosx::dataRepository::Wrapper< T >::unpackByIndex	(	buffer_unit_type const *&	buffer,
		arrayView1d< localIndex const > const &	unpackIndices,
		bool	withMetadata,
		bool	onDevice,
		parallelDeviceEvents &	events
	)

inlinefinaloverridevirtual

For indexable types, unpack selected indices of wrapped object from a buffer.

Parameters

[in,out]	buffer	the binary buffer pointer, advanced upon completion
[in]	unpackIndices	the list of indices to pack
[in]	withMetadata	whether to include metadata in the packing
[in]	onDevice	whether to use device-based packing functions (buffer must be either pinned or a device pointer)
[out]	events	a collection of events to poll for completion of async packing kernels ( device packing is incomplete until all events are finalized )

Returns: the number of buffer_unit_type units unpacked

Implements geosx::dataRepository::WrapperBase.

Definition at line 430 of file Wrapper.hpp.

◆ voidPointer()

template<typename T>

void const* geosx::dataRepository::Wrapper< T >::voidPointer ( ) const

inlineoverridevirtual

Returns: a const void pointer to the data.

Implements geosx::dataRepository::WrapperBase.

Definition at line 463 of file Wrapper.hpp.

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

coreComponents/dataRepository/Wrapper.hpp

Public Types

Public Member Functions

Miscellaneous

Additional Inherited Members

Detailed Description

template<typename T> class geosx::dataRepository::Wrapper< T >

Constructor & Destructor Documentation

◆ Wrapper() [1/3]

◆ Wrapper() [2/3]

◆ Wrapper() [3/3]

◆ ~Wrapper()

Member Function Documentation

◆ addBlueprintField()

◆ averageOverSecondDim()

◆ capacity()

◆ cast() [1/2]

◆ cast() [2/2]

◆ clone()

◆ copy()

◆ copyData()

◆ copyWrapper()

◆ copyWrapperAttributes()

◆ elementByteSize()

◆ getDefaultValue()

◆ getDefaultValueString()

◆ getDefaultValueStruct()

◆ getDimLabels()

◆ getHistoryMetadata()

◆ getTypeId()

◆ hasDefaultValue()

◆ isPackable()

◆ loadFromConduit()

◆ move()

◆ numArrayComp()

◆ numArrayDims()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ pack()

◆ packByIndex()

◆ packByIndexSize()

◆ packSize()

◆ populateMCArray()

◆ processInputFile()

◆ reference() [1/2]

◆ reference() [2/2]

◆ referenceAsView() [1/4]

◆ referenceAsView() [2/4]

◆ referenceAsView() [3/4]

◆ referenceAsView() [4/4]

◆ reserve()

◆ resize() [1/2]

◆ resize() [2/2]

◆ setApplyDefaultValue() [1/2]

◆ setApplyDefaultValue() [2/2]

◆ setDefaultValue()

◆ setDescription()

◆ setDimLabels()

◆ setInputFlag()

◆ setName()

◆ setPlotLevel()

◆ setRegisteringObjects()

◆ setRestartFlags()

◆ setSizedFromParent()

◆ size()

◆ typeRegex()

◆ unpack()

◆ unpackByIndex()

◆ voidPointer()

template<typename T>
class geosx::dataRepository::Wrapper< T >