Classes
class	CatalogEntry
	Class to hold allocation capability for specific target derived types. More...

class	CatalogEntry< BASETYPE, TYPE >
	Specialization of `CatalogEntry` for types with no-argument constructors. More...

class	CatalogEntryConstructor
	A class to generate the catalog entry. More...

class	CatalogEntryConstructor< BASETYPE, TYPE >
	A specialization of `CatalogEntryConstructor` for types with no-argument constructors. More...

class	CatalogInterface
	This class provides the base class/interface for the catalog value objects. More...

class	CatalogInterface< BASETYPE >
	Specialization of `CatalogInterface` for types with no-argument constructors/. More...

class	Group

class	Wrapper

class	WrapperBase
	Base class for all wrappers containing common operations. More...

Typedefs
template<typename T >
using	DefaultValue = internal::Helper< T >
	A templated alias to hold default values. More...

using	keyType = string
	The default key type for entries in the hierarchy.

using	indexType = localIndex
	The default index type for entries the hierarchy.

using	GroupKey = Group::subGroupMap::KeyIndex
	Type alias for KeyIndexT type used for sub-group lookups.

using	ViewKey = Group::wrapperMap::KeyIndex
	Type alias for KeyIndexT type used for wrapper lookups.

Enumerations
enum	InputFlags : integer { InputFlags::INVALID, InputFlags::FALSE, InputFlags::OPTIONAL, InputFlags::OPTIONAL_NONUNIQUE, InputFlags::REQUIRED, InputFlags::REQUIRED_NONUNIQUE, InputFlags::PROBLEM_ROOT }

enum	RestartFlags : integer { RestartFlags::NO_WRITE, RestartFlags::WRITE, RestartFlags::WRITE_AND_READ }

enum	PlotLevel : integer { PlotLevel::LEVEL_0, PlotLevel::LEVEL_1, PlotLevel::LEVEL_2, PlotLevel::LEVEL_3, PlotLevel::NOPLOT }

Functions
InputFlags	IntToInputFlag (int const val)
	Convert integer value to InputFlags. More...

int	InputFlagToInt (InputFlags const val)
	Convert InputFlags to int. More...

std::string	InputFlagToString (InputFlags const val)
	Convert an InputFlags value to a string. More...

bool	operator== (InputFlags const left, InputFlags const right)
	Comparison operator for InputFlags enumeration. More...

bool	operator!= (InputFlags const left, InputFlags const right)
	Comparison operator for InputFlags enumeration. More...

bool	operator< (InputFlags const left, InputFlags const right)
	Comparison operator for InputFlags enumeration. More...

bool	operator> (InputFlags const left, InputFlags const right)
	Comparison operator for InputFlags enumeration. More...

bool	operator<= (InputFlags const left, InputFlags const right)
	Comparison operator for InputFlags enumeration. More...

bool	operator>= (InputFlags const left, InputFlags const right)
	Comparison operator for InputFlags enumeration. More...

PlotLevel	toPlotLevel (int const val)
	Function to get a PlotLevel enum from an int. More...

std::istream &	operator>> (std::istream &is, PlotLevel &plotLevel)
	Reads a PlotLevel enum from a stream. More...

std::ostream &	operator<< (std::ostream &os, PlotLevel const &plotLevel)
	Writes a plot level to a stream. More...

Detailed Description

Encapsulates all dataRepository classes and functionality.

Typedef Documentation

◆ DefaultValue

template<typename T >

using geosx::dataRepository::DefaultValue = typedef internal::Helper< T >

A templated alias to hold default values.

Template Parameters

T	the type to check

Definition at line 133 of file DefaultValue.hpp.

Enumeration Type Documentation

◆ InputFlags

enum geosx::dataRepository::InputFlags : integer

strong

Enumeration of flags that control reading XML input and schema generation.

Enumerator
INVALID	Invalid value.
FALSE	Not read from input.
OPTIONAL	Optional in input.
OPTIONAL_NONUNIQUE	Optional in input, may be repeated.
REQUIRED	Required in input.
REQUIRED_NONUNIQUE	Required in input, may be repeated.
PROBLEM_ROOT	Root of the hierarchy.

Definition at line 36 of file InputFlags.hpp.

◆ PlotLevel

enum geosx::dataRepository::PlotLevel : integer

strong

A scoped enum for the Plot options.

Enumerator
LEVEL_0	Write to plot always.
LEVEL_1	Write to plot when plotLevel>=1 is specified in input.
LEVEL_2	Write to plot when plotLevel>=2 is specified in input.
LEVEL_3	Write to plot when plotLevel>=3 is specified in input.
NOPLOT	Do not ever write to plot file.

Definition at line 44 of file RestartFlags.hpp.

◆ RestartFlags

enum geosx::dataRepository::RestartFlags : integer

strong

A scoped enum for the restart options.

Enumerator
NO_WRITE	Doe no write into restart.
WRITE	Write into restart.
WRITE_AND_READ	Write and read from restart.

Definition at line 32 of file RestartFlags.hpp.

Function Documentation

◆ InputFlagToInt()

int geosx::dataRepository::InputFlagToInt ( InputFlags const val )

inline

Convert InputFlags to int.

Parameters

[in] val value to convert

Returns: converted integer

Definition at line 85 of file InputFlags.hpp.

◆ InputFlagToString()

std::string geosx::dataRepository::InputFlagToString ( InputFlags const val )

inline

Convert an InputFlags value to a string.

Parameters

[in] val The value of the input flag that will be converted to a string

Returns: The string equivalent of the input val.

Definition at line 96 of file InputFlags.hpp.

◆ IntToInputFlag()

InputFlags geosx::dataRepository::IntToInputFlag ( int const val )

inline

Convert integer value to InputFlags.

Parameters

[in] val value to convert

Returns: converted enumeration

Definition at line 52 of file InputFlags.hpp.

◆ operator!=()

bool geosx::dataRepository::operator!=	(	InputFlags const	left,
		InputFlags const	right
	)

inline

Comparison operator for InputFlags enumeration.

Parameters

left	lhs value
right	rhs value

Returns: comparison result

Definition at line 154 of file InputFlags.hpp.

◆ operator<()

bool geosx::dataRepository::operator<	(	InputFlags const	left,
		InputFlags const	right
	)

inline

Comparison operator for InputFlags enumeration.

Parameters

left	lhs value
right	rhs value

Returns: comparison result

Definition at line 162 of file InputFlags.hpp.

◆ operator<<()

std::ostream& geosx::dataRepository::operator<<	(	std::ostream &	os,
		PlotLevel const &	plotLevel
	)

inline

Writes a plot level to a stream.

Parameters

os	The stream to read from.
plotLevel	the PlotLevel to write.

Returns: The stream.

Definition at line 112 of file RestartFlags.hpp.

◆ operator<=()

bool geosx::dataRepository::operator<=	(	InputFlags const	left,
		InputFlags const	right
	)

inline

Comparison operator for InputFlags enumeration.

Parameters

left	lhs value
right	rhs value

Returns: comparison result

Definition at line 178 of file InputFlags.hpp.

◆ operator==()

bool geosx::dataRepository::operator==	(	InputFlags const	left,
		InputFlags const	right
	)

inline

Comparison operator for InputFlags enumeration.

Parameters

left	lhs value
right	rhs value

Returns: comparison result

Definition at line 146 of file InputFlags.hpp.

◆ operator>()

bool geosx::dataRepository::operator>	(	InputFlags const	left,
		InputFlags const	right
	)

inline

Comparison operator for InputFlags enumeration.

Parameters

left	lhs value
right	rhs value

Returns: comparison result

Definition at line 170 of file InputFlags.hpp.

◆ operator>=()

bool geosx::dataRepository::operator>=	(	InputFlags const	left,
		InputFlags const	right
	)

inline

Comparison operator for InputFlags enumeration.

Parameters

left	lhs value
right	rhs value

Returns: comparison result

Definition at line 186 of file InputFlags.hpp.

◆ operator>>()

std::istream& geosx::dataRepository::operator>>	(	std::istream &	is,
		PlotLevel &	plotLevel
	)

inline

Reads a PlotLevel enum from a stream.

Parameters

is	The stream to read from.
plotLevel	The PlotLevel to write to.

Returns: The stream.

Definition at line 97 of file RestartFlags.hpp.

◆ toPlotLevel()

PlotLevel geosx::dataRepository::toPlotLevel ( int const val )

inline

Function to get a PlotLevel enum from an int.

Parameters

val	int that represents the PlotLevel

Returns: The PlotLevel that corresponds to the input

Definition at line 58 of file RestartFlags.hpp.

Classes

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

◆ DefaultValue

Enumeration Type Documentation

◆ InputFlags

◆ PlotLevel

◆ RestartFlags

Function Documentation

◆ InputFlagToInt()

◆ InputFlagToString()

◆ IntToInputFlag()

◆ operator!=()

◆ operator<()

◆ operator<<()

◆ operator<=()

◆ operator==()

◆ operator>()

◆ operator>=()

◆ operator>>()

◆ toPlotLevel()